Skip to main content
POST
This endpoint is AI-powered and rate limited to 5 requests/minute. 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. Pass directly to Initiate AI Call as instructions.
  • extract_variables — Structured data fields the AI should extract during the call. Pass directly to Initiate AI Call as extract_variables.

Authorizations

string | header
required
API key of the form <token>, passed as the x-tidyhire-api-key header.

Body

string
required
Name of the company.Example: "Acme Corp"
string
required
The main task or goal for the AI call. Describes what the AI should accomplish.Example: "Screen candidates for the Senior Software Engineer position and assess their experience with distributed systems."
string[]
Specific questions the AI should ask during the call.Example:
object[]
Frequently asked questions and their answers to help the AI respond accurately.
boolean
If true, the AI automatically ends the call when a candidate is disqualified based on screening criteria. Defaults to false.

Response

AI call script generated successfully
boolean
Indicates if the request was successful. Example: true
object

Common Errors

Reason: The request body is not valid JSON.