Skip to content

Onboarding

Compozy Onboarding HTTP endpoints.

For people running agent work31 pages in this section

Get the first-run onboarding completion status

GET/api/onboarding

Response Body

application/json

application/json

curl -X GET "https://example.com/api/onboarding"
{  "onboarding": {    "completed": true,    "completed_at": "string"  }}

Clear the onboarding completion flag

DELETE/api/onboarding

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/onboarding"
{  "onboarding": {    "completed": true,    "completed_at": "string"  }}

Mark first-run onboarding as completed

POST/api/onboarding/complete

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/onboarding/complete"
{  "onboarding": {    "completed": true,    "completed_at": "string"  }}

Diagnostics

Compozy Diagnostics HTTP endpoints.

Filesystem

Compozy Filesystem HTTP endpoints.