Where a batch stands: its state and how many requests are done or failed

Before you call

Credential

Authorization: Bearer $KEY

Scope

models:read

Graphql

Query.modelsBatchGet

Sdk

models.batch.get

Cli

models batch get

Parameters

• idstring (uuid)required
  In the path

Responses

• 200application/json
  Success
  • idstringrequired
  • objectbatchrequired
  • kindstringrequired
  • statestringrequired
    One of: queued, running, completed, cancelled, failed.
  • idempotencyKeystringrequired
  • countsobjectrequired
    • totalnumberrequired
    • donenumberrequired
    • failednumberrequired
  • costUsdnumberrequired
  • createdAtstringrequired
  • startedAtstring or nullrequired
  • endedAtstring or nullrequired
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring