API Reference

Base URL

https://api.chicklet.io/v1

All API requests require a Bearer token in the Authorization header:

curl https://api.chicklet.io/v1/chicklets \
  -H "Authorization: Bearer $API_KEY"

See Authentication for details on obtaining an API key.

All responses are JSON. Successful responses return a 2xx status code. Errors return a 4xx or 5xx status code with a JSON body:

{
  "error": {
    "code": "not_found",
    "message": "Chicklet 'dev' not found"
  }
}

API requests are rate-limited per account. If you exceed the limit, you’ll receive a 429 Too Many Requests response with a Retry-After header.

Explore the full API interactively at api.chicklet.io/swagger.

⌘I