/jobs
Request all your past and present jobs.
Query your past and present jobs.
GET
https://waveline.ai/api/v1/jobs
Retrieve a list of all your account's jobs, ordered by creation date (newest first).
Query Parameters
Name
Type
Description
count
Number
The amount of jobs to return. Can be between 1
and 100
(default 10
).
offset
Number
The number of jobs to skip. For example with offset=1
, the newest job will be skipped and the list will start with the second newest job. Default: 0
Headers
Name
Type
Description
Authorization*
String
Bearer <YOUR_API_KEY>
{
"items": [
{
"id": string,
"createdAt": string, // ISO date string
"status": string, // CREATED, RUNNING, FAILED, COMPLETED
"type": string, // the type of job (e.g. "guess-shape")
"pages": number, // the number of billed pages
"fileName": string,
"urls": {
"get": string // Query this URL to get the status/result of your job
}
},
...
],
"offset": number,
"count": number,
"total": number // the total number of jobs associated with your account
}
Example Usage
If you've lost track of some jobs you have created, your last 15 jobs:
curl "https://waveline.ai/api/v1/jobs" \
-H "Authorization: Bearer YOUR_API_KEY"
Retrieving more than 10 jobs
You can use the count
parameter to request more than 10 jobs at a time (up to 100):
curl "https://waveline.ai/api/v1/jobs?count=20" \
-H "Authorization: Bearer YOUR_API_KEY"
Retrieving older jobs
If you want to search for jobs older than the first 20, say the next oldest 20, you can use the offset
parameter to do so:
curl "https://waveline.ai/api/v1/jobs?count=20&offset=20" \
-H "Authorization: Bearer YOUR_API_KEY"
Last updated