---
title: "Get agent onboarding run"
method: GET
path: "/api/v1/ee/projects/{projectUuid}/agent-onboarding/{agentOnboardingRunUuid}"
---

# Get agent onboarding run

`GET /api/v1/ee/projects/{projectUuid}/agent-onboarding/{agentOnboardingRunUuid}`

Get the durable state and progress events of an agent onboarding run.

## Path parameters

- `projectUuid` string, uuid, required — Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)
- `agentOnboardingRunUuid` string, uuid, required — Stringified UUIDv4. See [RFC 4112](https://tools.ietf.org/html/rfc4122)

## Response `200`

Success

- ApiAgentOnboardingRunResponse
  - `results` AgentOnboardingRun, required
    - `completedAt` string, nullable, required
    - `startedAt` string, nullable, required
    - `updatedAt` string, required
    - `createdAt` string, required
    - `errorMessage` string, nullable, required
    - `files` AgentOnboardingFile[], required
      - `updatedAt` string, required
      - `sizeBytes` number, double, required
      - `path` string, required
    - `usage` AgentOnboardingUsage, required
      - `numTurns` number, double, nullable, required
      - `outputTokens` number, double, nullable, required
      - `inputTokens` number, double, nullable, required
      - `costUsd` number, double, nullable, required
    - `handoff` AgentOnboardingHandoff, required
      - `dashboardUrl` string, nullable, required
      - `summary` string, nullable, required
    - `events` AgentOnboardingRunEvent[], required
      - `createdAt` string, required
      - `stage` 'preparing_project' | 'exploring_warehouse' | 'deploying_semantic_layer' | 'building_dashboard' | 'verifying' | 'handoff', required
      - `message` string, required
      - `eventType` 'stage' | 'step' | 'log', required
    - `stage` 'preparing_project' | 'exploring_warehouse' | 'deploying_semantic_layer' | 'building_dashboard' | 'verifying' | 'handoff', required
    - `status` 'queued' | 'running' | 'failed' | 'completed' | 'cancelled', required
    - `projectUuid` string, required
    - `agentOnboardingRunUuid` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

[API](https://skmtc.net/lightdash/apis/lightdash-api.md) · [All operations](https://skmtc.net/lightdash/apis/lightdash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightdash/lightdash-api/versions/40c933755c9a/schema)