Protocols
Saved & recent

Problem Details

Also called: RFC 9457, application/problem+json

Problem Details is a standard format for describing HTTP API errors beyond a status code. A JSON response uses application/problem+json. Its type identifies the kind of problem, title summarizes it, detail explains this occurrence, and instance can identify that occurrence. APIs may add documented extension fields.

For example, a report request might return 422 with a documented “invalid-date-range” type and a detail explaining that the end precedes the start. Software should use stable identifiers or structured extensions rather than parse the human explanation. If the body includes status, the origin must match it to the actual HTTP status; sensitive debugging data belongs elsewhere.

Read first
HTTP
Related
HTTP status codes, OpenAPI, Content negotiation
Further reading
IETF RFC 9457 — Problem Details for HTTP APIs
422 response Content-Type: application/problem+json type https://api.example/problems/invalid-date-range title Invalid date range detail End precedes start instance /problems/instances/17 type · machine identifier detail · human guidance
A hypothetical Problem Details response has a type URI for software and detail text for people. Its body status matches the actual 422 response; the shown URI is a documentation example.

View in the full Protocols collection