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

# Get onboarding run file

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

Read the latest persisted contents of a generated onboarding file.

## 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)

## Query parameters

- `path` string, required

## Response `200`

Success

- ApiAgentOnboardingFileResponse
  - `results` AgentOnboardingFileContent, required
    - `updatedAt` string, required
    - `sizeBytes` number, double, required
    - `path` string, required
    - `encoding` 'utf8' | 'base64', required
    - `content` string, required
  - `status` 'ok', required

## Other responses

- `default` — Error

---

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