Create Simulation Runs

Create a batch of text-only runs for saved simulations. Retry with the same Idempotency-Key and request to avoid duplicate runs.

post/v1/simulation/runs

Request

  • Base URL: https://api.decagon.ai
  • URL: https://api.decagon.ai/v1/simulation/runs
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Unique key for this submission within the team. Reuse it only to retry the same request.

Request body

simulation_idsstring[] required

Saved simulation IDs to run. IDs must be unique.

run_countinteger

Number of runs per simulation. Total runs equals len(simulation_ids) times run_count.

branchstring

Agent branch to run the simulation against. Defaults to main.

knowledge_mode'live' | 'draft'

Response

Successful Response

idstring required

Opaque batch ID. Use it to retrieve the batch's runs.

Changes

No recorded changes to this operation across all 1 revision of this API.