announce_appointment
ChatGPTEnd of a search: the appointment announcement for LinkedIn. A post for the firm, a post for the lead consultant and the graphic in three sizes. Costs 1 credit. Use only once the client has agreed the appointment can be announced; the organisation is named as you give it (give a description instead if it must stay confidential). A quote is used word for word. Reuse request_id on a retry: no second charge. Formatix drafts the posts and graphics; nothing is posted.
ats_add_note
ChatGPTAdd a note to a candidate or a job in the user's connected ATS or CRM. Only when the user asks, after they saw the wording. Free. Pass one of candidate_id or job_id.
ats_attach_document
ChatGPTAttach a document Formatix made (record_id) to a candidate or a job in the user's connected ATS or CRM. Only when the user asks, after they confirm which record. Free. Pass one of candidate_id or job_id.
ats_connections
ChatGPTThe ATS or CRM systems the user connected to Formatix (system = jobadder, hubspot, salesforce or ezekia). Call it first; the user connects a system on the Integrations page in Formatix. Read-only.
ats_find_candidates
ChatGPTFind candidates or contacts by name in the user's connected ATS or CRM. Returns ids, names and current roles, never contact details. Read-only.
ats_find_jobs
ChatGPTFind open jobs in the user's connected ATS (JobAdder jobs, Ezekia projects). HubSpot and Salesforce have no jobs. Read-only.
ats_get_job
ChatGPTRead one job from the user's connected ATS. Read-only.
check_template_status
ChatGPTCheck a template being built with create_template_from_file: 'processing', 'ready' or 'failed', with its fields when ready. Read-only.
create_launch_announcement
ChatGPTWrite the "we have been retained" LinkedIn announcement for a search: two understated posts plus the brand graphic in three sizes (1:1, 4:5, 1.91:1). Costs 1 credit. brief as for render_search_document; for a confidential search set brief.confidential = true, client_name and client_descriptor - the client is never named. Formatix drafts the posts and graphics; nothing is posted. Pass a request_id and reuse it on a retry.
create_role_briefing_video
ChatGPTStart a branded role-briefing video for a search (brand cards, voiceover, captions; 16:9, 1:1 and 9:16). Clean style costs 1.5 credits (0.5 now for the storyboard, 1.0 when rendered in Formatix). Returns the job; the storyboard is reviewed and rendered in Formatix, then check get_video_status. Confidential briefs never name the client.
create_template_from_file
ChatGPTBuild a new template from the user's own Word (.docx), PowerPoint (.pptx) or Excel (.xlsx) file, attached in this conversation: their firm's candidate profile, CV layout, shortlist deck or tracker. Formatix keeps the file's design (fonts, colours, logos, layout), finds where the candidate details go and writes the extraction rules, so CVs can then be formatted into it. - template_file: the attached file. - title: optional name for the template. Uses 1 credit from the user's Formatix account. Building takes a few minutes: returns template_id; call check_template_status, then format_cv with template_type 'user_template'. Only use files the user attached and asked to turn into a template.
edit_formatted_cv
ChatGPTChange a formatted CV the way the user asks (rewrite a summary, correct a date, add a qualification, reorder roles, shorten text ...) and get the document built again in the same template. You decide the new wording; Formatix only fills the template again. - changes: a list of {"candidate_index": 0, "details": {<field>: <new value>}}, using the field names and shape from get_cv_details. Send only the fields that change (a list field is sent whole). The same candidate only: the name cannot change and at most about a fifth of the text may change; up to 3 changes per document (a bigger change is a new CV: fill_template or format_cv). Free, no credits. Earlier versions are kept in Formatix. Templates, prompts and schemas are never changed. Not for Studio documents (template_type 'user_template').
fill_template
ChatGPTFill one of the user's Formatix templates with candidate details YOU read from the CVs, following the template's own extraction prompt and schema (get_template_schema), and get a download link. Formatix does not read the CVs again: it puts your details into the firm's template file (fonts, colours, layout, logos) exactly as the platform does, and keeps them so you can change the document later (edit_formatted_cv). - candidates: a list with one object per candidate, keyed by the schema's field names. A 'cvtobios' template puts up to 10 candidates in one document (Word, PowerPoint shortlist or Excel tracker); a 'custom' template holds one candidate, and so does a Word 'user_template' (a template the user built from their own file). Studio documents ('user_template') cannot be changed afterwards with edit_formatted_cv. - photo_urls: optional public photo links, in the same order as candidates ("" for none). - output_format: 'docx' (default), 'pptx' or 'xlsx', when the template has that format. Uses 1 credit per candidate. Pass a request_id and reuse it if you retry: nothing is filled or charged twice. Not for corrections: to change a document already made use edit_formatted_cv (free). A candidate's name cannot be changed; filling again for that is a new document with new credits, only when the user asks after hearing so. Formatix refuses (looks_like_correction) a fill of the same candidate in the same template within the hour; confirm_new_document=true only after the user agreed to the new charge.
find_template
ChatGPTFind the template in the user's Formatix account that best fits a plain-language request, for example "a one-page executive candidate bio" or "the shortlist deck for the London office". Returns up to 3 matches, best first, each with id, name, type, formats and a reason, including templates the user built themselves (type 'user_template'). Read-only and uses no credits. Ask the user which one to use, then format_cv with its id and type.
format_cv
ChatGPTFormat a candidate's CV into one of the user's Formatix templates on Formatix's servers and return a download link (Word, or PowerPoint/Excel when the template has that format). - Give the CV in exactly one of: cv_file, the CV file the user attached (PDF, Word .docx/.doc or plain text; Formatix reads it itself), or cv_text, the CV's full text exactly as the user pasted it. Never summarise, rewrite or add to it. - template_id and template_type ('cvtobios', 'custom' or 'user_template'): from find_template, list_templates, check_template_status or refine_template. 'user_template' is a template the user built from their own file. - output_format: 'docx' (default), 'pptx' or 'xlsx', only when the template lists that format. - candidate_name: used for the file name. Uses 1 credit from the user's Formatix account. Formatting takes from about 30 seconds to a few minutes: this waits up to a minute, then returns record_id for get_formatted_cv. Pass a request_id of your choosing and reuse it if you retry: the job already started comes back and the CV is not formatted or charged twice.
get_activity
ChatGPTWhat assistants formatted on this account recently, how many CVs today and the daily limit the user set. The user sets the limit in Formatix; it cannot be changed here. Read-only.
get_cv_details
ChatGPTThe details a formatted CV was filled with, per candidate (candidate_index, name, details keyed by the template's field names), whether the photo can be changed and how many changes are left. Works for documents made with fill_template, or format_cv with a cvtobios or custom template (and on the platform); not for Studio documents (template_type 'user_template'), whose ids are not record ids. Read before edit_formatted_cv. Read-only.
get_formatted_cv
ChatGPTCheck a CV formatting job started with format_cv: status 'Processing', 'Formatted' or 'Failed', and a download link when ready (call again for a fresh one). Pass template_type 'user_template' when the job used one of the user's own templates. Read-only.
get_my_template_file
ChatGPTA 24-hour download link to the template file of one of the user's OWN templates (one they or you built: type 'cvtobios' marked own, or 'user_template'), so you can fill it in the conversation with its prompt and fields. Templates set up for the firm are preview-only and are refused: format CVs with them through format_cv. Read-only.
get_refine_status
ChatGPTCheck a template change started with refine_template that was still running: status (queued, running, done or failed), the editor's reply, the new version number and preview pages when done. Pass template_type 'cvtobios' for a template saved with push_designed_template. Read-only.
get_template_design_guide
ChatGPTThe rules for turning the user's own document into a Formatix template: where fields and loops go, how to keep their design, how to write the extraction prompt and schema. Read-only.
get_template_schema
ChatGPTShow what a template needs: its extraction prompt (what Formatix takes from a CV) and its fields, for a template the user can use (template_type 'cvtobios', 'custom' or 'user_template', from find_template or list_templates). Use it to understand a template before formatting a CV or refining it. Read-only and uses no credits.
get_video_status
ChatGPTStatus of a role-briefing video job, with download links for 16:9, 1:1, 9:16 and captions when ready.
list_brand_kits
ChatGPTList the user's brand kits (the firm's own and any client brands). Pass a kit's id as kit_id to create a document in that brand; without kit_id the firm's confirmed brand is used. Read-only.
list_templates
ChatGPTList the templates in the user's Formatix account (their firm's templates): id, name, type and output formats. Read-only and uses no credits.
push_designed_template
ChatGPTSave a template you designed from the user's own Word, PowerPoint or Excel document: their file with the candidate's details replaced by fields, plus the extraction prompt and schema (call get_template_design_guide first). Formatix checks it: if a tag would not fill, nothing is saved and 'problems' says what to fix. On success it returns template_id (template_type 'cvtobios'), the fields and preview pages filled with an invented candidate. - template_file: the designed file, or template_file_base64 + filename (max 5 MB). - template_format: 'docx', 'pptx' or 'xlsx'. - extraction_prompt, schema: as text. Pass a request_id and reuse it on a retry: the template is not saved twice. Uses no credits.
refine_template
ChatGPTChange one of the user's own templates with a plain-language instruction, for example "add a languages section", "put the photo on the right" or "use the client's navy for headings". Uses no credits. - template_id: the template to change. template_type: 'user_template' (default), or 'cvtobios' for a template saved with push_designed_template. Only the user's own templates can be changed; templates Formatix set up for the firm are refused. - instruction: what to change, in the user's words. - request_id: any id of your choosing; reuse it if you retry and the change is not made twice. How the change is saved depends on the template: - Built from the user's Word, PowerPoint or Excel file: Formatix's template editor changes it in place. The template_id stays the same, the version number goes up and every earlier version is kept in Formatix. This waits up to a minute, then returns the editor's reply, the new version number and preview pages filled with an invented candidate, or a job_id to check with get_refine_status. - Any other own template: the change is saved as a new copy and the original stays unchanged. The reply gives the copy's template_id; use it with format_cv.
render_search_document
ChatGPTRender a branded executive-search document (Word/PowerPoint + PDF) in your firm's brand, or a client's brand via kit_id. template_key: - "position-specification" (1 credit): drafted from the brief. brief keys: role (required), jd_text, location, salary, reporting_line, must_haves[], organisation_overview, search_reference, consultants[{name,title,email,phone}], apply_url. Uses only facts in the brief. - "shortlist-deck" (0.5 credits): pass candidates[{name, current_role, current_company, location, summary_points[], fit[{criterion, rating 1-5}], readiness, notice, compensation}]. - "search-progress-report" (0.5 credits): pass funnel[{stage,count}], pipeline_rows[{candidate, employer, stage, status, next_step}], notes{glance_summary, search_stage, prepared_by, market_themes[], risks[], next_steps[]}. - "interview-pack" (0.5 credits): pass payload with the interview pack fields. - "appointment-brief" (1 credit): the published candidate pack, drafted from the brief, with a letter from your firm. Extra brief keys: closing_date, key_dates[{stage, date}] or "stage - date" lines, how_to_apply, diversity_statement. The result includes "content": keep it for the next three. - "linkedin-carousel" (0.5 credits): pass payload = the appointment brief's content: a PDF of 4:5 slides to post on LinkedIn as a document. - "role-teaser" (0.5 credits): pass payload = the appointment brief's content: a one-page Word/PDF for direct approaches; on a confidential search the client is described, never named. Confidential searches: set brief.confidential = true with client_name (used only to check the output, never sent to the AI) and client_descriptor (how the client is described instead). Returns download links. A document can take up to a few minutes. Pass a request_id of your choosing and reuse it if you retry after a timeout: the earlier result comes back and you are not charged twice.
set_candidate_photo
ChatGPTPut a new candidate photo into a formatted CV and build the document again (free; one of its 3 changes). - photo_url: a public link to the photo (JPEG or PNG). Without one, this returns a Formatix page where the user uploads the photo themselves - use that when the user attached the photo to this chat. - candidate_index: which candidate (from get_cv_details), 0 for a single-candidate document. - photo_file: the photo the user attached in ChatGPT (use it instead of photo_url).
announce_appointment
Claudecheck_template_upload_status
Claudecreate_launch_announcement
Claudecreate_platform_template
Claudecreate_template
Claudecreate_template_with_file
Claudedownload_template_file
Claudefind_template
Claudeget_custom_template_detail
Claudeget_refine_status
Claudeget_template_html
Claudeget_template_schema
Claudelist_brand_kits
Claudelist_custom_templates
Claudelist_templates
Claudepublish_appointment_page
Clauderender_custom_template
Clauderender_search_document
Claudetemplate_chat
Claudeupdate_custom_template
Claudeupdate_template_html
Claudeupload_custom_template
Claude