> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kair.is/llms.txt
> Use this file to discover all available pages before exploring further.

# Post sessions project candidates create workspace



## OpenAPI

````yaml /openapi.json post /sessions/{session_id}/project-candidates/{project_candidate_id}/create-workspace
openapi: 3.0.0
info:
  title: Braid
  version: '1.0'
servers:
  - url: http://localhost:8001/api
security: []
tags:
  - name: Admin
  - name: ApiKey
  - name: Auth
  - name: Calendar
  - name: Capture
  - name: Concerns
  - name: Dashboard
  - name: DataRequests
  - name: Device
  - name: Feedback
  - name: Graph
  - name: Health
  - name: Job
  - name: OAuth
  - name: Organisation
  - name: Realtime
  - name: Search
  - name: Session
  - name: Workshop
  - name: Workspace
paths:
  /sessions/{session_id}/project-candidates/{project_candidate_id}/create-workspace:
    post:
      tags:
        - Session
      parameters:
        - name: session_id
          schema:
            type: string
            format: uuid
          in: path
          required: true
          deprecated: false
          explode: true
        - name: project_candidate_id
          schema:
            type: string
            format: uuid
          in: path
          required: true
          deprecated: false
          explode: true
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/CreateProjectWorkspaceRequest'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CreatedWorkspaceResponse'
        '400':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: ''
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CreateProjectWorkspaceRequest:
      type: object
      title: CreateProjectWorkspaceRequest
      required:
        - name
        - onboarding
        - placement
      properties:
        name:
          type: string
        onboarding:
          $ref: '#/components/schemas/OnboardingDto'
        placement:
          $ref: '#/components/schemas/WorkspacePlacement'
        carry_forward:
          type: array
          description: >-
            Omit for the default sections; `[]` carries forward only the header
            and candidate.
          items:
            $ref: '#/components/schemas/CarryForwardSection'
        preferred_language:
          type: string
          description: Empty or omitted inherits the source session's target language.
          default: null
    CreatedWorkspaceResponse:
      type: object
      title: CreatedWorkspaceResponse
      required:
        - workspace_id
        - already_existed
        - brief_stored
      properties:
        workspace_id:
          type: string
          format: uuid
        already_existed:
          type: boolean
        brief_stored:
          type: boolean
    ErrorResponse:
      type: object
      title: ErrorResponse
      required:
        - success
        - message
      properties:
        success:
          type: boolean
        message:
          type: string
    OnboardingDto:
      type: object
      title: OnboardingDto
      required:
        - questions
      properties:
        questions:
          type: array
          items:
            $ref: '#/components/schemas/OnboardingQuestionDto'
        completed_at:
          type: string
    WorkspacePlacement:
      type: string
      enum:
        - child_project
        - child_event
        - top_level_project
    CarryForwardSection:
      type: string
      enum:
        - onboarding_answers
        - clarifying_questions
        - session_summary
        - related_pattern_cards
        - related_work_items
        - facilitator_notes
    OnboardingQuestionDto:
      type: object
      title: OnboardingQuestionDto
      description: >-
        API shape of one onboarding question. Mirrors

        `kair_voice_core::context::OnboardingQuestion`; kept separate so the
        core

        type need not depend on `poem_openapi`.
      required:
        - id
        - prompt
      properties:
        id:
          type: string
        prompt:
          type: string
        answer:
          type: string
          default: ''
        is_goal:
          type: boolean
          default: false

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.