Skip to main content
GET
/
api
/
v2
/
onboarding
/
workspaces
/
{workspaceId}
Get onboarding status
curl --request GET \
  --url https://sitegpt.ai/api/v2/onboarding/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "data": {
    "workspace": {
      "id": "workspace-id",
      "chatbotId": "chatbot-id",
      "sourceUrl": "https://example.com/",
      "normalizedDomain": "example.com",
      "status": "CREATED",
      "expiresAt": "2026-05-20T00:00:00.000Z",
      "claim": {
        "status": "NOT_STARTED",
        "email": null,
        "plan": null,
        "interval": null,
        "checkoutUrl": null
      }
    },
    "setupChecklist": [
      {
        "key": "knowledge",
        "label": "Knowledge",
        "state": "DONE",
        "detail": "24/24 trained from Sitemap."
      },
      {
        "key": "persona",
        "label": "Persona",
        "state": "DONE",
        "detail": "Custom persona active: Product expert."
      }
    ],
    "claimUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id/claim",
    "onboardingUrl": "https://sitegpt.ai/onboarding/preview/workspace-id",
    "statusUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id"
  },
  "meta": {
    "requestId": "request-id"
  }
}

Documentation Index

Fetch the complete documentation index at: https://sitegpt.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Response

Successful SiteGPT API v2 response.

ok
boolean
required
data
object
required
meta
object
required