Skip to main content
The Awardee API is the same API the dashboard uses. It is organized around REST, returns JSON, and is authenticated with org-scoped bearer keys. Resources are versioned under /v1 and the production base URL is https://api.awardee.dev/v1.

Quickstart

Mint a key and make your first authenticated call in under five minutes.

Authentication

aw_live_* keys, the Authorization header, rotation, and revocation.

API reference

Every endpoint, parameter, and response. With an interactive playground.

Webhooks

Signed, retried, idempotent event delivery for every resource that emits.

​
What you can build

  • AI chatbots that know your data. Create chatbots, attach pages and knowledge-base articles, and stream conversations into your CRM via webhooks.
  • Programmable scan URLs. Mint thousands of stable awardee.dev/o/<slug> URLs, then re-route them to chatbots, pages, knowledge bases, or external destinations without reprinting.
  • Self-serve knowledge bases. Sync articles, categories, tags, translations, and versions from your own CMS. Awardee indexes them for chatbots and human support.
  • Customer support inboxes. Read and reply to conversations, manage tags and assignment, and process submissions from forms attached to pages.
  • Custom integrations. Receive scan, conversation, submission, and member events as signed webhook deliveries, with at-least-once semantics and 24h replay-from-dashboard.

​
Conventions

  • Base URL. https://api.awardee.dev/v1. Every path in this reference is relative to it.
  • Auth. Authorization: Bearer aw_live_… on every request. See Authentication.
  • Content type. application/json for request and response bodies. Field names are snake_case.
  • Identifiers. Bare UUIDs, never prefixed. 8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e, not obj_….
  • Errors. A stable JSON envelope keyed by error. See Errors.
  • Pagination. Offset or cursor, depending on volume. See Pagination.
  • Idempotency. Any POST honors Idempotency-Key. See Idempotency.
  • Rate limits. Per-key minute and hour windows surfaced in response headers. See Rate limits.