Saltar al contenido principal

Estimación desde texto

Con una llave de producción, una estimación desde texto cuesta 10 créditos. Un seguimiento que responde su pregunta cuesta 5.

Envía una descripción​

curl https://api.wfskills.com/v1/estimates \
-H "Authorization: Bearer $HOMETOWN_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"input": {"text": "Install 100 feet of wood privacy fence"}}'

input.text admite hasta 4,000 caracteres. Para incluir la conversación hasta ahora, envía input.messages, con hasta 10 mensajes de 1,000 caracteres cada uno. Cada mensaje lleva un role, customer o assistant, y su content.

Campos opcionales​

CampoUso
regionUn código de región de GET /v1/regions, cuando el trabajo no está en la región predeterminada.
localeEl idioma de steps, como es-MX.
currencyEl código de moneda de la región. Otra moneda responde 422.
hourly_rateTu tarifa por hora en unidades enteras de la moneda, de 1 a 2,000 (72 significa USD 72.00). Reemplaza la tarifa del mercado.
crew_sizePersonas en el trabajo, de 1 a 10. Las horas no cambian y el tiempo en sitio baja.
include_extrasfalse para omitir los trabajos relacionados que también menciona la descripción.
metadataHasta 20 claves propias con valores de texto de hasta 500 caracteres, que vuelven con la estimación.

Lee el estado​

EstadoQué hacer
pricedMuestra price y steps.
needs_detailHazle al cliente la pregunta de question y envía un seguimiento.
unsupportedHometown no cotiza este trabajo. No hay nada que reintentar.
unclearHazle al cliente la pregunta de question o envía una descripción nueva.

Responde la pregunta​

Si el estado es needs_detail, envía la respuesta del cliente a la misma estimación:

curl https://api.wfskills.com/v1/estimates/est_<id>/follow-up \
-H "Authorization: Bearer $HOMETOWN_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"input": {"messages": [{"role": "customer", "content": "About 100 feet"}]}}'

La respuesta es una estimación nueva con su propio id.

Lee, lista y borra​

  • GET /v1/estimates/{id} devuelve una estimación.
  • GET /v1/estimates las lista, de la más reciente a la más antigua.
  • DELETE /v1/estimates/{id} borra una estimación y sus seguimientos. No se puede recuperar.

Hometown borra cada estimación al terminar el periodo de retención de la cuenta, de 30 días como máximo.