Quickstart
Create your first cue in 5 minutes.
1. Get an API key
Choose one of three methods:
Visit cueapi.ai/signup, enter your email, and receive your API key instantly.
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
bash
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:
json
{
"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"
}
}3. Verify it fired
bash
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:
bash
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": "Task completed successfully"}'Info
Outcomes are write-once. You can only report one outcome per execution.
5. Try the interactive quickstart (CLI)
The CLI has a guided quickstart that creates a test cue, verifies delivery, and cleans up:
bash
cueapi quickstart