Texto

Recuperar Resposta

Recupera uma resposta armazenada por ID, ou faz o polling de uma resposta em segundo plano.

GET
/v1/responses/{id}

Visão Geral

Retorna uma resposta que foi criada pelo Criar Resposta. Use-o para fazer o polling de uma resposta background até que seu status seja final, ou para ler uma resposta armazenada novamente.

  • Quais respostas: Respostas criadas com store não definido como false, e respostas background. Com store: false, o TokenLab não mantém nada para retornar.
  • Retenção: O TokenLab mantém uma resposta armazenada por 24 horas. Algumas permanecem recuperáveis por até 30 dias, mas não dependa disso: salve o resultado que você precisa. Após o período de retenção, o ID retorna 404.
  • Propriedade: Você pode ler apenas respostas criadas em sua própria conta. Um ID de outra conta retorna 404, o mesmo que um ID desconhecido.
  • Status: queued, in_progress, completed, incomplete, failed ou cancelled. Verifique o status, não apenas o código HTTP.

stream e starting_after aplicam-se enquanto uma resposta ainda está em execução. Uma resposta finalizada é retornada como JSON. include e include_obfuscation são encaminhados onde o modelo os suporta.

Exemplo

Requisição

cURL
curl -X GET "https://api.tokenlab.sh/v1/responses/resp_abc123" \
  -H "Authorization: Bearer sk-your-api-key"

Exemplo de resposta

Resposta

200 OK
{
  "id": "resp_abc123",
  "object": "response",
  "created_at": 1706000000,
  "status": "completed",
  "model": "gpt-5.6-terra",
  "output": [
    {
      "id": "msg_abc123",
      "type": "message",
      "status": "completed",
      "role": "assistant",
      "content": [
        {"type": "output_text", "text": "Hello! How can I help you today?", "annotations": []}
      ]
    }
  ],
  "usage": {
    "input_tokens": 10,
    "output_tokens": 12,
    "total_tokens": 22
  }
}

Erros

StatusCódigoSignificado
404response_not_foundO ID é desconhecido, pertence a outra conta, foi excluído, foi criado com store: false ou ultrapassou seu período de retenção.
502upstream_response_read_failedO TokenLab não conseguiu ler a resposta do serviço que a produziu. Tente novamente mais tarde.
503response_state_unavailable, response_result_unavailableO estado da resposta está temporariamente indisponível. Tente novamente mais tarde.

Autorização

BearerAuth
AuthorizationBearer <token>

Autenticação por Chave de API. Crie ou gerencie chaves de API em Dashboard > API > API Keys.

Local: header

Parâmetros de caminho

id*string

ID da resposta retornado por POST /v1/responses.

Parâmetros de consulta

include?array<string>

Campos de resposta adicionais para incluir, encaminhados onde o modelo os suporta.

include_obfuscation?boolean

Define se os eventos de streaming incluem campos de ofuscação, encaminhados onde o modelo os suporta.

stream?boolean

Define se a resposta deve ser recuperada como um stream de eventos. Aplica-se enquanto a resposta ainda está em execução; uma resposta finalizada é retornada como JSON.

starting_after?integer

Número da sequência após o qual os eventos de streaming são retornados. Aplica-se apenas com stream.

Resposta

application/json

application/json

application/json

application/json