Skip to main content
GET
List Jobs

Overview

Retrieve a paginated list of all jobs associated with your API client. This endpoint returns jobs in descending order by creation date (newest first), allowing you to monitor all asynchronous processing tasks such as video transcriptions, summaries, renders, and template creations.
You need a valid API key to use this endpoint. Get your API key from the API Access page in your Pictory dashboard.

API Endpoint


Request Parameters

Headers

string
required
API key for authentication (starts with pictai_)

Query Parameters

string
Base64-encoded pagination token returned from a previous request. Use this to retrieve the next page of results. If not provided, the first page of results will be returned.Example: "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7fX0="

Response

Returns a paginated list of job objects in the items array. Each job includes its unique job_id, current status, and job-specific data including transcripts, highlights, render results, or error information. If more results are available, a nextPageKey is included for pagination.
array of objects
required
Array of job objects, ordered by creation date in descending order (newest first)
string | null
required
Base64-encoded pagination token to retrieve the next page of results. If null, there are no more pages available. Pass this value as the nextPageKey query parameter in the next request to fetch additional results.

Response Examples


Code Examples

Replace YOUR_API_KEY with your actual API key that starts with pictai_

Usage Notes

Jobs are returned in reverse chronological order by creation date, with the most recently created jobs appearing first.
Pagination: When you have many jobs, use the nextPageKey value from the response to retrieve subsequent pages. Pass the nextPageKey as a query parameter in your next request.
Job Types: Jobs can represent various async operations including video transcriptions, summaries/highlights, project renders, and template creations. The data structure varies based on the job type.
Rate Limiting: Be mindful of API rate limits when polling for job status. Consider implementing exponential backoff or using webhooks for job completion notifications.

Common Use Cases

1. List All Recent Jobs

Retrieve and display all recent jobs:

2. Paginate Through All Jobs

Fetch all jobs across multiple pages:

3. Monitor Job Status

Check the status of specific job types:

4. Find Failed Jobs

Identify and log failed jobs for debugging:

5. Export Jobs to CSV

Export job data for reporting:

Job Data Structure

The data field in each job object varies based on the job type:

Transcription Jobs

Summary/Highlight Jobs

Failed Jobs