Skip to main content
GET
/
api
/
v2
/
external
/
batches
/
{batch_id}
Get Batch
curl --request GET \
  --url https://api.lyceum.technology/api/v2/external/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "created_at": 123,
  "expires_at": 123,
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "object": "batch",
  "errors": {
    "object": "list",
    "data": []
  },
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "in_progress_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "metadata": {}
}

Authorizations

Authorization
string
header
required

Pass an API key (prefixed lk_) or a JWT access token as a bearer token. Generate API keys in the dashboard at https://dashboard.lyceum.technology/api-keys.

Path Parameters

batch_id
string
required

Response

Successful Response

id
string
required
endpoint
string
required
input_file_id
string
required
completion_window
string
required
status
enum<string>
required
Available options:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
created_at
integer
required
expires_at
integer
required
request_counts
BatchRequestCounts · object
required
object
string
default:batch
errors
BatchErrors · object
output_file_id
string | null
error_file_id
string | null
in_progress_at
integer | null
finalizing_at
integer | null
completed_at
integer | null
failed_at
integer | null
expired_at
integer | null
cancelling_at
integer | null
cancelled_at
integer | null
metadata
Metadata · object