Browse docs
Anatomy of an error#
Every error follows the RFC 9457 shape: a type URL that identifies the kind of error, a title, a status that matches the HTTP status, and a detail sentence. SkedCast adds code (the stable identifier), category, severity and, where relevant, action (a recovery hint such as reconnect, upgrade or retry) and correlationId for support requests.
The type URL always opens a documentation page at https://skedcast.com/errors/{code}, as RFC 9457 §3.1.1 recommends.
An example response#
{
"type": "https://skedcast.com/errors/unauthenticated",
"title": "Authentication required",
"status": 401,
"detail": "You need to sign in to do that.",
"code": "unauthenticated",
"category": "auth",
"severity": "error",
"action": "login",
"correlationId": "c7f1e2a0-…"
}What each field means#
FAQ
- Does SkedCast's API return RFC 9457 problem+json errors?
- Yes. Every error response is application/problem+json with a type URL that opens a documentation page.
- How should I handle an error?
- Branch on code, not on title or detail, because the sentences can be reworded. Use action as a hint for recovery, and send correlationId to support if you need help.
- What does the action field on an error mean?
- A recovery hint a client can act on programmatically: for example login, reconnect, upgrade, verify-email, mfa, retry, or contact-support. It comes from the same catalogue entry as the error's documentation.