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.
Illustrative example, not a customer result.
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 accessBase URL
https://api.intent.am/v1Authentication
Authenticate with a bearer token in the Authorization header.
Authorization: Bearer YOUR_API_KEYEndpoints
POST
/simulationsCreate 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}/runStart 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_123Response
{
"id": "sim_123",
"status": "complete",
"friction": [
{ "rank": 1, "step": "Checkout", "affected": 0.42 }
]
}