Skip to main content
GET
/
v1
/
jobs
Get all jobs.
curl --request GET \
  --url https://api.pyannote.ai/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "status": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 100
}
This endpoint allows you to list all the jobs that you have created. They are sorted in descending order by the time they were created (latest job first). For performance reasons, job results are not included in the response. Retrieve the results by using the get job endpoint. By default the API will return the first 10 jobs. You can use the limit and offset query parameters to paginate through the list of jobs.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
take
number
default:10

Number of jobs to return

Required range: 1 <= x <= 100
Example:

10

​
status
enum<string>

Status of the jobs to return

Available options:
pending,
created,
succeeded,
canceled,
failed,
running
Example:

"succeeded"

​
skip
number

Number of jobs to skip

Required range: x >= 0
Example:

1

Response

​
items
object[]
required

List of jobs. Sorted by creation date, descending. Does not include output data.

​
total
number
required

Total number of jobs

Example:

100