{
"error": "Authentication credentials were not provided."
}
{
"error": "You do not have permission to perform this action."
}
{
"error": "Not found."
}
Authorizations
BearerAuthTokenAuth
Authorization
string
header
required
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..
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.
id
string<uuid>
read-only
can_edit
boolean
read-only
Whether an admin may still edit this sent interview (before its first answer).
not_editable_reason
string | null
read-only
Why the interview can no longer be edited (answered, completed, archived, test run, not guided); null while can_edit is true.
last_edited_at
string<date-time> | null
read-only
When an admin last edited this sent interview.
last_edited_by_email
string<email> | null
read-only
sent_from_draft_id
string<uuid> | null
read-only
The draft this interview was sent from, when it was sent from one.
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. Assigned interviews
carry planned_minutes (the planned length) among them.
chat_history
object[]
Ordered list of transcript entries (messages, tool calls, etc.).
chat_participants
object
read-only
Users who submitted at least one user turn, keyed by user id (each user entry
carries a user_id). Can differ from assigned_to when an admin finishes an
interview assigned to someone else.
Show child attributes
chat_memory
object
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
object[]
read-only
Files attached to this interview (ordered by upload time). Only the id, name and
source are included; resolve a fresh signed download URL via the project-level
local-documents detail endpoint. Both uploaded files and generated files
(produced by an agent in the conversation) can be imported into the Sources
library.
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
meeting_info
object | null
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.
Show child attributes
conversation_summary
string
read-only
Background-generated summary of the conversation ("" until generated).
feedback_state
enum<string>
read-only
Whether the interviewee has rated this interview. Drives whether the
post-interview feedback prompt is shown. The grade and comment
themselves are Clarifeye-internal and are never returned.
Available options:
none,
submitted
test_run
object | null
Set when this conversation is a test run of an unsent draft;
null for real interviews. Adds draft_id, draft_name, draft_edit_url.
Show child attributes
available_translations
string[]
read-only
ISO codes of the languages this transcript has a complete cached machine
translation in (see the translate / translations endpoints). The
translated text itself is never part of the interview payload.
language
string | null
read-only
ISO language code the assigner set for this interview (null = adapt to the
respondent). Fixed by the assign / test-run endpoints; the respondent's own
choice goes through respondent_language.
respondent_language
string | null
ISO language code the respondent picked for this interview — on the type-or-talk
card before Clara's first message, or later from the language selector.
Outranks every other language candidate for both the text prompt and
the voice agent; never written back to the user's preference. A change applies to
the next typed reply or the next call (a call in progress keeps its language).
PATCHable only by the person answering or a project admin (403 otherwise), and
only until the interview is completed (400 otherwise). Null clears it
(auto-detect); unsupported codes are rejected (400).
default_language
string | null
read-only
Detail payload only. The ISO code the interview would be conducted in for the
requesting user if respondent_language is left alone — respondent pick, else
the user's preferred language, else their org-membership language, else
language; null when nothing resolves (Clara mirrors the respondent).
live_voice_available
boolean | null
read-only
Detail payload only. Whether the organization owning THIS knowledge
store may take interviews as calls: the instance-wide LIVE_VOICE_ENABLED +
ElevenLabs key ANDed with the org's allow_live_voice. Store-scoped, unlike the
instance_flags.live_voice_enabled twin on the user payload, which answers for
the reader's active org — a respondent who also belongs to an org of their own
has a different one. Null outside detail payloads; treat null as "not asked",
never as "off". POST .../voice-call/ returns 503 when this is false.
status
enum<string> | null
read-only
Null for imported interviews until their transcript parse completes.
Available options:
pending,
in_progress,
completed
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Clarifeye","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/clarifeye/rS1qw7m9MGfBWCqd/logo/light.svg?fit=max\u0026auto=format\u0026n=rS1qw7m9MGfBWCqd\u0026q=85\u0026s=4d3effe58a3b57dfd7c35792fe374fbc","dark":"https://mintcdn.com/clarifeye/rS1qw7m9MGfBWCqd/logo/dark.svg?fit=max\u0026auto=format\u0026n=rS1qw7m9MGfBWCqd\u0026q=85\u0026s=3961c0193fc03b024980f639a3bf1dd3"},"favicon":"https://mintcdn.com/clarifeye/rS1qw7m9MGfBWCqd/favicon.svg?fit=max\u0026auto=format\u0026n=rS1qw7m9MGfBWCqd\u0026q=85\u0026s=0c8ea9410feaf5355fb91bdb814cb019","api":{"playground":{"display":"interactive"},"examples":{"languages":["python","javascript","bash"]}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/clarifeyeai"}},"search":{"prompt":"Search documentation..."},"seo":{},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"book-open-cover","href":"https://clarifeye.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clarifeye","hasAudioNarration":false,"actualSubdomain":"clarifeye","customDomains":["docs.clarifeye.ai"],"gitSource":{"type":"github","owner":"clarifeye","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af889f874b4f0f02ee0ef29","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Endpoints","count":336},{"language":"default","tag":"Back Office","count":273},{"language":"default","tag":"API","count":64},{"language":"default","tag":"Interviews","count":61},{"language":"default","tag":"Artifacts","count":36},{"language":"default","tag":"Documents","count":30},{"language":"default","tag":"Meetings","count":30},{"language":"default","tag":"Overview","count":29},{"language":"default","tag":"Organization items","count":19},{"language":"default","tag":"Conversations","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"backoffice/interviews/retrieve-interview-content","slug":"/backoffice/interviews/retrieve-interview-content","pageMetadata":{"title":"Retrieve interview content","description":"Retrieve a single interview with its full content, including the\ncomplete `chat_history` transcript and `chat_memory` (server-only keys omitted).\n\nNon-admins can only retrieve interviews assigned to them or that they\ncreated; admins can retrieve any interview in the project.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/{interview_id}/","href":"/backoffice/interviews/retrieve-interview-content","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Retrieve a single interview with its full content, including the\\ncomplete \", _jsx(_components.code, {\n children: \"chat_history\"\n }), \" transcript and \", _jsx(_components.code, {\n children: \"chat_memory\"\n }), \" (server-only keys omitted).\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Non-admins can only retrieve interviews assigned to them or that they\\ncreated; admins can retrieve any interview in the project.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve interview content","description":"Retrieve a single interview with its full content, including the\ncomplete `chat_history` transcript and `chat_memory` (server-only keys omitted).\n\nNon-admins can only retrieve interviews assigned to them or that they\ncreated; admins can retrieve any interview in the project.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/{interview_id}/","href":"/backoffice/interviews/retrieve-interview-content","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Interviews"],"summary":"Retrieve interview content","description":"Retrieve a single interview with its full content, including the\ncomplete `chat_history` transcript and `chat_memory` (server-only keys omitted).\n\nNon-admins can only retrieve interviews assigned to them or that they\ncreated; admins can retrieve any interview in the project.\n","operationId":"getInterview","parameters":["1310a329-9257-4f3c-92a2-63ebf60aead3","881cb28e-9a0b-4bec-800d-5a7ccce870a0"],"responses":{"200":"422d7f21-1aea-4dfd-b71f-597efaa3058e","401":"b8e99577-f3db-4519-8827-98aaebbc1793","403":"50c3640b-e46f-4ec5-a4f9-42649033f6dc","404":"99f7ae16-7401-4eb6-a19e-74494dc80609"},"method":"get","type":"path","servers":["e9f0702a-fc43-4d75-887f-57eae2520e1a","8d04323c-b364-425e-8c3a-179c8cd6a88e"],"security":["7e266cfe-bbb7-4615-b623-2db1547415c7","7e3e632c-bcdb-4b38-83a7-fda438e28eb3"],"path":"/projects/{project_id}/interviews/{interview_id}/","baseUrlOptions":["https://eu.app.clarifeye.ai/api/v1","https://us.app.clarifeye.ai/api/v1"],"title":"Retrieve interview content","codeSamples":[],"requestExampleLanguages":["python","javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1310a329-9257-4f3c-92a2-63ebf60aead3":{"name":"project_id","in":"path","required":true,"description":"UUID of the project","schema":{"type":"string","format":"uuid","isRequired":true,"description":"UUID of the project","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"881cb28e-9a0b-4bec-800d-5a7ccce870a0":{"name":"interview_id","in":"path","required":true,"description":"UUID of the interview","schema":{"type":"string","format":"uuid","isRequired":true,"description":"UUID of the interview","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"422d7f21-1aea-4dfd-b71f-597efaa3058e":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","description":"A structured interview conversation, including its full transcript.","properties":{"id":{"type":"string","format":"uuid","readOnly":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"can_edit":{"type":"boolean","readOnly":true,"description":"Whether an admin may still edit this sent interview (before its first answer).","uniqueKey":"can_edit","typeLabel":"boolean"},"not_editable_reason":{"oneOf":[{"type":"string","readOnly":true,"description":"Why the interview can no longer be edited (answered, completed, archived, test run, not guided); null while `can_edit` is true.","uniqueKey":"not_editable_reason.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Why the interview can no longer be edited (answered, completed, archived, test run, not guided); null while `can_edit` is true.","uniqueKey":"not_editable_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"not_editable_reason","typeLabel":"string | null"},"last_edited_at":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"description":"When an admin last edited this sent interview.","uniqueKey":"last_edited_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"description":"When an admin last edited this sent interview.","uniqueKey":"last_edited_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_edited_at","typeLabel":"string\u003cdate-time> | null"},"last_edited_by_email":{"oneOf":[{"type":"string","format":"email","readOnly":true,"uniqueKey":"last_edited_by_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","readOnly":true,"uniqueKey":"last_edited_by_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_edited_by_email","typeLabel":"string\u003cemail> | null"},"sent_from_draft_id":{"oneOf":[{"type":"string","format":"uuid","readOnly":true,"description":"The draft this interview was sent from, when it was sent from one.","uniqueKey":"sent_from_draft_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","readOnly":true,"description":"The draft this interview was sent from, when it was sent from one.","uniqueKey":"sent_from_draft_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"sent_from_draft_id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","description":"Interview title (auto-generated from the topic when not provided).","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Interview title (auto-generated from the topic when not provided).","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"created_by":{"type":"string","format":"uuid","readOnly":true,"description":"UUID of the user who created the interview.","uniqueKey":"created_by","typeLabel":"string\u003cuuid>"},"created_by_email":{"oneOf":[{"type":"string","format":"email","readOnly":true,"description":"Email of the user who created the interview (the importer, for imported interviews).","uniqueKey":"created_by_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","readOnly":true,"description":"Email of the user who created the interview (the importer, for imported interviews).","uniqueKey":"created_by_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by_email","typeLabel":"string\u003cemail> | null"},"type":{"type":"string","description":"Conversation type: \"interview\" (standard mono-topic), \"guided-interview\"\n(a multi-topic deep-dive whose ordered topics come from the sent draft or\nassign payload; its focus text lives in\n`type_additional_parameters.interview_focus`), or \"imported-interview\"\n(a read-only transcript of an interview recorded outside the platform,\ncreated via the import-transcript endpoint).\n","uniqueKey":"type","typeLabel":"string"},"type_additional_parameters":{"type":"object","description":"Free-form parameters associated with the conversation type. Assigned interviews\ncarry `planned_minutes` (the planned length) among them.\n","uniqueKey":"type_additional_parameters","typeLabel":"object"},"chat_history":{"type":"array","description":"Ordered list of transcript entries (messages, tool calls, etc.).","items":{"type":"object","uniqueKey":"chat_history.items.[INDEX]","typeLabel":"object"},"uniqueKey":"chat_history","typeLabel":"object[]"},"chat_participants":{"type":"object","readOnly":true,"description":"Users who submitted at least one user turn, keyed by user id (each user entry\ncarries a `user_id`). Can differ from `assigned_to` when an admin finishes an\ninterview assigned to someone else.\n","additionalProperties":{"type":"object","properties":{"email":{"type":"string","format":"email","uniqueKey":"chat_participants.additionalProperties.email","typeLabel":"string\u003cemail>"}},"uniqueKey":"chat_participants.additionalProperties","typeLabel":"object"},"uniqueKey":"chat_participants","typeLabel":"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.","uniqueKey":"chat_memory","typeLabel":"object"},"local_documents":{"type":"array","readOnly":true,"description":"Files attached to this interview (ordered by upload time). Only the id, name and\nsource are included; resolve a fresh signed download URL via the project-level\nlocal-documents detail endpoint. Both `uploaded` files and `generated` files\n(produced by an agent in the conversation) can be imported into the Sources\nlibrary.\n","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"local_documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"local_documents.items.[INDEX].name","typeLabel":"string"},"source":{"type":"string","enum":["uploaded","generated"],"uniqueKey":"local_documents.items.[INDEX].source","typeLabel":"enum\u003cstring>"}},"uniqueKey":"local_documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"local_documents","typeLabel":"object[]"},"assigned_to":{"oneOf":[{"type":"string","format":"uuid","readOnly":true,"description":"UUID of the assigned user (null while a pending invite has not yet joined).","uniqueKey":"assigned_to.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","readOnly":true,"description":"UUID of the assigned user (null while a pending invite has not yet joined).","uniqueKey":"assigned_to.oneOf.1","typeLabel":"null"}],"uniqueKey":"assigned_to","typeLabel":"string\u003cuuid> | null"},"assigned_by":{"oneOf":[{"type":"string","format":"uuid","readOnly":true,"description":"UUID of the user who created the assignment.","uniqueKey":"assigned_by.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","readOnly":true,"description":"UUID of the user who created the assignment.","uniqueKey":"assigned_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"assigned_by","typeLabel":"string\u003cuuid> | null"},"assigned_to_email":{"oneOf":[{"type":"string","format":"email","readOnly":true,"description":"Assignee email, falling back to the invite email for not-yet-joined invitees.","uniqueKey":"assigned_to_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","readOnly":true,"description":"Assignee email, falling back to the invite email for not-yet-joined invitees.","uniqueKey":"assigned_to_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"assigned_to_email","typeLabel":"string\u003cemail> | null"},"assigned_by_email":{"oneOf":[{"type":"string","format":"email","readOnly":true,"uniqueKey":"assigned_by_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","readOnly":true,"uniqueKey":"assigned_by_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"assigned_by_email","typeLabel":"string\u003cemail> | null"},"is_pending_invite":{"type":"boolean","readOnly":true,"description":"True when assigned to someone who has not yet joined the project.","uniqueKey":"is_pending_invite","typeLabel":"boolean"},"invite_config":{"oneOf":[{"type":"object","description":"Invitation-email customization and reminder schedule for an assigned interview.\nNull for self-assigned interviews, non-interview conversations, and interviews\ncreated before this feature existed.\n","readOnly":true,"properties":{"custom_message":{"type":"string","description":"The assigner's note; replaces the default invitation email copy when set.","uniqueKey":"invite_config.oneOf.0.custom_message","typeLabel":"string"},"custom_focus":{"oneOf":[{"type":"string","description":"The assigner's override of the email's \"what it's about\" focus block. Null\nmeans not customised (emails show the truncated topic); empty string means\nthe block was removed; text is shown verbatim.\n","uniqueKey":"invite_config.oneOf.0.custom_focus.oneOf.0","typeLabel":"string"},{"type":"null","description":"The assigner's override of the email's \"what it's about\" focus block. Null\nmeans not customised (emails show the truncated topic); empty string means\nthe block was removed; text is shown verbatim.\n","uniqueKey":"invite_config.oneOf.0.custom_focus.oneOf.1","typeLabel":"null"}],"uniqueKey":"invite_config.oneOf.0.custom_focus","typeLabel":"string | null"},"scheduled_send_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the invitation email is (or was) due to be sent. Null means it was sent immediately.","uniqueKey":"invite_config.oneOf.0.scheduled_send_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the invitation email is (or was) due to be sent. Null means it was sent immediately.","uniqueKey":"invite_config.oneOf.0.scheduled_send_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invite_config.oneOf.0.scheduled_send_at","typeLabel":"string\u003cdate-time> | null"},"invitation_email_sent_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the invitation email actually went out; null while a scheduled send is still pending.","uniqueKey":"invite_config.oneOf.0.invitation_email_sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the invitation email actually went out; null while a scheduled send is still pending.","uniqueKey":"invite_config.oneOf.0.invitation_email_sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invite_config.oneOf.0.invitation_email_sent_at","typeLabel":"string\u003cdate-time> | null"},"reminders_enabled":{"type":"boolean","uniqueKey":"invite_config.oneOf.0.reminders_enabled","typeLabel":"boolean"},"reminder_start_after_days":{"type":"integer","uniqueKey":"invite_config.oneOf.0.reminder_start_after_days","typeLabel":"integer"},"reminder_interval_days":{"type":"integer","uniqueKey":"invite_config.oneOf.0.reminder_interval_days","typeLabel":"integer"},"reminder_max_count":{"type":"integer","uniqueKey":"invite_config.oneOf.0.reminder_max_count","typeLabel":"integer"},"reminders_sent":{"type":"integer","description":"Automatic reminders sent so far (manual reminders are not counted).","uniqueKey":"invite_config.oneOf.0.reminders_sent","typeLabel":"integer"},"next_reminder_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the next automatic reminder is due; null when none is scheduled.","uniqueKey":"invite_config.oneOf.0.next_reminder_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the next automatic reminder is due; null when none is scheduled.","uniqueKey":"invite_config.oneOf.0.next_reminder_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"invite_config.oneOf.0.next_reminder_at","typeLabel":"string\u003cdate-time> | null"},"reminders_stopped":{"type":"boolean","description":"True once an admin/assigner stopped the schedule via stop-reminders.","uniqueKey":"invite_config.oneOf.0.reminders_stopped","typeLabel":"boolean"}},"uniqueKey":"invite_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"invite_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"invite_config","typeLabel":"object | null"},"interview_focus":{"oneOf":[{"type":"object","readOnly":true,"description":"The seeded interview topic and optional specific questions, for rendering the\nin-chat intro card. Null for non-interviews and interviews without a topic.\nFor guided interviews this is read from\n`type_additional_parameters.interview_focus` (they have no focus issue).\n","properties":{"topic":{"type":"string","uniqueKey":"interview_focus.oneOf.0.topic","typeLabel":"string"},"instructions":{"type":"string","description":"Guided interviews only: the organiser's rules for how Clara runs the\nsession (read from `type_additional_parameters.interview_instructions`).\nInterviewer-only — never included in invitation emails or shown on the\nrespondent's screen. Empty when none were set.\n","uniqueKey":"interview_focus.oneOf.0.instructions","typeLabel":"string"},"questions":{"type":"array","items":{"type":"string","uniqueKey":"interview_focus.oneOf.0.questions.items.[INDEX]","typeLabel":"string"},"uniqueKey":"interview_focus.oneOf.0.questions","typeLabel":"string[]"}},"uniqueKey":"interview_focus.oneOf.0","typeLabel":"object"},{"type":"null","readOnly":true,"description":"The seeded interview topic and optional specific questions, for rendering the\nin-chat intro card. Null for non-interviews and interviews without a topic.\nFor guided interviews this is read from\n`type_additional_parameters.interview_focus` (they have no focus issue).\n","properties":{"topic":{"type":"string"},"instructions":{"type":"string","description":"Guided interviews only: the organiser's rules for how Clara runs the\nsession (read from `type_additional_parameters.interview_instructions`).\nInterviewer-only — never included in invitation emails or shown on the\nrespondent's screen. Empty when none were set.\n"},"questions":{"type":"array","items":{"type":"string"}}},"uniqueKey":"interview_focus.oneOf.1","typeLabel":"null"}],"uniqueKey":"interview_focus","typeLabel":"object | null"},"topics":{"type":"array","readOnly":true,"description":"Guided interviews only: the ordered topic agenda seeded at send time,\nwith per-topic progress. Empty for every other interview type.\n","items":{"type":"object","properties":{"topic_id":{"type":"string","format":"uuid","description":"The topic row's id (the value `jump_to_topic_id` takes on a test run).","uniqueKey":"topics.items.[INDEX].topic_id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","uniqueKey":"topics.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"topics.items.[INDEX].description","typeLabel":"string"},"status":{"type":"string","enum":["open","resolved","dismissed","skipped"],"description":"\"open\" while the topic still has to be covered; \"resolved\" or\n\"dismissed\" once it no longer is. The interview auto-completes\nwhen no topic is left open. \"skipped\" (test runs only): the tester\ndeliberately left the topic out — a choice, not a gap.\n","uniqueKey":"topics.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"skill_id":{"oneOf":[{"type":"string","description":"Standard-guide skill backing the topic; null for custom topics.","uniqueKey":"topics.items.[INDEX].skill_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Standard-guide skill backing the topic; null for custom topics.","uniqueKey":"topics.items.[INDEX].skill_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"topics.items.[INDEX].skill_id","typeLabel":"string | null"}},"uniqueKey":"topics.items.[INDEX]","typeLabel":"object"},"uniqueKey":"topics","typeLabel":"object[]"},"campaign":{"oneOf":[{"type":"object","description":"Campaign this interview belongs to; null for ad hoc interviews.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"campaign.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"campaign.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"campaign.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"campaign.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign","typeLabel":"object | null"},"is_first_interview":{"type":"boolean","readOnly":true,"description":"True while the requesting user has never started an assigned interview in this\nproject. Drives the intro card's expanded \"how it works\" explainer.\n","uniqueKey":"is_first_interview","typeLabel":"boolean"},"import_info":{"oneOf":[{"type":"object","description":"Parse-pipeline state of an imported external transcript (interviews of type\n\"imported-interview\"). Null on every other interview type. The raw pasted\ntranscript is never returned — the parsed `chat_history` is the transcript.\n","properties":{"import_status":{"type":"string","enum":["parsing","ready","failed"],"description":"\"parsing\" while the async parse runs (transcript not yet readable),\n\"ready\" once chat_history holds the speaker-labeled turns (status becomes\n\"completed\"), \"failed\" when parsing errored (use retry-import).\n","uniqueKey":"import_info.oneOf.0.import_status","typeLabel":"enum\u003cstring>"},"participants":{"type":"array","description":"Participant names (importer-supplied or inferred from the transcript).","items":{"type":"string","uniqueKey":"import_info.oneOf.0.participants.items.[INDEX]","typeLabel":"string"},"uniqueKey":"import_info.oneOf.0.participants","typeLabel":"string[]"},"interview_date":{"oneOf":[{"type":"string","format":"date","description":"Date the conversation happened (importer-supplied or inferred).","uniqueKey":"import_info.oneOf.0.interview_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Date the conversation happened (importer-supplied or inferred).","uniqueKey":"import_info.oneOf.0.interview_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"import_info.oneOf.0.interview_date","typeLabel":"string\u003cdate> | null"},"error":{"oneOf":[{"type":"string","description":"Failure detail when import_status is \"failed\".","uniqueKey":"import_info.oneOf.0.error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Failure detail when import_status is \"failed\".","uniqueKey":"import_info.oneOf.0.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"import_info.oneOf.0.error","typeLabel":"string | null"}},"uniqueKey":"import_info.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"import_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"import_info","typeLabel":"object | null"},"meeting_info":{"oneOf":[{"type":"object","description":"Set on conversations of type `meeting` — the transcript of a call Clara attended\nas a bot. The conversation is created post-call, so this block is always\ncomplete when present. Every turn of such a transcript is `role: user` with a\n`speaker` name and a `meeting_offset_ms`; attribute by speaker.\n","properties":{"meeting_id":{"type":"string","format":"uuid","uniqueKey":"meeting_info.oneOf.0.meeting_id","typeLabel":"string\u003cuuid>"},"platform":{"type":"string","enum":["google_meet","zoom","microsoft_teams"],"uniqueKey":"meeting_info.oneOf.0.platform","typeLabel":"enum\u003cstring>"},"participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"meeting_info.oneOf.0.participants.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"meeting_info.oneOf.0.participants.items.[INDEX].name","typeLabel":"string"},"is_host":{"type":"boolean","uniqueKey":"meeting_info.oneOf.0.participants.items.[INDEX].is_host","typeLabel":"boolean"}},"uniqueKey":"meeting_info.oneOf.0.participants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"meeting_info.oneOf.0.participants","typeLabel":"object[]"},"duration_ms":{"oneOf":[{"type":"integer","uniqueKey":"meeting_info.oneOf.0.duration_ms.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"meeting_info.oneOf.0.duration_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"meeting_info.oneOf.0.duration_ms","typeLabel":"integer | null"},"started_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"meeting_info.oneOf.0.started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"meeting_info.oneOf.0.started_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"meeting_info.oneOf.0.started_at","typeLabel":"string\u003cdate-time> | null"},"url":{"oneOf":[{"type":"string","description":"Relative in-app path of the meeting page (recording, insights).","uniqueKey":"meeting_info.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Relative in-app path of the meeting page (recording, insights).","uniqueKey":"meeting_info.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"meeting_info.oneOf.0.url","typeLabel":"string | null"}},"uniqueKey":"meeting_info.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"meeting_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"meeting_info","typeLabel":"object | null"},"conversation_summary":{"type":"string","readOnly":true,"description":"Background-generated summary of the conversation (\"\" until generated).","uniqueKey":"conversation_summary","typeLabel":"string"},"feedback_state":{"type":"string","readOnly":true,"enum":["none","submitted"],"description":"Whether the interviewee has rated this interview. Drives whether the\npost-interview feedback prompt is shown. The grade and comment\nthemselves are Clarifeye-internal and are never returned.\n","uniqueKey":"feedback_state","typeLabel":"enum\u003cstring>"},"test_run":{"oneOf":[{"type":"object","description":"Set when this conversation is a test run of an unsent draft;\nnull for real interviews. Adds `draft_id`, `draft_name`, `draft_edit_url`.\n","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"test_run.oneOf.0.id","typeLabel":"string\u003cuuid>"},"status":{"oneOf":[{"type":"string","enum":["pending","in_progress","completed"],"uniqueKey":"test_run.oneOf.0.status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pending","in_progress","completed"],"uniqueKey":"test_run.oneOf.0.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_run.oneOf.0.status","typeLabel":"enum\u003cstring> | null"},"language":{"oneOf":[{"type":"string","description":"ISO code the run is conducted in (outranks the tester's preference); null = auto-detect.","uniqueKey":"test_run.oneOf.0.language.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO code the run is conducted in (outranks the tester's preference); null = auto-detect.","uniqueKey":"test_run.oneOf.0.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_run.oneOf.0.language","typeLabel":"string | null"},"started_from_topic_index":{"type":"integer","uniqueKey":"test_run.oneOf.0.started_from_topic_index","typeLabel":"integer"},"started_from_topic_title":{"oneOf":[{"type":"string","uniqueKey":"test_run.oneOf.0.started_from_topic_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"test_run.oneOf.0.started_from_topic_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_run.oneOf.0.started_from_topic_title","typeLabel":"string | null"},"skipped_topic_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"test_run.oneOf.0.skipped_topic_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"test_run.oneOf.0.skipped_topic_ids","typeLabel":"string\u003cuuid>[]"},"jumps":{"type":"array","items":{"type":"object","properties":{"from_topic_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"test_run.oneOf.0.jumps.items.[INDEX].from_topic_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"test_run.oneOf.0.jumps.items.[INDEX].from_topic_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_run.oneOf.0.jumps.items.[INDEX].from_topic_id","typeLabel":"string\u003cuuid> | null"},"to_topic_id":{"type":"string","format":"uuid","uniqueKey":"test_run.oneOf.0.jumps.items.[INDEX].to_topic_id","typeLabel":"string\u003cuuid>"},"at_message_count":{"type":"integer","uniqueKey":"test_run.oneOf.0.jumps.items.[INDEX].at_message_count","typeLabel":"integer"}},"uniqueKey":"test_run.oneOf.0.jumps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"test_run.oneOf.0.jumps","typeLabel":"object[]"},"message_count":{"type":"integer","description":"Conversation-detail flavour only (drafts list runs without their transcripts).","uniqueKey":"test_run.oneOf.0.message_count","typeLabel":"integer"},"draft_changed_since_start":{"type":"boolean","description":"The draft's interview-shaping fields (focus, topics, questions, language)\nchanged after this run began — it rehearsed a previous version. Re-saving the\ndraft unchanged, or starting another run, does not set it.\n","uniqueKey":"test_run.oneOf.0.draft_changed_since_start","typeLabel":"boolean"},"interview_url":{"type":"string","description":"Absolute URL of the run's focused interview page.","uniqueKey":"test_run.oneOf.0.interview_url","typeLabel":"string"},"draft_source_session":{"oneOf":[{"type":"object","description":"Conversation-detail flavour only. The session that drafted the interview, so the test page can resume it for feedback.","properties":{"kind":{"type":"string","enum":["clara_fast","cma","coach"],"uniqueKey":"test_run.oneOf.0.draft_source_session.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","uniqueKey":"test_run.oneOf.0.draft_source_session.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","uniqueKey":"test_run.oneOf.0.draft_source_session.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"test_run.oneOf.0.draft_source_session.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_run.oneOf.0.draft_source_session.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"test_run.oneOf.0.draft_source_session.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"test_run.oneOf.0.draft_source_session.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_run.oneOf.0.draft_source_session","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"test_run.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"test_run.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"test_run.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"test_run.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_run","typeLabel":"object | null"},"available_translations":{"type":"array","readOnly":true,"description":"ISO codes of the languages this transcript has a complete cached machine\ntranslation in (see the `translate` / `translations` endpoints). The\ntranslated text itself is never part of the interview payload.\n","items":{"type":"string","uniqueKey":"available_translations.items.[INDEX]","typeLabel":"string"},"uniqueKey":"available_translations","typeLabel":"string[]"},"language":{"oneOf":[{"type":"string","readOnly":true,"description":"ISO language code the assigner set for this interview (null = adapt to the\nrespondent). Fixed by the assign / test-run endpoints; the respondent's own\nchoice goes through `respondent_language`.\n","uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"ISO language code the assigner set for this interview (null = adapt to the\nrespondent). Fixed by the assign / test-run endpoints; the respondent's own\nchoice goes through `respondent_language`.\n","uniqueKey":"language.oneOf.1","typeLabel":"null"}],"uniqueKey":"language","typeLabel":"string | null"},"respondent_language":{"oneOf":[{"type":"string","description":"ISO language code the respondent picked for this interview — on the type-or-talk\ncard before Clara's first message, or later from the language selector.\nOutranks every other language candidate for both the text prompt and\nthe voice agent; never written back to the user's preference. A change applies to\nthe next typed reply or the next call (a call in progress keeps its language).\nPATCHable only by the person answering or a project admin (403 otherwise), and\nonly until the interview is completed (400 otherwise). Null clears it\n(auto-detect); unsupported codes are rejected (400).\n","uniqueKey":"respondent_language.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO language code the respondent picked for this interview — on the type-or-talk\ncard before Clara's first message, or later from the language selector.\nOutranks every other language candidate for both the text prompt and\nthe voice agent; never written back to the user's preference. A change applies to\nthe next typed reply or the next call (a call in progress keeps its language).\nPATCHable only by the person answering or a project admin (403 otherwise), and\nonly until the interview is completed (400 otherwise). Null clears it\n(auto-detect); unsupported codes are rejected (400).\n","uniqueKey":"respondent_language.oneOf.1","typeLabel":"null"}],"uniqueKey":"respondent_language","typeLabel":"string | null"},"default_language":{"oneOf":[{"type":"string","readOnly":true,"description":"Detail payload only. The ISO code the interview would be conducted in for the\nrequesting user if `respondent_language` is left alone — respondent pick, else\nthe user's preferred language, else their org-membership language, else\n`language`; null when nothing resolves (Clara mirrors the respondent).\n","uniqueKey":"default_language.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Detail payload only. The ISO code the interview would be conducted in for the\nrequesting user if `respondent_language` is left alone — respondent pick, else\nthe user's preferred language, else their org-membership language, else\n`language`; null when nothing resolves (Clara mirrors the respondent).\n","uniqueKey":"default_language.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_language","typeLabel":"string | null"},"live_voice_available":{"oneOf":[{"type":"boolean","readOnly":true,"description":"Detail payload only. Whether the organization owning THIS knowledge\nstore may take interviews as calls: the instance-wide `LIVE_VOICE_ENABLED` +\nElevenLabs key ANDed with the org's `allow_live_voice`. Store-scoped, unlike the\n`instance_flags.live_voice_enabled` twin on the user payload, which answers for\nthe reader's *active* org — a respondent who also belongs to an org of their own\nhas a different one. Null outside detail payloads; treat null as \"not asked\",\nnever as \"off\". `POST .../voice-call/` returns 503 when this is false.\n","uniqueKey":"live_voice_available.oneOf.0","typeLabel":"boolean"},{"type":"null","readOnly":true,"description":"Detail payload only. Whether the organization owning THIS knowledge\nstore may take interviews as calls: the instance-wide `LIVE_VOICE_ENABLED` +\nElevenLabs key ANDed with the org's `allow_live_voice`. Store-scoped, unlike the\n`instance_flags.live_voice_enabled` twin on the user payload, which answers for\nthe reader's *active* org — a respondent who also belongs to an org of their own\nhas a different one. Null outside detail payloads; treat null as \"not asked\",\nnever as \"off\". `POST .../voice-call/` returns 503 when this is false.\n","uniqueKey":"live_voice_available.oneOf.1","typeLabel":"null"}],"uniqueKey":"live_voice_available","typeLabel":"boolean | null"},"status":{"oneOf":[{"type":"string","readOnly":true,"enum":["pending","in_progress","completed"],"description":"Null for imported interviews until their transcript parse completes.","uniqueKey":"status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","readOnly":true,"enum":["pending","in_progress","completed"],"description":"Null for imported interviews until their transcript parse completes.","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"enum\u003cstring> | null"},"created_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","can_edit":true,"not_editable_reason":"\u003cstring>","last_edited_at":"2023-11-07T05:31:56Z","last_edited_by_email":"[email protected]","sent_from_draft_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","created_by":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_by_email":"[email protected]","type":"\u003cstring>","type_additional_parameters":{},"chat_history":[{}],"chat_participants":{},"chat_memory":{},"local_documents":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","source":"uploaded"}],"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":"\u003cstring>","custom_focus":"\u003cstring>","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":"\u003cstring>","instructions":"\u003cstring>","questions":["\u003cstring>"]},"topics":[{"topic_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","description":"\u003cstring>","status":"open","skill_id":"\u003cstring>"}],"campaign":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"is_first_interview":true,"import_info":{"import_status":"parsing","participants":["\u003cstring>"],"interview_date":"2023-12-25","error":"\u003cstring>"},"meeting_info":{"meeting_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","platform":"google_meet","participants":[{"id":"\u003cstring>","name":"\u003cstring>","is_host":true}],"duration_ms":123,"started_at":"2023-11-07T05:31:56Z","url":"\u003cstring>"},"conversation_summary":"\u003cstring>","feedback_state":"none","test_run":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"pending","language":"\u003cstring>","started_from_topic_index":123,"started_from_topic_title":"\u003cstring>","skipped_topic_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"jumps":[{"from_topic_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","to_topic_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","at_message_count":123}],"message_count":123,"draft_changed_since_start":true,"interview_url":"\u003cstring>","draft_source_session":{"kind":"clara_fast","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"available_translations":["\u003cstring>"],"language":"\u003cstring>","respondent_language":"\u003cstring>","default_language":"\u003cstring>","live_voice_available":true,"status":"pending","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"b8e99577-f3db-4519-8827-98aaebbc1793":{"description":"Unauthorized - missing or invalid authentication","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"}},"example":{"error":"User not found"},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Authentication credentials were not provided."},"examples":{"Example":{"title":"Example","value":{"error":"Authentication credentials were not provided."}}},"exampleType":"examples"}},"exampleType":"examples"},"50c3640b-e46f-4ec5-a4f9-42649033f6dc":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"}},"example":{"error":"User not found"},"uniqueKey":"","typeLabel":"object"},"example":{"error":"You do not have permission to perform this action."},"examples":{"Example":{"title":"Example","value":{"error":"You do not have permission to perform this action."}}},"exampleType":"examples"}},"exampleType":"examples"},"99f7ae16-7401-4eb6-a19e-74494dc80609":{"description":"Not found - resource does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"}},"example":{"error":"User not found"},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Not found."},"examples":{"Example":{"title":"Example","value":{"error":"Not found."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7e266cfe-bbb7-4615-b623-2db1547415c7":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Use `Authorization: Bearer \u003ctoken>`. The token is either a user token / OAuth access\ntoken, or a service-account API key (`cfk_...`). A key is valid on every endpoint and\nacts as its service account, an organization member with per-store permissions.\nRefused keys answer 403 with `Invalid API key.`, `API key revoked.`,\n`API key expired.` or `API key disabled.`.\n","scopes":[],"schemeName":"BearerAuth"}},"7e3e632c-bcdb-4b38-83a7-fda438e28eb3":{"TokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Use Authorization: Token \u003ctoken>","scopes":[],"schemeName":"TokenAuth"}}},"servers":{"e9f0702a-fc43-4d75-887f-57eae2520e1a":{"url":"https://eu.app.clarifeye.ai/api/v1","description":"EU"},"8d04323c-b364-425e-8c3a-179c8cd6a88e":{"url":"https://us.app.clarifeye.ai/api/v1","description":"US"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Use `Authorization: Bearer \u003ctoken>`. The token is either a user token / OAuth access\ntoken, or a service-account API key (`cfk_...`). A key is valid on every endpoint and\nacts as its service account, an organization member with per-store permissions.\nRefused keys answer 403 with `Invalid API key.`, `API key revoked.`,\n`API key expired.` or `API key disabled.`.\n","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use `Authorization: Bearer \u003ctoken>`. The token is either a user token / OAuth access\ntoken, or a service-account API key (`cfk_...`). A key is valid on every endpoint and\nacts as its service account, an organization member with per-store permissions.\nRefused keys answer 403 with `Invalid API key.`, `API key revoked.`,\n`API key expired.` or `API key disabled.`.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Use Authorization: Token \u003ctoken>","scopes":[],"schemeName":"TokenAuth"},"schema":{"title":"Authorization","type":"string","description":"Use Authorization: Token \u003ctoken>","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"TokenAuth","name":"Authorization"}],"title":"TokenAuth"}]},"originalFileLocation":"api-reference/openapi-full.yaml"},"subdomain":"clarifeye","siteName":"Clarifeye","title":"Retrieve interview content - Clarifeye","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T17:11:01.845Z","originalFileLocation":"backoffice/interviews/retrieve-interview-content.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a single interview with its full content, including the complete chat_history transcript and chat_memory (server-only keys omitted). Non-admins can only retrieve interviews assigned to them or that they created; admins can retrieve any interview in the project.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Clarifeye\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve interview content - Clarifeye\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single interview with its full content, including the complete chat_history transcript and chat_memory (server-only keys omitted). Non-admins can only retrieve interviews assigned to them or that they created; admins can retrieve any interview in the project.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Clarifeye\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clarifeye.mintlify.site/_mintlify/api/og/v2?division=Interviews\u0026amp;title=Retrieve+interview+content\u0026amp;description=Retrieve+a+single+interview+with+its+full+content%2C+including+the%0Acomplete+%60chat_history%60+transcript+and+%60chat_memory%60+%28server-only+keys+omitted%29.%0A%0ANon-admins+ca\u0026amp;theme=a85dbd7e60f2999baa747b03\u0026amp;signature=c099261e624ee0092b9e00a575c09f05fd70c11bf532f846b7f011b3164ef3db\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve interview content - Clarifeye\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single interview with its full content, including the complete chat_history transcript and chat_memory (server-only keys omitted). Non-admins can only retrieve interviews assigned to them or that they created; admins can retrieve any interview in the project.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clarifeye.mintlify.site/_mintlify/api/og/v2?division=Interviews\u0026amp;title=Retrieve+interview+content\u0026amp;description=Retrieve+a+single+interview+with+its+full+content%2C+including+the%0Acomplete+%60chat_history%60+transcript+and+%60chat_memory%60+%28server-only+keys+omitted%29.%0A%0ANon-admins+ca\u0026amp;theme=a85dbd7e60f2999baa747b03\u0026amp;signature=c099261e624ee0092b9e00a575c09f05fd70c11bf532f846b7f011b3164ef3db\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/clarifeye/82rYKFZ_GE9XhWgh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Clarifeye\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/backoffice/interviews/retrieve-interview-content.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clarifeye.ai/#organization\",\"name\":\"Clarifeye\",\"url\":\"https://docs.clarifeye.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clarifeye/rS1qw7m9MGfBWCqd/logo/light.svg?fit=max\u0026auto=format\u0026n=rS1qw7m9MGfBWCqd\u0026q=85\u0026s=4d3effe58a3b57dfd7c35792fe374fbc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clarifeye.ai#website\",\"name\":\"Clarifeye\",\"url\":\"https://docs.clarifeye.ai\",\"publisher\":{\"@id\":\"https://docs.clarifeye.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content#webpage\",\"url\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content\",\"name\":\"Retrieve interview content\",\"description\":\"Retrieve a single interview with its full content, including the complete chat_history transcript and chat_memory (server-only keys omitted). Non-admins can only retrieve interviews assigned to them or that they created; admins can retrieve any interview in the project.\",\"dateModified\":\"2026-11-07T17:11:01.845Z\",\"isPartOf\":{\"@id\":\"https://docs.clarifeye.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.clarifeye.ai/backoffice/user-provisioning/pre-create-or-re-activate-an-org-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Interviews\",\"item\":\"https://docs.clarifeye.ai/backoffice/interviews/list-interviews\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve interview content\",\"item\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content#apireference\",\"headline\":\"Retrieve interview content\",\"name\":\"Retrieve interview content\",\"description\":\"Retrieve a single interview with its full content, including the complete chat_history transcript and chat_memory (server-only keys omitted). Non-admins can only retrieve interviews assigned to them or that they created; admins can retrieve any interview in the project.\",\"url\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clarifeye.ai/backoffice/interviews/retrieve-interview-content#webpage\"},\"dateModified\":\"2026-11-07T17:11:01.845Z\",\"publisher\":{\"@id\":\"https://docs.clarifeye.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clarifeye.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Clarifeye\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Clarifeye\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/backoffice/interviews/retrieve-interview-content.md","siteName":"Clarifeye","nav":{"global":{"anchors":[{"anchor":"Website","icon":"book-open-cover","href":"https://clarifeye.ai"}]},"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/guides/what-is-clarifeye"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"API","pages":[{"title":"API","href":"/api-reference/users/list-project-users"}]},{"tab":"Back Office","groups":[{"group":"Concepts","pages":[{"title":"Back office concepts","href":"/backoffice/concepts"}]},{"group":"Endpoints","pages":[{"group":"User Provisioning","pages":[{"title":"Pre-create (or re-activate) an org user","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{id}/provision-user/","href":"/backoffice/user-provisioning/pre-create-or-re-activate-an-org-user"},{"title":"Remove an org user's membership","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{id}/deprovision-user/","href":"/backoffice/user-provisioning/remove-an-org-users-membership"}]},{"group":"Service Accounts","pages":[{"title":"List the organization's service accounts (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organizations/{id}/service-accounts/","href":"/backoffice/service-accounts/list-the-organizations-service-accounts-org-admin"},{"title":"Create a service account (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{id}/service-accounts/","href":"/backoffice/service-accounts/create-a-service-account-org-admin"},{"title":"Service account detail, with its stores and keys (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organizations/{id}/service-accounts/{user_id}/","href":"/backoffice/service-accounts/service-account-detail-with-its-stores-and-keys-org-admin"},{"title":"Rename, disable / re-enable, or set the usage limit (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /organizations/{id}/service-accounts/{user_id}/","href":"/backoffice/service-accounts/rename-disable-re-enable-or-set-the-usage-limit-org-admin"},{"title":"The knowledge stores of the organization the account can access (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organizations/{id}/service-accounts/{user_id}/stores/","href":"/backoffice/service-accounts/the-knowledge-stores-of-the-organization-the-account-can-access-org-admin"},{"title":"Give the account access to a store of the organization (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{id}/service-accounts/{user_id}/stores/","href":"/backoffice/service-accounts/give-the-account-access-to-a-store-of-the-organization-org-admin"},{"title":"Remove the account's access to a store (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /organizations/{id}/service-accounts/{user_id}/stores/{project_id}/","href":"/backoffice/service-accounts/remove-the-accounts-access-to-a-store-org-admin"},{"title":"Change the account's permissions on a store (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /organizations/{id}/service-accounts/{user_id}/stores/{project_id}/","href":"/backoffice/service-accounts/change-the-accounts-permissions-on-a-store-org-admin"},{"title":"Service accounts with access to this store (read-only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/service-accounts/","href":"/backoffice/service-accounts/service-accounts-with-access-to-this-store-read-only"}]},{"group":"Organization API Keys","pages":[{"title":"List API keys (org admin → own org's keys)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organization-api-keys/","href":"/backoffice/organization-api-keys/list-api-keys-org-admin-→-own-orgs-keys"},{"title":"Mint an API key for a service account (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organization-api-keys/","href":"/backoffice/organization-api-keys/mint-an-api-key-for-a-service-account-org-admin"},{"title":"Retrieve API key metadata (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organization-api-keys/{id}/","href":"/backoffice/organization-api-keys/retrieve-api-key-metadata-org-admin"},{"title":"Revoke an API key (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /organization-api-keys/{id}/","href":"/backoffice/organization-api-keys/revoke-an-api-key-org-admin"},{"title":"Rename or re-date an API key (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /organization-api-keys/{id}/","href":"/backoffice/organization-api-keys/rename-or-re-date-an-api-key-org-admin"},{"title":"Download the full secret (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organization-api-keys/{id}/reveal/","href":"/backoffice/organization-api-keys/download-the-full-secret-org-admin"}]},{"group":"External MCP","pages":[{"title":"List a knowledge store's external MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/mcp-servers/","href":"/backoffice/external-mcp/list-a-knowledge-stores-external-mcp-servers"},{"title":"Register an external MCP server (admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/mcp-servers/","href":"/backoffice/external-mcp/register-an-external-mcp-server-admin"},{"title":"Remove an external MCP server (admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/mcp-servers/{id}/","href":"/backoffice/external-mcp/remove-an-external-mcp-server-admin"},{"title":"Update an external MCP server (admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/mcp-servers/{id}/","href":"/backoffice/external-mcp/update-an-external-mcp-server-admin"},{"title":"Re-sync an MCP server's tool catalog (admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/mcp-servers/{id}/sync_tools/","href":"/backoffice/external-mcp/re-sync-an-mcp-servers-tool-catalog-admin"},{"title":"Current user's connection status per enabled server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/mcp-servers/connection-status/","href":"/backoffice/external-mcp/current-users-connection-status-per-enabled-server"},{"title":"List my external MCP connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /users/me/mcp-connections/","href":"/backoffice/external-mcp/list-my-external-mcp-connections"},{"title":"Begin an external MCP OAuth connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /users/me/mcp-connections/initiate/","href":"/backoffice/external-mcp/begin-an-external-mcp-oauth-connection"},{"title":"Re-authorize an existing MCP connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /users/me/mcp-connections/{id}/reconnect/","href":"/backoffice/external-mcp/re-authorize-an-existing-mcp-connection"},{"title":"Set the current user's API key for an api_key MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /users/me/mcp-connections/set-api-key/","href":"/backoffice/external-mcp/set-the-current-users-api-key-for-an-api_key-mcp-server"},{"title":"Revoke an external MCP connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /users/me/mcp-connections/{id}/revoke/","href":"/backoffice/external-mcp/revoke-an-external-mcp-connection"}]},{"group":"Organization items","pages":[{"title":"List the organization's MCP servers (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organizations/{organization_id}/mcp-servers/","href":"/backoffice/organization-items/list-the-organizations-mcp-servers-org-admin"},{"title":"Define an organization MCP server (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{organization_id}/mcp-servers/","href":"/backoffice/organization-items/define-an-organization-mcp-server-org-admin"},{"title":"Delete an organization MCP server (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /organizations/{organization_id}/mcp-servers/{id}/","href":"/backoffice/organization-items/delete-an-organization-mcp-server-org-admin"},{"title":"Update an organization MCP server (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /organizations/{organization_id}/mcp-servers/{id}/","href":"/backoffice/organization-items/update-an-organization-mcp-server-org-admin"},{"title":"Re-sync an organization MCP server's tool catalog (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{organization_id}/mcp-servers/{id}/sync_tools/","href":"/backoffice/organization-items/re-sync-an-organization-mcp-servers-tool-catalog-org-admin"},{"title":"List the organization's design templates (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organizations/{organization_id}/design-templates/","href":"/backoffice/organization-items/list-the-organizations-design-templates-org-admin"},{"title":"Create an organization design template (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{organization_id}/design-templates/","href":"/backoffice/organization-items/create-an-organization-design-template-org-admin"},{"title":"Get an organization design template (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /organizations/{organization_id}/design-templates/{id}/","href":"/backoffice/organization-items/get-an-organization-design-template-org-admin"},{"title":"Delete an organization design template and its files (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /organizations/{organization_id}/design-templates/{id}/","href":"/backoffice/organization-items/delete-an-organization-design-template-and-its-files-org-admin"},{"title":"Update an organization design template (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /organizations/{organization_id}/design-templates/{id}/","href":"/backoffice/organization-items/update-an-organization-design-template-org-admin"},{"title":"Add a file to an organization design template (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /organizations/{organization_id}/design-templates/{id}/files/","href":"/backoffice/organization-items/add-a-file-to-an-organization-design-template-org-admin"},{"title":"Remove a file from an organization design template (org admin)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /organizations/{organization_id}/design-templates/{id}/files/{file_id}/","href":"/backoffice/organization-items/remove-a-file-from-an-organization-design-template-org-admin"},{"title":"Organization MCP servers this store may add","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/organization-mcp-servers/","href":"/backoffice/organization-items/organization-mcp-servers-this-store-may-add"},{"title":"Add an organization MCP server to this store as a linked copy (technical_setup write)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/organization-mcp-servers/{id}/pull/","href":"/backoffice/organization-items/add-an-organization-mcp-server-to-this-store-as-a-linked-copy-technical_setup-write"},{"title":"Take, or dismiss, a newer organization version of a linked copy (technical_setup write)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/organization-mcp-servers/{id}/update/","href":"/backoffice/organization-items/take-or-dismiss-a-newer-organization-version-of-a-linked-copy-technical_setup-write"},{"title":"Organization design templates this store may add, and where its linked copies stand","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/organization-design-templates/","href":"/backoffice/organization-items/organization-design-templates-this-store-may-add-and-where-its-linked-copies-stand"},{"title":"Add an organization design template to this store as a linked copy (artifacts write)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/organization-design-templates/{id}/pull/","href":"/backoffice/organization-items/add-an-organization-design-template-to-this-store-as-a-linked-copy-artifacts-write"},{"title":"Take, or dismiss, a newer organization version of a linked copy (artifacts write)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/organization-design-templates/{id}/update/","href":"/backoffice/organization-items/take-or-dismiss-a-newer-organization-version-of-a-linked-copy-artifacts-write"},{"title":"Share a store design template with the organization (org admin and artifacts write)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/organization-design-templates/promote/","href":"/backoffice/organization-items/share-a-store-design-template-with-the-organization-org-admin-and-artifacts-write"}]},{"group":"Users","pages":[{"title":"List project users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/users/","href":"/backoffice/users/list-project-users"},{"title":"Remove user by email","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/users/remove-by-email/","href":"/backoffice/users/remove-user-by-email"},{"title":"Update user permissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/users/{permission_id}/","href":"/backoffice/users/update-user-permissions"}]},{"group":"Invitations","pages":[{"title":"List invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/invites/","href":"/backoffice/invitations/list-invitations"},{"title":"Invite user to project","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/invites/invite/","href":"/backoffice/invitations/invite-user-to-project"},{"title":"Bulk invite users to project","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/invites/bulk-invite/","href":"/backoffice/invitations/bulk-invite-users-to-project"},{"title":"Cancel invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/invites/{invite_id}/","href":"/backoffice/invitations/cancel-invitation"},{"title":"Edit a pending invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/invites/{invite_id}/","href":"/backoffice/invitations/edit-a-pending-invitation"}]},{"group":"Documents","pages":[{"title":"Bulk upload documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/bulk-upload/","href":"/backoffice/documents/bulk-upload-documents"},{"title":"Move a document to a collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/{document_id}/set-collection/","href":"/backoffice/documents/move-a-document-to-a-collection"},{"title":"Move multiple documents to a collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/bulk-set-collection/","href":"/backoffice/documents/move-multiple-documents-to-a-collection"},{"title":"Archive multiple documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/bulk-archive/","href":"/backoffice/documents/archive-multiple-documents"},{"title":"Re-process multiple failed documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/bulk-force-reparse/","href":"/backoffice/documents/re-process-multiple-failed-documents"},{"title":"Re-process a failed document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/{document_id}/force-reparse/","href":"/backoffice/documents/re-process-a-failed-document"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/documents/{document_id}/","href":"/backoffice/documents/delete-document"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/documents/","href":"/backoffice/documents/list-documents"},{"title":"List document collections","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/document-collections/","href":"/backoffice/documents/list-document-collections"},{"title":"Create a document collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/document-collections/","href":"/backoffice/documents/create-a-document-collection"},{"title":"Retrieve a document collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/document-collections/{collection_id}/","href":"/backoffice/documents/retrieve-a-document-collection"},{"title":"Delete a document collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/document-collections/{collection_id}/","href":"/backoffice/documents/delete-a-document-collection"},{"title":"Rename a document collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/document-collections/{collection_id}/","href":"/backoffice/documents/rename-a-document-collection"},{"title":"List documents without file data","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/documents/get-without-file/","href":"/backoffice/documents/list-documents-without-file-data"},{"title":"Count documents per folder, type, collection, or duplicate set","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/documents/groups/","href":"/backoffice/documents/count-documents-per-folder-type-collection-or-duplicate-set"},{"title":"Filter documents by tag values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/filter-by-tag/","href":"/backoffice/documents/filter-documents-by-tag-values"},{"title":"Filter documents by metadata values","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/filter-by-metadata/","href":"/backoffice/documents/filter-documents-by-metadata-values"},{"title":"List available document tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/available-document-tags/","href":"/backoffice/documents/list-available-document-tags"},{"title":"List available document metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/available-document-metadata/","href":"/backoffice/documents/list-available-document-metadata"},{"title":"Get document tags grouped by document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/document-tags-by-document/","href":"/backoffice/documents/get-document-tags-grouped-by-document"},{"title":"Add metadata to a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/{document_id}/metadata-add/","href":"/backoffice/documents/add-metadata-to-a-document"},{"title":"Remove a specific metadata pair","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/{document_id}/metadata-remove-pair/","href":"/backoffice/documents/remove-a-specific-metadata-pair"},{"title":"Remove all metadata pairs for a key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/documents/{document_id}/metadata-remove-key/","href":"/backoffice/documents/remove-all-metadata-pairs-for-a-key"},{"title":"Get metadata values for a key","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/documents/{document_id}/metadata-values/","href":"/backoffice/documents/get-metadata-values-for-a-key"},{"title":"Import conversation files into the document library","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/local-documents/import-to-documents/","href":"/backoffice/documents/import-conversation-files-into-the-document-library"}]},{"group":"Projects","pages":[{"title":"Home dashboard summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/home-summary/","href":"/backoffice/projects/home-dashboard-summary"},{"title":"Favourite a knowledge store","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/favourite/","href":"/backoffice/projects/favourite-a-knowledge-store"},{"title":"Unfavourite a knowledge store","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/unfavourite/","href":"/backoffice/projects/unfavourite-a-knowledge-store"},{"title":"List knowledge changelog entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/knowledge-changelog/","href":"/backoffice/projects/list-knowledge-changelog-entries"},{"title":"List knowledge artifact catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/list-knowledge/","href":"/backoffice/projects/list-knowledge-artifact-catalog"},{"title":"Get warehouse tags and object schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/library-tags-objects/","href":"/backoffice/projects/get-warehouse-tags-and-object-schema"},{"title":"Read or edit a markdown catalog artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/read-write-markdown-artifact/","href":"/backoffice/projects/read-or-edit-a-markdown-catalog-artifact"},{"title":"Read or edit a playbook_list catalog artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/read-write-playbook-list-artifact/","href":"/backoffice/projects/read-or-edit-a-playbook_list-catalog-artifact"},{"title":"Read or edit a mental_map catalog artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/read-write-mental-map-artifact/","href":"/backoffice/projects/read-or-edit-a-mental_map-catalog-artifact"},{"title":"Read or edit a design_template_list catalog artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/read-write-design-template-list-artifact/","href":"/backoffice/projects/read-or-edit-a-design_template_list-catalog-artifact"}]},{"group":"Agent Settings","pages":[{"title":"List agent settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/agent-settings/","href":"/backoffice/agent-settings/list-agent-settings"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/playground-conversations/","href":"/backoffice/conversations/list-conversations"},{"title":"Create conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/playground-conversations/","href":"/backoffice/conversations/create-conversation"},{"title":"Get conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/playground-conversations/{conversation_id}/","href":"/backoffice/conversations/get-conversation"},{"title":"Archive conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/playground-conversations/{conversation_id}/","href":"/backoffice/conversations/archive-conversation"},{"title":"Unarchive conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/playground-conversations/{conversation_id}/unarchive/","href":"/backoffice/conversations/unarchive-conversation"},{"title":"Permanently delete conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/playground-conversations/{conversation_id}/permanent_delete/","href":"/backoffice/conversations/permanently-delete-conversation"},{"title":"Send message (async)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/playground-conversations/{conversation_id}/send_message/","href":"/backoffice/conversations/send-message-async"},{"title":"Retry a failed turn (async)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/playground-conversations/{conversation_id}/retry-turn/","href":"/backoffice/conversations/retry-a-failed-turn-async"},{"title":"Poll turn status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/playground-conversations/{conversation_id}/poll/","href":"/backoffice/conversations/poll-turn-status"},{"title":"Get all conversation tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/playground-conversations/all-tags/","href":"/backoffice/conversations/get-all-conversation-tags"},{"title":"Share conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/playground-conversations/{conversation_id}/share/","href":"/backoffice/conversations/share-conversation"},{"title":"Unshare conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/playground-conversations/{conversation_id}/unshare/","href":"/backoffice/conversations/unshare-conversation"},{"title":"Retrieve conversation feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/playground-conversations/{conversation_id}/retrieve-feedback/","href":"/backoffice/conversations/retrieve-conversation-feedback"},{"title":"List Work with Clara skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/clara-skills/","href":"/backoffice/conversations/list-work-with-clara-skills"}]},{"group":"Interviews","pages":[{"title":"List interviews","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/","href":"/backoffice/interviews/list-interviews"},{"title":"Search interview transcripts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/search-transcripts/","href":"/backoffice/interviews/search-interview-transcripts"},{"title":"Create and assign interviews","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/assign/","href":"/backoffice/interviews/create-and-assign-interviews"},{"title":"List assignable users","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/assignable-users/","href":"/backoffice/interviews/list-assignable-users"},{"title":"Stop automatic reminders","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/{interview_id}/stop-reminders/","href":"/backoffice/interviews/stop-automatic-reminders"},{"title":"Send a scheduled invitation now","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/{interview_id}/send-now/","href":"/backoffice/interviews/send-a-scheduled-invitation-now"},{"title":"List the interviews feed","description":"The admin interviews page as one pageable list: each campaign is a single\nrow carrying its progress aggregates, and campaign-less interviews are\nplain rows. Rows interleave newest first, a campaign sorting at its own\ncreation date and a standalone interview at its own — the same order the\ninterviews list uses. Campaigns without interviews are not listed.\n\n**Admin only.** Filters are not supported here: a filtered or searched\nview is served by the interviews list.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/feed/","href":"/backoffice/interviews/list-the-interviews-feed"},{"title":"Retrieve interview content","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/{interview_id}/","href":"/backoffice/interviews/retrieve-interview-content"},{"title":"Update an interview","description":"Partially update an interview's writable fields — most usefully `name`\n(rename) and `campaign_id` (move the interview to another campaign of the\nproject, or null to remove it from its campaign, so past interviews can be\nre-bucketed retroactively). Lifecycle and transcript fields are read-only.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/interviews/{interview_id}/","href":"/backoffice/interviews/update-an-interview"},{"title":"Artifacts shown beside an interview","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/{interview_id}/artifacts/","href":"/backoffice/interviews/artifacts-shown-beside-an-interview"},{"title":"Duplicate an interview as a draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/{interview_id}/duplicate-as-draft/","href":"/backoffice/interviews/duplicate-an-interview-as-a-draft"},{"title":"Sheets of a spreadsheet attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/coach-conversations/{coach_conversation_id}/local-documents/{id}/spreadsheet-blocks/","href":"/backoffice/interviews/sheets-of-a-spreadsheet-attachment"},{"title":"Download all interview files as a zip","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/coach-conversations/{coach_conversation_id}/local-documents/download-all/","href":"/backoffice/interviews/download-all-interview-files-as-a-zip"},{"title":"Submit post-interview feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/coach-conversations/{coach_conversation_id}/feedback/","href":"/backoffice/interviews/submit-post-interview-feedback"},{"title":"Import an external interview transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/import-transcript/","href":"/backoffice/interviews/import-an-external-interview-transcript"},{"title":"Edit a sent interview before its first answer","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/{interview_id}/edit/","href":"/backoffice/interviews/edit-a-sent-interview-before-its-first-answer"},{"title":"Retry a failed transcript import","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/{interview_id}/retry-import/","href":"/backoffice/interviews/retry-a-failed-transcript-import"},{"title":"Translate an interview transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interviews/{interview_id}/translate/","href":"/backoffice/interviews/translate-an-interview-transcript"},{"title":"Get a cached transcript translation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interviews/{interview_id}/translations/","href":"/backoffice/interviews/get-a-cached-transcript-translation"},{"title":"List interview drafts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interview-drafts/","href":"/backoffice/interviews/list-interview-drafts"},{"title":"Create an interview draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interview-drafts/","href":"/backoffice/interviews/create-an-interview-draft"},{"title":"Retrieve an interview draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interview-drafts/{draft_id}/","href":"/backoffice/interviews/retrieve-an-interview-draft"},{"title":"Delete an interview draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/interview-drafts/{draft_id}/","href":"/backoffice/interviews/delete-an-interview-draft"},{"title":"Update an interview draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/interview-drafts/{draft_id}/","href":"/backoffice/interviews/update-an-interview-draft"},{"title":"List guided-interview topic types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interview-drafts/topic-skills/","href":"/backoffice/interviews/list-guided-interview-topic-types"},{"title":"Start a test run of an interview draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interview-drafts/{draft_id}/test-runs/","href":"/backoffice/interviews/start-a-test-run-of-an-interview-draft"},{"title":"List a draft's reference documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interview-drafts/{draft_id}/local-documents/","href":"/backoffice/interviews/list-a-drafts-reference-documents"},{"title":"Attach Sources documents to a draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interview-drafts/{draft_id}/local-documents/attach-from-sources/","href":"/backoffice/interviews/attach-sources-documents-to-a-draft"},{"title":"Attach the caller's session files to a draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interview-drafts/{draft_id}/local-documents/attach-session-files/","href":"/backoffice/interviews/attach-the-callers-session-files-to-a-draft"},{"title":"Sheets of a draft's spreadsheet reference document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interview-drafts/{draft_id}/local-documents/{id}/spreadsheet-blocks/","href":"/backoffice/interviews/sheets-of-a-drafts-spreadsheet-reference-document"},{"title":"Duplicate an interview draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interview-drafts/{draft_id}/clone/","href":"/backoffice/interviews/duplicate-an-interview-draft"},{"title":"List interview campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interview-campaigns/","href":"/backoffice/interviews/list-interview-campaigns"},{"title":"Retrieve an interview campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/interview-campaigns/{campaign_id}/","href":"/backoffice/interviews/retrieve-an-interview-campaign"},{"title":"Rename an interview campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/interview-campaigns/{campaign_id}/","href":"/backoffice/interviews/rename-an-interview-campaign"},{"title":"Remind every unfinished interview in a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/interview-campaigns/{campaign_id}/remind-all/","href":"/backoffice/interviews/remind-every-unfinished-interview-in-a-campaign"}]},{"group":"Design System Templates","pages":[{"title":"Attach conversation files to a design template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/local-documents/import-to-design-template/","href":"/backoffice/design-system-templates/attach-conversation-files-to-a-design-template"},{"title":"List design template files","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/design-template-files/","href":"/backoffice/design-system-templates/list-design-template-files"},{"title":"Upload a design template file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/design-template-files/","href":"/backoffice/design-system-templates/upload-a-design-template-file"},{"title":"Delete a design template file","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/design-template-files/{file_id}/","href":"/backoffice/design-system-templates/delete-a-design-template-file"}]},{"group":"Meetings","pages":[{"title":"List meetings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/","href":"/backoffice/meetings/list-meetings"},{"title":"Send Clara to a meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/","href":"/backoffice/meetings/send-clara-to-a-meeting"},{"title":"Meetings feature summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/summary/","href":"/backoffice/meetings/meetings-feature-summary"},{"title":"Get a meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/{meeting_id}/","href":"/backoffice/meetings/get-a-meeting"},{"title":"Delete a meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/meetings/{meeting_id}/","href":"/backoffice/meetings/delete-a-meeting"},{"title":"Update a meeting's title, brief or language","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/meetings/{meeting_id}/","href":"/backoffice/meetings/update-a-meetings-title-brief-or-language"},{"title":"Meeting transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/{meeting_id}/transcript/","href":"/backoffice/meetings/meeting-transcript"},{"title":"Ask Clara to leave the call","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/leave/","href":"/backoffice/meetings/ask-clara-to-leave-the-call"},{"title":"Add Clara back to the call","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/rejoin/","href":"/backoffice/meetings/add-clara-back-to-the-call"},{"title":"Clara joins every occurrence of this meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/series/","href":"/backoffice/meetings/clara-joins-every-occurrence-of-this-meeting"},{"title":"Edit the recurring meeting's standing brief or languages","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/meetings/{meeting_id}/series/","href":"/backoffice/meetings/edit-the-recurring-meetings-standing-brief-or-languages"},{"title":"Stop joining this recurring meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/series/stop/","href":"/backoffice/meetings/stop-joining-this-recurring-meeting"},{"title":"Read an attached document's text","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/{meeting_id}/documents/{document_id}/text/","href":"/backoffice/meetings/read-an-attached-documents-text"},{"title":"Clara's live insights","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/{meeting_id}/insights/","href":"/backoffice/meetings/claras-live-insights"},{"title":"Run an insights pass now","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/insights/refresh/","href":"/backoffice/meetings/run-an-insights-pass-now"},{"title":"Dismiss an insight","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/insights/{insight_id}/dismiss/","href":"/backoffice/meetings/dismiss-an-insight"},{"title":"Undo dismissing an insight","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/insights/{insight_id}/restore/","href":"/backoffice/meetings/undo-dismissing-an-insight"},{"title":"Mark a question as asked","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/insights/{insight_id}/asked/","href":"/backoffice/meetings/mark-a-question-as-asked"},{"title":"Your Ask Clara thread on this meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/{meeting_id}/ask/","href":"/backoffice/meetings/your-ask-clara-thread-on-this-meeting"},{"title":"Ask Clara a question during the meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/ask/","href":"/backoffice/meetings/ask-clara-a-question-during-the-meeting"},{"title":"Answer again a question Clara failed to answer","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/{meeting_id}/ask/retry/","href":"/backoffice/meetings/answer-again-a-question-clara-failed-to-answer"},{"title":"List a meeting's context documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/{meeting_id}/local-documents/","href":"/backoffice/meetings/list-a-meetings-context-documents"},{"title":"Calendar status for this store","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/calendar/status/","href":"/backoffice/meetings/calendar-status-for-this-store"},{"title":"The requesting user's upcoming events","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/meetings/calendar/events/","href":"/backoffice/meetings/the-requesting-users-upcoming-events"},{"title":"Clara joins this event for this store","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/calendar/events/{event_id}/schedule/","href":"/backoffice/meetings/clara-joins-this-event-for-this-store"},{"title":"Clara no longer joins this event for this store","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/meetings/calendar/events/{event_id}/schedule/","href":"/backoffice/meetings/clara-no-longer-joins-this-event-for-this-store"},{"title":"Refresh the requesting user's calendars now","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/meetings/calendar/sync/","href":"/backoffice/meetings/refresh-the-requesting-users-calendars-now"},{"title":"My calendar connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /users/me/meeting-calendars/","href":"/backoffice/meetings/my-calendar-connections"},{"title":"Start connecting a calendar","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /users/me/meeting-calendars/connect/","href":"/backoffice/meetings/start-connecting-a-calendar"},{"title":"Disconnect a calendar","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /users/me/meeting-calendars/{id}/","href":"/backoffice/meetings/disconnect-a-calendar"}]},{"group":"Feedback","pages":[{"title":"List feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/feedbacks/","href":"/backoffice/feedback/list-feedback"},{"title":"Submit feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/feedbacks/","href":"/backoffice/feedback/submit-feedback"},{"title":"Delete feedback","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/feedbacks/{feedback_id}/","href":"/backoffice/feedback/delete-feedback"},{"title":"Update feedback status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/feedbacks/{feedback_id}/","href":"/backoffice/feedback/update-feedback-status"},{"title":"Get feedbacks grouped by conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/feedbacks/grouped_by_conversation/","href":"/backoffice/feedback/get-feedbacks-grouped-by-conversation"},{"title":"Mark all feedbacks in a conversation as reviewed","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/feedbacks/mark_conversation_reviewed/","href":"/backoffice/feedback/mark-all-feedbacks-in-a-conversation-as-reviewed"},{"title":"Get feedback counts by status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/feedbacks/counts/","href":"/backoffice/feedback/get-feedback-counts-by-status"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/tools/","href":"/backoffice/tools/list-tools"},{"title":"Get tool parameters schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/tools/{tool_id}/parameters/","href":"/backoffice/tools/get-tool-parameters-schema"},{"title":"Run a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/tools/{tool_id}/run/","href":"/backoffice/tools/run-a-tool"}]},{"group":"Tables","pages":[{"title":"Read extractor output rows","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/tables/{table_id}/extractor-table-retrieval/","href":"/backoffice/tables/read-extractor-output-rows"}]},{"group":"Notifications","pages":[{"title":"List project notifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/notifications/","href":"/backoffice/notifications/list-project-notifications"},{"title":"Retrieve a notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/notifications/{notification_id}/","href":"/backoffice/notifications/retrieve-a-notification"},{"title":"Delete a notification","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/notifications/{notification_id}/","href":"/backoffice/notifications/delete-a-notification"},{"title":"Mark notification as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/notifications/{notification_id}/mark-as-read/","href":"/backoffice/notifications/mark-notification-as-read"},{"title":"Mark notification as unread","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/notifications/{notification_id}/mark-as-unread/","href":"/backoffice/notifications/mark-notification-as-unread"},{"title":"Mark all notifications as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/notifications/mark-all-as-read/","href":"/backoffice/notifications/mark-all-notifications-as-read"},{"title":"Delete all read notifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/notifications/delete-read/","href":"/backoffice/notifications/delete-all-read-notifications"}]},{"group":"Extraction Flows","pages":[{"title":"List extraction flows","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/extraction-flows/","href":"/backoffice/extraction-flows/list-extraction-flows"},{"title":"Update an extraction flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/extraction-flows/{flow_id}/","href":"/backoffice/extraction-flows/update-an-extraction-flow"},{"title":"Run an extraction flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/extraction-flows/{flow_id}/run-sync/","href":"/backoffice/extraction-flows/run-an-extraction-flow"},{"title":"Get extraction flow statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/extraction-flows/{flow_id}/node-stats/","href":"/backoffice/extraction-flows/get-extraction-flow-statistics"},{"title":"Publish an extraction flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/extraction-flows/{flow_id}/publish/","href":"/backoffice/extraction-flows/publish-an-extraction-flow"}]},{"group":"Pipeline Runs","pages":[{"title":"List pipeline runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/pipeline-runs/","href":"/backoffice/pipeline-runs/list-pipeline-runs"},{"title":"Get pipeline run details and status","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/pipeline-runs/{pipeline_run_id}/","href":"/backoffice/pipeline-runs/get-pipeline-run-details-and-status"},{"title":"Abort a pipeline run","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/pipeline-runs/{pipeline_run_id}/abort/","href":"/backoffice/pipeline-runs/abort-a-pipeline-run"}]},{"group":"Object Extractors","pages":[{"title":"List object extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/object-extractors/","href":"/backoffice/object-extractors/list-object-extractors"},{"title":"Create object extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/object-extractors/","href":"/backoffice/object-extractors/create-object-extractor"},{"title":"Retrieve object extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/object-extractors/{extractor_id}/","href":"/backoffice/object-extractors/retrieve-object-extractor"},{"title":"Delete object extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/object-extractors/{extractor_id}/","href":"/backoffice/object-extractors/delete-object-extractor"},{"title":"Update object extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/object-extractors/{extractor_id}/","href":"/backoffice/object-extractors/update-object-extractor-auto-creates-new-version"}]},{"group":"Tag Extractors","pages":[{"title":"List tag extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/tag-extractors/","href":"/backoffice/tag-extractors/list-tag-extractors"},{"title":"Create tag extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/tag-extractors/","href":"/backoffice/tag-extractors/create-tag-extractor"},{"title":"Retrieve tag extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/tag-extractors/{extractor_id}/","href":"/backoffice/tag-extractors/retrieve-tag-extractor"},{"title":"Delete tag extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/tag-extractors/{extractor_id}/","href":"/backoffice/tag-extractors/delete-tag-extractor"},{"title":"Update tag extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/tag-extractors/{extractor_id}/","href":"/backoffice/tag-extractors/update-tag-extractor-auto-creates-new-version"}]},{"group":"Chunks","pages":[{"title":"Get a single chunk by id (version-agnostic)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/chunks/{chunk_id}/","href":"/backoffice/chunks/get-a-single-chunk-by-id-version-agnostic"}]},{"group":"Chunks Extractors","pages":[{"title":"List chunks extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/chunks-extractors/","href":"/backoffice/chunks-extractors/list-chunks-extractors"},{"title":"Create chunks extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/chunks-extractors/","href":"/backoffice/chunks-extractors/create-chunks-extractor"},{"title":"Retrieve chunks extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/chunks-extractors/{extractor_id}/","href":"/backoffice/chunks-extractors/retrieve-chunks-extractor"},{"title":"Delete chunks extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/chunks-extractors/{extractor_id}/","href":"/backoffice/chunks-extractors/delete-chunks-extractor"},{"title":"Update chunks extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/chunks-extractors/{extractor_id}/","href":"/backoffice/chunks-extractors/update-chunks-extractor-auto-creates-new-version"}]},{"group":"Parsing Extractors","pages":[{"title":"List parsing extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/parsing-extractors/","href":"/backoffice/parsing-extractors/list-parsing-extractors"},{"title":"Create parsing extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/parsing-extractors/","href":"/backoffice/parsing-extractors/create-parsing-extractor"},{"title":"Retrieve parsing extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/parsing-extractors/{extractor_id}/","href":"/backoffice/parsing-extractors/retrieve-parsing-extractor"},{"title":"Delete parsing extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/parsing-extractors/{extractor_id}/","href":"/backoffice/parsing-extractors/delete-parsing-extractor"},{"title":"Update parsing extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/parsing-extractors/{extractor_id}/","href":"/backoffice/parsing-extractors/update-parsing-extractor-auto-creates-new-version"}]},{"group":"Document Filter Extractors","pages":[{"title":"List document filter extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/document-filter-extractors/","href":"/backoffice/document-filter-extractors/list-document-filter-extractors"},{"title":"Create document filter extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/document-filter-extractors/","href":"/backoffice/document-filter-extractors/create-document-filter-extractor"},{"title":"Retrieve document filter extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/document-filter-extractors/{extractor_id}/","href":"/backoffice/document-filter-extractors/retrieve-document-filter-extractor"},{"title":"Delete document filter extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/document-filter-extractors/{extractor_id}/","href":"/backoffice/document-filter-extractors/delete-document-filter-extractor"},{"title":"Update document filter extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/document-filter-extractors/{extractor_id}/","href":"/backoffice/document-filter-extractors/update-document-filter-extractor-auto-creates-new-version"}]},{"group":"Chunk Tag Filter Extractors","pages":[{"title":"List chunk tag filter extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/chunk-tag-filter-extractors/","href":"/backoffice/chunk-tag-filter-extractors/list-chunk-tag-filter-extractors"},{"title":"Create chunk tag filter extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/chunk-tag-filter-extractors/","href":"/backoffice/chunk-tag-filter-extractors/create-chunk-tag-filter-extractor"},{"title":"Retrieve chunk tag filter extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/chunk-tag-filter-extractors/{extractor_id}/","href":"/backoffice/chunk-tag-filter-extractors/retrieve-chunk-tag-filter-extractor"},{"title":"Delete chunk tag filter extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/chunk-tag-filter-extractors/{extractor_id}/","href":"/backoffice/chunk-tag-filter-extractors/delete-chunk-tag-filter-extractor"},{"title":"Update chunk tag filter extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/chunk-tag-filter-extractors/{extractor_id}/","href":"/backoffice/chunk-tag-filter-extractors/update-chunk-tag-filter-extractor-auto-creates-new-version"}]},{"group":"Document Tag Extractors","pages":[{"title":"List document tag extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/document-tag-extractors/","href":"/backoffice/document-tag-extractors/list-document-tag-extractors"},{"title":"Create document tag extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/document-tag-extractors/","href":"/backoffice/document-tag-extractors/create-document-tag-extractor"},{"title":"Retrieve document tag extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/document-tag-extractors/{extractor_id}/","href":"/backoffice/document-tag-extractors/retrieve-document-tag-extractor"},{"title":"Delete document tag extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/document-tag-extractors/{extractor_id}/","href":"/backoffice/document-tag-extractors/delete-document-tag-extractor"},{"title":"Update document tag extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/document-tag-extractors/{extractor_id}/","href":"/backoffice/document-tag-extractors/update-document-tag-extractor-auto-creates-new-version"}]},{"group":"Tag Alerts Extractors","pages":[{"title":"List tag alerts extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/tag-alerts-extractors/","href":"/backoffice/tag-alerts-extractors/list-tag-alerts-extractors"},{"title":"Create tag alerts extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/tag-alerts-extractors/","href":"/backoffice/tag-alerts-extractors/create-tag-alerts-extractor"},{"title":"Retrieve tag alerts extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/tag-alerts-extractors/{extractor_id}/","href":"/backoffice/tag-alerts-extractors/retrieve-tag-alerts-extractor"},{"title":"Delete tag alerts extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/tag-alerts-extractors/{extractor_id}/","href":"/backoffice/tag-alerts-extractors/delete-tag-alerts-extractor"},{"title":"Update tag alerts extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/tag-alerts-extractors/{extractor_id}/","href":"/backoffice/tag-alerts-extractors/update-tag-alerts-extractor-auto-creates-new-version"}]},{"group":"Object Alerts Extractors","pages":[{"title":"List object alerts extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/object-alerts-extractors/","href":"/backoffice/object-alerts-extractors/list-object-alerts-extractors"},{"title":"Create object alerts extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/object-alerts-extractors/","href":"/backoffice/object-alerts-extractors/create-object-alerts-extractor"},{"title":"Retrieve object alerts extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/object-alerts-extractors/{extractor_id}/","href":"/backoffice/object-alerts-extractors/retrieve-object-alerts-extractor"},{"title":"Delete object alerts extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/object-alerts-extractors/{extractor_id}/","href":"/backoffice/object-alerts-extractors/delete-object-alerts-extractor"},{"title":"Update object alerts extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/object-alerts-extractors/{extractor_id}/","href":"/backoffice/object-alerts-extractors/update-object-alerts-extractor-auto-creates-new-version"}]},{"group":"Imported Object Extractors","pages":[{"title":"List imported object extractors","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/imported-object-extractors/","href":"/backoffice/imported-object-extractors/list-imported-object-extractors"},{"title":"Create imported object extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/imported-object-extractors/","href":"/backoffice/imported-object-extractors/create-imported-object-extractor"},{"title":"Retrieve imported object extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/imported-object-extractors/{extractor_id}/","href":"/backoffice/imported-object-extractors/retrieve-imported-object-extractor"},{"title":"Delete imported object extractor","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/imported-object-extractors/{extractor_id}/","href":"/backoffice/imported-object-extractors/delete-imported-object-extractor"},{"title":"Update imported object extractor (auto-creates new version)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/imported-object-extractors/{extractor_id}/","href":"/backoffice/imported-object-extractors/update-imported-object-extractor-auto-creates-new-version"}]},{"group":"Artifacts","pages":[{"title":"List artifacts in the catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/artifacts/","href":"/backoffice/artifacts/list-artifacts-in-the-catalog"},{"title":"Create a custom artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/artifacts/","href":"/backoffice/artifacts/create-a-custom-artifact"},{"title":"Read the store map","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/artifacts/store-map/","href":"/backoffice/artifacts/read-the-store-map"},{"title":"Update the store map axes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/artifacts/store-map/","href":"/backoffice/artifacts/update-the-store-map-axes"},{"title":"Regenerate the store map","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/artifacts/store-map/regenerate/","href":"/backoffice/artifacts/regenerate-the-store-map"},{"title":"Export the artifact catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/artifacts/export-catalog/","href":"/backoffice/artifacts/export-the-artifact-catalog"},{"title":"Import an artifact catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/artifacts/import-catalog/","href":"/backoffice/artifacts/import-an-artifact-catalog"},{"title":"Retrieve an artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/artifacts/{slug}/","href":"/backoffice/artifacts/retrieve-an-artifact"},{"title":"Delete an artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml delete /projects/{project_id}/artifacts/{slug}/","href":"/backoffice/artifacts/delete-an-artifact"},{"title":"Update a custom artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml patch /projects/{project_id}/artifacts/{slug}/","href":"/backoffice/artifacts/update-a-custom-artifact"},{"title":"Remove an artifact from scope","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/artifacts/{slug}/remove-from-scope/","href":"/backoffice/artifacts/remove-an-artifact-from-scope"},{"title":"Restore an artifact to scope","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/artifacts/{slug}/restore-to-scope/","href":"/backoffice/artifacts/restore-an-artifact-to-scope"},{"title":"List artifact versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/artifacts/{slug}/versions/","href":"/backoffice/artifacts/list-artifact-versions"},{"title":"Publish a new artifact version","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/artifacts/{slug}/versions/","href":"/backoffice/artifacts/publish-a-new-artifact-version"},{"title":"Artifact version history","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/artifacts/{slug}/versions/history/","href":"/backoffice/artifacts/artifact-version-history"},{"title":"Retrieve an artifact version","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/artifacts/{slug}/versions/{version_number}/","href":"/backoffice/artifacts/retrieve-an-artifact-version"},{"title":"Restore an artifact version","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/artifacts/{slug}/versions/{version_number}/restore/","href":"/backoffice/artifacts/restore-an-artifact-version"}]},{"group":"Connectors","pages":[{"title":"Start importing the connection's saved selection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/connections/{connection_id}/start-import/","href":"/backoffice/connectors/start-importing-the-connections-saved-selection"},{"title":"Start a dry-run count of what an import would do","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/connections/{connection_id}/import-preview/","href":"/backoffice/connectors/start-a-dry-run-count-of-what-an-import-would-do"},{"title":"Poll a dry-run import count","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml get /projects/{project_id}/connections/{connection_id}/import-preview-status/","href":"/backoffice/connectors/poll-a-dry-run-import-count"},{"title":"Set the file-type allow/deny rules for a connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi-full.yaml post /projects/{project_id}/connections/{connection_id}/set-file-type-rules/","href":"/backoffice/connectors/set-the-file-type-allowdeny-rules-for-a-connection"}]}]}]}]},"basePath":"","title":"Retrieve interview content - Clarifeye","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}