Error Reference

Error response shape and every code Suzanne returns from HTTP responses and failed jobs.

Every error response is JSON:

{
  "error": {
    "type":       "invalid_request | auth | rate_limit | internal | vendor",
    "code":       "machine-readable string",
    "message":    "human-readable explanation",
    "request_id": "..."
  }
}

Always include request_id in support requests.

Common HTTP error codes

HTTP	`code`	Meaning
400	`validation_error`	Request body doesn't match the schema.
400	`missing_body`	POST without a JSON body.
400	`invalid_param`	`faces` value not in the allowed enum.
400	`inline_multi_photo_not_supported`	Multi-view inline isn't a thing; use `images_upload_ids`.
401	`unauthorized`	Missing / bad API key.
403	`forbidden_scope`	Key lacks the required scope.
409	`idempotency_key_conflict`	Same `Idempotency-Key` with a different body.
409	`concurrent_limit_reached`	Account is at the concurrent-jobs ceiling.
500	`internal`	Server-side bug; please report.

Job-failure codes

When a job ends with status: "failed", error.code will be one of:

`code`	Meaning
`vendor_model_error`	The upstream model rejected the input or produced no mesh.
`vendor_http_error`	The vendor returned an HTTP error mid-job.
`vendor_timeout`	The vendor didn't respond within our deadline.
`vendor_not_configured`	The upstream vendor required for this request shape isn't provisioned for the account. Contact support.
`missing_image`	A referenced `upload_id` doesn't resolve to an object in S3.
`insufficient_views`	Multi-view job submitted without enough valid views.
`job_cancelled`	The job was cancelled before completion.
`sqs_enqueue_failed`	Internal queue rejected the job; safe to retry.