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

# Create and assign interviews

> Create and assign one interview per assignee. **Admin only.**

Provide existing project members via `assignee_ids` and/or new people to
invite via `invite_emails` (at least one is required). Invitees are added
as non-admin Contributors. A separate interview is created for each
assignee and the response is the list of created interviews.

`write_scope` defaults to `local`. A `global` write scope requires every
assignee to already be a project admin and cannot be combined with
`invite_emails`.

`campaign_id` / `campaign_name` group the created interviews under an
interview campaign (e.g. a workshop wave). `campaign_id` picks an existing
campaign of the project; `campaign_name` reuses the project's campaign
with that name (case-insensitive) or creates it.




## OpenAPI

````yaml /api-reference/openapi-public.yaml post /projects/{project_id}/interviews/assign/
openapi: 3.0.3
info:
  title: Clarifeye Platform API — Public API
  description: >
    Forward-facing, supported REST API for new integrators of the Clarifeye
    Platform.


    Covers the curated public surface: authentication, knowledge management

    (documents), users & teams, signals, and tool execution. New integrations

    should target these endpoints.


    ## Authentication

    All endpoints require authentication. Include the Authorization header in
    every request using either format:

    - `Authorization: Token <token_key>`

    - `Authorization: Bearer <token_key>`
  version: 1.0.0
  contact:
    name: Clarifeye Support
servers:
  - url: https://eu.app.clarifeye.ai/api/v1
    description: EU
  - url: https://us.app.clarifeye.ai/api/v1
    description: US
security:
  - BearerAuth: []
  - TokenAuth: []
tags:
  - name: Users
    description: Manage users within a project
  - name: Invitations
    description: Manage project invitations
  - name: Documents
    description: Manage documents within a project
  - name: Signals
    description: Submit signals about the project's content for domain experts to review
  - name: Tools
    description: Execute configured AI tools with custom parameters
  - name: Interviews
    description: Assign and review structured interview conversations
paths:
  /projects/{project_id}/interviews/assign/:
    post:
      tags:
        - Interviews
      summary: Create and assign interviews
      description: >
        Create and assign one interview per assignee. **Admin only.**


        Provide existing project members via `assignee_ids` and/or new people to

        invite via `invite_emails` (at least one is required). Invitees are
        added

        as non-admin Contributors. A separate interview is created for each

        assignee and the response is the list of created interviews.


        `write_scope` defaults to `local`. A `global` write scope requires every

        assignee to already be a project admin and cannot be combined with

        `invite_emails`.


        `campaign_id` / `campaign_name` group the created interviews under an

        interview campaign (e.g. a workshop wave). `campaign_id` picks an
        existing

        campaign of the project; `campaign_name` reuses the project's campaign

        with that name (case-insensitive) or creates it.
      operationId: assignInterviews
      parameters:
        - $ref: '#/components/parameters/ProjectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                assignee_ids:
                  type: array
                  description: >-
                    UUIDs of existing project members to interview (must be
                    tech/contributor members).
                  items:
                    type: string
                    format: uuid
                invite_emails:
                  type: array
                  description: >-
                    Email addresses of people to invite on the fly as non-admin
                    Contributors and assign an interview.
                  items:
                    type: string
                    format: email
                topic:
                  type: string
                  description: >-
                    The interview focus. Used to auto-name the interview and
                    seed its first question.
                write_scope:
                  type: string
                  description: >-
                    Whether interview edits stay local to the conversation or
                    write to the shared knowledge store.
                  enum:
                    - local
                    - global
                  default: local
                campaign_id:
                  type: string
                  format: uuid
                  nullable: true
                  description: >
                    Existing campaign to group the created interviews under
                    (must belong

                    to the project). Wins over `campaign_name` when both are
                    sent.
                campaign_name:
                  type: string
                  description: >
                    Campaign to group the created interviews under, by name:
                    reuses the

                    project's campaign with that name (case-insensitive) or
                    creates it.
            example:
              assignee_ids:
                - 3fa85f64-5717-4562-b3fc-2c963f66afa6
              invite_emails:
                - newperson@example.com
              topic: Q4 planning and roadmap review
              write_scope: local
              campaign_name: Q4 expert workshop wave
      responses:
        '201':
          description: Interviews created and assigned
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Interview'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: UUID of the project
      schema:
        type: string
        format: uuid
  schemas:
    Interview:
      type: object
      description: A structured interview conversation, including its full transcript.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          nullable: true
          description: Interview title (auto-generated from the topic when not provided).
        created_by:
          type: string
          format: uuid
          readOnly: true
          description: UUID of the user who created the interview.
        created_by_email:
          type: string
          format: email
          nullable: true
          readOnly: true
          description: >-
            Email of the user who created the interview (the importer, for
            imported interviews).
        type:
          type: string
          description: >
            Conversation type: "interview" (standard), "guided-interview"
            (multi-topic),

            or "imported-interview" (a read-only transcript of an interview
            recorded

            outside the platform, created via the import-transcript endpoint).
        type_additional_parameters:
          type: object
          description: Free-form parameters associated with the conversation type.
        chat_history:
          type: array
          description: Ordered list of transcript entries (messages, tool calls, etc.).
          items:
            type: object
        chat_memory:
          type: object
          description: Assistant memory state accumulated over the conversation.
        local_documents:
          type: array
          readOnly: true
          description: UUIDs of documents scoped locally to this interview.
          items:
            type: string
            format: uuid
        assigned_to:
          type: string
          format: uuid
          nullable: true
          readOnly: true
          description: >-
            UUID of the assigned user (null while a pending invite has not yet
            joined).
        assigned_by:
          type: string
          format: uuid
          nullable: true
          readOnly: true
          description: UUID of the user who created the assignment.
        assigned_to_email:
          type: string
          format: email
          nullable: true
          readOnly: true
          description: >-
            Assignee email, falling back to the invite email for not-yet-joined
            invitees.
        assigned_by_email:
          type: string
          format: email
          nullable: true
          readOnly: true
        is_pending_invite:
          type: boolean
          readOnly: true
          description: True when assigned to someone who has not yet joined the project.
        topics:
          type: array
          readOnly: true
          description: >
            Guided interviews only: the ordered topic agenda seeded at assign
            time,

            with per-topic progress. Empty for every other interview type.
          items:
            type: object
            properties:
              title:
                type: string
              description:
                type: string
              status:
                type: string
                enum:
                  - open
                  - resolved
                  - dismissed
                description: |
                  "open" while the topic still has to be covered; "resolved" or
                  "dismissed" once it no longer is. The interview auto-completes
                  when no topic is left open.
              skill_id:
                type: string
                nullable: true
                description: >-
                  Standard-guide skill backing the topic; null for custom
                  topics.
        campaign:
          allOf:
            - $ref: '#/components/schemas/InterviewCampaignRef'
          nullable: true
          readOnly: true
          description: Campaign this interview belongs to; null for ad hoc interviews.
        import_info:
          allOf:
            - $ref: '#/components/schemas/ImportedInterviewInfo'
          nullable: true
          readOnly: true
        status:
          type: string
          nullable: true
          readOnly: true
          enum:
            - pending
            - in_progress
            - completed
          description: Null for imported interviews until their transcript parse completes.
        write_scope:
          type: string
          enum:
            - local
            - global
          description: >-
            Whether edits stay local to the conversation or write to the shared
            knowledge store.
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    InterviewCampaignRef:
      type: object
      description: Nested campaign reference carried by interviews.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    ImportedInterviewInfo:
      type: object
      description: >
        Parse-pipeline state of an imported external transcript (interviews of
        type

        "imported-interview"). Null on every other interview type. The raw
        submitted

        transcript is never returned — the parsed `chat_history` is the
        transcript.
      properties:
        import_status:
          type: string
          enum:
            - parsing
            - ready
            - failed
          description: >
            "parsing" while the async parse runs (transcript not yet readable),

            "ready" once chat_history holds the speaker-labeled turns (status
            becomes

            "completed"), "failed" when parsing errored.
        participants:
          type: array
          description: >-
            Participant names (importer-supplied or inferred from the
            transcript).
          items:
            type: string
        interview_date:
          type: string
          format: date
          nullable: true
          description: Date the conversation happened (importer-supplied or inferred).
        error:
          type: string
          nullable: true
          description: Failure detail when import_status is "failed".
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: User not found
    ValidationError:
      type: object
      additionalProperties:
        type: array
        items:
          type: string
      example:
        email:
          - This field is required.
  responses:
    BadRequest:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/ValidationError'
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Authentication credentials were not provided.
    Forbidden:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: You do not have permission to perform this action.
    NotFound:
      description: Not found - resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not found.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Use Authorization: Bearer <token>'
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use Authorization: Token <token>'

````