curl -X POST "https://api.interviewflowai.com/api/external/ingest/job" \ -H "Content-Type: application/json" \ -H "X-API-KEY: your_api_key_here" \ -d '{ "title": "Senior Software Engineer", "role": "Backend Developer", "jobDescription": "Build scalable backend systems. Requirements: 5+ years of experience with Node.js, AWS, and MongoDB, with strong problem-solving skills. Benefits: Health insurance, 401k, unlimited PTO, remote-first culture, and an annual learning stipend.", "interviewLanguage": "english", "videoRequired": true, "linkExpirationDays": 4, "introductionMessage": "Hi {firstName}, I'\''ll be your AI interviewer today. It'\''s a pleasure to meet you! This is a structured interview designed to provide a fair and consistent experience for all candidates. For each question, you'\''ll have about two minutes to respond. If you don'\''t understand a question, you can ask me to repeat it. Are you ready to get started?", "iceBreaker": "To start off, could you tell me a little about yourself and what excites you about the {jobTitle} role?", "closingMessage": "Thank you for completing the interview. We appreciate the time and effort you have taken to share your experience with us. Your responses will now be reviewed as part of our selection process. If your profile is shortlisted for the next stage, our team will contact you directly. Thank you again for your interest in the opportunity, and we wish you all the best.", "customQuestionConfig": { "sectionOrder": ["manual", "resume"], "manual": { "enabled": true }, "resume": { "enabled": true, "maxQuestions": 3, "maxDuration": 3, "generationInstructions": "Focus on relevant experience from the candidate resume." } }, "instructions": "Please ensure you are in a quiet environment with a stable internet connection.", "interviewMode": "web_call", "resumeRequired": true, "portfolioRequired": false, "viewStatus": "public", "experienceMin": 3, "experienceMax": 7, "jobType": "full-time", "locationType": "remote", "context": "This role is part of the core platform team building next-generation hiring tools.", "interviewDuration": 20, "desktopOnly": true, "completionRedirectUrl": "https://yourcompany.com/thank-you", "customQuestions": [ { "question": "Describe a challenging project you worked on recently.", "generationSource": "manual", "evaluationCriteria": { "lookingFor": "Clear problem description, technical depth, and impact metrics", "strongAnswer": "Articulates the problem, approach, and measurable outcomes with specifics", "weakAnswer": "Vague description without technical details or quantifiable results", "weight": 5, "maxFollowup": 1, "maxDuration": 3 } } ], "tags": [ { "label": "Department", "options": ["Engineering", "Platform"] }, { "label": "Seniority", "options": ["Senior"] } ], "webhookConfig": { "url": "https://example.com/webhooks/interviews", "events": [ "interview.created", "interview.started", "interview.completed", "interview.report_available" ] } }'
Create an Interviewer with its full interview setup.
POST
/
api
/
external
/
ingest
/
job
curl -X POST "https://api.interviewflowai.com/api/external/ingest/job" \ -H "Content-Type: application/json" \ -H "X-API-KEY: your_api_key_here" \ -d '{ "title": "Senior Software Engineer", "role": "Backend Developer", "jobDescription": "Build scalable backend systems. Requirements: 5+ years of experience with Node.js, AWS, and MongoDB, with strong problem-solving skills. Benefits: Health insurance, 401k, unlimited PTO, remote-first culture, and an annual learning stipend.", "interviewLanguage": "english", "videoRequired": true, "linkExpirationDays": 4, "introductionMessage": "Hi {firstName}, I'\''ll be your AI interviewer today. It'\''s a pleasure to meet you! This is a structured interview designed to provide a fair and consistent experience for all candidates. For each question, you'\''ll have about two minutes to respond. If you don'\''t understand a question, you can ask me to repeat it. Are you ready to get started?", "iceBreaker": "To start off, could you tell me a little about yourself and what excites you about the {jobTitle} role?", "closingMessage": "Thank you for completing the interview. We appreciate the time and effort you have taken to share your experience with us. Your responses will now be reviewed as part of our selection process. If your profile is shortlisted for the next stage, our team will contact you directly. Thank you again for your interest in the opportunity, and we wish you all the best.", "customQuestionConfig": { "sectionOrder": ["manual", "resume"], "manual": { "enabled": true }, "resume": { "enabled": true, "maxQuestions": 3, "maxDuration": 3, "generationInstructions": "Focus on relevant experience from the candidate resume." } }, "instructions": "Please ensure you are in a quiet environment with a stable internet connection.", "interviewMode": "web_call", "resumeRequired": true, "portfolioRequired": false, "viewStatus": "public", "experienceMin": 3, "experienceMax": 7, "jobType": "full-time", "locationType": "remote", "context": "This role is part of the core platform team building next-generation hiring tools.", "interviewDuration": 20, "desktopOnly": true, "completionRedirectUrl": "https://yourcompany.com/thank-you", "customQuestions": [ { "question": "Describe a challenging project you worked on recently.", "generationSource": "manual", "evaluationCriteria": { "lookingFor": "Clear problem description, technical depth, and impact metrics", "strongAnswer": "Articulates the problem, approach, and measurable outcomes with specifics", "weakAnswer": "Vague description without technical details or quantifiable results", "weight": 5, "maxFollowup": 1, "maxDuration": 3 } } ], "tags": [ { "label": "Department", "options": ["Engineering", "Platform"] }, { "label": "Seniority", "options": ["Senior"] } ], "webhookConfig": { "url": "https://example.com/webhooks/interviews", "events": [ "interview.created", "interview.started", "interview.completed", "interview.report_available" ] } }'
Use the Create Interviewer API to set up a new Interviewer from your ATS or internal tools instead of the dashboard. Send the same settings you would fill in on the dashboard, and you get back the new Interviewer’s ID and public link.
Rate limit: 5 requests per minute per API key. This limit is shared with Update an Interviewer. Requests over the limit return 429 Too Many Requests.
Each API field maps to a step in the Create an AI Interviewer dashboard workflow. Use the table below to see which fields correspond to each step.
Interviewer description, including responsibilities, requirements, and benefits. Must contain 1–50,000 characters.
string
required
Language code for the interview: english, hindi, spanish, french, chinese, german, italian, japanese, korean, portuguese, dutch, ukrainian, malay, indonesian, arabic, or vietnamese.
boolean
required
Whether video responses are required.
number
required
Days until the interview link expires. Minimum 1 and maximum 365.
The following message fields support template variables like {fullName}, {firstName}, {jobTitle}, and {jobRole}, which are automatically replaced during the interview.
string
required
Introduction message shown to Candidates. Must contain 1–1,000 characters.
string
required
Ice breaker question. Maximum 500 characters. The field is required but can be an empty string.
string
required
Closing message shown to Candidates. Must contain 1–500 characters.
object
required
Configuration for manual, resume, and skills question sections. Set manual.enabled to true when you send customQuestions, and set resume.enabled to true when resumeRequired is true.
string
Interview instructions. Maximum 5,000 characters.
string
default:"web_call"
web_call, phone_only, or both. Phone modes require Twilio phone call credentials configured for your Company. When phone_only, videoRequired must be false.
boolean
Whether a resume is required.
boolean
Whether a portfolio is required.
string
public or private.
boolean
Whether the Interviewer is visible to Candidates.
boolean
Whether the Interviewer is archived on creation.
number
Minimum years of experience.
number
Maximum years of experience.
string
full-time, part-time, contract, or intern.
string
default:"remote"
remote, onsite, or hybrid. Onsite and hybrid Interviewers require country, city, and zipcode.
string
Country. Required for onsite and hybrid Interviewers. Maximum 255 characters.
string
City. Required for onsite and hybrid Interviewers. Maximum 255 characters.
string
Postal code. Required for onsite and hybrid Interviewers. Maximum 20 characters.
string
Additional Interviewer context. Maximum 200 words and 5,000 characters. Required when candidateQuestioning is true.
boolean
Whether Candidates can ask the AI Interviewer questions. Requires context.
boolean
Whether Candidates can opt out of the interview.
number
default:"10"
Duration in minutes. Minimum 10 and maximum 60.
boolean
default:"true"
Whether the interview requires a desktop device.
boolean
default:"true"
Whether Candidates see live captions and the transcript during the interview.
number
Number of retakes allowed. Minimum 0 and maximum 3.
object[]
Custom interview questions with evaluation criteria.
object[]
Screening questions shown before the interview.
object[]
Questions shown after the interview.
object[]
Interviewer tags for categorization. Each tag has a label (1–100 characters) and up to 20 options. Maximum 25 tags.
string
URL to an introduction video. Maximum 500 characters.
string
URL where Candidates are redirected after the interview, or an empty string. Maximum 2,048 characters.
object
Webhook destination and subscribed interview events.
Screening question fields
Each screeningQuestions item uses the following fields:
Field
Type
Description
question
string
Question shown to the Candidate. 1–200 characters.
type
string
numeric, text, or yesno.
expectedAnswer
string
Numeric target, minimum, or range minimum. Required for every screening question.
idealAnswerType
string
Numeric comparison: min (default), max, exact, or range.
expectedAnswerMax
string
Range maximum. Required when idealAnswerType is range.
isRequired
boolean
Whether the Candidate must answer the question.
mustHaveQualification
boolean
Whether a failed answer declines the Candidate.
Numeric comparisons are inclusive. For a range, expectedAnswer must be less than expectedAnswerMax.
{ "question": "How many years of experience do you have?", "type": "numeric", "idealAnswerType": "min", "expectedAnswer": "5", "isRequired": true, "mustHaveQualification": true}
curl -X POST "https://api.interviewflowai.com/api/external/ingest/job" \ -H "Content-Type: application/json" \ -H "X-API-KEY: your_api_key_here" \ -d '{ "title": "Senior Software Engineer", "role": "Backend Developer", "jobDescription": "Build scalable backend systems. Requirements: 5+ years of experience with Node.js, AWS, and MongoDB, with strong problem-solving skills. Benefits: Health insurance, 401k, unlimited PTO, remote-first culture, and an annual learning stipend.", "interviewLanguage": "english", "videoRequired": true, "linkExpirationDays": 4, "introductionMessage": "Hi {firstName}, I'\''ll be your AI interviewer today. It'\''s a pleasure to meet you! This is a structured interview designed to provide a fair and consistent experience for all candidates. For each question, you'\''ll have about two minutes to respond. If you don'\''t understand a question, you can ask me to repeat it. Are you ready to get started?", "iceBreaker": "To start off, could you tell me a little about yourself and what excites you about the {jobTitle} role?", "closingMessage": "Thank you for completing the interview. We appreciate the time and effort you have taken to share your experience with us. Your responses will now be reviewed as part of our selection process. If your profile is shortlisted for the next stage, our team will contact you directly. Thank you again for your interest in the opportunity, and we wish you all the best.", "customQuestionConfig": { "sectionOrder": ["manual", "resume"], "manual": { "enabled": true }, "resume": { "enabled": true, "maxQuestions": 3, "maxDuration": 3, "generationInstructions": "Focus on relevant experience from the candidate resume." } }, "instructions": "Please ensure you are in a quiet environment with a stable internet connection.", "interviewMode": "web_call", "resumeRequired": true, "portfolioRequired": false, "viewStatus": "public", "experienceMin": 3, "experienceMax": 7, "jobType": "full-time", "locationType": "remote", "context": "This role is part of the core platform team building next-generation hiring tools.", "interviewDuration": 20, "desktopOnly": true, "completionRedirectUrl": "https://yourcompany.com/thank-you", "customQuestions": [ { "question": "Describe a challenging project you worked on recently.", "generationSource": "manual", "evaluationCriteria": { "lookingFor": "Clear problem description, technical depth, and impact metrics", "strongAnswer": "Articulates the problem, approach, and measurable outcomes with specifics", "weakAnswer": "Vague description without technical details or quantifiable results", "weight": 5, "maxFollowup": 1, "maxDuration": 3 } } ], "tags": [ { "label": "Department", "options": ["Engineering", "Platform"] }, { "label": "Seniority", "options": ["Senior"] } ], "webhookConfig": { "url": "https://example.com/webhooks/interviews", "events": [ "interview.created", "interview.started", "interview.completed", "interview.report_available" ] } }'
Webhook configuration
Use webhookConfig to register a webhook destination when creating the Interviewer. Webhooks require a Pro plan.
Field
Type
Required
Description
webhookConfig.url
string
✅ Yes
HTTP or HTTPS URL that receives webhook deliveries (max 2000 characters).
webhookConfig.events
string[]
✅ Yes
One or more unique supported event types.
Both url and events are required when webhookConfig is supplied. Duplicate or unsupported events are rejected.
Event
Trigger
interview.created
A new candidate is added to the Interviewer.
interview.started
A candidate starts the interview.
interview.completed
A candidate completes the interview.
interview.declined
A candidate is declined for an interview.
interview.opted_out
A candidate opts out of an interview.
interview.report_available
The interview report becomes available.
assessment.shortlisted
A candidate is shortlisted for an assessment.
assessment.started
A candidate starts an assessment.
assessment.completed
A candidate completes an assessment.
Response
The endpoint returns 201 Created with the Interviewer ID, title, and public link. When webhookConfig is supplied, it also returns the registered endpoint and signing secret.
Store the signing secret securely and use it to verify webhook signatures. See Webhook events for the data each event sends. The webhookConfig property is omitted when no webhook configuration is supplied.If webhook setup fails, the Interviewer isn’t kept: InterviewFlowAI deletes it and returns an error. Retry the whole request.
Status
Message
Cause
503
Webhook configuration is currently unavailable
The webhook service isn’t configured or reachable.
502
Failed to configure webhook
The webhook destination couldn’t be registered. The Interviewer was rolled back.
Best Practice: Use this endpoint to create Interviewers programmatically from your ATS or internal tools whenever a new position opens. You can then use the returned id in subsequent ingest-candidate API calls.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"InterviewFlowAI Knowledge Base","colors":{"primary":"#5B50D6","light":"#8E85F2","dark":"#463CC0"},"logo":{"light":"https://mintcdn.com/interviewflowai/3Gmnw_L8IR0faXhJ/logo/logo.png?fit=max\u0026auto=format\u0026n=3Gmnw_L8IR0faXhJ\u0026q=85\u0026s=2eefa6ed5f15b3b9fe696130b4e91d1a","dark":"https://mintcdn.com/interviewflowai/HHntDfCf9L_iX9_5/logo/logo_dark.png?fit=max\u0026auto=format\u0026n=HHntDfCf9L_iX9_5\u0026q=85\u0026s=b6a48ac6c4168660ec1887845e784135"},"favicon":"https://mintcdn.com/interviewflowai/QTePgE545nTugw-v/favicon.png?fit=max\u0026auto=format\u0026n=QTePgE545nTugw-v\u0026q=85\u0026s=0b8290bc9a3e6ea91ca417135d5e3f5d","api":{"playground":{"display":"interactive"},"examples":{"autogenerate":false},"mdx":{"auth":{"method":"key","name":"X-API-KEY"},"server":"https://api.interviewflowai.com"}},"background":{"color":{"light":"#FCFCFD","dark":"#0F0E1A"}},"navbar":{"links":[{"href":"mailto:support@interviewflowai.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.interviewflowai.com"}},"footer":{"socials":{"x":"https://x.com/interviewflowai","linkedin":"https://linkedin.com/company/interviewflowai"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://interviewflowai.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"interviewflowai","hasAudioNarration":false,"actualSubdomain":"interviewflowai","customDomains":["docs.interviewflowai.com"],"gitSource":{"type":"github","owner":"imukulmunjal","repo":"docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af9fc960752de1b55396b93","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Guides","count":48},{"language":"default","tag":"Main","count":31},{"language":"default","tag":"Interviewers","count":24},{"language":"default","tag":"API reference","count":13},{"language":"default","tag":"Create an AI Interviewer","count":7},{"language":"default","tag":"ATS \u0026 Integrations","count":7},{"language":"default","tag":"Settings","count":6},{"language":"default","tag":"Configuration","count":6},{"language":"default","tag":"Candidates","count":5},{"language":"default","tag":"Getting started","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"img[src*=\"/logo/logo\"]{transform:scale(1.2)!important;transform-origin:left center!important}"}],"page":{"pagePath":"api-reference/interviewers/create","slug":"/api-reference/interviewers/create","pageMetadata":{"title":"Create an Interviewer","description":"Create an Interviewer with its full interview setup.","api":"POST /api/external/ingest/job","href":"/api-reference/interviewers/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create an Interviewer with its full interview setup.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use the Create Interviewer API to set up a new Interviewer from your ATS or internal tools instead of the dashboard. Send the same settings you would fill in on the dashboard, and you get back the new Interviewer’s ID and public link.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate limit:`}),` 5 requests per minute per API key. This limit is shared with `,_jsx(_components.a,{href:`/api-reference/interviewers/update`,children:`Update an Interviewer`}),`. Requests over the limit return `,_jsx(_components.code,{children:`429 Too Many Requests`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`Each API field maps to a step in the `,_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/overview`,children:`Create an AI Interviewer`}),` dashboard workflow. Use the table below to see which fields correspond to each step.`]}),`\n`,_jsx(Heading,{level:`2`,id:`dashboard-field-reference`,children:`Dashboard field reference`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Dashboard step`}),_jsx(_components.th,{children:`API fields`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/role-details`,children:`Role details`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`role`}),`, `,_jsx(_components.code,{children:`jobDescription`}),`, `,_jsx(_components.code,{children:`experienceMin`}),`, `,_jsx(_components.code,{children:`experienceMax`}),`, `,_jsx(_components.code,{children:`jobType`}),`, `,_jsx(_components.code,{children:`locationType`}),`, `,_jsx(_components.code,{children:`country`}),`, `,_jsx(_components.code,{children:`city`}),`, `,_jsx(_components.code,{children:`zipcode`}),`, `,_jsx(_components.code,{children:`context`}),`, `,_jsx(_components.code,{children:`tags`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/interview-settings`,children:`Interview settings`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`interviewLanguage`}),`, `,_jsx(_components.code,{children:`interviewDuration`}),`, `,_jsx(_components.code,{children:`linkExpirationDays`}),`, `,_jsx(_components.code,{children:`retakesAllowed`}),`, `,_jsx(_components.code,{children:`videoRequired`}),`, `,_jsx(_components.code,{children:`portfolioRequired`}),`, `,_jsx(_components.code,{children:`desktopOnly`}),`, `,_jsx(_components.code,{children:`showCaptions`}),`, `,_jsx(_components.code,{children:`introVideoUrl`}),`, `,_jsx(_components.code,{children:`introductionMessage`}),`, `,_jsx(_components.code,{children:`iceBreaker`}),`, `,_jsx(_components.code,{children:`closingMessage`}),`, `,_jsx(_components.code,{children:`postInterviewQuestions`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/application-form`,children:`Application form`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`screeningQuestions`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/question-settings`,children:`Question settings`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`customQuestionConfig`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/questions`,children:`Questions`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`customQuestions`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`payload-structure`,children:`Payload structure`}),`\n`,_jsx(ParamField,{body:`title`,type:`string`,required:true,id:`param-title`,children:_jsx(_components.p,{children:`Interviewer title. Must contain 1–255 characters.`})}),`\n`,_jsx(ParamField,{body:`role`,type:`string`,required:true,id:`param-role`,children:_jsx(_components.p,{children:`Interviewer role. Must contain 1–255 characters.`})}),`\n`,_jsx(ParamField,{body:`jobDescription`,type:`string`,required:true,id:`param-job-description`,children:_jsx(_components.p,{children:`Interviewer description, including responsibilities, requirements, and benefits. Must contain 1–50,000 characters.`})}),`\n`,_jsx(ParamField,{body:`interviewLanguage`,type:`string`,required:true,id:`param-interview-language`,children:_jsxs(_components.p,{children:[`Language code for the interview: `,_jsx(_components.code,{children:`english`}),`, `,_jsx(_components.code,{children:`hindi`}),`, `,_jsx(_components.code,{children:`spanish`}),`, `,_jsx(_components.code,{children:`french`}),`, `,_jsx(_components.code,{children:`chinese`}),`, `,_jsx(_components.code,{children:`german`}),`, `,_jsx(_components.code,{children:`italian`}),`, `,_jsx(_components.code,{children:`japanese`}),`, `,_jsx(_components.code,{children:`korean`}),`, `,_jsx(_components.code,{children:`portuguese`}),`, `,_jsx(_components.code,{children:`dutch`}),`, `,_jsx(_components.code,{children:`ukrainian`}),`, `,_jsx(_components.code,{children:`malay`}),`, `,_jsx(_components.code,{children:`indonesian`}),`, `,_jsx(_components.code,{children:`arabic`}),`, or `,_jsx(_components.code,{children:`vietnamese`}),`.`]})}),`\n`,_jsx(ParamField,{body:`videoRequired`,type:`boolean`,required:true,id:`param-video-required`,children:_jsx(_components.p,{children:`Whether video responses are required.`})}),`\n`,_jsx(ParamField,{body:`linkExpirationDays`,type:`number`,required:true,id:`param-link-expiration-days`,children:_jsxs(_components.p,{children:[`Days until the interview link expires. Minimum `,_jsx(_components.code,{children:`1`}),` and maximum `,_jsx(_components.code,{children:`365`}),`.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The following message fields support template variables like `,_jsx(_components.code,{children:`{fullName}`}),`, `,_jsx(_components.code,{children:`{firstName}`}),`, `,_jsx(_components.code,{children:`{jobTitle}`}),`, and `,_jsx(_components.code,{children:`{jobRole}`}),`, which are automatically replaced during the interview.`]})}),`\n`,_jsx(ParamField,{body:`introductionMessage`,type:`string`,required:true,id:`param-introduction-message`,children:_jsx(_components.p,{children:`Introduction message shown to Candidates. Must contain 1–1,000 characters.`})}),`\n`,_jsx(ParamField,{body:`iceBreaker`,type:`string`,required:true,id:`param-ice-breaker`,children:_jsx(_components.p,{children:`Ice breaker question. Maximum 500 characters. The field is required but can be an empty string.`})}),`\n`,_jsx(ParamField,{body:`closingMessage`,type:`string`,required:true,id:`param-closing-message`,children:_jsx(_components.p,{children:`Closing message shown to Candidates. Must contain 1–500 characters.`})}),`\n`,_jsx(ParamField,{body:`customQuestionConfig`,type:`object`,required:true,id:`param-custom-question-config`,children:_jsxs(_components.p,{children:[`Configuration for manual, resume, and skills question sections. Set `,_jsx(_components.code,{children:`manual.enabled`}),` to `,_jsx(_components.code,{children:`true`}),` when you send `,_jsx(_components.code,{children:`customQuestions`}),`, and set `,_jsx(_components.code,{children:`resume.enabled`}),` to `,_jsx(_components.code,{children:`true`}),` when `,_jsx(_components.code,{children:`resumeRequired`}),` is `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`instructions`,type:`string`,id:`param-instructions`,children:_jsx(_components.p,{children:`Interview instructions. Maximum 5,000 characters.`})}),`\n`,_jsx(ParamField,{body:`interviewMode`,type:`string`,default:`web_call`,id:`param-interview-mode`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`web_call`}),`, `,_jsx(_components.code,{children:`phone_only`}),`, or `,_jsx(_components.code,{children:`both`}),`. Phone modes require Twilio phone call credentials configured for your Company. When `,_jsx(_components.code,{children:`phone_only`}),`, `,_jsx(_components.code,{children:`videoRequired`}),` must be `,_jsx(_components.code,{children:`false`}),`.`]})}),`\n`,_jsx(ParamField,{body:`resumeRequired`,type:`boolean`,id:`param-resume-required`,children:_jsx(_components.p,{children:`Whether a resume is required.`})}),`\n`,_jsx(ParamField,{body:`portfolioRequired`,type:`boolean`,id:`param-portfolio-required`,children:_jsx(_components.p,{children:`Whether a portfolio is required.`})}),`\n`,_jsx(ParamField,{body:`viewStatus`,type:`string`,id:`param-view-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`public`}),` or `,_jsx(_components.code,{children:`private`}),`.`]})}),`\n`,_jsx(ParamField,{body:`showToJobSeekers`,type:`boolean`,id:`param-show-to-job-seekers`,children:_jsx(_components.p,{children:`Whether the Interviewer is visible to Candidates.`})}),`\n`,_jsx(ParamField,{body:`isArchived`,type:`boolean`,id:`param-is-archived`,children:_jsx(_components.p,{children:`Whether the Interviewer is archived on creation.`})}),`\n`,_jsx(ParamField,{body:`experienceMin`,type:`number`,id:`param-experience-min`,children:_jsx(_components.p,{children:`Minimum years of experience.`})}),`\n`,_jsx(ParamField,{body:`experienceMax`,type:`number`,id:`param-experience-max`,children:_jsx(_components.p,{children:`Maximum years of experience.`})}),`\n`,_jsx(ParamField,{body:`jobType`,type:`string`,id:`param-job-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`full-time`}),`, `,_jsx(_components.code,{children:`part-time`}),`, `,_jsx(_components.code,{children:`contract`}),`, or `,_jsx(_components.code,{children:`intern`}),`.`]})}),`\n`,_jsx(ParamField,{body:`locationType`,type:`string`,default:`remote`,id:`param-location-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`remote`}),`, `,_jsx(_components.code,{children:`onsite`}),`, or `,_jsx(_components.code,{children:`hybrid`}),`. Onsite and hybrid Interviewers require `,_jsx(_components.code,{children:`country`}),`, `,_jsx(_components.code,{children:`city`}),`, and `,_jsx(_components.code,{children:`zipcode`}),`.`]})}),`\n`,_jsx(ParamField,{body:`country`,type:`string`,id:`param-country`,children:_jsx(_components.p,{children:`Country. Required for onsite and hybrid Interviewers. Maximum 255 characters.`})}),`\n`,_jsx(ParamField,{body:`city`,type:`string`,id:`param-city`,children:_jsx(_components.p,{children:`City. Required for onsite and hybrid Interviewers. Maximum 255 characters.`})}),`\n`,_jsx(ParamField,{body:`zipcode`,type:`string`,id:`param-zipcode`,children:_jsx(_components.p,{children:`Postal code. Required for onsite and hybrid Interviewers. Maximum 20 characters.`})}),`\n`,_jsx(ParamField,{body:`context`,type:`string`,id:`param-context`,children:_jsxs(_components.p,{children:[`Additional Interviewer context. Maximum 200 words and 5,000 characters. Required when `,_jsx(_components.code,{children:`candidateQuestioning`}),` is `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`candidateQuestioning`,type:`boolean`,id:`param-candidate-questioning`,children:_jsxs(_components.p,{children:[`Whether Candidates can ask the AI Interviewer questions. Requires `,_jsx(_components.code,{children:`context`}),`.`]})}),`\n`,_jsx(ParamField,{body:`candidateOptOutEnabled`,type:`boolean`,id:`param-candidate-opt-out-enabled`,children:_jsx(_components.p,{children:`Whether Candidates can opt out of the interview.`})}),`\n`,_jsx(ParamField,{body:`interviewDuration`,type:`number`,default:`10`,id:`param-interview-duration`,children:_jsxs(_components.p,{children:[`Duration in minutes. Minimum `,_jsx(_components.code,{children:`10`}),` and maximum `,_jsx(_components.code,{children:`60`}),`.`]})}),`\n`,_jsx(ParamField,{body:`desktopOnly`,type:`boolean`,default:`true`,id:`param-desktop-only`,children:_jsx(_components.p,{children:`Whether the interview requires a desktop device.`})}),`\n`,_jsx(ParamField,{body:`showCaptions`,type:`boolean`,default:`true`,id:`param-show-captions`,children:_jsx(_components.p,{children:`Whether Candidates see live captions and the transcript during the interview.`})}),`\n`,_jsx(ParamField,{body:`retakesAllowed`,type:`number`,id:`param-retakes-allowed`,children:_jsxs(_components.p,{children:[`Number of retakes allowed. Minimum `,_jsx(_components.code,{children:`0`}),` and maximum `,_jsx(_components.code,{children:`3`}),`.`]})}),`\n`,_jsx(ParamField,{body:`customQuestions`,type:`object[]`,id:`param-custom-questions`,children:_jsx(_components.p,{children:`Custom interview questions with evaluation criteria.`})}),`\n`,_jsx(ParamField,{body:`screeningQuestions`,type:`object[]`,id:`param-screening-questions`,children:_jsx(_components.p,{children:`Screening questions shown before the interview.`})}),`\n`,_jsx(ParamField,{body:`postInterviewQuestions`,type:`object[]`,id:`param-post-interview-questions`,children:_jsx(_components.p,{children:`Questions shown after the interview.`})}),`\n`,_jsx(ParamField,{body:`tags`,type:`object[]`,id:`param-tags`,children:_jsxs(_components.p,{children:[`Interviewer tags for categorization. Each tag has a `,_jsx(_components.code,{children:`label`}),` (1–100 characters) and up to 20 `,_jsx(_components.code,{children:`options`}),`. Maximum 25 tags.`]})}),`\n`,_jsx(ParamField,{body:`introVideoUrl`,type:`string`,id:`param-intro-video-url`,children:_jsx(_components.p,{children:`URL to an introduction video. Maximum 500 characters.`})}),`\n`,_jsx(ParamField,{body:`completionRedirectUrl`,type:`string`,id:`param-completion-redirect-url`,children:_jsx(_components.p,{children:`URL where Candidates are redirected after the interview, or an empty string. Maximum 2,048 characters.`})}),`\n`,_jsx(ParamField,{body:`webhookConfig`,type:`object`,id:`param-webhook-config`,children:_jsx(_components.p,{children:`Webhook destination and subscribed interview events.`})}),`\n`,_jsx(Heading,{level:`3`,id:`screening-question-fields`,children:`Screening question fields`}),`\n`,_jsxs(_components.p,{children:[`Each `,_jsx(_components.code,{children:`screeningQuestions`}),` item uses the following fields:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`question`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Question shown to the Candidate. 1–200 characters.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`numeric`}),`, `,_jsx(_components.code,{children:`text`}),`, or `,_jsx(_components.code,{children:`yesno`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`expectedAnswer`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Numeric target, minimum, or range minimum. Required for every screening question.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`idealAnswerType`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Numeric comparison: `,_jsx(_components.code,{children:`min`}),` (default), `,_jsx(_components.code,{children:`max`}),`, `,_jsx(_components.code,{children:`exact`}),`, or `,_jsx(_components.code,{children:`range`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`expectedAnswerMax`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Range maximum. Required when `,_jsx(_components.code,{children:`idealAnswerType`}),` is `,_jsx(_components.code,{children:`range`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`isRequired`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Whether the Candidate must answer the question.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`mustHaveQualification`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Whether a failed answer declines the Candidate.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Numeric comparisons are inclusive. For a range, `,_jsx(_components.code,{children:`expectedAnswer`}),` must be less than `,_jsx(_components.code,{children:`expectedAnswerMax`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"question\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"How many years of experience do you have?\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"numeric\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"idealAnswerType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"min\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expectedAnswer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isRequired\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mustHaveQualification\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`webhook-configuration`,children:`Webhook configuration`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`webhookConfig`}),` to register a webhook destination when creating the Interviewer. Webhooks require a Pro plan.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhookConfig.url`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`HTTP or HTTPS URL that receives webhook deliveries (max 2000 characters).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhookConfig.events`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`One or more unique supported event types.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Both `,_jsx(_components.code,{children:`url`}),` and `,_jsx(_components.code,{children:`events`}),` are required when `,_jsx(_components.code,{children:`webhookConfig`}),` is supplied. Duplicate or unsupported events are rejected.`]})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Trigger`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.created`})}),_jsx(_components.td,{children:`A new candidate is added to the Interviewer.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.started`})}),_jsx(_components.td,{children:`A candidate starts the interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.completed`})}),_jsx(_components.td,{children:`A candidate completes the interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.declined`})}),_jsx(_components.td,{children:`A candidate is declined for an interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.opted_out`})}),_jsx(_components.td,{children:`A candidate opts out of an interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.report_available`})}),_jsx(_components.td,{children:`The interview report becomes available.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`assessment.shortlisted`})}),_jsx(_components.td,{children:`A candidate is shortlisted for an assessment.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`assessment.started`})}),_jsx(_components.td,{children:`A candidate starts an assessment.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`assessment.completed`})}),_jsx(_components.td,{children:`A candidate completes an assessment.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`The endpoint returns `,_jsx(_components.code,{children:`201 Created`}),` with the Interviewer ID, title, and public link. When `,_jsx(_components.code,{children:`webhookConfig`}),` is supplied, it also returns the registered endpoint and signing secret.`]}),`\n`,`\n`,_jsxs(_components.p,{children:[`Store the signing secret securely and use it to `,_jsx(_components.a,{href:`/api-reference/webhook-events#receive-events`,children:`verify webhook signatures`}),`. See `,_jsx(_components.a,{href:`/api-reference/webhook-events`,children:`Webhook events`}),` for the data each event sends. The `,_jsx(_components.code,{children:`webhookConfig`}),` property is omitted when no webhook configuration is supplied.`]}),`\n`,_jsx(_components.p,{children:`If webhook setup fails, the Interviewer isn’t kept: InterviewFlowAI deletes it and returns an error. Retry the whole request.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Message`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:`Webhook configuration is currently unavailable`}),_jsx(_components.td,{children:`The webhook service isn’t configured or reachable.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`502`})}),_jsx(_components.td,{children:`Failed to configure webhook`}),_jsx(_components.td,{children:`The webhook destination couldn’t be registered. The Interviewer was rolled back.`})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Best Practice:`}),` Use this endpoint to create Interviewers programmatically from your ATS or internal tools whenever a new position opens. You can then use the returned `,_jsx(_components.code,{children:`id`}),` in subsequent ingest-candidate API calls.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an Interviewer","description":"Create an Interviewer with its full interview setup.","api":"POST /api/external/ingest/job","href":"/api-reference/interviewers/create"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,RequestExample,ResponseExample,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use the Create Interviewer API to set up a new Interviewer from your ATS or internal tools instead of the dashboard. Send the same settings you would fill in on the dashboard, and you get back the new Interviewer’s ID and public link.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate limit:`}),` 5 requests per minute per API key. This limit is shared with `,_jsx(_components.a,{href:`/api-reference/interviewers/update`,children:`Update an Interviewer`}),`. Requests over the limit return `,_jsx(_components.code,{children:`429 Too Many Requests`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`Each API field maps to a step in the `,_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/overview`,children:`Create an AI Interviewer`}),` dashboard workflow. Use the table below to see which fields correspond to each step.`]}),`\n`,_jsx(Heading,{level:`2`,id:`dashboard-field-reference`,children:`Dashboard field reference`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Dashboard step`}),_jsx(_components.th,{children:`API fields`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/role-details`,children:`Role details`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`role`}),`, `,_jsx(_components.code,{children:`jobDescription`}),`, `,_jsx(_components.code,{children:`experienceMin`}),`, `,_jsx(_components.code,{children:`experienceMax`}),`, `,_jsx(_components.code,{children:`jobType`}),`, `,_jsx(_components.code,{children:`locationType`}),`, `,_jsx(_components.code,{children:`country`}),`, `,_jsx(_components.code,{children:`city`}),`, `,_jsx(_components.code,{children:`zipcode`}),`, `,_jsx(_components.code,{children:`context`}),`, `,_jsx(_components.code,{children:`tags`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/interview-settings`,children:`Interview settings`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`interviewLanguage`}),`, `,_jsx(_components.code,{children:`interviewDuration`}),`, `,_jsx(_components.code,{children:`linkExpirationDays`}),`, `,_jsx(_components.code,{children:`retakesAllowed`}),`, `,_jsx(_components.code,{children:`videoRequired`}),`, `,_jsx(_components.code,{children:`portfolioRequired`}),`, `,_jsx(_components.code,{children:`desktopOnly`}),`, `,_jsx(_components.code,{children:`showCaptions`}),`, `,_jsx(_components.code,{children:`introVideoUrl`}),`, `,_jsx(_components.code,{children:`introductionMessage`}),`, `,_jsx(_components.code,{children:`iceBreaker`}),`, `,_jsx(_components.code,{children:`closingMessage`}),`, `,_jsx(_components.code,{children:`postInterviewQuestions`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/application-form`,children:`Application form`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`screeningQuestions`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/question-settings`,children:`Question settings`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`customQuestionConfig`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/interview-automation/create-an-ai-interviewer/questions`,children:`Questions`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`customQuestions`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`payload-structure`,children:`Payload structure`}),`\n`,_jsx(ParamField,{body:`title`,type:`string`,required:true,id:`param-title`,children:_jsx(_components.p,{children:`Interviewer title. Must contain 1–255 characters.`})}),`\n`,_jsx(ParamField,{body:`role`,type:`string`,required:true,id:`param-role`,children:_jsx(_components.p,{children:`Interviewer role. Must contain 1–255 characters.`})}),`\n`,_jsx(ParamField,{body:`jobDescription`,type:`string`,required:true,id:`param-job-description`,children:_jsx(_components.p,{children:`Interviewer description, including responsibilities, requirements, and benefits. Must contain 1–50,000 characters.`})}),`\n`,_jsx(ParamField,{body:`interviewLanguage`,type:`string`,required:true,id:`param-interview-language`,children:_jsxs(_components.p,{children:[`Language code for the interview: `,_jsx(_components.code,{children:`english`}),`, `,_jsx(_components.code,{children:`hindi`}),`, `,_jsx(_components.code,{children:`spanish`}),`, `,_jsx(_components.code,{children:`french`}),`, `,_jsx(_components.code,{children:`chinese`}),`, `,_jsx(_components.code,{children:`german`}),`, `,_jsx(_components.code,{children:`italian`}),`, `,_jsx(_components.code,{children:`japanese`}),`, `,_jsx(_components.code,{children:`korean`}),`, `,_jsx(_components.code,{children:`portuguese`}),`, `,_jsx(_components.code,{children:`dutch`}),`, `,_jsx(_components.code,{children:`ukrainian`}),`, `,_jsx(_components.code,{children:`malay`}),`, `,_jsx(_components.code,{children:`indonesian`}),`, `,_jsx(_components.code,{children:`arabic`}),`, or `,_jsx(_components.code,{children:`vietnamese`}),`.`]})}),`\n`,_jsx(ParamField,{body:`videoRequired`,type:`boolean`,required:true,id:`param-video-required`,children:_jsx(_components.p,{children:`Whether video responses are required.`})}),`\n`,_jsx(ParamField,{body:`linkExpirationDays`,type:`number`,required:true,id:`param-link-expiration-days`,children:_jsxs(_components.p,{children:[`Days until the interview link expires. Minimum `,_jsx(_components.code,{children:`1`}),` and maximum `,_jsx(_components.code,{children:`365`}),`.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The following message fields support template variables like `,_jsx(_components.code,{children:`{fullName}`}),`, `,_jsx(_components.code,{children:`{firstName}`}),`, `,_jsx(_components.code,{children:`{jobTitle}`}),`, and `,_jsx(_components.code,{children:`{jobRole}`}),`, which are automatically replaced during the interview.`]})}),`\n`,_jsx(ParamField,{body:`introductionMessage`,type:`string`,required:true,id:`param-introduction-message`,children:_jsx(_components.p,{children:`Introduction message shown to Candidates. Must contain 1–1,000 characters.`})}),`\n`,_jsx(ParamField,{body:`iceBreaker`,type:`string`,required:true,id:`param-ice-breaker`,children:_jsx(_components.p,{children:`Ice breaker question. Maximum 500 characters. The field is required but can be an empty string.`})}),`\n`,_jsx(ParamField,{body:`closingMessage`,type:`string`,required:true,id:`param-closing-message`,children:_jsx(_components.p,{children:`Closing message shown to Candidates. Must contain 1–500 characters.`})}),`\n`,_jsx(ParamField,{body:`customQuestionConfig`,type:`object`,required:true,id:`param-custom-question-config`,children:_jsxs(_components.p,{children:[`Configuration for manual, resume, and skills question sections. Set `,_jsx(_components.code,{children:`manual.enabled`}),` to `,_jsx(_components.code,{children:`true`}),` when you send `,_jsx(_components.code,{children:`customQuestions`}),`, and set `,_jsx(_components.code,{children:`resume.enabled`}),` to `,_jsx(_components.code,{children:`true`}),` when `,_jsx(_components.code,{children:`resumeRequired`}),` is `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`instructions`,type:`string`,id:`param-instructions`,children:_jsx(_components.p,{children:`Interview instructions. Maximum 5,000 characters.`})}),`\n`,_jsx(ParamField,{body:`interviewMode`,type:`string`,default:`web_call`,id:`param-interview-mode`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`web_call`}),`, `,_jsx(_components.code,{children:`phone_only`}),`, or `,_jsx(_components.code,{children:`both`}),`. Phone modes require Twilio phone call credentials configured for your Company. When `,_jsx(_components.code,{children:`phone_only`}),`, `,_jsx(_components.code,{children:`videoRequired`}),` must be `,_jsx(_components.code,{children:`false`}),`.`]})}),`\n`,_jsx(ParamField,{body:`resumeRequired`,type:`boolean`,id:`param-resume-required`,children:_jsx(_components.p,{children:`Whether a resume is required.`})}),`\n`,_jsx(ParamField,{body:`portfolioRequired`,type:`boolean`,id:`param-portfolio-required`,children:_jsx(_components.p,{children:`Whether a portfolio is required.`})}),`\n`,_jsx(ParamField,{body:`viewStatus`,type:`string`,id:`param-view-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`public`}),` or `,_jsx(_components.code,{children:`private`}),`.`]})}),`\n`,_jsx(ParamField,{body:`showToJobSeekers`,type:`boolean`,id:`param-show-to-job-seekers`,children:_jsx(_components.p,{children:`Whether the Interviewer is visible to Candidates.`})}),`\n`,_jsx(ParamField,{body:`isArchived`,type:`boolean`,id:`param-is-archived`,children:_jsx(_components.p,{children:`Whether the Interviewer is archived on creation.`})}),`\n`,_jsx(ParamField,{body:`experienceMin`,type:`number`,id:`param-experience-min`,children:_jsx(_components.p,{children:`Minimum years of experience.`})}),`\n`,_jsx(ParamField,{body:`experienceMax`,type:`number`,id:`param-experience-max`,children:_jsx(_components.p,{children:`Maximum years of experience.`})}),`\n`,_jsx(ParamField,{body:`jobType`,type:`string`,id:`param-job-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`full-time`}),`, `,_jsx(_components.code,{children:`part-time`}),`, `,_jsx(_components.code,{children:`contract`}),`, or `,_jsx(_components.code,{children:`intern`}),`.`]})}),`\n`,_jsx(ParamField,{body:`locationType`,type:`string`,default:`remote`,id:`param-location-type`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`remote`}),`, `,_jsx(_components.code,{children:`onsite`}),`, or `,_jsx(_components.code,{children:`hybrid`}),`. Onsite and hybrid Interviewers require `,_jsx(_components.code,{children:`country`}),`, `,_jsx(_components.code,{children:`city`}),`, and `,_jsx(_components.code,{children:`zipcode`}),`.`]})}),`\n`,_jsx(ParamField,{body:`country`,type:`string`,id:`param-country`,children:_jsx(_components.p,{children:`Country. Required for onsite and hybrid Interviewers. Maximum 255 characters.`})}),`\n`,_jsx(ParamField,{body:`city`,type:`string`,id:`param-city`,children:_jsx(_components.p,{children:`City. Required for onsite and hybrid Interviewers. Maximum 255 characters.`})}),`\n`,_jsx(ParamField,{body:`zipcode`,type:`string`,id:`param-zipcode`,children:_jsx(_components.p,{children:`Postal code. Required for onsite and hybrid Interviewers. Maximum 20 characters.`})}),`\n`,_jsx(ParamField,{body:`context`,type:`string`,id:`param-context`,children:_jsxs(_components.p,{children:[`Additional Interviewer context. Maximum 200 words and 5,000 characters. Required when `,_jsx(_components.code,{children:`candidateQuestioning`}),` is `,_jsx(_components.code,{children:`true`}),`.`]})}),`\n`,_jsx(ParamField,{body:`candidateQuestioning`,type:`boolean`,id:`param-candidate-questioning`,children:_jsxs(_components.p,{children:[`Whether Candidates can ask the AI Interviewer questions. Requires `,_jsx(_components.code,{children:`context`}),`.`]})}),`\n`,_jsx(ParamField,{body:`candidateOptOutEnabled`,type:`boolean`,id:`param-candidate-opt-out-enabled`,children:_jsx(_components.p,{children:`Whether Candidates can opt out of the interview.`})}),`\n`,_jsx(ParamField,{body:`interviewDuration`,type:`number`,default:`10`,id:`param-interview-duration`,children:_jsxs(_components.p,{children:[`Duration in minutes. Minimum `,_jsx(_components.code,{children:`10`}),` and maximum `,_jsx(_components.code,{children:`60`}),`.`]})}),`\n`,_jsx(ParamField,{body:`desktopOnly`,type:`boolean`,default:`true`,id:`param-desktop-only`,children:_jsx(_components.p,{children:`Whether the interview requires a desktop device.`})}),`\n`,_jsx(ParamField,{body:`showCaptions`,type:`boolean`,default:`true`,id:`param-show-captions`,children:_jsx(_components.p,{children:`Whether Candidates see live captions and the transcript during the interview.`})}),`\n`,_jsx(ParamField,{body:`retakesAllowed`,type:`number`,id:`param-retakes-allowed`,children:_jsxs(_components.p,{children:[`Number of retakes allowed. Minimum `,_jsx(_components.code,{children:`0`}),` and maximum `,_jsx(_components.code,{children:`3`}),`.`]})}),`\n`,_jsx(ParamField,{body:`customQuestions`,type:`object[]`,id:`param-custom-questions`,children:_jsx(_components.p,{children:`Custom interview questions with evaluation criteria.`})}),`\n`,_jsx(ParamField,{body:`screeningQuestions`,type:`object[]`,id:`param-screening-questions`,children:_jsx(_components.p,{children:`Screening questions shown before the interview.`})}),`\n`,_jsx(ParamField,{body:`postInterviewQuestions`,type:`object[]`,id:`param-post-interview-questions`,children:_jsx(_components.p,{children:`Questions shown after the interview.`})}),`\n`,_jsx(ParamField,{body:`tags`,type:`object[]`,id:`param-tags`,children:_jsxs(_components.p,{children:[`Interviewer tags for categorization. Each tag has a `,_jsx(_components.code,{children:`label`}),` (1–100 characters) and up to 20 `,_jsx(_components.code,{children:`options`}),`. Maximum 25 tags.`]})}),`\n`,_jsx(ParamField,{body:`introVideoUrl`,type:`string`,id:`param-intro-video-url`,children:_jsx(_components.p,{children:`URL to an introduction video. Maximum 500 characters.`})}),`\n`,_jsx(ParamField,{body:`completionRedirectUrl`,type:`string`,id:`param-completion-redirect-url`,children:_jsx(_components.p,{children:`URL where Candidates are redirected after the interview, or an empty string. Maximum 2,048 characters.`})}),`\n`,_jsx(ParamField,{body:`webhookConfig`,type:`object`,id:`param-webhook-config`,children:_jsx(_components.p,{children:`Webhook destination and subscribed interview events.`})}),`\n`,_jsx(Heading,{level:`3`,id:`screening-question-fields`,children:`Screening question fields`}),`\n`,_jsxs(_components.p,{children:[`Each `,_jsx(_components.code,{children:`screeningQuestions`}),` item uses the following fields:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`question`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Question shown to the Candidate. 1–200 characters.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`numeric`}),`, `,_jsx(_components.code,{children:`text`}),`, or `,_jsx(_components.code,{children:`yesno`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`expectedAnswer`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Numeric target, minimum, or range minimum. Required for every screening question.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`idealAnswerType`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Numeric comparison: `,_jsx(_components.code,{children:`min`}),` (default), `,_jsx(_components.code,{children:`max`}),`, `,_jsx(_components.code,{children:`exact`}),`, or `,_jsx(_components.code,{children:`range`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`expectedAnswerMax`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Range maximum. Required when `,_jsx(_components.code,{children:`idealAnswerType`}),` is `,_jsx(_components.code,{children:`range`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`isRequired`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Whether the Candidate must answer the question.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`mustHaveQualification`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Whether a failed answer declines the Candidate.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Numeric comparisons are inclusive. For a range, `,_jsx(_components.code,{children:`expectedAnswer`}),` must be less than `,_jsx(_components.code,{children:`expectedAnswerMax`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"question\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"How many years of experience do you have?\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"numeric\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"idealAnswerType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"min\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expectedAnswer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isRequired\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mustHaveQualification\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`64`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`64`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.interviewflowai.com/api/external/ingest/job\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-KEY: your_api_key_here\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"title\": \"Senior Software Engineer\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"role\": \"Backend Developer\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"jobDescription\": \"Build scalable backend systems. Requirements: 5+ years of experience with Node.js, AWS, and MongoDB, with strong problem-solving skills. Benefits: Health insurance, 401k, unlimited PTO, remote-first culture, and an annual learning stipend.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interviewLanguage\": \"english\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"videoRequired\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"linkExpirationDays\": 4,`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"introductionMessage\": \"Hi {firstName}, I'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\'`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'ll be your AI interviewer today. It'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\'`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'s a pleasure to meet you! This is a structured interview designed to provide a fair and consistent experience for all candidates. For each question, you'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\'`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'ll have about two minutes to respond. If you don'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\'`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'t understand a question, you can ask me to repeat it. Are you ready to get started?\",`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"iceBreaker\": \"To start off, could you tell me a little about yourself and what excites you about the {jobTitle} role?\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"closingMessage\": \"Thank you for completing the interview. We appreciate the time and effort you have taken to share your experience with us. Your responses will now be reviewed as part of our selection process. If your profile is shortlisted for the next stage, our team will contact you directly. Thank you again for your interest in the opportunity, and we wish you all the best.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"customQuestionConfig\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sectionOrder\": [\"manual\", \"resume\"],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"manual\": { \"enabled\": true },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"resume\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"enabled\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"maxQuestions\": 3,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"maxDuration\": 3,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"generationInstructions\": \"Focus on relevant experience from the candidate resume.\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"instructions\": \"Please ensure you are in a quiet environment with a stable internet connection.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interviewMode\": \"web_call\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"resumeRequired\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"portfolioRequired\": false,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"viewStatus\": \"public\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"experienceMin\": 3,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"experienceMax\": 7,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"jobType\": \"full-time\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"locationType\": \"remote\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"context\": \"This role is part of the core platform team building next-generation hiring tools.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interviewDuration\": 20,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"desktopOnly\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"completionRedirectUrl\": \"https://yourcompany.com/thank-you\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"customQuestions\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"question\": \"Describe a challenging project you worked on recently.\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"generationSource\": \"manual\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"evaluationCriteria\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"lookingFor\": \"Clear problem description, technical depth, and impact metrics\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"strongAnswer\": \"Articulates the problem, approach, and measurable outcomes with specifics\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"weakAnswer\": \"Vague description without technical details or quantifiable results\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"weight\": 5,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"maxFollowup\": 1,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"maxDuration\": 3`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"tags\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"label\": \"Department\", \"options\": [\"Engineering\", \"Platform\"] },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` { \"label\": \"Seniority\", \"options\": [\"Senior\"] }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"webhookConfig\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"url\": \"https://example.com/webhooks/interviews\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"events\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.created\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.started\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.completed\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.report_available\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-configuration`,children:`Webhook configuration`}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`webhookConfig`}),` to register a webhook destination when creating the Interviewer. Webhooks require a Pro plan.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhookConfig.url`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`HTTP or HTTPS URL that receives webhook deliveries (max 2000 characters).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhookConfig.events`})}),_jsx(_components.td,{children:`string[]`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`One or more unique supported event types.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Both `,_jsx(_components.code,{children:`url`}),` and `,_jsx(_components.code,{children:`events`}),` are required when `,_jsx(_components.code,{children:`webhookConfig`}),` is supplied. Duplicate or unsupported events are rejected.`]})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event`}),_jsx(_components.th,{children:`Trigger`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.created`})}),_jsx(_components.td,{children:`A new candidate is added to the Interviewer.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.started`})}),_jsx(_components.td,{children:`A candidate starts the interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.completed`})}),_jsx(_components.td,{children:`A candidate completes the interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.declined`})}),_jsx(_components.td,{children:`A candidate is declined for an interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.opted_out`})}),_jsx(_components.td,{children:`A candidate opts out of an interview.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`interview.report_available`})}),_jsx(_components.td,{children:`The interview report becomes available.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`assessment.shortlisted`})}),_jsx(_components.td,{children:`A candidate is shortlisted for an assessment.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`assessment.started`})}),_jsx(_components.td,{children:`A candidate starts an assessment.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`assessment.completed`})}),_jsx(_components.td,{children:`A candidate completes an assessment.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`The endpoint returns `,_jsx(_components.code,{children:`201 Created`}),` with the Interviewer ID, title, and public link. When `,_jsx(_components.code,{children:`webhookConfig`}),` is supplied, it also returns the registered endpoint and signing secret.`]}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`201`,numberOfLines:`20`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`20`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"00000000-0000-0000-0000-000000000101\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Senior Software Engineer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"jobLink\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://app.interviewflowai.com/public/00000000-0000-0000-0000-000000000101\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"webhookConfig\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"endpointId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ep_01JEXAMPLE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/webhooks/interviews\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"events\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.created\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.started\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.completed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"interview.report_available\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"secret\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"whsec_EXAMPLE\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`201`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Job created successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsxs(_components.p,{children:[`Store the signing secret securely and use it to `,_jsx(_components.a,{href:`/api-reference/webhook-events#receive-events`,children:`verify webhook signatures`}),`. See `,_jsx(_components.a,{href:`/api-reference/webhook-events`,children:`Webhook events`}),` for the data each event sends. The `,_jsx(_components.code,{children:`webhookConfig`}),` property is omitted when no webhook configuration is supplied.`]}),`\n`,_jsx(_components.p,{children:`If webhook setup fails, the Interviewer isn’t kept: InterviewFlowAI deletes it and returns an error. Retry the whole request.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Message`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:`Webhook configuration is currently unavailable`}),_jsx(_components.td,{children:`The webhook service isn’t configured or reachable.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`502`})}),_jsx(_components.td,{children:`Failed to configure webhook`}),_jsx(_components.td,{children:`The webhook destination couldn’t be registered. The Interviewer was rolled back.`})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Best Practice:`}),` Use this endpoint to create Interviewers programmatically from your ATS or internal tools whenever a new position opens. You can then use the returned `,_jsx(_components.code,{children:`id`}),` in subsequent ingest-candidate API calls.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an Interviewer","description":"Create an Interviewer with its full interview setup.","api":"POST /api/external/ingest/job","href":"/api-reference/interviewers/create"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Dashboard field reference","slug":"dashboard-field-reference","depth":2,"children":[]},{"title":"Payload structure","slug":"payload-structure","depth":2,"children":[{"title":"Screening question fields","slug":"screening-question-fields","depth":3,"children":[]}]},{"title":"Webhook configuration","slug":"webhook-configuration","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"64\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -X\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://api.interviewflowai.com/api/external/ingest/job\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -H\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-API-KEY: your_api_key_here\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -d\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"title\": \"Senior Software Engineer\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"role\": \"Backend Developer\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"jobDescription\": \"Build scalable backend systems. Requirements: 5+ years of experience with Node.js, AWS, and MongoDB, with strong problem-solving skills. Benefits: Health insurance, 401k, unlimited PTO, remote-first culture, and an annual learning stipend.\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interviewLanguage\": \"english\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"videoRequired\": true,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"linkExpirationDays\": 4,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"introductionMessage\": \"Hi {firstName}, I'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\'\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'ll be your AI interviewer today. It'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\'\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'s a pleasure to meet you! This is a structured interview designed to provide a fair and consistent experience for all candidates. For each question, you'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\'\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'ll have about two minutes to respond. If you don'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\">\\'\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'t understand a question, you can ask me to repeat it. Are you ready to get started?\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"iceBreaker\": \"To start off, could you tell me a little about yourself and what excites you about the {jobTitle} role?\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"closingMessage\": \"Thank you for completing the interview. We appreciate the time and effort you have taken to share your experience with us. Your responses will now be reviewed as part of our selection process. If your profile is shortlisted for the next stage, our team will contact you directly. Thank you again for your interest in the opportunity, and we wish you all the best.\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"customQuestionConfig\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"sectionOrder\": [\"manual\", \"resume\"],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"manual\": { \"enabled\": true },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"resume\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"enabled\": true,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"maxQuestions\": 3,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"maxDuration\": 3,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"generationInstructions\": \"Focus on relevant experience from the candidate resume.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"instructions\": \"Please ensure you are in a quiet environment with a stable internet connection.\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interviewMode\": \"web_call\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"resumeRequired\": true,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"portfolioRequired\": false,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"viewStatus\": \"public\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"experienceMin\": 3,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"experienceMax\": 7,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"jobType\": \"full-time\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"locationType\": \"remote\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"context\": \"This role is part of the core platform team building next-generation hiring tools.\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interviewDuration\": 20,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"desktopOnly\": true,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"completionRedirectUrl\": \"https://yourcompany.com/thank-you\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"customQuestions\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"question\": \"Describe a challenging project you worked on recently.\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"generationSource\": \"manual\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"evaluationCriteria\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"lookingFor\": \"Clear problem description, technical depth, and impact metrics\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"strongAnswer\": \"Articulates the problem, approach, and measurable outcomes with specifics\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"weakAnswer\": \"Vague description without technical details or quantifiable results\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"weight\": 5,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"maxFollowup\": 1,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"maxDuration\": 3\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"tags\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> { \"label\": \"Department\", \"options\": [\"Engineering\", \"Platform\"] },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> { \"label\": \"Seniority\", \"options\": [\"Senior\"] }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"webhookConfig\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"url\": \"https://example.com/webhooks/interviews\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"events\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.created\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.started\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.completed\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.report_available\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"201","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"20\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"00000000-0000-0000-0000-000000000101\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"title\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Senior Software Engineer\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"jobLink\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://app.interviewflowai.com/public/00000000-0000-0000-0000-000000000101\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"webhookConfig\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"endpointId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"ep_01JEXAMPLE\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://example.com/webhooks/interviews\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"events\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.created\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.started\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.completed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"interview.report_available\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"secret\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"whsec_EXAMPLE\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"code\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">201\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Job created successfully\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create an Interviewer","path":"/api/external/ingest/job","servers":[{"url":"https://api.interviewflowai.com"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"X-API-KEY":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"title":[{"type":"string","description":"Interviewer title. Must contain 1–255 characters.","required":true}],"role":[{"type":"string","description":"Interviewer role. Must contain 1–255 characters.","required":true}],"jobDescription":[{"type":"string","description":"Interviewer description, including responsibilities, requirements, and benefits. Must contain 1–50,000 characters.","required":true}],"interviewLanguage":[{"type":"string","description":"Language code for the interview: `english` , `hindi` , `spanish` , `french` , `chinese` , `german` , `italian` , `japanese` , `korean` , `portuguese` , `dutch` , `ukrainian` , `malay` , `indonesian` , `arabic` , or `vietnamese` .","required":true}],"videoRequired":[{"type":"boolean","description":"Whether video responses are required.","required":true}],"linkExpirationDays":[{"type":"number","description":"Days until the interview link expires. Minimum `1` and maximum `365` .","required":true}],"introductionMessage":[{"type":"string","description":"Introduction message shown to Candidates. Must contain 1–1,000 characters.","required":true}],"iceBreaker":[{"type":"string","description":"Ice breaker question. Maximum 500 characters. The field is required but can be an empty string.","required":true}],"closingMessage":[{"type":"string","description":"Closing message shown to Candidates. Must contain 1–500 characters.","required":true}],"customQuestionConfig":[{"type":"object","properties":{},"description":"Configuration for manual, resume, and skills question sections. Set `manual.enabled` to `true` when you send `customQuestions` , and set `resume.enabled` to `true` when `resumeRequired` is `true` .","required":true}],"instructions":[{"type":"string","description":"Interview instructions. Maximum 5,000 characters."}],"interviewMode":[{"type":"string","description":"`web_call` , `phone_only` , or `both` . Phone modes require Twilio phone call credentials configured for your Company. When `phone_only` , `videoRequired` must be `false` ."}],"resumeRequired":[{"type":"boolean","description":"Whether a resume is required."}],"portfolioRequired":[{"type":"boolean","description":"Whether a portfolio is required."}],"viewStatus":[{"type":"string","description":"`public` or `private` ."}],"showToJobSeekers":[{"type":"boolean","description":"Whether the Interviewer is visible to Candidates."}],"isArchived":[{"type":"boolean","description":"Whether the Interviewer is archived on creation."}],"experienceMin":[{"type":"number","description":"Minimum years of experience."}],"experienceMax":[{"type":"number","description":"Maximum years of experience."}],"jobType":[{"type":"string","description":"`full-time` , `part-time` , `contract` , or `intern` ."}],"locationType":[{"type":"string","description":"`remote` , `onsite` , or `hybrid` . Onsite and hybrid Interviewers require `country` , `city` , and `zipcode` ."}],"country":[{"type":"string","description":"Country. Required for onsite and hybrid Interviewers. Maximum 255 characters."}],"city":[{"type":"string","description":"City. Required for onsite and hybrid Interviewers. Maximum 255 characters."}],"zipcode":[{"type":"string","description":"Postal code. Required for onsite and hybrid Interviewers. Maximum 20 characters."}],"context":[{"type":"string","description":"Additional Interviewer context. Maximum 200 words and 5,000 characters. Required when `candidateQuestioning` is `true` ."}],"candidateQuestioning":[{"type":"boolean","description":"Whether Candidates can ask the AI Interviewer questions. Requires `context` ."}],"candidateOptOutEnabled":[{"type":"boolean","description":"Whether Candidates can opt out of the interview."}],"interviewDuration":[{"type":"number","description":"Duration in minutes. Minimum `10` and maximum `60` ."}],"desktopOnly":[{"type":"boolean","description":"Whether the interview requires a desktop device."}],"showCaptions":[{"type":"boolean","description":"Whether Candidates see live captions and the transcript during the interview."}],"retakesAllowed":[{"type":"number","description":"Number of retakes allowed. Minimum `0` and maximum `3` ."}],"customQuestions":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Custom interview questions with evaluation criteria."}],"screeningQuestions":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Screening questions shown before the interview."}],"postInterviewQuestions":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Questions shown after the interview."}],"tags":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"Interviewer tags for categorization. Each tag has a `label` (1–100 characters) and up to 20 `options` . Maximum 25 tags."}],"introVideoUrl":[{"type":"string","description":"URL to an introduction video. Maximum 500 characters."}],"completionRedirectUrl":[{"type":"string","description":"URL where Candidates are redirected after the interview, or an empty string. Maximum 2,048 characters."}],"webhookConfig":[{"type":"object","properties":{},"description":"Webhook destination and subscribed interview events."}]}}],"examples":{"example":{"value":{"title":"\u003cstring>","role":"\u003cstring>","jobDescription":"\u003cstring>","interviewLanguage":"\u003cstring>","videoRequired":true,"linkExpirationDays":123,"introductionMessage":"\u003cstring>","iceBreaker":"\u003cstring>","closingMessage":"\u003cstring>","customQuestionConfig":{},"instructions":"\u003cstring>","interviewMode":"\u003cstring>","resumeRequired":true,"portfolioRequired":true,"viewStatus":"\u003cstring>","showToJobSeekers":true,"isArchived":true,"experienceMin":123,"experienceMax":123,"jobType":"\u003cstring>","locationType":"\u003cstring>","country":"\u003cstring>","city":"\u003cstring>","zipcode":"\u003cstring>","context":"\u003cstring>","candidateQuestioning":true,"candidateOptOutEnabled":true,"interviewDuration":123,"desktopOnly":true,"showCaptions":true,"retakesAllowed":123,"customQuestions":[{}],"screeningQuestions":[{}],"postInterviewQuestions":[{}],"tags":[{}],"introVideoUrl":"\u003cstring>","completionRedirectUrl":"\u003cstring>","webhookConfig":{}}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"interviewflowai","siteName":"InterviewFlowAI Knowledge Base","title":"Create an Interviewer - InterviewFlowAI Knowledge Base","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T18:40:25.914Z","originalFileLocation":"api-reference/interviewers/create.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=\"Create an Interviewer with its full interview setup.\">\u003cmeta data-mint-head name=\"application-name\" content=\"InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_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/interviewflowai/fm_oLBQTYOxe_7Ed/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an Interviewer - InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create an Interviewer with its full interview setup.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.interviewflowai.com/api-reference/interviewers/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://interviewflowai.mintlify.site/_mintlify/api/og/v2?division=Interviewers\u0026amp;title=Create+an+Interviewer\u0026amp;description=Create+an+Interviewer+with+its+full+interview+setup.\u0026amp;theme=529d83cbab2ef6e2d0e572c0\u0026amp;signature=c2249f1bfc0ff0935bcbebe5a5c08b7b4d32ca424d05f1cbf5c675e920bdd866\">\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=\"Create an Interviewer - InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create an Interviewer with its full interview setup.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://interviewflowai.mintlify.site/_mintlify/api/og/v2?division=Interviewers\u0026amp;title=Create+an+Interviewer\u0026amp;description=Create+an+Interviewer+with+its+full+interview+setup.\u0026amp;theme=529d83cbab2ef6e2d0e572c0\u0026amp;signature=c2249f1bfc0ff0935bcbebe5a5c08b7b4d32ca424d05f1cbf5c675e920bdd866\">\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/interviewflowai/fm_oLBQTYOxe_7Ed/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"InterviewFlowAI Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B50D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.interviewflowai.com/api-reference/interviewers/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/interviewers/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.interviewflowai.com/#organization\",\"name\":\"InterviewFlowAI Knowledge Base\",\"url\":\"https://docs.interviewflowai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/interviewflowai/3Gmnw_L8IR0faXhJ/logo/logo.png?fit=max\u0026auto=format\u0026n=3Gmnw_L8IR0faXhJ\u0026q=85\u0026s=2eefa6ed5f15b3b9fe696130b4e91d1a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.interviewflowai.com#website\",\"name\":\"InterviewFlowAI Knowledge Base\",\"url\":\"https://docs.interviewflowai.com\",\"publisher\":{\"@id\":\"https://docs.interviewflowai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.interviewflowai.com/api-reference/interviewers/create#webpage\",\"url\":\"https://docs.interviewflowai.com/api-reference/interviewers/create\",\"name\":\"Create an Interviewer\",\"description\":\"Create an Interviewer with its full interview setup.\",\"dateModified\":\"2026-11-15T18:40:25.914Z\",\"isPartOf\":{\"@id\":\"https://docs.interviewflowai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.interviewflowai.com/api-reference/interviewers/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.interviewflowai.com/api-reference/interviewers/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"InterviewFlowAI Knowledge Base\",\"item\":\"https://docs.interviewflowai.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an Interviewer\",\"item\":\"https://docs.interviewflowai.com/api-reference/interviewers/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.interviewflowai.com/api-reference/interviewers/create#apireference\",\"headline\":\"Create an Interviewer\",\"name\":\"Create an Interviewer\",\"description\":\"Create an Interviewer with its full interview setup.\",\"url\":\"https://docs.interviewflowai.com/api-reference/interviewers/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.interviewflowai.com/api-reference/interviewers/create#webpage\"},\"dateModified\":\"2026-11-15T18:40:25.914Z\",\"publisher\":{\"@id\":\"https://docs.interviewflowai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.interviewflowai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"InterviewFlowAI Knowledge Base\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"InterviewFlowAI Knowledge Base\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/interviewers/create.md","siteName":"InterviewFlowAI Knowledge Base","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://interviewflowai.com/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"ATS \u0026 Integrations","pages":[{"title":"ATS \u0026 Integrations","href":"/platform/integrations"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API overview","icon":"code","href":"/api-reference/introduction"}]},{"group":"Developer setup","pages":[{"title":"API keys","icon":"key","href":"/platform/api-keys"},{"title":"Connect an AI assistant","icon":"server","href":"/platform/mcp"},{"title":"Webhooks","icon":"webhook","href":"/platform/webhooks"},{"title":"Custom integrations","description":"Connect a hiring tool that has no built-in integration, with help from a developer on your team.","icon":"code","href":"/platform/api-integration/overview"}]},{"group":"Interviewers","pages":[{"title":"Create an Interviewer","api":"POST /api/external/ingest/job","href":"/api-reference/interviewers/create"},{"title":"Update an Interviewer","description":"Change only the Interviewer settings you send.","api":"PUT /api/external/ingest/job/{jobId}","href":"/api-reference/interviewers/update"}]},{"group":"Candidates","pages":[{"title":"Invite a Candidate","api":"POST /api/external/ingest/candidate","href":"/api-reference/candidates/invite"},{"title":"Invite Candidates in bulk","api":"POST /api/external/ingest/interview","href":"/api-reference/candidates/invite-bulk"},{"title":"List Candidates","api":"POST /api/external/fetch/candidates","href":"/api-reference/candidates/list"},{"title":"Update a Candidate","api":"PUT /api/external/interview","href":"/api-reference/candidates/update"},{"title":"Update custom fields","api":"PATCH /api/external/custom-fields","href":"/api-reference/candidates/update-custom-fields"}]},{"group":"Requests we send you","pages":[{"title":"Webhook events","icon":"webhook","href":"/api-reference/webhook-events"}]}]}]},"basePath":"","title":"Create an Interviewer - InterviewFlowAI Knowledge Base","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js"]}