Responses And Errors

REST responses use a small JSON envelope.

Success Envelope

{
  "ok": true,
  "data": {
    "id": "draft_123"
  }
}

{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "scheduledFor is required.",
    "details": []
  }
}

details is optional and usually contains validation issues or structured domain context.

Status	Meaning
`400`	Bad request shape or unreadable request body.
`401`	Missing, invalid, or expired authentication.
`402`	Billing or entitlement restriction.
`403`	Authenticated user cannot access the requested resource or capability.
`404`	Resource was not found.
`409`	Request conflicts with current state.
`422`	Request was valid JSON but failed validation or domain rules.
`500`	Server error or server misconfiguration.

The TypeScript SDK parses the response envelope. For ok: false, it throws an Error with the code and message combined:

VALIDATION_ERROR: scheduledFor is required.

When the server returns a non-API response shape, the SDK throws a generic request or invalid-response error.