Retrieve interview content

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/ \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_email": "[email protected]",
  "type": "<string>",
  "type_additional_parameters": {},
  "chat_history": [
    {}
  ],
  "chat_memory": {},
  "local_documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assigned_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assigned_to_email": "[email protected]",
  "assigned_by_email": "[email protected]",
  "is_pending_invite": true,
  "invite_config": {
    "custom_message": "<string>",
    "scheduled_send_at": "2023-11-07T05:31:56Z",
    "invitation_email_sent_at": "2023-11-07T05:31:56Z",
    "reminders_enabled": true,
    "reminder_start_after_days": 123,
    "reminder_interval_days": 123,
    "reminder_max_count": 123,
    "reminders_sent": 123,
    "next_reminder_at": "2023-11-07T05:31:56Z",
    "reminders_stopped": true
  },
  "interview_focus": {
    "topic": "<string>",
    "questions": [
      "<string>"
    ]
  },
  "topics": [
    {
      "title": "<string>",
      "description": "<string>",
      "skill_id": "<string>"
    }
  ],
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "is_first_interview": true,
  "import_info": {
    "participants": [
      "<string>"
    ],
    "interview_date": "2023-12-25",
    "error": "<string>"
  },
  "conversation_summary": "<string>",
  "focused_mode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

GET

projects

{project_id}

interviews

{interview_id}

Retrieve interview content

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/{interview_id}/ \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_email": "[email protected]",
  "type": "<string>",
  "type_additional_parameters": {},
  "chat_history": [
    {}
  ],
  "chat_memory": {},
  "local_documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assigned_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assigned_to_email": "[email protected]",
  "assigned_by_email": "[email protected]",
  "is_pending_invite": true,
  "invite_config": {
    "custom_message": "<string>",
    "scheduled_send_at": "2023-11-07T05:31:56Z",
    "invitation_email_sent_at": "2023-11-07T05:31:56Z",
    "reminders_enabled": true,
    "reminder_start_after_days": 123,
    "reminder_interval_days": 123,
    "reminder_max_count": 123,
    "reminders_sent": 123,
    "next_reminder_at": "2023-11-07T05:31:56Z",
    "reminders_stopped": true
  },
  "interview_focus": {
    "topic": "<string>",
    "questions": [
      "<string>"
    ]
  },
  "topics": [
    {
      "title": "<string>",
      "description": "<string>",
      "skill_id": "<string>"
    }
  ],
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "is_first_interview": true,
  "import_info": {
    "participants": [
      "<string>"
    ],
    "interview_date": "2023-12-25",
    "error": "<string>"
  },
  "conversation_summary": "<string>",
  "focused_mode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer

Path Parameters

project_id

string<uuid>

required

UUID of the project

interview_id

string<uuid>

required

UUID of the interview

Response

Successful response

A structured interview conversation, including its full transcript.

string<uuid>

read-only

name

string | null

Interview title (auto-generated from the topic when not provided).

created_by

string<uuid>

read-only

UUID of the user who created the interview.

created_by_email

string<email> | null

read-only

Email of the user who created the interview (the importer, for imported interviews).

type

string

Conversation type: "interview" (standard mono-topic), "guided-interview" (a multi-topic deep-dive whose ordered topics come from the sent draft or assign payload; its focus text lives in type_additional_parameters.interview_focus), or "imported-interview" (a read-only transcript of an interview recorded outside the platform, created via the import-transcript endpoint).

type_additional_parameters

object

Free-form parameters associated with the conversation type.

chat_history

object[]

Ordered list of transcript entries (messages, tool calls, etc.).

chat_memory

object

Assistant memory state accumulated over the conversation.

local_documents

object[]

read-only

Files uploaded during this interview (ordered by upload time). Only the id and name are included; resolve a fresh signed download URL via the project-level local-documents detail endpoint.

Show child attributes

assigned_to

string<uuid> | null

read-only

UUID of the assigned user (null while a pending invite has not yet joined).

assigned_by

string<uuid> | null

read-only

UUID of the user who created the assignment.

assigned_to_email

string<email> | null

read-only

Assignee email, falling back to the invite email for not-yet-joined invitees.

assigned_by_email

string<email> | null

read-only

is_pending_invite

boolean

read-only

True when assigned to someone who has not yet joined the project.

invite_config

object | null

read-only

Invitation-email customization and reminder schedule for an assigned interview. Null for self-assigned interviews, non-interview conversations, and interviews created before this feature existed.

Show child attributes

interview_focus

object | null

read-only

The seeded interview topic and optional specific questions, for rendering the in-chat intro card. Null for non-interviews and interviews without a topic. For guided interviews this is read from type_additional_parameters.interview_focus (they have no focus issue).

Show child attributes

topics

object[]

read-only

Guided interviews only: the ordered topic agenda seeded at send time, with per-topic progress. Empty for every other interview type.

Show child attributes

campaign

object | null

Campaign this interview belongs to; null for ad hoc interviews.

Show child attributes

is_first_interview

boolean

read-only

True while the requesting user has never started an assigned interview in this project. Drives the intro card's expanded "how it works" explainer.

import_info

object | null

Parse-pipeline state of an imported external transcript (interviews of type "imported-interview"). Null on every other interview type. The raw pasted transcript is never returned — the parsed chat_history is the transcript.

Show child attributes

conversation_summary

string

read-only

Background-generated summary of the conversation ("" until generated).

status

enum<string> | null

read-only

Null for imported interviews until their transcript parse completes.

Available options:

pending,

in_progress,

completed

write_scope

enum<string>

Whether edits stay local to the conversation or write to the shared knowledge store.

Available options:

local,

global

focused_mode

boolean

read-only

Simplified interview: when true the invite opens the distraction-free full-page chat (/interview//) instead of the app. Set at assign time; never changed afterwards.

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

Send a scheduled invitation now Update an interview

Concepts

Endpoints

Retrieve interview content

Authorizations

Path Parameters

Response