API de Amazi

Chats de proyectos

Crea y gestiona chats, envía mensajes y sigue sus resultados a través de API v1.

Antes de empezar

Utilice https://api.amazi.ai/v1/projects/{projectId}/chats desde su servidor o automatización. Copie los ID del proyecto y del chat del proyecto URL; la lista de chat también devuelve ID de chat.

Cree un token API personal con permisos de chat: lectura y/o chat: escritura.

Listar chats por ID de proyecto

Envíe GET /v1/projects/{projectId}/chats con un token que tenga el permiso chat:read. Sólo necesitas el ID del proyecto; No se requiere una identificación de chat.

Configure PROJECT_ID con el ID de su proyecto y AMAZI_API_TOKEN con su token API personal, luego ejecute:


HTTP 200 devuelve una matriz **items** que contiene los chats activos del proyecto. El **id** de cada elemento es el chatId que se utilizará en los otros puntos finales. Si no hay chats activos, los elementos están vacíos. Para enumerar los chats archivados, utilice **GET /v1/projects/{projectId}/chats?archived=true**. Esta lista no tiene parámetros de paginación.

## Operaciones de chat

Todas las rutas a continuación son rutas completas en **https://api.amazi.ai**. Reemplace **{projectId}** con su ID de proyecto y **{chatId}** con un ID de chat de la lista.

| Método y camino | Alcance | Resultado |
| --- | --- | --- |
| OBTENER /v1/proyectos/{projectId}/chats | charla: leer | elementos que contienen chats activos; archived=true selecciona chats archivados |
| ENVIAR /v1/proyectos/{projectId}/chats | charla:escribir | Crea un chat vacío con {"title":"Automation"}; HTTP 201 |
| OBTENER /v1/proyectos/{projectId}/chats/{chatId} | charla: leer | Leer un chat |
| PARCHE /v1/projects/{projectId}/chats/{chatId} | charla:escribir | Cambiar nombre con {"title":"Nuevo título"} |
| ENVIAR /v1/proyectos/{projectId}/chats/{chatId}/archive | charla:escribir | Archivar el chat |
| ENVIAR /v1/proyectos/{projectId}/chats/{chatId}/restore | charla:escribir | Restaurar un chat archivado |
| OBTENER /v1/proyectos/{projectId}/chats/{chatId}/messages | charla: leer | artículos y nextCursor; límite opcional de 1 a 100 |
| ENVIAR /v1/proyectos/{projectId}/chats/{chatId}/messages | charla:escribir | Enviar texto; HTTP 202 |
| OBTENER /v1/proyectos/{projectId}/chats/{chatId}/queue | charla: leer | Envíos pendientes, enviados y fallidos para este chat |

Consulte la [referencia de Swagger API v1](https://api.amazi.ai/v1/docs) para conocer los parámetros de solicitud y los esquemas de respuesta.

## enviar un mensaje

~~~bash curl --fail-with-body "https://api.amazi.ai/v1/projects/$PROJECT_ID/chats/$CHAT_ID/messages" \ -H "Authorization: Portador $AMAZI_API_TOKEN" \ -H "Idempotency-Key: $REQUEST_UUID" \ -H "Content-Type: application/json" \ -d '{"content":"Actualizar la página de inicio"}' ~~~

Genere REQUEST_UUID una vez para cada mensaje deseado. Vuelva a intentarlo con el mismo UUID y cuerpo idéntico después de una falla de conexión. Los envíos retenidos en cola y los mensajes guardados se deduplican; Se rechaza la reutilización de una clave con texto modificado o respuesta. No vuelva a intentar un envío que haya cancelado en Amazi. El replyToMessageId opcional debe identificar un mensaje en este chat. La versión 1 acepta texto de hasta 100.000 caracteres; La carga de archivos adjuntos y la selección de modelo no están disponibles a través de este punto final.

## Sigue el resultado

La respuesta contiene submissionId, chatId y disposición (**en cola** o **iniciado**). HTTP 202 confirma la aceptación, no la finalización. Siga la cola de chat y el historial de mensajes para obtener resultados. Si isAwaitingUser es verdadero, abra Amazi para responder la pregunta o solicitud de conexión del agente. Se aplican reglas normales de acceso al proyecto, disponibilidad, colas de mantenimiento y crédito.

[Límites, errores y seguridad de tokens](doc:amazi-api-authentication) · [API descripción general y mantenimiento](doc:amazi-api)