Criar conversa com agente

Criar conversa com agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.

POST /Agent/conversation

Criar conversa com agente. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.

Descrição no OpenAPI: This endpoint creates a new conversation between a user and the agent.

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: application/json · Schema: AgentConversationRequestDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`agentId`	`integer · int32`	Não	—	—
`inputMessage`	`string`	Não	—	aceita null
`messageType`	`MessageType`	Não	—	—
`mediaFileName`	`string`	Não	—	aceita null
`mediaUrl`	`string`	Não	—	aceita null
`documentId`	`integer · int32`	Não	—	—

Exemplo de requisição

curl --request POST \
  --url 'https://api.zild.ai/Agent/conversation' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentId": 0,
  "inputMessage": "string",
  "messageType": 0,
  "mediaFileName": "string",
  "mediaUrl": "string",
  "documentId": 0
}'

Respostas

Status	Descrição	Corpo da resposta
`200`	Conversation created successfully	Nenhum corpo de resposta está definido.

Modelos de dados

AgentConversationRequestDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`agentId`	`integer · int32`	Não	—	—
`inputMessage`	`string`	Não	—	aceita null
`messageType`	`MessageType`	Não	—	—
`mediaFileName`	`string`	Não	—	aceita null
`mediaUrl`	`string`	Não	—	aceita null
`documentId`	`integer · int32`	Não	—	—

MessageType

0 = Text; 1 = Image; 2 = File; 3 = Audio; 4 = Video; 5 = Internal; 6 = TemplateMarketing; 7 = TemplateUtility; 8 = Location; 9 = Contact

integer