Skip to main content
Use o recurso Responses quando quiser que a API MKA1 retorne texto. Comece com uma string simples para prompts simples. Use itens de mensagem quando precisar de funções explícitas ou estado da conversa.

Enviar um prompt simples

Passe uma string em input para uma solicitação de uma única interação. A resposta inclui o texto gerado em output_text.
Se você não estiver agindo em nome de um usuário final, omita X-On-Behalf-Of.

Adicionar instruções

Use instructions para definir o comportamento antes de o modelo ver a entrada do usuário. Mantenha as instruções curtas e específicas.

Enviar mensagens estruturadas

Use uma matriz de itens de mensagem em input quando quiser funções explícitas. Cada item de mensagem usa type, role e content.
Esse padrão é útil quando você quer que o corpo da solicitação transporte diretamente o histórico de mensagens.

Continuar uma troca de várias interações

Use previous_response_id para continuar a partir de uma resposta anterior sem reenviar todo o histórico.
Se precisar de um contêiner de conversa reutilizável, crie um com o recurso Conversations e passe o ID da conversa em conversation.
Consulte as páginas Conversations e Responses na Referência da API para conhecer o fluxo de trabalho completo do recurso.

Transmitir texto à medida que é gerado

Defina stream como true para receber eventos enviados pelo servidor em vez de esperar pela resposta completa.
Use streaming quando quiser renderizar a saída parcial à medida que ela chega.

Próximas etapas

  • Consulte a visão geral da API para detalhes sobre autenticação e URL base
  • Consulte respostas em segundo plano quando precisar delegar trabalhos de longa duração e consultar ou transmitir os resultados
  • Consulte gerenciar conversas para organizar trocas de várias interações em contêineres de conversa reutilizáveis
  • Consulte gerenciar agentes quando quiser definições de agentes reutilizáveis e execuções persistentes