Docs / SynthEvents / Errors / domain-unknown

domain-unknown

The request names a domain that SynthEvents does not offer.

  • Status: 422 Unprocessable Entity
  • Route: POST /api/v1/generate-events
  • Description: domain is unknown: expected 'courses', 'library', or 'todo'
  • Details: value, the domain as the request gave it.

Why It Happens#

The value of domain is none of the domains that the description lists. Names are lowercase and exact, so Library is unknown.

How to Fix It#

Use one of the domains that the description lists. The list grows with the domains SynthEvents offers, and read-domains lists them as well.

Example#

For the domain Library, SynthEvents answers:

{
  "type": "error",
  "data": {
    "code": "https://docs.synthevents.io/errors/domain-unknown",
    "description": "domain is unknown: expected 'courses', 'library', or 'todo'",
    "details": {
      "value": "Library"
    }
  }
}