Get Simulation Run Item

GET

https://api.vapi.ai/eval/simulation/run/:id/item/:itemId

GET

/eval/simulation/run/:id/item/:itemId

curl https://api.vapi.ai/eval/simulation/run/id/item/itemId \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "id": "string",
  "orgId": "string",
  "simulationId": "string",
  "status": "queued",
  "queuedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "startedAt": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z",
  "failedAt": "2024-01-15T09:30:00Z",
  "canceledAt": "2024-01-15T09:30:00Z",
  "failureReason": "string",
  "callId": "string",
  "runId": "string",
  "hooks": [
    {
      "do": [
        {
          "include": {
            "messages": false,
            "recordingUrl": false,
            "transcript": false
          },
          "server": {
            "backoffPlan": {
              "baseDelaySeconds": 1,
              "excludedStatusCodes": [
                400,
                401,
                403,
                404
              ],
              "maxRetries": 0,
              "type": "fixed"
            },
            "credentialId": "550e8400-e29b-41d4-a716-446655440000",
            "encryptedPaths": [
              "string"
            ],
            "headers": {},
            "staticIpAddressesEnabled": false,
            "timeoutSeconds": 20,
            "url": "string"
          },
          "type": "webhook"
        }
      ],
      "on": "simulation.run.started"
    }
  ],
  "iterationNumber": 1,
  "sessionId": "string",
  "scenarioId": "string",
  "personalityId": "string",
  "metadata": {
    "assistant": {},
    "squad": {},
    "scenario": {},
    "personality": {},
    "simulation": {},
    "call": {
      "transcript": "string",
      "messages": [
        {}
      ],
      "recordingUrl": "string",
      "monitor": {
        "listenUrl": "string"
      }
    },
    "hooks": {}
  },
  "results": {
    "evaluations": [
      {
        "structuredOutputId": "string",
        "name": "string",
        "extractedValue": 1.1,
        "expectedValue": 1.1,
        "comparator": "=",
        "passed": true,
        "required": true,
        "path": "string",
        "description": "string",
        "schema": {
          "type": "string",
          "items": {
            "type": "string",
            "items": {
              "type": "string",
              "items": {
                "type": "string",
                "items": {
                  "type": "string",
                  "items": {
                    "type": "string",
                    "items": {
                      "type": "string",
                      "items": {
                        "type": "string",
                        "items": {
                          "type": "string",
                          "items": {
                            "type": {},
                            "items": {},
                            "properties": {},
                            "description": {},
                            "pattern": {},
                            "format": {},
                            "required": {},
                            "enum": {},
                            "title": {}
                          },
                          "properties": {},
                          "description": "string",
                          "pattern": "string",
                          "format": "date-time",
                          "required": [
                            "string"
                          ],
                          "enum": [
                            "string"
                          ],
                          "title": "string"
                        },
                        "properties": {},
                        "description": "string",
                        "pattern": "string",
                        "format": "date-time",
                        "required": [
                          "string"
                        ],
                        "enum": [
                          "string"
                        ],
                        "title": "string"
                      },
                      "properties": {},
                      "description": "string",
                      "pattern": "string",
                      "format": "date-time",
                      "required": [
                        "string"
                      ],
                      "enum": [
                        "string"
                      ],
                      "title": "string"
                    },
                    "properties": {},
                    "description": "string",
                    "pattern": "string",
                    "format": "date-time",
                    "required": [
                      "string"
                    ],
                    "enum": [
                      "string"
                    ],
                    "title": "string"
                  },
                  "properties": {},
                  "description": "string",
                  "pattern": "string",
                  "format": "date-time",
                  "required": [
                    "string"
                  ],
                  "enum": [
                    "string"
                  ],
                  "title": "string"
                },
                "properties": {},
                "description": "string",
                "pattern": "string",
                "format": "date-time",
                "required": [
                  "string"
                ],
                "enum": [
                  "string"
                ],
                "title": "string"
              },
              "properties": {},
              "description": "string",
              "pattern": "string",
              "format": "date-time",
              "required": [
                "string"
              ],
              "enum": [
                "string"
              ],
              "title": "string"
            },
            "properties": {},
            "description": "string",
            "pattern": "string",
            "format": "date-time",
            "required": [
              "string"
            ],
            "enum": [
              "string"
            ],
            "title": "string"
          },
          "properties": {},
          "description": "string",
          "pattern": "string",
          "format": "date-time",
          "required": [
            "string"
          ],
          "enum": [
            "string"
          ],
          "title": "string"
        },
        "error": "string",
        "isSkipped": true,
        "skipReason": "string"
      }
    ],
    "passed": true,
    "latencyMetrics": {
      "turnCount": 1.1,
      "avgTurn": 1.1,
      "avgTranscriber": 1.1,
      "avgModel": 1.1,
      "avgVoice": 1.1,
      "avgEndpointing": 1.1
    }
  },
  "improvementSuggestions": {
    "analysis": "string",
    "systemPromptSuggestions": [
      {
        "issue": "string",
        "suggestion": "string"
      }
    ],
    "toolSuggestions": [
      {
        "issue": "string",
        "suggestion": "string"
      }
    ],
    "scenarioSuggestions": [
      {
        "issue": "string",
        "suggestion": "string"
      }
    ],
    "suggestedSystemPrompt": "string"
  },
  "configurations": {
    "transport": {
      "provider": "vapi.websocket"
    }
  }
}

Returns the specified run item, including its evaluation results and the ID of the call that ran it.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequired

The unique identifier of the simulation run.

itemIdstringRequired

The unique identifier of the run item.

Response

idstringformat: "uuid"

This is the unique identifier for the simulation run item.

orgIdstringformat: "uuid"

This is the unique identifier for the organization.

simulationIdstringformat: "uuid"

This is the ID of the simulation this run belongs to.

statusenum

The run item's current status.

queuedAtdatetime

This is the ISO 8601 date-time string of when the run was queued.

createdAtdatetime

This is the ISO 8601 date-time string of when the run item was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the run item was last updated.

startedAtdatetimeOptional

This is the ISO 8601 date-time string of when the run started.

completedAtdatetimeOptional

This is the ISO 8601 date-time string of when the run completed.

failedAtdatetimeOptional

This is the ISO 8601 date-time string of when the run failed.

canceledAtdatetimeOptional

This is the ISO 8601 date-time string of when the run was canceled.

failureReasonstringOptional<=2000 characters

Why the run item failed, when applicable.

callIdstringOptionalformat: "uuid"

The ID of the call that ran this item.

runIdstringOptionalformat: "uuid"

This is the ID of the parent run (batch/group).

hookslist of objectsOptional

Hooks configured for this simulation run item

iterationNumberdoubleOptionalDefaults to 1

Which iteration of the simulation this item represents.

sessionIdstringOptionalformat: "uuid"

This is the session ID for chat-based simulations (webchat transport).

scenarioIdstringOptionalformat: "uuid"

The ID of the scenario used for this run item.

personalityIdstringOptionalformat: "uuid"

The ID of the personality used for this run item.

metadataobjectOptional

This is the metadata containing snapshots and call data.

resultsobjectOptional

The evaluation results for this run item.

improvementSuggestionsobjectOptional

AI-generated suggestions for improving the assistant or squad’s system prompt, tools, and scenarios after a failed run.

configurationsobjectOptional

This is the configuration for how this simulation run executes.