Skip to main content
GET
Get interview flow

Authorizations

Authorization
string
header
required

Provide your API key UUID in the 'Authorization' header prefixed with 'Bearer '. Example: 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000'

Path Parameters

interview_flow_id
string
required
Minimum string length: 1

Response

OK

interview_flow_id
string
required

The ID of the interview flow.

team_id
string
required

The ID of the team this interview flow belongs to.

org_name
string
required

The name of the organization requesting the interview.

title
string
required

The title for the interview.

status
enum<string>
required

The status of the interview flow. One of: open, closed, archived. Archived flows have been deleted.

Available options:
open,
closed,
archived
questions
string[]
required

A list of questions to include in the interview.

voice_id
any | null
default:db6b0ed5-d5d3-463d-ae85-518a07d3c2b4

The voice ID to be used for the interview agent.

Available options:
11labs-Anna,
openai-Onyx,
openai-Shimmer,
11labs-Anthony,
11labs-Kate,
11labs-Amy,
11labs-Rahul,
IPgYtHTNLjC7Bq7IPHrm,
UOIqAnmS11Reiei1Ytkc,
bhJUNIXWQQ94l8eI2VUf,
uNsWM1StCcpydKYOjKyu,
f786b574-daa5-4673-aa0c-cbe3e8534c02,
a4a16c5e-5902-4732-b9b6-2a48efd2e11b,
8e14933d-ecd7-402b-9505-795130d69b35,
8017ae3f-c9b1-4633-87aa-2fada6a89953,
3c0f09d6-e0d7-499c-a594-70c5b7b93048,
dc30854e-e398-4579-9dc8-16f6cb2c19b9,
1259b7e3-cb8a-43df-9446-30971a46b8b0,
e2d08065-b658-466b-ad52-cef8ee21d307,
710feaa3-b550-42f3-b3eb-6f37f2a7cc0a,
cc4276e6-1ebc-429a-8c7d-930993d51abc,
ccfea4bf-b3f4-421e-87ed-dd05dae01431,
c68a8bd0-f99e-4e7f-915d-a097da6d024c,
fb936dd1-66ea-43a0-86bd-18a6203dcda2,
f9a4b3a6-b44b-469f-90e3-c8e19bd30e99,
4f7b1820-6263-4615-87a7-b105768d8f64,
c9611be8-aae9-4a93-bb1c-98dd6b7d52a4,
935a9060-373c-49e4-b078-f4ea6326987a,
fc923f89-1de5-4ddf-b93c-6da2ba63428a,
9cebb910-d4b7-4a4a-85a4-12c79137724c,
38aabb6a-f52b-4fb0-a3d1-988518f4dc06,
498e7f37-7fa3-4e2c-b8e2-8b6e9276f956,
89f4372f-1f73-4b85-8e1e-5d24ed8bc826,
5de076e9-7b28-4442-b279-e7d80d573505,
f4a3a8e4-694c-4c45-9ca0-27caf97901b5,
87286a8d-7ea7-4235-a41a-dd9fa6630feb,
a5136bf9-224c-4d76-b823-52bd5efcffcc,
146485fd-8736-41c7-88a8-7cdd0da34d84,
ca566b43-944e-4474-b494-7d9f0695f307,
8d8ce8c9-44a4-46c4-b10f-9a927b99a853,
66c6b81c-ddb7-4892-bdd5-19b5a7be38e7,
25bf938a-025c-4dd0-906f-8cf8be2e26e9,
1e9b9b3d-d2ce-4cac-9d05-bc36a63fa28e,
fb02b554-7d64-4f90-841e-e57fc88f410c,
bb7e8daa-8b79-47a2-8408-a7a1cc72b53c,
7d7d769c-5ab1-4dd5-bb17-ec8d4b69d03d,
187d1cc5-a771-4ccd-9110-9df8c4e39499,
9626c31c-bec5-4cca-baa8-f8ba9e84c8bc,
db6b0ed5-d5d3-463d-ae85-518a07d3c2b4,
e8e5fffb-252c-436d-b842-8879b84445b6,
null
language
any | null
default:en-US

The language of the interview flow.

Available options:
en-US,
de-DE,
es-419,
hi-IN,
ja-JP,
pt-BR,
fr-FR,
zh-CN,
ko-KR,
vi-VN,
th-TH,
ar-AE,
no-NO,
null
company_logo_url
string | null

Optional URL for the company's logo. If not provided, the Ribbon logo will be shown.

additional_info
string | null

Extra contextual information relevant to the interview. This can include background details, facts, or data points that the AI may use to enrich its questions or answers. For example: research focus, demographics or situational context.

additional_instructions
string | null

Guidelines on how the AI should behave during the interview. For example, adjust tone formality, avoid certain topics, or follow specific communication rules.

interview_type
enum<string> | null
default:general

The type of interview.

Available options:
recruitment,
general,
null
is_video_enabled
boolean | null
default:false

Whether the interview is video recorded or not.

is_doc_upload_enabled
boolean | null
default:false

Whether candidates can add resumes or other documents during the interview or not.

redirect_url
string | null

The URL where interviewee will be redirected after completing the interview. Make sure you're using the full URL, including https://

webhook_url
string | null

The URL that will be called after interview processing is complete. The payload will contain interview_flow_id, interview_id, and status.

webhook_secret_key
string | null

A secret key used to sign webhook payloads. When set, an X-Ribbon-Signature header containing an HMAC-SHA256 signature will be included with each webhook request.

intro
string | null

Introductory text spoken by the AI interviewer at the beginning of the interview.

outro
string | null

Concluding text spoken by the AI interviewer at the end of the interview.