Skip to main content
POST
/
api
/
v2
/
onboarding
/
agent
/
start
Start onboarding
curl --request POST \
  --url https://sitegpt.ai/api/v2/onboarding/agent/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "websiteUrl": "https://example.com",
  "agentName": "Claude",
  "agentClientId": "claude-web"
}
'
{
  "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"
    },
    "apiToken": "sgpt_xxxxxxxxx",
    "apiBase": "https://sitegpt.ai",
    "mcpUrl": "https://sitegpt.ai/mcp",
    "onboardingUrl": "https://sitegpt.ai/onboarding/preview/workspace-id",
    "statusUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id",
    "claimUrl": "https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id/claim",
    "expiresAt": "2026-05-20T00:00:00.000Z"
  },
  "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.

Body

application/json
websiteUrl
string<uri>
required

Public website URL to prepare a temporary chatbot for.

agentName
string

Optional display name of the AI agent starting setup.

Maximum string length: 120
agentClientId
string

Optional stable client identifier for the agent runtime.

Maximum string length: 120

Response

Successful SiteGPT API v2 response.

ok
boolean
required
data
object
required
meta
object
required