Errors
Every stable
code a problem response can carry, with its HTTP status. The type URL in each response links to the code's page. See the errors guide for the problem document's shape.Credentials
| Code | HTTP | Meaning |
|---|---|---|
| missing_authorization | 401 | The request carried no bearer credential. |
| invalid_key | 401 | The bearer key is not one we issued. |
| key_revoked | 401 | The bearer key was revoked. |
| invalid_token | 401 | An OAuth access token failed verification. |
| organization_not_selected | 403 | The token is genuine but names no organization, so there is no balance to spend. |
| organization_access_revoked | 403 | The token is valid, but its user has left the organization it acts for. |
| connection_revoked | 401 | The connection the token was issued under has been revoked. |
| forbidden | 403 | The credential is good, but its user's role cannot do this. |
The request itself
| Code | HTTP | Meaning |
|---|---|---|
| invalid_request | 400 | The request does not match what the operation accepts. |
| unsupported_platform | 400 | The platform named is not one this operation covers. |
| unsupported_kind | 422 | A well-formed request for something this API does not serve yet. Nothing was run or charged. |
| kind_deprecated | 400 | A new Tracker or Collection of a kind that is no longer offered. Nothing was created or charged. |
| video_too_long | 422 | The video is over the 10-minute cap that analysis and downloads share. |
| not_found | 404 | Nothing with that identifier exists for this customer. |
| idempotency_conflict | 409 | This Idempotency-Key was already used with a different payload. |
| run_not_ready | 409 | A read that needs a settled Run was asked of one that has nothing to serve yet. |
| advertiser_ambiguous | 409 | Several Facebook Pages carry that advertiser name. Nothing was charged. |
| collection_kind_mismatch | 409 | A Tracker of one kind was offered to a Collection of another kind. |
| collection_name_taken | 409 | Another of the customer's Collections already has this name. |
Money
| Code | HTTP | Meaning |
|---|---|---|
| insufficient_balance | 402 | The balance does not cover the call. |
Limits
| Code | HTTP | Meaning |
|---|---|---|
| rate_limit_exceeded | 429 | Requests are arriving too quickly on this credential. |
| concurrency_limit_exceeded | 429 | Too many Runs are already in flight for this organization. |
| tracker_limit_exceeded | 409 | The customer is at the cap on active Trackers. |
| collection_limit_exceeded | 409 | The customer is at the cap on Collections. |
| webhook_limit_exceeded | 409 | The customer is at the cap on webhook endpoints. |
| webhook_rotation_in_progress | 409 | The previous secret rotation's overlap window is still open. |
Upstream and ours
| Code | HTTP | Meaning |
|---|---|---|
| media_unavailable | 502 | We could not fetch the video's media. |
| vendor_error | 502 | An upstream source failed while answering. |
| source_unavailable | 503 | No source can answer this read right now, or it is switched off while we fix it. Never charged. |
| service_unavailable | 503 | The work could not be queued, so the Run failed uncharged. |
| internal_error | 500 | Something broke on our side. |