`onboarding`

Open an operation to see its authentication, its parameters and the fields of its request and response.

15 operations

GET`/v1/onboarding`

The onboarding wizard: steps, agent, demo, next steps.

Authentication: Dashboard session

Response `200`

Response, GET /v1/onboarding
Name	Type	Description
`workspace`required	`object`
`workspace.id`required	`string`
`workspace.name`required	`string`
`workspace.client_name`required	`string`
`workspace.slug`required	`string`
`workspace.locale`required	`enum`	Values `it \| en`
`workspace.execution_mode`required	`enum`	Values `managed \| runner \| mcp`
`workspace.agent_id`required	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`workspace.auth_method`required	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`workspace.runner_transport`required	`enum`	Values `github_actions \| container`
`workspace.inbound_address`required	`string`
`repository`required	`object`
`repository.id`required	`string`
`repository.full_name`required	`string`
`repository.html_url`required	`string`
`repository.default_branch`required	`string`
`repository.is_public`required	`boolean`
`repository.onboarding_pr`required	`object`
`repository.onboarding_pr.number`required	`integer`
`repository.onboarding_pr.url`required	`string`
`repository.onboarding_pr.status`required	`enum`	Values `none \| open \| merged \| closed`
`repository.onboarding_pr.requested_at`required	`string (date-time)`
`repository.onboarding_pr.error`required	`string`
`repository.onboarding_pr.title`required	`string`
`repository.agent_key`required	`object`
`repository.agent_key.last4`required	`string`
`repository.agent_key.set_at`required	`string (date-time)`
`repository.runs_on`required	`array of string`
`repository.cloud_auth`required	`object`
`current`required	`enum`	Values `repository \| channels \| agent \| logs \| done`
`steps`required	`array of object`
`steps[].id`required	`enum`	Values `repository \| channels \| agent \| logs`
`steps[].status`required	`enum`	Values `todo \| done \| skipped`
`steps[].completed_at`required	`string (date-time)`
`steps[].available`required	`boolean`
`steps[].optional`required	`boolean`
`agent`required	`object`
`agent.answer`required	`enum`	Values `no_agent \| api_key_only \| claude_code_api \| claude_code_subscription \| codex \| ide_agent`
`agent.detail`required	`object`
`agent.detail.codex_auth`	`enum`	Values `chatgpt \| api-key`
`agent.detail.claude_auth`	`enum`	Values `api-key \| bedrock \| vertex`
`agent.detail.ide_agent`	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`agent.mode`required	`enum`	Values `managed \| runner \| mcp`
`agent.agent`required	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`agent.auth`required	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`agent.transport`required	`enum`	Values `github_actions \| container`
`agent.credential_pending`required	`boolean`
`agent.confirmed_at`required	`string (date-time)`
`requirements`required	`array of enum`
`credentials`required	`array of object`
`credentials[].id`required	`string`
`credentials[].kind`required	`enum`	Values `anthropic_api_key \| openai_api_key \| codex_auth_json \| bedrock \| vertex \| openrouter \| github_user_token \| sentry_client_secret \| sentry_auth_token \| datadog_keys \| aws_credentials \| endpoint_token \| sso_client_secret`
`credentials[].last4`required	`string`
`credentials[].workspace_id`required	`string`
`credentials[].created_at`required	`string (date-time)`
`credentials[].rotated_at`required	`string (date-time)`
`credentials[].in_use`required	`boolean`
`demo`required	`object`
`demo.consent`required	`enum`	Values `granted \| refused`
`demo.consent_at`required	`string (date-time)`
`demo.consent_required`required	`boolean`
`demo.consent_reason`required	`enum`	Values `runs_elsewhere \| not_chosen`
`demo.used`required	`boolean`
`demo.can_start`required	`boolean`
`demo.start_blocker`required	`string`
`demo.workspace_demo`required	`object`
`demo.workspace_demo.available`required	`boolean`
`demo.workspace_demo.blocker`required	`string`
`demo.cap_usd`required	`number`
`demo.run`required	`object`
`demo.run.id`required	`string`
`demo.run.status`required	`enum`	Values `pending \| indexing \| choosing_case \| running \| completed \| failed`
`demo.run.mode`required	`enum`	Values `managed \| workspace`
`demo.run.phase`required	`enum`	Values `choosing_case \| reading_code \| indexing \| diagnosing \| fixing \| waiting_runner \| done \| failed`
`demo.run.outcome`required	`enum`	Values `answer \| pull_request \| fix_ready \| fix_not_verified \| escalated`
`demo.run.done`required	`boolean`
`demo.run.case_kind`required	`enum`	Values `real_error \| github_issue \| plausible_defect \| readme_question`
`demo.run.source`required	`object`
`demo.run.source.kind`required	`enum`	Values `real_error \| github_issue \| plausible_defect \| readme_question`
`demo.run.source.error_group_id`required	`string`

POST`/v1/onboarding/agent`

Step 3: the execution of the answer, its credentials, the updated pull request.

Rule 6: a forbidden combination (a Claude subscription outside MCP mode…) answers 422 `forbidden_combination` with `details.message` (it, en) and `details.suggestion`. Secrets are write-only: the API key goes to the repository’s Actions secret, auth.json is stored encrypted.

Authentication: Dashboard session

Request body

Request body, POST /v1/onboarding/agent
Name	Type	Description
`mode`required	`enum`	Values `managed \| runner \| mcp`
`agent`required	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`auth`required	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`transport`	`enum`	Values `github_actions \| container`
`agent_key`	`string`
`codex_auth_json`	`string`
`cloud_auth`	`object`
`runs_on`	`array of string`
`credential_later`	`boolean`
`answer`required	`enum`	Values `no_agent \| api_key_only \| claude_code_api \| claude_code_subscription \| codex \| ide_agent`
`detail`	`object`
`detail.codex_auth`	`enum`	Values `chatgpt \| api-key`
`detail.claude_auth`	`enum`	Values `api-key \| bedrock \| vertex`
`detail.ide_agent`	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`

Response `200`

The same fields as GET /v1/onboarding.

POST`/v1/onboarding/complete`

Ends the wizard.

Authentication: Dashboard session

Response `200`

The same fields as GET /v1/onboarding.

GET`/v1/onboarding/demo`

The live view of the demo: email, status page, diagnosis, draft, pull request.

Authentication: Dashboard session

Response `200`

Response, GET /v1/onboarding/demo
Name	Type	Description
`id`required	`string`
`status`required	`enum`	Values `pending \| indexing \| choosing_case \| running \| completed \| failed`
`mode`required	`enum`	Values `managed \| workspace`
`phase`required	`enum`	Values `choosing_case \| reading_code \| indexing \| diagnosing \| fixing \| waiting_runner \| done \| failed`
`outcome`required	`enum`	Values `answer \| pull_request \| fix_ready \| fix_not_verified \| escalated`
`done`required	`boolean`
`case_kind`required	`enum`	Values `real_error \| github_issue \| plausible_defect \| readme_question`
`source`required	`object`
`source.kind`required	`enum`	Values `real_error \| github_issue \| plausible_defect \| readme_question`
`source.error_group_id`required	`string`
`source.issue_number`required	`integer`
`source.issue_url`required	`string`
`source.path`required	`string`
`source.line_start`required	`integer`
`source.line_end`required	`integer`
`source.readme_path`required	`string`
`started_at`required	`string (date-time)`
`first_diagnosis_at`required	`string (date-time)`
`completed_at`required	`string (date-time)`
`cost_usd`required	`number`
`cap_usd`required	`number`
`error`required	`object`
`error.code`required	`enum`	Values `budget_exhausted \| repository_unavailable \| no_case \| job_failed \| timed_out \| internal`
`error.detail`required	`string`
`retry`required	`object`
`retry.allowed`required	`boolean`
`retry.reason`required	`string`
`attempts`required	`integer`
`repository`required	`object`
`repository.full_name`required	`string`
`repository.html_url`required	`string`
`email`required	`object`
`email.from_name`required	`string`
`email.from_address`required	`string`
`email.subject`required	`string`
`email.body`required	`string`
`email.received_at`required	`string (date-time)`
`ticket`required	`object`
`ticket.id`required	`string`
`ticket.state`required	`enum`	Values `received \| triage \| needs_info \| draft_ready \| answered \| fixing \| awaiting_approval \| releasing \| customer_notified \| closed \| escalated`
`ticket.public_state`required	`enum`	Values `in_analysis \| needs_reply \| answered \| fix_in_progress \| releasing \| resolved \| team_review`
`status_page_url`required	`string`
`indexed`required	`boolean`
`diagnosis`required	`object`
`diagnosis.category`required	`enum`	Values `usage \| config \| docs \| bug \| feature_request \| unknown`
`diagnosis.confidence`required	`number`
`diagnosis.root_cause_md`required	`string`
`diagnosis.references`required	`array of object`
`diagnosis.references[].path`required	`string`
`diagnosis.references[].line_start`required	`integer`
`diagnosis.references[].line_end`required	`integer`
`diagnosis.references[].symbol`required	`string`
`diagnosis.references[].url`required	`string`
`diagnosis.public_summary`required	`string`
`diagnosis.created_at`required	`string (date-time)`
`draft`required	`object`
`draft.kind`required	`enum`	Values `reply \| needs_info \| interim \| release_notice \| proactive_notice`
`draft.body_md`required	`string`
`draft.created_at`required	`string (date-time)`
`fix`required	`object`
`fix.status`required	`enum`	Values `running \| verified \| not_verified`
`fix.verify_passed`required	`boolean`
`fix.tests_passed`required	`boolean`
`fix.tests_ran`required	`boolean`
`fix.reason`required	`enum`	Values `verification_failed \| tests_failed \| tests_not_run_without_reason \| other`
`pull_request`required	`object`
`pull_request.number`required	`integer`
`pull_request.url`required	`string`
`pull_request.title`required	`string`
`pull_request.branch`required	`string`
`pull_request.draft`required	`boolean`
`pull_request.labeled`required	`boolean`
`ticket_closed`required	`boolean`

POST`/v1/onboarding/demo`

Starts the demo ticket (once per organization, at Loopback’s expense, cost cap).

Authentication: Dashboard session

Response `202`

The same fields as GET /v1/onboarding.

POST`/v1/onboarding/demo/consent`

Consent to clone the repository in the Managed sandbox for the demo; granted starts it.

Authentication: Dashboard session

Request body

Request body, POST /v1/onboarding/demo/consent
Name	Type	Description
`consent`required	`enum`	Values `granted \| refused`

Response `200`

The same fields as GET /v1/onboarding.

POST`/v1/onboarding/demo/retry`

Runs a demo that stopped without a diagnosis again, within its cost cap.

Authentication: Dashboard session

Response `202`

The same fields as GET /v1/onboarding/demo.

POST`/v1/onboarding/demo/workspace`

Without the consent: a test ticket through the workspace’s own runner or agent.

Authentication: Dashboard session

Response `202`

The same fields as GET /v1/onboarding.

GET`/v1/onboarding/execution/{workspaceId}`

Execution settings of a workspace with the files the onboarding pull request writes.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/onboarding/execution/{workspaceId}
Name	Type	Description
`workspaceId`pathrequired	`string`

Response `200`

Response, GET /v1/onboarding/execution/{workspaceId}
Name	Type	Description
`workspace_id`required	`string`
`mode`required	`enum`	Values `managed \| runner \| mcp`
`agent`required	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`auth`required	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`transport`required	`enum`	Values `github_actions \| container`
`allowed_modes`required	`array of enum`
`managed_available`required	`boolean`
`requirements`required	`array of enum`
`credentials`required	`array of object`
`credentials[].id`required	`string`
`credentials[].kind`required	`enum`	Values `anthropic_api_key \| openai_api_key \| codex_auth_json \| bedrock \| vertex \| openrouter \| github_user_token \| sentry_client_secret \| sentry_auth_token \| datadog_keys \| aws_credentials \| endpoint_token \| sso_client_secret`
`credentials[].last4`required	`string`
`credentials[].workspace_id`required	`string`
`credentials[].created_at`required	`string (date-time)`
`credentials[].rotated_at`required	`string (date-time)`
`credentials[].in_use`required	`boolean`
`repositories`required	`array of object`
`repositories[].id`required	`string`
`repositories[].full_name`required	`string`
`repositories[].html_url`required	`string`
`repositories[].default_branch`required	`string`
`repositories[].is_public`required	`boolean`
`repositories[].onboarding_pr`required	`object`
`repositories[].onboarding_pr.number`required	`integer`
`repositories[].onboarding_pr.url`required	`string`
`repositories[].onboarding_pr.status`required	`enum`	Values `none \| open \| merged \| closed`
`repositories[].onboarding_pr.requested_at`required	`string (date-time)`
`repositories[].onboarding_pr.error`required	`string`
`repositories[].onboarding_pr.title`required	`string`
`repositories[].agent_key`required	`object`
`repositories[].agent_key.last4`required	`string`
`repositories[].agent_key.set_at`required	`string (date-time)`
`repositories[].runs_on`required	`array of string`
`repositories[].cloud_auth`required	`object`
`runs_on`required	`array of string`
`cloud_auth`required	`object`
`preview`required	`object`
`preview.files`required	`array of object`
`preview.files[].path`required	`string`
`preview.files[].content`required	`string`
`preview.includes_workflow`required	`boolean`
`preview.needs_agent_key`required	`boolean`
`preview.missing_variables`required	`array of string`
`preview.repository_id`required	`string`

PUT`/v1/onboarding/execution/{workspaceId}`

Changes mode, agent, authentication and credentials of a workspace (rule 6).

Authentication: Dashboard session

Parameters

Parameters, PUT /v1/onboarding/execution/{workspaceId}
Name	Type	Description
`workspaceId`pathrequired	`string`

Request body

Request body, PUT /v1/onboarding/execution/{workspaceId}
Name	Type	Description
`mode`required	`enum`	Values `managed \| runner \| mcp`
`agent`required	`enum`	Values `claude-code \| codex \| opencode \| builtin \| cursor \| windsurf \| zed \| kiro \| antigravity \| continue \| cline \| copilot \| other`
`auth`required	`enum`	Values `api-key \| chatgpt \| bedrock \| vertex \| subscription`
`transport`	`enum`	Values `github_actions \| container`
`agent_key`	`string`
`codex_auth_json`	`string`
`cloud_auth`	`object`
`runs_on`	`array of string`
`credential_later`	`boolean`

Response `200`

The same fields as GET /v1/onboarding/execution/{workspaceId}.

DELETE`/v1/onboarding/execution/{workspaceId}/credentials/{credentialId}`

Deletes a stored agent credential that no workspace uses (audited).

Authentication: Dashboard session

Parameters

Parameters, DELETE /v1/onboarding/execution/{workspaceId}/credentials/{credentialId}
Name	Type	Description
`workspaceId`pathrequired	`string`
`credentialId`pathrequired	`string`

Response `200`

The same fields as GET /v1/onboarding/execution/{workspaceId}.

GET`/v1/onboarding/metrics`

Staff: signup → first diagnosis shown, demos by case, demo costs.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/onboarding/metrics
Name	Type	Description
`from`query	`string (date-time) \| string (date)`
`to`query	`string (date-time) \| string (date)`

Response `200`

Response, GET /v1/onboarding/metrics
Name	Type	Description
`from`required	`string (date-time)`
`to`required	`string (date-time)`
`signups`required	`integer`
`demos_started`required	`integer`
`demos_completed`required	`integer`
`demos_failed`required	`integer`
`time_to_first_diagnosis`required	`object`
`time_to_first_diagnosis.count`required	`integer`
`time_to_first_diagnosis.median_s`required	`number`
`time_to_first_diagnosis.p90_s`required	`number`
`time_to_first_diagnosis.under_target_ratio`required	`number`
`target_s`required	`integer`
`by_case`required	`array of object`
`by_case[].kind`required	`enum`	Values `real_error \| github_issue \| plausible_defect \| readme_question`
`by_case[].count`required	`integer`
`cost`required	`object`
`cost.total_usd`required	`number`
`cost.average_usd`required	`number`
`recent`required	`array of object`
`recent[].org_id`required	`string`
`recent[].status`required	`enum`	Values `pending \| indexing \| choosing_case \| running \| completed \| failed`
`recent[].case_kind`required	`enum`	Values `real_error \| github_issue \| plausible_defect \| readme_question`
`recent[].cost_usd`required	`number`
`recent[].signup_at`required	`string (date-time)`
`recent[].first_diagnosis_at`required	`string (date-time)`
`recent[].seconds_to_first_diagnosis`required	`number`

POST`/v1/onboarding/repository`

Step 1: the connected repository; opens the onboarding pull request.

Authentication: Dashboard session

Request body

Request body, POST /v1/onboarding/repository
Name	Type	Description
`repository_id`required	`string`

Response `200`

The same fields as GET /v1/onboarding.

POST`/v1/onboarding/steps/{step}`

Completes, skips (logs) or reopens a step.

Authentication: Dashboard session

Parameters

Parameters, POST /v1/onboarding/steps/{step}
Name	Type	Description
`step`pathrequired	`enum`	Values `repository \| channels \| agent \| logs`

Request body

Request body, POST /v1/onboarding/steps/{step}
Name	Type	Description
`action`required	`enum`	Values `complete \| skip \| reopen`

Response `200`

The same fields as GET /v1/onboarding.

POST`/v1/onboarding/workspace`

The workspace the wizard sets up (created with POST /v1/workspaces).

Authentication: Dashboard session

Request body

Request body, POST /v1/onboarding/workspace
Name	Type	Description
`workspace_id`required	`string`

Response `200`

The same fields as GET /v1/onboarding.

Name

Type

Description

workspacerequired

object

workspace.idrequired

string

workspace.namerequired

string

workspace.client_namerequired

string

workspace.slugrequired

string

workspace.localerequired

enum

Values it | en

workspace.execution_moderequired

enum

Values managed | runner | mcp

workspace.agent_idrequired

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

workspace.auth_methodrequired

enum

Values api-key | chatgpt | bedrock | vertex | subscription

workspace.runner_transportrequired

enum

Values github_actions | container

workspace.inbound_addressrequired

string

repositoryrequired

object

repository.idrequired

string

repository.full_namerequired

string

repository.html_urlrequired

string

repository.default_branchrequired

string

repository.is_publicrequired

boolean

repository.onboarding_prrequired

object

repository.onboarding_pr.numberrequired

integer

repository.onboarding_pr.urlrequired

string

repository.onboarding_pr.statusrequired

enum

Values none | open | merged | closed

repository.onboarding_pr.requested_atrequired

string (date-time)

repository.onboarding_pr.errorrequired

string

repository.onboarding_pr.titlerequired

string

repository.agent_keyrequired

object

repository.agent_key.last4required

string

repository.agent_key.set_atrequired

string (date-time)

repository.runs_onrequired

array of string

repository.cloud_authrequired

object

currentrequired

enum

Values repository | channels | agent | logs | done

stepsrequired

array of object

steps[].idrequired

enum

Values repository | channels | agent | logs

steps[].statusrequired

enum

Values todo | done | skipped

steps[].completed_atrequired

string (date-time)

steps[].availablerequired

boolean

steps[].optionalrequired

boolean

agentrequired

object

agent.answerrequired

enum

agent.detailrequired

object

agent.detail.codex_auth

enum

Values chatgpt | api-key

agent.detail.claude_auth

enum

Values api-key | bedrock | vertex

agent.detail.ide_agent

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

agent.moderequired

enum

Values managed | runner | mcp

agent.agentrequired

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

agent.authrequired

enum

Values api-key | chatgpt | bedrock | vertex | subscription

agent.transportrequired

enum

Values github_actions | container

agent.credential_pendingrequired

boolean

agent.confirmed_atrequired

string (date-time)

requirementsrequired

array of enum

credentialsrequired

array of object

credentials[].idrequired

string

credentials[].kindrequired

enum

Values

anthropic_api_key | openai_api_key | codex_auth_json | bedrock | vertex | openrouter | github_user_token | sentry_client_secret | sentry_auth_token | datadog_keys | aws_credentials | endpoint_token | sso_client_secret

credentials[].last4required

string

credentials[].workspace_idrequired

string

credentials[].created_atrequired

string (date-time)

credentials[].rotated_atrequired

string (date-time)

credentials[].in_userequired

boolean

demorequired

object

demo.consentrequired

enum

Values granted | refused

demo.consent_atrequired

string (date-time)

demo.consent_requiredrequired

boolean

demo.consent_reasonrequired

enum

Values runs_elsewhere | not_chosen

demo.usedrequired

boolean

demo.can_startrequired

boolean

demo.start_blockerrequired

string

demo.workspace_demorequired

object

demo.workspace_demo.availablerequired

boolean

demo.workspace_demo.blockerrequired

string

demo.cap_usdrequired

number

demo.runrequired

object

demo.run.idrequired

string

demo.run.statusrequired

enum

demo.run.moderequired

enum

Values managed | workspace

demo.run.phaserequired

enum

demo.run.outcomerequired

enum

Values answer | pull_request | fix_ready | fix_not_verified | escalated

demo.run.donerequired

boolean

demo.run.case_kindrequired

enum

Values real_error | github_issue | plausible_defect | readme_question

demo.run.sourcerequired

object

demo.run.source.kindrequired

enum

Values real_error | github_issue | plausible_defect | readme_question

demo.run.source.error_group_idrequired

string

Name

Type

Description

moderequired

enum

Values managed | runner | mcp

agentrequired

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

authrequired

enum

Values api-key | chatgpt | bedrock | vertex | subscription

transport

enum

Values github_actions | container

agent_key

string

codex_auth_json

string

cloud_auth

object

runs_on

array of string

credential_later

boolean

answerrequired

enum

detail

object

detail.codex_auth

enum

Values chatgpt | api-key

detail.claude_auth

enum

Values api-key | bedrock | vertex

detail.ide_agent

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

Name

Type

Description

idrequired

string

statusrequired

enum

moderequired

enum

Values managed | workspace

phaserequired

enum

outcomerequired

enum

Values answer | pull_request | fix_ready | fix_not_verified | escalated

donerequired

boolean

case_kindrequired

enum

Values real_error | github_issue | plausible_defect | readme_question

sourcerequired

object

source.kindrequired

enum

Values real_error | github_issue | plausible_defect | readme_question

source.error_group_idrequired

string

source.issue_numberrequired

integer

source.issue_urlrequired

string

source.pathrequired

string

source.line_startrequired

integer

source.line_endrequired

integer

source.readme_pathrequired

string

started_atrequired

string (date-time)

first_diagnosis_atrequired

string (date-time)

completed_atrequired

string (date-time)

cost_usdrequired

number

cap_usdrequired

number

errorrequired

object

error.coderequired

enum

error.detailrequired

string

retryrequired

object

retry.allowedrequired

boolean

retry.reasonrequired

string

attemptsrequired

integer

repositoryrequired

object

repository.full_namerequired

string

repository.html_urlrequired

string

emailrequired

object

email.from_namerequired

string

email.from_addressrequired

string

email.subjectrequired

string

email.bodyrequired

string

email.received_atrequired

string (date-time)

ticketrequired

object

ticket.idrequired

string

ticket.staterequired

enum

Values

received | triage | needs_info | draft_ready | answered | fixing | awaiting_approval | releasing | customer_notified | closed | escalated

ticket.public_staterequired

enum

status_page_urlrequired

string

indexedrequired

boolean

diagnosisrequired

object

diagnosis.categoryrequired

enum

diagnosis.confidencerequired

number

diagnosis.root_cause_mdrequired

string

diagnosis.referencesrequired

array of object

diagnosis.references[].pathrequired

string

diagnosis.references[].line_startrequired

integer

diagnosis.references[].line_endrequired

integer

diagnosis.references[].symbolrequired

string

diagnosis.references[].urlrequired

string

diagnosis.public_summaryrequired

string

diagnosis.created_atrequired

string (date-time)

draftrequired

object

draft.kindrequired

enum

Values reply | needs_info | interim | release_notice | proactive_notice

draft.body_mdrequired

string

draft.created_atrequired

string (date-time)

fixrequired

object

fix.statusrequired

enum

Values running | verified | not_verified

fix.verify_passedrequired

boolean

fix.tests_passedrequired

boolean

fix.tests_ranrequired

boolean

fix.reasonrequired

enum

Values verification_failed | tests_failed | tests_not_run_without_reason | other

pull_requestrequired

object

pull_request.numberrequired

integer

pull_request.urlrequired

string

pull_request.titlerequired

string

pull_request.branchrequired

string

pull_request.draftrequired

boolean

pull_request.labeledrequired

boolean

ticket_closedrequired

boolean

Name

Type

Description

consentrequired

enum

Values granted | refused

Name

Type

Description

workspaceIdpathrequired

string

Name

Type

Description

workspace_idrequired

string

moderequired

enum

Values managed | runner | mcp

agentrequired

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

authrequired

enum

Values api-key | chatgpt | bedrock | vertex | subscription

transportrequired

enum

Values github_actions | container

allowed_modesrequired

array of enum

managed_availablerequired

boolean

requirementsrequired

array of enum

credentialsrequired

array of object

credentials[].idrequired

string

credentials[].kindrequired

enum

Values

anthropic_api_key | openai_api_key | codex_auth_json | bedrock | vertex | openrouter | github_user_token | sentry_client_secret | sentry_auth_token | datadog_keys | aws_credentials | endpoint_token | sso_client_secret

credentials[].last4required

string

credentials[].workspace_idrequired

string

credentials[].created_atrequired

string (date-time)

credentials[].rotated_atrequired

string (date-time)

credentials[].in_userequired

boolean

repositoriesrequired

array of object

repositories[].idrequired

string

repositories[].full_namerequired

string

repositories[].html_urlrequired

string

repositories[].default_branchrequired

string

repositories[].is_publicrequired

boolean

repositories[].onboarding_prrequired

object

repositories[].onboarding_pr.numberrequired

integer

repositories[].onboarding_pr.urlrequired

string

repositories[].onboarding_pr.statusrequired

enum

Values none | open | merged | closed

repositories[].onboarding_pr.requested_atrequired

string (date-time)

repositories[].onboarding_pr.errorrequired

string

repositories[].onboarding_pr.titlerequired

string

repositories[].agent_keyrequired

object

repositories[].agent_key.last4required

string

repositories[].agent_key.set_atrequired

string (date-time)

repositories[].runs_onrequired

array of string

repositories[].cloud_authrequired

object

runs_onrequired

array of string

cloud_authrequired

object

previewrequired

object

preview.filesrequired

array of object

preview.files[].pathrequired

string

preview.files[].contentrequired

string

preview.includes_workflowrequired

boolean

preview.needs_agent_keyrequired

boolean

preview.missing_variablesrequired

array of string

preview.repository_idrequired

string

Name

Type

Description

workspaceIdpathrequired

string

Name

Type

Description

moderequired

enum

Values managed | runner | mcp

agentrequired

enum

Values

claude-code | codex | opencode | builtin | cursor | windsurf | zed | kiro | antigravity | continue | cline | copilot | other

authrequired

enum

Values api-key | chatgpt | bedrock | vertex | subscription

transport

enum

Values github_actions | container

agent_key

string

codex_auth_json

string

cloud_auth

object

runs_on

array of string

credential_later

boolean

Name

Type

Description

workspaceIdpathrequired

string

credentialIdpathrequired

string

Name

Type

Description

fromquery

string (date-time) | string (date)

toquery

string (date-time) | string (date)

Name

Type

Description

fromrequired

string (date-time)

torequired

string (date-time)

signupsrequired

integer

demos_startedrequired

integer

demos_completedrequired

integer

demos_failedrequired

integer

time_to_first_diagnosisrequired

object

time_to_first_diagnosis.countrequired

integer

time_to_first_diagnosis.median_srequired

number

time_to_first_diagnosis.p90_srequired

number

time_to_first_diagnosis.under_target_ratiorequired

number

target_srequired

integer

by_caserequired

array of object

by_case[].kindrequired

enum

Values real_error | github_issue | plausible_defect | readme_question

by_case[].countrequired

integer

costrequired

object

cost.total_usdrequired

number

cost.average_usdrequired

number

recentrequired

array of object

recent[].org_idrequired

string

recent[].statusrequired

enum

recent[].case_kindrequired

enum

Values real_error | github_issue | plausible_defect | readme_question

recent[].cost_usdrequired

number

recent[].signup_atrequired

string (date-time)

recent[].first_diagnosis_atrequired

string (date-time)

recent[].seconds_to_first_diagnosisrequired

number

Name

Type

Description

repository_idrequired

string

Name

Type

Description

steppathrequired

enum

Values repository | channels | agent | logs

Name

Type

Description

actionrequired

enum

Values complete | skip | reopen

Name

Type

Description

workspace_idrequired

string

GET/v1/onboarding

Response 200

POST/v1/onboarding/agent

Request body

Response 200

POST/v1/onboarding/complete

Response 200

GET/v1/onboarding/demo

Response 200

POST/v1/onboarding/demo

Response 202

POST/v1/onboarding/demo/consent

Request body

Response 200

POST/v1/onboarding/demo/retry

Response 202

POST/v1/onboarding/demo/workspace

Response 202

GET/v1/onboarding/execution/{workspaceId}

Parameters

Response 200

PUT/v1/onboarding/execution/{workspaceId}

Parameters

Request body

Response 200

DELETE/v1/onboarding/execution/{workspaceId}/credentials/{credentialId}

Parameters

Response 200

GET/v1/onboarding/metrics

Parameters

Response 200

POST/v1/onboarding/repository

Request body

Response 200

POST/v1/onboarding/steps/{step}

Parameters

Request body

Response 200

POST/v1/onboarding/workspace

Request body

Response 200

GET/v1/onboarding

Response 200

POST/v1/onboarding/agent

Request body

Response 200

POST/v1/onboarding/complete

Response 200

GET/v1/onboarding/demo

Response 200

POST/v1/onboarding/demo

Response 202

POST/v1/onboarding/demo/consent

Request body

Response 200

POST/v1/onboarding/demo/retry

Response 202

POST/v1/onboarding/demo/workspace

Response 202

GET/v1/onboarding/execution/{workspaceId}

Parameters

Response 200

PUT/v1/onboarding/execution/{workspaceId}

Parameters

Request body

Response 200

DELETE/v1/onboarding/execution/{workspaceId}/credentials/{credentialId}

Parameters

Response 200

GET/v1/onboarding/metrics

Parameters

Response 200

POST/v1/onboarding/repository

Request body

Response 200

POST/v1/onboarding/steps/{step}

Parameters

Request body

Response 200

POST/v1/onboarding/workspace

GET`/v1/onboarding`

Response `200`

POST`/v1/onboarding/agent`

Response `200`

POST`/v1/onboarding/complete`

Response `200`

GET`/v1/onboarding/demo`

Response `200`

POST`/v1/onboarding/demo`

Response `202`

POST`/v1/onboarding/demo/consent`

Response `200`

POST`/v1/onboarding/demo/retry`

Response `202`

POST`/v1/onboarding/demo/workspace`

Response `202`

GET`/v1/onboarding/execution/{workspaceId}`

Response `200`

PUT`/v1/onboarding/execution/{workspaceId}`

Response `200`

DELETE`/v1/onboarding/execution/{workspaceId}/credentials/{credentialId}`

Response `200`

GET`/v1/onboarding/metrics`

Response `200`

POST`/v1/onboarding/repository`

Response `200`

POST`/v1/onboarding/steps/{step}`

Response `200`

POST`/v1/onboarding/workspace`

Response `200`

GET`/v1/onboarding`

Response `200`

POST`/v1/onboarding/agent`

Response `200`

POST`/v1/onboarding/complete`

Response `200`

GET`/v1/onboarding/demo`

Response `200`

POST`/v1/onboarding/demo`

Response `202`

POST`/v1/onboarding/demo/consent`

Response `200`

POST`/v1/onboarding/demo/retry`

Response `202`

POST`/v1/onboarding/demo/workspace`

Response `202`

GET`/v1/onboarding/execution/{workspaceId}`

Response `200`

PUT`/v1/onboarding/execution/{workspaceId}`

Response `200`

DELETE`/v1/onboarding/execution/{workspaceId}/credentials/{credentialId}`

Response `200`

GET`/v1/onboarding/metrics`

Response `200`

POST`/v1/onboarding/repository`

Response `200`

POST`/v1/onboarding/steps/{step}`

Response `200`

POST`/v1/onboarding/workspace`

Response `200`