Referência da API

Criar conversa de chat

POST/v1/chat/completions

Endpoint compatível de texto/ferramentas OpenAI Chat Completions. image_url só está disponível em modelos com entrada de imagens. Saída de texto/ferramentas; recursos, campos opcionais e preços dependem do modelo. stream=true retorna SSE, pode incluir uso final e termina com data: [DONE].

Autenticação e permissões

Use sua chave atual do GloopAPI. Modelos, recursos e permissões disponíveis dependem do catálogo da chave e da documentação do endpoint.

Authorization: Bearer $GLOOP_API_KEY

Esquemas de autenticação: BearerAuth

Solicitação

Corpo da solicitação · application/json

Tipo
object
Campos obrigatórios
modelmessages

Corpo da solicitação obrigatório

  • modelstringObrigatório

    ID do modelo

  • messagesarrayObrigatório

    Lista de mensagens da conversa

    Campos filhos de messages (1)
    • []objectOpcional
      Campos filhos de [] (6)
      • rolestringObrigatório

        Papel da mensagem

        Enumeração
        ["system","user","assistant","tool","developer"]
      • contentunionObrigatório

        Conteúdo da mensagem

        Ramificação oneOf 1

        Tipo: string

        Ramificação oneOf 2

        Tipo: array

        • []objectOpcional
          Campos filhos de [] (6)
          • typestringOpcional
            Enumeração
            ["text","image_url","input_audio","file","video_url"]
          • textstringOpcional
          • image_urlunionOpcional

            Aceita URL/Base64 como string ou objeto {url, detail} em wire; apenas modelos com imagens. Não garante visão em todos os modelos.

            Ramificação oneOf 1

            URL da imagem ou URL de dados Base64.

            Tipo: string

            Ramificação oneOf 2

            O objeto deve incluir pelo menos url; Message.ParseContent normaliza detail omitido para high. O suporte depende do modelo visual escolhido.

            Tipo: object

            Obrigatório nesta ramificação: url

            • urlstringObrigatório

              URL da imagem ou base64

            • detailstringOpcional
              Enumeração
              ["low","high","auto"]
          • input_audioobjectOpcional
            Campos filhos de input_audio (2)
            • datastringOpcional

              Áudio codificado em Base64

            • formatstringOpcional
              Enumeração
              ["wav","mp3"]
          • fileobjectOpcional
            Campos filhos de file (3)
          • video_urlstringOpcional

            A entrada wire real lida por Message.ParseContent é uma string URL de vídeo, apenas para modelos com entrada de vídeo. Um objeto {url: ...} não entra nos resultados de conteúdo/medição desse parser e não é publicado como contrato utilizável.

      • namestringOpcional

        Nome do remetente

      • tool_callsarrayOpcional
        Campos filhos de tool_calls (1)
        • []objectOpcional
          Campos filhos de [] (3)
      • tool_call_idstringOpcional

        ID da chamada de ferramenta (mensagens com papel tool)

      • reasoning_contentstringOpcional

        Conteúdo de raciocínio

  • temperaturenumberOpcional

    Temperatura de amostragem. Suporte e limites conforme modelo; sem padrões uniformes garantidos.

  • top_pnumberOpcional

    Parâmetro de amostragem por núcleo. Suporte e limites conforme modelo; sem padrões uniformes garantidos.

  • nintegerOpcional

    Quantidade a gerar. Suporte e limites conforme modelo; sem padrões uniformes garantidos.

  • streambooleanOpcional

    Se a resposta é em streaming

    Valor padrão
    false
  • stream_optionsobjectOpcional

    Opções de uso no fluxo Chat; o suporte e o retorno de dados de uso dependem do modelo escolhido.

    Campos filhos de stream_options (1)
  • stopunionOpcional

    Sequências de parada

    Ramificação oneOf 1

    Tipo: string

    Ramificação oneOf 2

    Tipo: array

    • []stringOpcional
  • max_tokensintegerOpcional

    Máximo de tokens gerados. Suporte e limites conforme modelo; sem padrões uniformes garantidos.

  • max_completion_tokensintegerOpcional

    Máximo de tokens de conclusão. Suporte e limites conforme modelo; sem padrões uniformes garantidos.

  • presence_penaltynumberOpcional

    O suporte e os limites dependem do modelo escolhido; não há garantia de valores padrão uniformes.

  • frequency_penaltynumberOpcional

    O suporte e os limites dependem do modelo escolhido; não há garantia de valores padrão uniformes.

  • logit_biasobjectOpcional
    Campos filhos de logit_bias (1)
  • userstringOpcional
  • toolsarrayOpcional
    Campos filhos de tools (1)
    • []objectOpcional
      Campos filhos de [] (2)
      • typestringOpcional
      • functionobjectOpcional
        Campos filhos de function (3)
  • tool_choiceunionOpcional
    Ramificação oneOf 1

    Tipo: string

    Enumeração: ["none","auto","required"]

    Ramificação oneOf 2

    Tipo: object

    • typestringOpcional
    • functionobjectOpcional
      Campos filhos de function (1)
  • response_formatobjectOpcional
    Campos filhos de response_format (2)
    • typestringOpcional
      Enumeração
      ["text","json_object","json_schema"]
    • json_schemaobjectOpcional

      Definição JSON Schema

  • seedintegerOpcional

    O suporte e os limites dependem do modelo escolhido; não há garantia de valores padrão uniformes.

  • reasoning_effortstringOpcional

    Intensidade de raciocínio (modelos compatíveis). Suporte e limites conforme modelo, sem padrões uniformes garantidos.

  • modalitiesarrayOpcional
    Campos filhos de modalities (1)
    • []stringOpcional
      Enumeração
      ["text","audio"]
  • audioobjectOpcional
    Campos filhos de audio (2)
  • parallel_tool_callsbooleanOpcional

    Chamadas paralelas de ferramentas dependem do modelo escolhido. Chat aceita um booleano; Responses aceita valores JSON do protocolo compatível.

  • storebooleanOpcional

    A permissão para armazenar solicitações e respostas depende do modelo escolhido e dos recursos do serviço. Isso não oferece uma API geral de armazenamento de conversas.

  • prompt_cache_keystringOpcional

    Identificador de correlação de cache de prompt do serviço; depende do modelo, sem garantia de acerto ou suporte. Chat aceita strings; Responses, valores JSON do protocolo do serviço.

  • prompt_cache_retentionunknownOpcional

    Valor JSON de controle de retenção de cache de prompt do serviço; depende do modelo. Não há enumeração, padrão ou garantia de retenção uniforme da plataforma.

  • service_tierunknownOpcional

    Nível de serviço solicitado, que pode afetar o custo. Ignorado por padrão e aplicado apenas quando compatível. Os valores aceitos dependem do modelo escolhido.

Respostas e erros

HTTP 200

Resposta criada com sucesso

application/json

Tipo
object
Propriedades adicionais
false

text/event-stream

Tipo
string
Descrição
Fluxo de eventos SSE; eventos, uso e marcadores finais dependem do endpoint. Podem ocorrer erros dentro do fluxo.
{
  "type": "string",
  "description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}

HTTP 400

Parâmetros de solicitação incorretos

application/json

Tipo
object
  • errorobjectOpcional
    Campos filhos de error (4)
    • messagestringOpcional

      Mensagem de erro

    • typestringOpcional

      Tipo de erro

    • paramstringOpcionalPermite null

      Parâmetros relacionados

    • codestringOpcionalPermite null

      Código de erro

HTTP 401

A chave está ausente, inválida, expirada ou revogada.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 403

Permissões insuficientes de IP, conta, modelo ou ferramenta.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 429

Limite de frequência de solicitações

application/json

Tipo
object
  • errorobjectOpcional
    Campos filhos de error (4)
    • messagestringOpcional

      Mensagem de erro

    • typestringOpcional

      Tipo de erro

    • paramstringOpcionalPermite null

      Parâmetros relacionados

    • codestringOpcionalPermite null

      Código de erro

HTTP 500

Falha interna de autenticação ou armazenamento de dados.

application/json

Tipo
object
Campos obrigatórios
error
Pronto para criar? Abra console para criar uma chave de API, ou explore recursos.