ReferenceUntagged
Get active agent onboarding run
Get the agent onboarding run that is currently queued or running for a project, if any.
GET/api/v1/ee/projects/{projectUuid}/agent-onboarding
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectUuid | string | Yes |
Responses
200 — Success
{
"results": {
"completedAt": "string",
"startedAt": "string",
"updatedAt": "string",
"createdAt": "string",
"errorMessage": "string",
"files": [
{
"updatedAt": "string",
"sizeBytes": 0,
"path": "string"
}
],
"usage": {
"numTurns": 0,
"outputTokens": 0,
"inputTokens": 0,
"costUsd": 0
},
"handoff": {
"dashboardUrl": "string",
"summary": "string"
},
"events": [
{
"createdAt": "string",
"stage": {},
"message": "string",
"eventType": "stage"
}
],
"stage": {},
"status": "queued",
"projectUuid": "string",
"agentOnboardingRunUuid": "string"
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}