API Reference

Run simulations from your own tooling.

The Intent API lets you create simulations, start runs and read results, so you can test on every deploy.

Preview

The public API is in preview and the shapes below may change. Contact us to request access and to be told when it is generally available.

Request API access

Base URL

https://api.intent.am/v1

Authentication

Authenticate with a bearer token in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Endpoints

POST/simulations

Create a simulation

Defines a target and a goal. Returns the simulation with a draft status.

Request

{
  "name": "Checkout test",
  "url": "https://staging.example.com",
  "goal": "Buy the cheapest item as a guest"
}

Response

{
  "id": "sim_123",
  "status": "draft"
}
POST/simulations/{id}/run

Start a run

Starts a run for an existing simulation.

Request

{
  "agents": 25
}

Response

{
  "id": "run_456",
  "simulation_id": "sim_123",
  "status": "running"
}
GET/simulations/{id}

Get results

Returns the run status and, once complete, the ranked friction points.

Request

GET /simulations/sim_123

Response

{
  "id": "sim_123",
  "status": "complete",
  "friction": [
    { "rank": 1, "step": "Checkout", "affected": 0.42 }
  ]
}