> ## Documentation Index > Fetch the complete documentation index at: https://wiredesk.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get an onboarding > How the onboarding stands, and its setup checklist. Fix what is not `done` before you share `claim_url`; knowledge stays `pending` while the site is crawled, usually a minute or two. Works with the trial's key, and with a key of the workspace it was claimed into. ## OpenAPI ````yaml /api-reference/openapi.json get /onboarding/{onboarding_id} openapi: 3.1.0 info: title: Wiredesk API version: 1.0.0 description: >- Read and change a Wiredesk workspace: agents, conversations, contacts, leads and knowledge, and talk to an agent. Authenticate with an API key from Developers → API keys. Every response carries an x-request-id header, which Developers → Logs finds the request by. servers: - url: https://wiredesk.ai/api/v1 security: - bearerAuth: [] tags: - name: Agents description: 'The workspace''s agents: their name, greeting, instructions and channels.' - name: Chat description: >- Send a customer's message to an agent and get its reply, without the chat widget. - name: Knowledge description: >- What an agent answers from: pasted text and websites, and the sources added in the dashboard. - name: Conversations description: Conversations on every channel, and their transcripts. - name: Contacts description: The people the agents talk to, by phone number, email or your own id. - name: Leads description: Leads the agents captured. - name: Onboarding description: >- Agent-first onboarding: an AI agent builds a trial agent from a website, and a person claims it. paths: /onboarding/{onboarding_id}: get: tags: - Onboarding summary: Get an onboarding description: >- How the onboarding stands, and its setup checklist. Fix what is not `done` before you share `claim_url`; knowledge stays `pending` while the site is crawled, usually a minute or two. Works with the trial's key, and with a key of the workspace it was claimed into. operationId: get_onboarding parameters: - name: onboarding_id in: path required: true schema: type: string pattern: ^ob_[0-9a-f]{32}$ description: The onboarding's id, `ob_` and 32 hex characters. responses: '200': description: The onboarding content: application/json: schema: type: object required: - data properties: data: allOf: - $ref: '#/components/schemas/Onboarding' - type: object properties: setup: type: - array - 'null' description: >- What is left to do before the person sees the agent. Null once the trial is gone. items: $ref: '#/components/schemas/SetupItem' headers: x-request-id: $ref: '#/components/headers/RequestId' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/Error' headers: x-request-id: $ref: '#/components/headers/RequestId' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/Error' headers: x-request-id: $ref: '#/components/headers/RequestId' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/Error' headers: x-request-id: $ref: '#/components/headers/RequestId' components: schemas: Onboarding: type: object description: >- An agent-first onboarding: a trial agent built from a website before anyone had an account, and where it went. properties: id: type: string description: '`ob_` and 32 hex characters.' object: type: string const: onboarding status: type: string enum: - active - claimed - deleted - expired description: >- `active` until someone claims it, it is deleted, or its week runs out. agent_id: type: - string - 'null' description: >- The trial's agent; once claimed, the agent in the claimer's workspace. website_url: type: string setup_agent: type: - string - 'null' description: The `agent_name` it was started with. claim_url: type: string format: uri description: >- The one link for the person: they chat with the agent there, and claim it. claim: type: object properties: email: type: - string - 'null' description: Prefilled on the sign-up form. plan: type: string const: free description: A claimed agent is always on the Free plan. claimed_at: type: - string - 'null' format: date-time created_at: type: string format: date-time expires_at: type: string format: date-time description: Unclaimed by then, the trial is deleted. SetupItem: type: object properties: key: type: string enum: - knowledge - instructions - greeting - appearance state: type: string enum: - done - pending - warning description: '`pending` is in progress or not started; `warning` needs a look.' detail: type: string Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - invalid_request - unauthorized - spend_cap_reached - read_only_key - channel_disabled - knowledge_full - not_found - method_not_allowed - already_exists - conflict - rate_limited - internal_error - upstream_error - not_configured message: type: string additionalProperties: true headers: RequestId: description: >- A unique id for this request, on every response including errors. Developers → Logs finds the request by it; quote it to support. schema: type: string format: uuid securitySchemes: bearerAuth: type: http scheme: bearer description: An API key, `wd_...`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.