Skip to main content
POST
AI Simulation needs an active Pro or Business plan. On another plan, every simulation endpoint returns 403 POLICY_DENY.
Check what a simulation would cost before you start it. The estimate queues nothing, calls no model and costs nothing. Every field is optional.

Request

Headers

string
required
Bearer token with your API key (scope agents)
string
required
application/json

Path

string
required
The agent id (UUID). The agent must be in your workspace and saved at least once

Body

integer
default:"12"
1 to 50. How many stories
integer
default:"1"
1 to 100
number
Your estimate of the credits one call uses. Must be more than 0
number
The credit ceiling. Needs estimated_credits_per_call
integer
At least 1
string
default:"manual"
manual, or ci (API keys only)

Response

200 OK.
  • minutes_upper_bound is calls × 5 minutes, the cap for one call. It is not a prediction.
  • admitted_calls is the lowest of the number of calls, max_calls, and max_credits ÷ estimated_credits_per_call. max_minutes is a time limit, so it does not change this number.
  • budget_limited is true when the ceilings would stop the run before every call is made.
  • credits is null when you gave no estimated_credits_per_call.

Errors

Example