Pular para o conteúdo
Guias
Guias

Início rápido

Chame modelos de linguagem do RunAPI por meio de um protocolo síncrono ou de streaming compatível.

O RunAPI expõe modelos de linguagem por meio de formatos de protocolo públicos familiares. Aponte um cliente compatível existente para https://runapi.ai, use um identificador de modelo RunAPI e autentique-se com uma Chave de API padrão.

Escolher um protocolo

  • Chat Completions compatível com OpenAI usa POST /v1/chat/completions.
  • Responses compatível com OpenAI usa POST /v1/responses.
  • Messages compatível com Anthropic usa POST /v1/messages.
  • Geração de conteúdo compatível com Gemini usa /v1beta/models/{model}:generateContent ou :streamGenerateContent.

Escolha o protocolo que melhor se adapta ao seu cliente e fluxo de aplicação existentes. O catálogo de modelos indica quais protocolos públicos cada modelo suporta.

Enviar uma requisição

Esta requisição de Chat Completions retorna uma resposta síncrona:

SHELL
curl "https://runapi.ai/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [{"role": "user", "content": "Summarize why idempotency matters."}]
  }'

Mantenha a requisição e a resposta no formato de protocolo selecionado. Use a Referência da API da operação para campos exatos, chamada de ferramentas, saída estruturada e restrições específicas do modelo.

Saída em streaming

Defina a opção de streaming do protocolo e consuma os server-sent events retornados de forma incremental. Para Chat Completions, adicione "stream": true; para chamadas compatíveis com Gemini, use a operação :streamGenerateContent. Feche o stream quando seu cliente receber o evento terminal do protocolo.

Inspecionar fidelidade de entrega

Toda resposta LLM aceita inclui X-RunAPI-Fidelity. Um valor de full significa que a requisição foi entregue sem omissão. Um valor de lossy significa que o RunAPI omitiu controles opcionais para completar a requisição; X-RunAPI-Omitted-Fields contém seus nomes de campo separados por vírgula. Requisições cujos ciclos de vida obrigatórios, continuação, ferramenta ou semântica de item tipado não puderem ser preservados são rejeitadas antes da criação de uma Task.

Ambos os cabeçalhos são expostos via CORS, de modo que clientes de navegador podem inspecioná-los. Registre-os junto ao identificador da requisição quando o comportamento exato de entrega for importante para a aplicação.

Tratar erros e uso

Trate 401 como falha de Autenticação, respostas 4xx como problemas de requisição ou de política, e tente novamente apenas falhas transitórias de servidor ou de rede. Leia o uso de tokens da resposta final ou do evento de stream terminal no formato de protocolo selecionado, e mantenha os identificadores de requisição nos logs da aplicação para suporte.