Trawl API reference

Trawl API · Credits

get/v1/workspaces/{workspace_id}/creditsAuth

Remaining Trawl steps for this workspace, whether the balance is low, and recent ledger entries

The balance in steps (one agent step uses one credit), whether it is under the low-balance line the `credits.low` webhook uses, and the 50 most recent ledger entries behind it, newest first.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200 Balance, low-balance state and recent entries.

balance_steps*number

Remaining steps. One agent step uses one credit; new jobs are refused (402) at zero. Can dip slightly below zero, because a running job is always allowed to finish.

Example: 8420

low_balance*boolean

True when the balance is under `low_balance_threshold_steps`. The `credits.low` webhook fires once when this turns true, and again only after the next top-up.

Example: false

low_balance_threshold_steps*number

The low-balance line: 10% of the last top-up, and never under 100 steps.

Example: 1000

entries*array

The 50 most recent ledger entries, newest first.

Example

Request

GET https://api.trawl.productcraft.co/v1/workspaces/{workspace_id}/credits
Authorization: Bearer YOUR_TOKEN

Response

{
  "balance_steps": 8420,
  "low_balance": false,
  "low_balance_threshold_steps": 1000,
  "entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "delta_steps": -12,
      "reason": "job",
      "job_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}