Skip to main content
GET
/
api
/
v1
/
agent-simulation
/
runs
List agent simulation runs
curl --request GET \
  --url https://app.promptingco.com/api/v1/agent-simulation/runs \
  --header 'x-api-key: <api-key>'
{
  "ok": true,
  "data": {
    "runs": [
      {
        "id": "<string>",
        "environmentId": "<string>",
        "taskId": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "sandboxId": "<string>",
        "sandboxSnapshot": "<string>",
        "overallScore": 123,
        "passed": true,
        "tokensUsed": 123,
        "costUsd": 123,
        "startedAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z",
        "duration": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "volumeIds": "<unknown>",
        "logS3Keys": "<unknown>",
        "metadata": "<unknown>",
        "environment": {
          "id": "<string>",
          "name": "<string>",
          "agentConfig": "<unknown>",
          "task": {
            "id": "<string>",
            "name": "<string>",
            "category": "<string>"
          }
        },
        "task": {
          "id": "<string>",
          "name": "<string>",
          "category": "<string>"
        }
      }
    ],
    "total": 1
  }
}

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Query Parameters

environmentId
string
taskId
string
status
string
page
integer
pageSize
integer

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required