Quickstart

1. Get an API key

Choose one of three methods:

Your API key looks like cue_sk_a1b2c3d4.... Save it somewhere safe. You can regenerate it later, but the old one is immediately revoked.

2. Create a cue

curl -X POST https://api.cueapi.ai/v1/cues \
  -H "Authorization: Bearer cue_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-first-cue",
    "schedule": {
      "type": "once",
      "at": "2026-03-14T10:00:00Z"
    },
    "callback": {
      "url": "https://your-endpoint.com/webhook"
    }
  }'

Response:

{
  "id": "cue_a1b2c3d4e5f6",
  "name": "my-first-cue",
  "status": "active",
  "next_run": "2026-03-14T10:00:00+00:00",
  "schedule": {
    "type": "once",
    "at": "2026-03-14T10:00:00Z"
  },
  "callback": {
    "url": "https://your-endpoint.com/webhook",
    "method": "POST"
  }
}

Optional fields

The create request above uses only required fields. You can also configure:

• catch_up - What happens when executions are missed during downtime (default: run_once_if_missed)
• delivery.timeout_seconds - How long to wait for your webhook to respond (default: 30s)
• delivery.outcome_deadline_seconds - How long to wait for outcome report (default: 300s)
• verification - What evidence is required for verified outcomes (default: none)

See Create a cue for the full schema.

3. Verify it fired

curl https://api.cueapi.ai/v1/cues/cue_a1b2c3d4e5f6 \
  -H "Authorization: Bearer cue_sk_YOUR_KEY"

Look for executions[0].status == "success" in the response.

4. Report the outcome (optional)

After your handler processes the webhook, report what happened:

curl -X POST https://api.cueapi.ai/v1/executions/{execution_id}/outcome \
  -H "Authorization: Bearer cue_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "success": true,
    "result": "Processed 142 records",
    "external_id": "batch:20260323",
    "result_type": "data_sync"
  }'

5. Try the interactive quickstart (CLI)

The CLI has a guided quickstart that creates a test cue, verifies delivery, and cleans up:

cueapi quickstart

Next steps