Getting started

Errors

Failures use standard HTTP status codes and always return the same JSON shape:

Error response
{
  "error": {
    "code": "not_found",
    "message": "Post not found.",
    "status": 404
  }
}
StatusCodeMeaning
400invalid_request, invalid_id, missing_*Something in the request is wrong. The message says what.
401unauthorizedMissing or invalid API key.
402plan_requiredThe workspace has no active Creator OS plan.
403forbiddenThe key can’t act on this resource.
403insufficient_scopeThe key or connection is read only and the request would change something.
404not_foundThe resource or endpoint doesn’t exist.
409workspace_not_ready, conflictThe workspace isn’t set up yet, or the request conflicts with current state.
415unsupported_mediaThat file type isn’t accepted by the networks.
429rate_limitedA network is rate limiting this account. Retry later.
502 / 503upstream_error, service_unavailableA network or our publishing service had a problem. Safe to retry.