Jobs, Assets and Your Balance

This page shows how to follow a job, get its files and upload your own pictures with the Public API.

What it does

Every job you start has an id. An asset is a file in your Library: a result, or a picture you uploaded.

Step by step

1. Start a job and keep its id.
2. When status is done, each item in assets has a file address.
3. Request that address with your key. You are sent to a download link that lasts 10 minutes.

Every option explained

Job status

credits is what was held for the job. charged is what it cost in the end.

Lists

GET /api/public/v1/jobs lists the jobs your keys started, newest first. GET /api/public/v1/assets lists your results, and ?media=image, video or audio narrows it.

Both take ?limit= (up to 50). When the answer has "more": true, send its cursor as ?cursor= to read the next page.

Upload a picture

1. The answer has a url. Send the file there with PUT, with the Content-Type it names.
2. The answer is your asset, with its id.

Pictures can be PNG, JPEG or WebP. Clips and sound files work the same way, for captions: send their own mime, and duration_ms in the last step. They all pass the same checks as a website upload.

Your balance

GET /api/public/v1/balance gives credits, what is held for running jobs, and when your next credits expire.

About this key

GET /api/public/v1/me shows this key's scopes, limits, how much it has used today and this month, and in tools what it can run now. It needs no scope.

Common problems

A job is not_found

The id belongs to another account, or the job was not started through the API. The website's own jobs are in your Library, but not in the jobs list here.

The download link stopped working

It lasts 10 minutes. Request the file address again.