Estimate Ai Credits

About how many AI credits a bulk job will use before it starts (RO-381): a research batch of `items` leads or companies, or a discovery run. The credit formula on the workspace's own recent calls for the same task (else a default), with what's left this month for the workspace and the caller and a warning when it may not fit. Nothing is reserved: at the cap a running job finishes its current item and pauses until the reset.

API key access

Needs the leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

POST/api/v1/ai-credits/estimate

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

actionstring

research_batch, discovery_run or ai_column (RO-340).

items?integer | null

The leads or companies of a research batch, or the rows an AI column runs on, 1-1000 (default 1; a discovery run is one).

Formatint64

Range1 <= value <= 1000

Response Body

curl -X POST "http://localhost:8000/api/v1/ai-credits/estimate" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "string"
  }'

curl -X POST "http://localhost:8000/api/v1/ai-credits/estimate" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "action": "string"  }'

{
  "action": "string",
  "items": 0,
  "llm_calls": 0,
  "credits_per_call": 0.1,
  "credits": 0,
  "text": "string",
  "basis": "string",
  "remaining": 0,
  "member_remaining": 0,
  "exceeds_remaining": true,
  "exceeds_member_limit": true,
  "warning": "string",
  "resets_at": "2019-08-24T14:15:22Z"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Header Parameters

Request Body

Response Body

200

422