Endpoints

Saídas estruturadas

Faça o modelo retornar JSON que segue o seu JSON Schema usando response_format, com parâmetros, exemplo de resposta e suporte por modelo.

Teste no playground

As saídas estruturadas fazem o modelo retornar JSON que corresponde a um JSON Schema fornecido por você. Use-as para extração, classificação e qualquer resposta que o seu código precise interpretar. Defina response_format em Chat completions (ou text.format em Responses).

Parâmetros da requisição

Parâmetro	Tipo	Descrição
`response_format.type`	string	`"json_schema"` para saída restrita por schema. `"json_object"` para o modo JSON livre.
`response_format.json_schema.name`	string	Um nome para o schema.
`response_format.json_schema.strict`	boolean	`true` aplica o schema exatamente onde o provedor suporta.
`response_format.json_schema.schema`	object	Um JSON Schema. Com `strict`, use `additionalProperties: false` e liste todas as propriedades em `required`.

{
  "model": "openai/gpt-5-mini",
  "messages": [{ "role": "user", "content": "Extract: Ada Lovelace, born 1815 in London." }],
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "person",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "born": { "type": "integer" },
          "city": { "type": "string" }
        },
        "required": ["name", "born", "city"],
        "additionalProperties": false
      }
    }
  }
}

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api14.com/api/v1",
  apiKey: process.env.API14_API_KEY,
});

const result = await client.chat.completions.create({
  "model": "openai/gpt-5-mini",
  "messages": [
    {
      "role": "user",
      "content": "Extract the city and country from: \"I live in Lisbon, Portugal.\""
    }
  ],
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "place",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        },
        "required": [
          "city",
          "country"
        ],
        "additionalProperties": false
      }
    }
  }
});
console.log(JSON.parse(result.choices[0].message.content));

Resposta

O JSON chega como uma string em message.content:

{
  "id": "gen-1760000000-json1",
  "model": "openai/gpt-5-mini",
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": { "role": "assistant", "content": "{\"name\":\"Ada Lovelace\",\"born\":1815,\"city\":\"London\"}" }
    }
  ],
  "usage": { "prompt_tokens": 71, "completion_tokens": 18, "total_tokens": 89, "cost": 0.0000538 }
}

Os helpers dos SDKs funcionam normalmente, por exemplo client.chat.completions.parse(...) com Zod no Node ou Pydantic no Python.

Suporte por modelo

Para encontrar modelos que o suportam, verifique supported_parameters em Modelos procurando por structured_outputs ou response_format.
Para garantir que a requisição vá apenas a provedores que respeitam o schema, adicione provider: { "require_parameters": true }.
Modelos sem suporte nativo ainda podem produzir JSON se você pedir no prompt, mas a saída não é garantida. Sempre valide.
Se finish_reason for "length", o JSON foi truncado. Aumente max_tokens.

Erros

Um schema inválido geralmente retorna um 400 do provedor com a mensagem dele. Os demais erros são os mesmos de Chat completions. Veja Erros.