Skip to main content
GET
Batch status and results

Authorizations

Authorization
string
header
required

API key ret_live_… created in Settings → API keys.

Path Parameters

id
string
required

Query Parameters

wait_seconds
integer
default:0

Seconds to wait for every line to end before answering.

Required range: 0 <= x <= 60

Response

Batch.

ok
boolean
batch_id
string
Example:

"svcbatch_9f2c4b1e8a7d6c5f"

service
string
size
integer
status
enum<string>

completed once every job has ended, whatever each one's outcome.

Available options:
queued,
running,
completed
counts
object
jobs
object[]

One entry per input, in the order sent.

poll_url
string