Discovery

Worked request examples, the auth header format, and the error-code vocabulary.

Public and unauthenticated ON PURPOSE — it is what a client reads BEFORE it has a key, and it names where to obtain one. Returns the API version, base URL, the Authorization header format, the full error-code list, and runnable examples.

get/examples

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/examples
  • Auth: HTTP bearer

Response

Examples, auth format and error vocabulary.

versionstring
baseUrlstring
errorCodesstring[]
examplesobject[]

Example response

{
  "authentication": {
    "format": "Bearer sh_<prefix>_<secret>"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.