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

# Edit a sent interview before its first answer

> Change a sent guided interview's content in place. **Admin only.**

Possible while the interview's `can_edit` is true: not yet answered by its
respondent, not completed, not archived, not a test run. If Clara's opener was
already generated (the respondent opened the link), it is discarded so the next
open greets them with the new agenda. Nobody is notified and the link is
unchanged. Recipients and invitation settings cannot be changed here.

Send only the fields that change. `topics` replaces the whole ordered list
(same shape and rules as on drafts); `artifacts` replaces the selection.




## OpenAPI

````yaml /api-reference/openapi-public.yaml post /projects/{project_id}/interviews/{interview_id}/edit/
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>`


    ## Service accounts and API keys

    Integrations authenticate with an **API key** of a **service account**:

    - `Authorization: Bearer <key>` (keys start with `cfk_`)


    A service account is an ordinary member (role `member`) of one organization
    that cannot log

    in. Organization admins create it and mint its keys on the organization's
    *Service

    accounts* page, and give it access to knowledge stores with ordinary store
    permissions. A

    key is valid on every endpoint and acts as its service account: it reaches
    exactly the

    stores, with exactly the rights, the account was given. An account can hold
    several keys

    (each with its own name, optional expiry and revocation), so a key can be
    rotated without

    changing identity.


    A refused key answers **403** with one of: `Invalid API key.`, `API key
    revoked.`,

    `API key expired.`, `API key disabled.` (the service account is disabled).
  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, run and review structured interview conversations, and manage
      interview drafts and campaigns
  - name: Artifacts
    description: >
      Knowledge-store artifact catalog: list artifacts, create and edit custom
      artifacts,

      manage scope membership, read and publish versions, and configure the
      store map.
  - name: Knowledge Changelog
    description: Chronological log of changes to the knowledge store's artifacts.
paths:
  /projects/{project_id}/interviews/{interview_id}/edit/:
    post:
      tags:
        - Interviews
      summary: Edit a sent interview before its first answer
      description: >
        Change a sent guided interview's content in place. **Admin only.**


        Possible while the interview's `can_edit` is true: not yet answered by
        its

        respondent, not completed, not archived, not a test run. If Clara's
        opener was

        already generated (the respondent opened the link), it is discarded so
        the next

        open greets them with the new agenda. Nobody is notified and the link is

        unchanged. Recipients and invitation settings cannot be changed here.


        Send only the fields that change. `topics` replaces the whole ordered
        list

        (same shape and rules as on drafts); `artifacts` replaces the selection.
      operationId: editSentInterview
      parameters:
        - $ref: '#/components/parameters/ProjectId'
        - name: interview_id
          in: path
          required: true
          description: UUID of the interview to edit
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                focus:
                  type: string
                  description: What the interview is about. Cannot be blank.
                topics:
                  type: array
                  maxItems: 12
                  items:
                    $ref: '#/components/schemas/GuidedInterviewTopic'
                instructions:
                  type: string
                  description: >-
                    How Clara runs the session (interviewer-only). Empty removes
                    them.
                artifacts:
                  type: array
                  items:
                    $ref: '#/components/schemas/InterviewArtifactSelection'
                language:
                  type: string
                  nullable: true
                  description: ISO language code, or null for auto-detect.
                planned_minutes:
                  type: integer
                  minimum: 5
                  maximum: 180
                  description: >-
                    The whole interview's planned length in minutes. Left out on
                    a topics change, a length still at the old topic default
                    follows the new agenda.
                surface:
                  type: string
                  enum:
                    - ui
                    - mcp
                  default: ui
                  description: >-
                    Where the edit came from, for analytics only. The MCP server
                    sends `mcp`.
      responses:
        '200':
          description: The updated interview, plus the fields that actually changed.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Interview'
                  - type: object
                    properties:
                      updated_fields:
                        type: array
                        items:
                          type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            The interview can no longer be edited (already answered, completed,
            archived, or a test run).
components:
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: UUID of the project
      schema:
        type: string
        format: uuid
  schemas:
    GuidedInterviewTopic:
      type: object
      description: >
        One ordered topic of a guided interview. `title` and `description` say
        what THIS

        topic must cover; `skill_id` is its TYPE — how the interviewer works it
        — and

        round-trips through edits, so preserve the values you received or the
        topic loses

        its skill-backed interview depth. Accepted values are the interview
        skills

        (`use_case_exploration`, `use_case_context`, `document_library`,

        `document_upload`, `custom_topic`, `guided_wrap_up`, plus ids retired
        from new

        agendas but still carried by older drafts); an unrecognized id is
        rejected with

        400. Omit `skill_id` for a free-form topic, driven by its own
        title/description

        text.
      required:
        - title
      properties:
        title:
          type: string
          maxLength: 200
        description:
          type: string
        skill_id:
          type: string
          nullable: true
    InterviewArtifactSelection:
      type: object
      required:
        - slug
      properties:
        slug:
          type: string
          description: An in-scope artifact slug.
        show_to_respondent:
          type: boolean
          default: false
          description: >
            Whether the respondent can also open this artifact, read-only,
            beside the chat

            (`GET .../interviews/{id}/artifacts/`). False keeps it as the
            interviewer's

            background only.
    Interview:
      type: object
      description: A structured interview conversation, including its full transcript.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        can_edit:
          type: boolean
          readOnly: true
          description: >-
            Whether an admin may still edit this sent interview (before its
            first answer).
        not_editable_reason:
          type: string
          nullable: true
          readOnly: true
          description: >-
            Why the interview can no longer be edited (answered, completed,
            archived, test run, not guided); null while `can_edit` is true.
        last_edited_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: When an admin last edited this sent interview.
        last_edited_by_email:
          type: string
          format: email
          nullable: true
          readOnly: true
        sent_from_draft_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
          description: The draft this interview was sent from, when it was sent from one.
        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. Assigned
            interviews

            carry `planned_minutes` (the planned length) among them.
        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.
            Server-only keys (`respondent_profile`, the respondent's profile as
            of the first turn) are omitted; sending one is a 400, and a write
            keeps the stored value.
        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
        meeting_info:
          allOf:
            - $ref: '#/components/schemas/MeetingInfo'
          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.
        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".
    MeetingInfo:
      type: object
      description: >
        Set on conversations of type `meeting` — the transcript of a call Clara
        attended

        as a bot. The conversation is created post-call, so this block is always

        complete when present. Every turn of such a transcript is `role: user`
        with a

        `speaker` name and a `meeting_offset_ms`; attribute by speaker.
      properties:
        meeting_id:
          type: string
          format: uuid
        platform:
          type: string
          enum:
            - google_meet
            - zoom
            - microsoft_teams
        participants:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              is_host:
                type: boolean
        duration_ms:
          type: integer
          nullable: true
        started_at:
          type: string
          format: date-time
          nullable: true
        url:
          type: string
          nullable: true
          description: Relative in-app path of the meeting page (recording, insights).
    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>`. The token is either a user token /
        OAuth access

        token, or a service-account API key (`cfk_...`). A key is valid on every
        endpoint and

        acts as its service account, an organization member with per-store
        permissions.

        Refused keys answer 403 with `Invalid API key.`, `API key revoked.`,

        `API key expired.` or `API key disabled.`.
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use Authorization: Token <token>'

````

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