Skip to main content

Ejecutar con API

Usa el endpoint público de invocación cuando quieras llamar a un prompt desde tu propia aplicación o servicio. Primero crea un deployment de prompt y una variante en el dashboard, luego invoca el deployment con tu clave de API del workspace.

Autenticación

Consulta API Keys para saber cómo crear y administrar claves.

Endpoint

POST https://api.fetchhive.com/v1/prompt/invoke Antes de llamar a este endpoint, crea o actualiza un deployment de prompt desde el editor de prompts. Consulta Publicación y versionado para el flujo de la interfaz.

Solicitud

Usa esta forma de solicitud: metadata debe ser plana y solo escalar: cadenas, números, booleanos o null. Los objetos anidados y los arreglos devuelven un error de validación antes de que comience la ejecución. Este endpoint no acepta image_urls ni attachments de documento a nivel superior. Si un prompt desplegado usa una parte de mensaje con URL de imagen, configura esa URL de imagen en el editor de prompts o vincúlala mediante una variable inputs en el contenido del prompt. Para adjuntos de imagen/documento en tiempo de ejecución, invoca un agente con POST /v1/agent/invoke.

Ejemplo básico

Reemplaza YOUR_API_KEY, YOUR_DEPLOYMENT_NAME, YOUR_VARIANT_NAME y el objeto inputs con tus valores reales. Usa metadata para campos de auditoría que quieras ver o filtrar en los registros, como IDs de clientes, nombres de planes, regiones o nombres de experimentos. No pongas variables de prompt ahí; las variables de prompt van en inputs. Consulta Metadata de invoke para ver ejemplos y detalles de filtrado de registros.

Respuesta

Si streaming es true, la API devuelve una transmisión de eventos data: en lugar de un solo objeto JSON final. Si el proveedor falla después de que la transmisión se ha abierto, la API envía un evento error final antes de cerrar la transmisión.

Respuesta en streaming

Puedes recibir diferentes tipos de eventos durante la transmisión. Por ejemplo: Evento de razonamiento o pensamiento:
Evento de respuesta:
Evento final de uso:
Evento de error:

Respuesta sin streaming

Si streaming es false, la API devuelve una sola respuesta JSON. Los fallos de ejecución del proveedor devuelven 502 Bad Gateway con un mensaje de error. Por ejemplo:

Siguientes pasos