Arquivos e lotes

Listar Batches

Lista os batches no Workspace atual.

GET
/v1/batches

Visão geral

Retorna os batches criados por meio de POST /v1/batches no Workspace atual, do mais recente para o mais antigo. Message Batches são listados por Listar Message Batches.

Parâmetros de consulta

limitintegerquerypadrão: 20
Número de batches a serem retornados, de 1 a 100.
afterstringquery
Cursor de ID de batch: retorna batches após este. Use o last_id da página anterior. Não pode ser combinado com before.
beforestringquery
Cursor de ID de batch: retorna batches antes deste. Não pode ser combinado com after.
orderstringquerypadrão: desc
asc ou desc, por data de criação.

Exemplo

Requisição

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

Exemplo de resposta

Resposta

200 OK
{
  "object": "list",
  "data": [{ "id": "batch_abc123", "object": "batch", "status": "completed" }],
  "first_id": "batch_abc123",
  "last_id": "batch_abc123",
  "has_more": false
}

Campos importantes

objectstring
Sempre list.
dataarray
Batches.
statusstring
Status de cada batch.
has_moreboolean
Mais resultados estão disponíveis quando has_more for true.

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 consulta

limit?integer

Número de lotes a retornar. Padrão 20.

Intervalo1 <= value <= 100
padrão20
after?string

Cursor de ID de lote: retorna lotes após este. Não pode ser combinado com before.

before?string

Cursor de ID de lote: retorna lotes antes deste. Não pode ser combinado com after.

order?string

Ordem de classificação por tempo de criação.

padrão"desc"

Valores permitidos

  • "asc"
  • "desc"

Resposta

application/json

application/json

application/json