Skip to main content

FAQ

Can I start a run with an API key?​

Yes, with runs:create. Send maxCredits and an idempotencyKey with every start; see Start runs. To run one Addon on many items, start a batch; see Run batches.

Why does a working key get a 403?​

Check code. identity.missing_permission names the required permission in details.permission. identity.api_key_not_allowed means that operation does not accept account keys. Selecting all permissions does not open it.

Can I use a key in a browser application?​

Keep keys in your backend or automation. A key acts for the account and must not be exposed in browser code. The docs site's reference does not send live API requests; use the guide's commands or your backend.

Signed links expire. Read the asset or run again to get a fresh link. Store the asset ID or file key for later use, rather than keeping the URL.

Can I retry an upload?​

It depends on which call failed. Creating an upload twice creates two assets; uploading the same bytes twice is refused once storage has accepted them. See Upload media before retrying.

Is the public API stable?​

It is in preview and may change. See Versioning and changes.