SuperCoolDocs Get an API key

Guides

Work

List and read your SuperCool agent's work. The same chats you see in the app, whether they started over the API, in the app, by phone or elsewhere.

View as Markdown

Every piece of work the agent does happens in a chat, identified by a work_id. These are the same chats you see in the SuperCool app. Work you start over the API shows up there, and work you start in the app, by phone, on WhatsApp, in the CLI or through the MCP shows up here.

Messages are short-lived and belong to the API key that sent them. Work belongs to your account and lasts as long as the chat does. Use it to read results long after a message is gone, or to see what the agent is doing across every channel.

#List recent work

bash
curl "https://api.supercool.com/v1/work?limit=10" -H "Authorization: Bearer $SUPERCOOL_API_KEY"
json
{
  "object": "list",
  "data": [
    {
      "object": "work",
      "work_id": "5d0c3e2a-8f1b-4c6d-9e7f-1a2b3c4d5e6f",
      "title": "Candle shop vertical ad",
      "preview": "Your 15 second ad is ready.",
      "link": "https://supercool.com/chat/5d0c3e2a-8f1b-4c6d-9e7f-1a2b3c4d5e6f"
    }
  ]
}

Newest first. limit is 1 to 50 (default 20). link opens the chat in the SuperCool app.

#Read one piece of work

bash
curl https://api.supercool.com/v1/work/5d0c3e2a-8f1b-4c6d-9e7f-1a2b3c4d5e6f \
  -H "Authorization: Bearer $SUPERCOOL_API_KEY"
json
{
  "object": "work",
  "work_id": "5d0c3e2a-8f1b-4c6d-9e7f-1a2b3c4d5e6f",
  "title": "Candle shop vertical ad",
  "status": "idle",
  "text": "Your 15 second ad is ready. I used slow push-ins on the candles and a warm grade...",
  "next_from_char": null,
  "link": "https://supercool.com/chat/5d0c3e2a-8f1b-4c6d-9e7f-1a2b3c4d5e6f",
  "files": [
    {
      "file_id": "5d0c3e2a-8f1b-4c6d-9e7f-1a2b3c4d5e6f/candle_ad.mp4",
      "name": "candle_ad.mp4",
      "content_type": "video/mp4",
      "kind": "video",
      "size": 4812345,
      "url": "https://api.supercool.sh/api/v1/files/s/eyJmIjoiNWQwYzNl...",
      "revision": "\"5b1c0e6f9d2a4b7c8e1f3a5d7c9b0e2f\"",
      "work_id": "5d0c3e2a-8f1b-4c6d-9e7f-1a2b3c4d5e6f",
      "label": null
    }
  ]
}
Field Meaning
status running (the agent is working in it now), stalled_credits (stopped until credits are added) or idle.
text The latest result text.
next_from_char More text is available: call again with ?from_char= this value. null when you have it all.
files The chat's most recent files (up to 8), each with a fresh download link.
link The chat in the SuperCool app.

Long results are paged: pass from_char to read on from where the last page stopped.

#Continue a piece of work

There's no separate endpoint for this. Send a message and refer to the work the way you would in the app ("in the candle ad, swap the music for something calmer"). The agent knows your chats and continues the right one.

#Limits

Reading work counts toward a limit of 600 reads per hour per account, on top of the per-key request limit. See Rate limits.

Last updated