Call get_resume_format once before your first create_resume or update_resume. It
returns the exact document shape plus the available templates, fonts and writing guidance,
so what you build validates the first time.
update_resume with data replaces the whole document. Read it with get_resume,
modify the JSON you get back, and send all of it. Sending only the section you changed
deletes the rest.
preview_resume_text renders and estimates length
without saving anything, and export_resume_pdf reports the page count measured from the
rendered document rather than estimated.
The document contract → · Publishing and exporting →
The descriptions below are quoted verbatim from what the server sends a connected
assistant, which is why they address it rather than you. They are reproduced rather than
rewritten so this page cannot drift from what your assistant actually receives.
list_resumes
List resumes
All saved resumes with their target role/company, how many applications each is attached to, and publicUrl — the shareable link, or null if that resume isn’t published.
No arguments.
get_resume
Get a resume
Fetch one resume: its settings, its full document JSON, and publicUrl — the shareable link, or null if it isn’t published. Read this before update_resume, which replaces the whole document.
create_resume
Create a resume
Create a resume. Either pass a complete data document you have written (call get_resume_format first), or pass seedFromBrain: true to auto-populate a first draft from the knowledge base and then refine it with update_resume.
update_resume
Update a resume
Update a resume’s settings and/or replace its document. Passing data replaces the ENTIRE document, so call get_resume first, modify the JSON you get back, and send the whole thing.
Overwrites or deletes.
export_resume_pdf
Export a resume as a PDF
Render a resume to a real PDF on the server and return a download url, plus how many pages it actually came out to. Reach for this when the user wants a FILE to attach to an email or upload to a form — use publish_resume instead when they want a link. The page count is measured from the rendered document rather than estimated, so it is the reliable way to answer ‘does this fit on one page?’ before they send it. The url opens in their browser, where they are already signed in; it is not a public link and nobody else can fetch it. If this instance has no headless browser the tool says so and points at the print page, which produces the same document through the browser’s own print dialog.
publish_resume
Publish a resume to a public link
Give a resume a shareable web address. Reach for this whenever the user needs a LINK rather than a file — an application form with a ‘portfolio or resume URL’ field, a recruiter asking them to send something over, a message where attaching a PDF would be awkward. Returns publicUrl, which is the whole point: hand it straight to the user. Anyone with the link can read the resume without signing in, and the link is the only protection, so it is long and random — it cannot be guessed or found by searching, and the page tells search engines not to index it. The user’s private notes on the resume are never shown — but if this resume has showPhoto on, their face is on that page, visible to anyone holding the link. Say so before publishing one, or offer to turn the photo off first. Calling this again while the resume is already published returns the SAME url, so it is safe to repeat. If the resume was previously unpublished, publishing mints a brand new url and the old one stays dead.
unpublish_resume
Withdraw a resume’s public link
Turn off a resume’s public link. Reach for this when the user is done with a link, or has sent one somewhere they regret. The page starts returning ‘not found’ immediately for everyone who has the url. This is PERMANENT for that address: the link is not parked or paused, it is destroyed, and publishing the same resume later produces a different url. Say so before doing it if the user might still need the old link working. Does not touch the resume itself — nothing is deleted.
Overwrites or deletes.
duplicate_resume
Duplicate a resume
Copy an existing resume so you can tailor a variant without losing the original. The usual flow for a new application.
delete_resume
Delete a resume
Permanently delete a resume.
Overwrites or deletes.
preview_resume_text
Preview a resume document as text
Render a resume document JSON to plain text WITHOUT saving it, and estimate how many lines it will occupy. Use it to check length and flow before committing with create_resume or update_resume.
