Skip to main content
POST
Generate AI Call Script
This endpoint is AI-powered. It generates AI call instructions and a structured data extraction plan based on your company details, task prompt, questions, and FAQs.

What it returns

  • instructions — AI behavior instructions for the call. These can be passed directly to the Initiate AI Call endpoint as the instructions field.
  • extract_variables — Structured data fields the AI should extract during the call. These can be passed directly to the Initiate AI Call endpoint as the extract_variables field.

Example Request

Example Response

Authorizations

x-tidyhire-api-key
string
header
required

Your Tidyhire API key

Body

application/json
company_name
string
required

Name of the company.

Minimum string length: 1
Example:

"Acme Corp"

prompt
string
required

The main task or goal for the AI call. Describes what the AI should accomplish.

Minimum string length: 1
Example:

"Screen candidates for the Senior Software Engineer position and assess their experience with distributed systems."

questions
string[]

Specific questions the AI should ask during the call.

Minimum string length: 1
Example:
faqs
object[]

Frequently asked questions and their answers to help the AI respond accurately.

Example:
end_call_on_disqualification
boolean
default:false

If true, the AI will automatically end the call when a candidate is disqualified based on screening criteria.

Example:

false

Response

Success.

success
boolean
Example:

true

data
object
Last modified on May 28, 2026