Errors

Every error returns a JSON body with a single error field.

{ "error": "Human-readable message" }

Reference

Status	Message	Cause
`401`	`"API key is required"`	`X-Api-Key` header missing
`401`	`"Invalid API key"`	Key does not match any active key
`404`	`"Scribe not found"`	Scribe ID doesn't exist in your organization
`404`	`"Request not found"`	Request ID doesn't exist
`422`	`"Scribe is not active"`	Scribe is powered off or not provisioned
`422`	`"Summary is required"`	`task.summary` is missing or blank
`422`	`"Attachment url is required"`	Attachment missing `url`
`422`	`"Attachment content_type is required"`	Attachment missing `content_type`
`422`	`"Maximum of 5 attachments allowed"`	Too many attachments
`422`	`"Attachment download failed: ..."`	Could not fetch file from provided URL

Examples

401 — Missing key

curl -i https://www.obelisk.li/api/v1/scribes/SCRIBE_ID/requests

HTTP/1.1 401 Unauthorized

{ "error": "API key is required" }

404 — Bad scribe ID

curl -i https://www.obelisk.li/api/v1/scribes/nonexistent/requests \
  -H "X-Api-Key: your_api_key_here"

HTTP/1.1 404 Not Found

{ "error": "Scribe not found" }

422 — Validation

curl -i -X POST https://www.obelisk.li/api/v1/scribes/SCRIBE_ID/requests \
  -H "X-Api-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "task": {} }'

HTTP/1.1 422 Unprocessable Entity

{ "error": "Summary is required" }

← Authentication