Arquivos e lotes

Recuperar Batch

Recupera o status atual, as contagens e os arquivos de resultado de um batch.

GET
/v1/batches/{batch_id}

Visão geral

Retorna o status do batch, as contagens de requisições e os IDs dos arquivos de resultado. Um ID de batch desconhecido, ou um batch de outro Workspace, retorna 404 batch_not_found.

status é um dos seguintes: validating, queued, in_progress, finalizing, completed, failed, cancelling, cancelled ou expired. Os arquivos de resultado estão prontos quando status for completed; leia-os com Recuperar Conteúdo do Arquivo.

Exemplo

Requisição

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

Exemplo de resposta

Resposta

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "completed",
  "input_file_id": "file_abc123",
  "output_file_id": "file_out123",
  "error_file_id": "file_err123",
  "request_counts": { "total": 100, "completed": 98, "failed": 2 }
}

Campos importantes

request_countsobject
Contagens de requisições totais, concluídas, com falha e canceladas.
output_file_idstring|null
ID do arquivo de resultado bem-sucedido.
error_file_idstring|null
ID do arquivo de resultado com falha.

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

batch_id*string

Resposta

application/json

application/json

application/json