Run your hiring pipeline from your AI assistant

Sessions in your workspace, newest first.

querystring

Filter by name.

pageintegerdefault 1

Page number.

page_sizeintegerdefault 20

Up to 100.

Returns Sessions with id, name, type, duration, status and apply link.

“Which sessions do we have running?”

One session with all of its settings.

session_idstringrequired

Session id.

Returns Instructions, questions, phases, voice, language, duration, recording and anti-cheat settings.

“Show me the questions in the Front desk screen.”

Valid values for create_session and update_session.

languagestring

Only voices that speak this language, e.g. es-ES.

Returns Languages, durations, voices (with preview links), assessment blocks and plan limits.

“Which Spanish voices can I use?”

Applications across your workspace or one session, filtered and paginated.

session_idstring

Only this session.

statusstring[]

e.g. completed, scheduled, imported, idle.

min_scorenumber

Only scores at or above this (0–100).

searchstring

Name or email contains.

include_archivedbooleandefault false

Include archived applications.

sort"created_at" | "completed_at" | "score"default created_at

Sort field.

order"desc" | "asc"default desc

Sort order.

pageintegerdefault 1

Page number.

page_sizeintegerdefault 20

Up to 100.

Returns { items, page, page_size, total, has_more } — each item has the applicant, status, score and dates.

“Who are the top 5 applicants for Front desk this week?”

One application in full.

application_idstringrequired

Application id.

Returns Scores per question and assessment, summary, transcript link and recording view link.

“Why did Maya score 92?”

Recorded conversations you're allowed to watch.

session_idstring

Only this session.

include_media_urlsbooleandefault true

Include signed video links.

pageintegerdefault 1

Page number.

page_sizeintegerdefault 20

Up to 50.

Returns Each item: application_id, candidate, completed_at, view_url (opens the recording in the Greet app; workspace sign-in required) and media_url (signed video link, expires in 1 hour).

“Open the recording of Maya's interview.”

Create a session with the same settings as the session editor in the app.

namestringrequired

Shown to applicants.

instructionsstringrequired

What the AI should do and look for.

questions{ text, max_score }[]

Asked in order. Up to 30; max_score defaults to 10.

descriptionstring

Internal description.

session_type"company-job-interview" | "general" | "presentation"default company-job-interview

Kind of conversation.

introstring

First line the AI says.

duration_minutes5 | 10 | 15 | 30default 5

10 needs a Pro plan; 15 and 30 need extended sessions.

language"en-US" | "es-ES" | "fr-FR" | "de-DE" | "pt-PT" | "cmn-CN" | "ka-GE"default en-US

Spoken language.

voice_idstring

From list_session_options; default voice if empty.

recordingbooleandefault false

Record audio and video (Pro plan).

camera_requiredbooleandefault false

Applicant can't start until their camera is on.

block_copy_pastebooleandefault false

No copying or pasting during the session.

hide_transcriptionbooleandefault false

Hide the live transcript.

enable_text_inputbooleandefault false

Let applicants type answers.

push_to_talkbooleandefault true

Applicants hold a button to speak (more reliable).

allow_interruptionbooleandefault true

Applicants can talk over the AI.

show_feedbackbooleandefault false

Show applicants their results at the end.

phases{ phase, label, percentage, instruction }[]

Introduction / middle / conclusion split; percentages add up to 100.

steps{ label, description?, goal? }[]

Visible form steps, up to 8 (e.g. Background, Financials, Contact info). The call screen shows the current step in the top corner, and the AI moves it on as it goes. goal tells the AI what to find out and is never shown. [] removes them.

assessment_blocksstring[]

Keys from list_session_options; default is the standard set (match rate, key points, summary…).

use_realtime_modelbooleandefault false

Native speech-to-speech model.

realtime_provider"openai" | "google"default openai

With use_realtime_model.

publishbooleandefault true

Publish right away, or keep as a draft.

Returns The session, its apply link and a ready-to-paste widget snippet.

“Create a 10-minute Spanish voice screen for medical receptionists and give me the widget code.”

Change any setting of an existing session.

session_idstringrequired

Session id.

…

Any create_session field. Only the fields you pass change.

Returns The updated session. With publish: false the change is saved as a draft and the live session stays as it was.

“Require camera on the Front desk screen and add a question about night shifts.”

Email people a link to a session. Built not to spam.

session_idstringrequired

Session to invite to.

applicants{ name, email, phone? }[]required

Up to 50 per call.

dry_runbooleandefault false

Show who would be invited and who skipped, without sending.

Returns { invited[], skipped[{ email, reason }] } — reasons: already_invited, already_applied, duplicate_in_request, invalid_email, daily_limit, failed. Also remaining_today.

“Invite these 12 people from my spreadsheet to the Front desk screen.”

Re-run scoring and the summary, e.g. after you changed the questions.

application_idsstring[]required

Up to 50.

Returns { queued, skipped[{ id, reason }] } — reasons: not_found, not_completed, cooldown. Each application can be re-analyzed once every 10 minutes.

“Re-score everyone who applied to Front desk yesterday.”