Executar agente
Executar agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
POST
/Agent/runExecutar agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.
Descrição no OpenAPI: This endpoint runs the agent with the provided input message.
Autenticação
Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.
Parâmetros
Esta operação não possui parâmetros de rota, query ou header.
Corpo da requisição
Content type: multipart/form-data · Schema: object
| Propriedade | Tipo | Obrigatório | Descrição | Restrições |
|---|---|---|---|---|
file | string · binary | Não | — | — |
AgentId | integer · int32 | Não | — | — |
ConversationId | integer · int32 | Não | — | — |
UserInputMessage | string | Não | — | — |
MessageType | MessageType | Não | — | — |
ProgressRunId | string | Não | — | — |
DocumentId | integer · int32 | Não | — | — |
Exemplo de requisição
curl --request POST \
--url 'https://api.zild.ai/Agent/run' \
--header 'X-API-Key: YOUR_USER_API_KEY' \
--form 'file=@file' \
--form 'AgentId={AgentId}' \
--form 'ConversationId={ConversationId}' \
--form 'UserInputMessage={UserInputMessage}' \
--form 'MessageType={MessageType}' \
--form 'ProgressRunId={ProgressRunId}' \
--form 'DocumentId={DocumentId}'
Respostas
| Status | Descrição | Corpo da resposta |
|---|---|---|
200 | Execution completed successfully | application/json · AgentRunTextResponseDto |
Exemplo de resposta (200):
{
"conversationId": 0,
"userMessageId": 0,
"attachmentMessageId": 0,
"assistantMessageId": 0,
"reply": "string"
}
Modelos de dados
AgentRunTextResponseDto
| Propriedade | Tipo | Obrigatório | Descrição | Restrições |
|---|---|---|---|---|
conversationId | integer · int32 | Não | — | — |
userMessageId | integer · int32 | Não | — | — |
attachmentMessageId | integer · int32 | Não | — | aceita null |
assistantMessageId | integer · int32 | Não | — | — |
reply | string | Não | — | aceita null |
MessageType
0 = Text; 1 = Image; 2 = File; 3 = Audio; 4 = Video; 5 = Internal; 6 = TemplateMarketing; 7 = TemplateUtility; 8 = Location; 9 = Contact
integer