> ## 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.

# Start onboarding

> Start an agent-first onboarding workspace for a public website.

No authentication is required.



## OpenAPI

````yaml openapi-v2.json POST /api/v2/onboarding/agent/start
openapi: 3.1.0
info:
  title: SiteGPT Agent API
  version: 2.0.0
  description: >-
    Agent-facing API for managing SiteGPT chatbots, dashboard summaries,
    appearance media, knowledge, settings, conversations, leads, members,
    account profiles, usage, billing reads, and API tokens.
servers:
  - url: https://sitegpt.ai
security:
  - bearerAuth: []
tags:
  - name: Discovery
  - name: Onboarding
  - name: Account
  - name: Billing
  - name: Tokens
  - name: Chatbots
  - name: Knowledge
  - name: Knowledge Sync Jobs
  - name: Knowledge Sources
  - name: Custom Responses
  - name: Personas
  - name: Instructions
  - name: Settings
  - name: Conversation Starters
  - name: Conversation Followups
  - name: Members
  - name: Leads
  - name: Conversations
  - name: Messages
  - name: Tags
paths:
  /api/v2/onboarding/agent/start:
    post:
      tags:
        - Onboarding
      summary: Start onboarding
      description: |-
        Start an agent-first onboarding workspace for a public website.

        No authentication is required.
      operationId: startOnboardingWorkspace
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - websiteUrl
              additionalProperties: false
              properties:
                websiteUrl:
                  type: string
                  format: uri
                  description: Public website URL to prepare a temporary chatbot for.
                agentName:
                  type: string
                  maxLength: 120
                  description: Optional display name of the AI agent starting setup.
                agentClientId:
                  type: string
                  maxLength: 120
                  description: Optional stable client identifier for the agent runtime.
            example:
              websiteUrl: https://example.com
              agentName: Claude
              agentClientId: claude-web
      responses:
        '201':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                  - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      workspace:
                        $ref: '#/components/schemas/GenericObject'
                      apiToken:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Temporary one-chatbot token returned once for the
                          setup agent.
                      apiBase:
                        type: string
                        format: uri
                      mcpUrl:
                        type: string
                        format: uri
                      onboardingUrl:
                        type: string
                        format: uri
                        description: >-
                          Single user-facing URL where the user can test and
                          claim the chatbot.
                      statusUrl:
                        type: string
                        format: uri
                      claimUrl:
                        type: string
                        format: uri
                      expiresAt:
                        type: string
                        format: date-time
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                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
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
      security: []
components:
  schemas:
    GenericObject:
      type: object
      additionalProperties: true
    AgentResponseMeta:
      type: object
      required:
        - requestId
      properties:
        requestId:
          type: string
        warnings:
          type: array
          items:
            type: string
        nextCursor:
          type:
            - string
            - 'null'
      additionalProperties: true
    AgentError:
      type: object
      required:
        - ok
        - error
        - meta
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          additionalProperties: false
        meta:
          type: object
          required:
            - requestId
          properties:
            requestId:
              type: string
          additionalProperties: true
      additionalProperties: false
  responses:
    AgentError:
      description: SiteGPT agent API error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AgentError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SiteGPT API token

````