AppleakDocs
Open AppleakGet an API key

Get started

Quickstart

From no key to a finished category report: make a key, check it, start a run, and read the result when it is done.

#Five steps

  1. Make a key

    In Appleak, open Account → API and make a key. It is shown once, so copy it then. Put it in an environment variable rather than in your code:

    Terminal
    export APPLEAK_KEY=apk_live_YOUR_KEY

  2. Check it

    Ask for your balance. It is free, and the answer lists what every run costs right now.

    curl "https://appleak.app/api/v1/me" \
  -H "Authorization: Bearer $APPLEAK_KEY"

  3. Start a run

    A category report reads the reviews of the apps charting in a category and answers your question. It answers at once with a job:

    curl "https://appleak.app/api/v1/reports" \
  -H "Authorization: Bearer $APPLEAK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "what do users hate about meditation apps",
    "scope": "both"
  }'
    Response202 Accepted
    {
  "id": "6f1c2b9e-1d0a-4c55-9a51-2b7f0c3e8d41",
  "object": "job",
  "kind": "report",
  "status": "queued",
  "credits": 10,
  "refunded": false,
  "progress": null,
  "createdAt": "2026-10-19T12:00:00.000Z",
  "startedAt": null,
  "finishedAt": null,
  "error": null,
  "result": null,
  "links": {
    "self": "/api/v1/jobs/6f1c2b9e-1d0a-4c55-9a51-2b7f0c3e8d41"
  }
}

  4. Wait for it

    Ask for the job with wait=30. The call returns as soon as the run finishes, or after 30 seconds. Ask again until status is done.

    curl "https://appleak.app/api/v1/jobs/6f1c2b9e-1d0a-4c55-9a51-2b7f0c3e8d41?wait=30" \
  -H "Authorization: Bearer $APPLEAK_KEY"

  5. Read the result

    The finished job carries the whole report in result. It is also filed in your History in the app.

#The whole thing

The same flow as one script, in your language:

export APPLEAK_KEY=apk_live_YOUR_KEY

# Your balance and what each run costs (free)
curl https://appleak.app/api/v1/me -H "Authorization: Bearer $APPLEAK_KEY"

# Start a category report, then wait for it
curl https://appleak.app/api/v1/reports -H "Authorization: Bearer $APPLEAK_KEY" \
  -H "Content-Type: application/json" -H "Idempotency-Key: meditation-1" \
  -d '{"question":"what do users hate about meditation apps"}'
curl "https://appleak.app/api/v1/jobs/JOB_ID?wait=30" -H "Authorization: Bearer $APPLEAK_KEY"

#Next