Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.mka1.com/llms.txt

Use this file to discover all available pages before exploring further.

Use o recurso de Conversas quando você quiser que a API MKA1 mantenha o estado da conversa entre as requisições de Responses. Isso é útil para chats de múltiplas interações, threads de suporte e fluxos de trabalho onde você deseja buscar ou editar o histórico salvo posteriormente.

Criar uma conversa

Crie uma conversa primeiro. Você pode anexar metadados para manter seu próprio contexto de sessão ou roteamento.
mka1 llm conversations create \
  -H 'X-On-Behalf-Of: <end-user-id>' \
  --body '{
    "metadata": {
      "session_id": "web-42",
      "channel": "support"
    }
  }'
Se sua requisição não estiver vinculada a um usuário final específico, omita X-On-Behalf-Of. Veja o guia de autenticação para o padrão completo.

Adicionar itens à conversa

Adicione um ou mais itens com POST /api/v1/llm/conversations/{conversation_id}/items.
mka1 llm conversations create-items \
  --conversation-id conv_abc123 \
  --body '{
    "items": [
      {
        "type": "message",
        "role": "user",
        "content": "Summarize the latest support ticket."
      }
    ]
  }'
Use este endpoint quando quiser escrever o histórico explicitamente antes de chamar o recurso Responses.

Continue o fluxo com o recurso Responses

Passe o ID da conversa na sua próxima requisição de Responses. Isso permite que a API MKA1 use o estado salvo da conversa.
mka1 llm responses create \
  --model meetkai:functionary-pt \
  --conversation conv_abc123 \
  --input '"Turn that summary into a customer-ready reply."'
Você também pode continuar adicionando itens à mesma conversa conforme a troca evolui.

Ler, atualizar ou limpar uma conversa

Use os endpoints de Conversas para:
  • Listar conversas para a conta atual ou usuário final (GET /api/v1/llm/conversations).
  • Filtrar listas com after, limit, order, metadata e search.
  • Buscar uma conversa pelo ID (GET /api/v1/llm/conversations/{conversation_id}).
  • Atualizar os metadados da conversa (POST /api/v1/llm/conversations/{conversation_id}).
  • Listar itens em uma conversa (GET /api/v1/llm/conversations/{conversation_id}/items).
  • Buscar um item específico (GET /api/v1/llm/conversations/{conversation_id}/items/{item_id}).
  • Excluir itens (um ou vários) via:
    • DELETE /api/v1/llm/conversations/{conversation_id}/items/{item_id}
    • DELETE /api/v1/llm/conversations/{conversation_id}/items com { "item_ids": ["item_..."] }
  • Excluir a conversa (DELETE /api/v1/llm/conversations/{conversation_id}).
Nota: excluir uma conversa não exclui seus itens. Use a aba de Referência da API para os formatos exatos de requisição e resposta de cada operação.

Quando usar conversas vs previous_response_id

Use uma conversa quando:
  • Você deseja um contêiner reutilizável para várias interações.
  • Você precisa listar ou gerenciar itens salvos posteriormente.
  • Você quer anexar metadados ao thread em andamento.
Use previous_response_id quando:
  • Você só precisa continuar a partir de uma resposta anterior.
  • Você não precisa de um recurso de conversa armazenado separadamente.
Para o padrão do lado da resposta, veja gerar uma resposta.