Jobs
Operations related to job creation and management
All endpoints require a JWT Bearer token in the Authorization header.
GET /v1/jobs
Get all jobs for the authenticated user
Retrieves all jobs associated with the authenticated user with optional filtering, sorting, and cursor-based pagination
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| query |
| Yes | Number of items to return (1-100) |
| query |
| No | Cursor for pagination - use the exact base64 token from the previous response to get the next page |
| query |
| No | Filter by job type |
| query |
| No | Filter by job status |
| query |
| No | Filter by result type |
| query |
| No | Filter jobs created from this timestamp (Unix timestamp in milliseconds) |
| query |
| No | Filter jobs created until this timestamp (Unix timestamp in milliseconds) |
| query |
| No | Sort field |
| query |
| No | Sort order |
Responses
Status | Description |
|---|---|
| Successfully retrieved jobs |
| Bad request - Invalid query parameters |
| Unauthorized - Invalid or missing authentication |
| Internal server error |
200 response schema
Field | Type | Required | Description |
|---|---|---|---|
|
| No | |
|
| No | |
|
| No |
POST /v1/jobs
Create a new job
Creates a new job for the authenticated user
Request body (required)
Field | Type | Required | Description |
|---|---|---|---|
|
| Yes | The type of job to create |
|
| Yes | The job payload data |
Responses
Status | Description |
|---|---|
| Job created successfully |
| Bad request - Invalid input data |
| Unauthorized - Invalid or missing authentication |
| Internal server error |
201 response schema
Field | Type | Required | Description |
|---|---|---|---|
|
| No | |
|
| No | |
|
| No |
GET /v1/jobs/{jobId}
Get a specific job by ID
Retrieves a specific job by its ID. The job must belong to the authenticated user.
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path |
| Yes | The ID of the job to retrieve |
Responses
Status | Description |
|---|---|
| Job retrieved successfully |
| Unauthorized - Invalid or missing authentication |
| Job not found or does not belong to the authenticated user |
| Internal server error |
200 response schema
Field | Type | Required | Description |
|---|---|---|---|
|
| No | |
|
| No | |
|
| No |