ResumlyClient¶

The main entry point for all SDK operations.

ResumlyClient ¶

ResumlyClient(api_key: str, base_url: str = _DEFAULT_BASE_URL, timeout: int = 180, max_retries: int = 3)

Official Python client for the Resumly API.

Every user-facing endpoint in Resumly is accessible through this client. Authenticate with an API key created from your Resumly dashboard.

Parameters:

Name	Type	Description	Default
`api_key`	`str`	Your Resumly API key (starts with `rly_`).	required
`base_url`	`str`	Override the API base URL (useful for local development).	`_DEFAULT_BASE_URL`
`timeout`	`int`	HTTP request timeout in seconds. Defaults to 180.	`180`
`max_retries`	`int`	Auto-retry on 429 (rate limit). Defaults to 3.	`3`

upload_base_resume ¶

upload_base_resume(file_path: Union[str, Path]) -> dict

Upload a PDF or DOCX as your base resume.

get_base_resume ¶

get_base_resume() -> dict

Get the parsed JSON of your base resume.

update_base_resume ¶

update_base_resume(resume_data: dict) -> dict

Update your base resume with new JSON data.

improve_base_resume ¶

improve_base_resume(comments: str) -> dict

Improve base resume based on feedback.

translate_base_resume ¶

translate_base_resume(target_language: str) -> dict

Translate base resume to a target language.

generate_base_resume_docx ¶

generate_base_resume_docx(resume_data: dict = None) -> bytes

Generate a Word document from the base resume.

freeze_base_resume_element ¶

freeze_base_resume_element(element_path: str, freeze: bool = True) -> dict

Freeze or unfreeze a base resume element.

get_locked_elements ¶

get_locked_elements() -> dict

Get all locked elements in the base resume.

generate_base_resume_pdf ¶

generate_base_resume_pdf(path: Union[str, Path] = None) -> bytes

Download the base resume as a PDF.

Parameters:

Name	Type	Description	Default
`path`	`str or Path`	If provided, save the PDF to disk.	`None`

create_api_key ¶

create_api_key(name: str = None) -> dict

Create a new API key.

Parameters:

Name	Type	Description	Default
`name`	`str`	A friendly name/label for the key.	`None`

list_api_keys ¶

list_api_keys() -> dict

List all API keys (masked).

revoke_api_key ¶

revoke_api_key(key_id: str) -> dict

Revoke an API key.

Parameters:

Name	Type	Description	Default
`key_id`	`str`	The ID of the key to revoke.	required

get_profile ¶

get_profile() -> dict

Get user profile information.

update_profile ¶

update_profile(email: str, **fields) -> dict

Update user profile fields (name, location, etc.).

upload_profile_picture ¶

upload_profile_picture(file_path: Union[str, Path]) -> dict

Upload a profile picture.

get_user_settings ¶

get_user_settings() -> dict

Get all user settings.

update_user_settings ¶

update_user_settings(settings: dict) -> dict

Update user settings (language, tone, style, etc.).

reset_style_settings ¶

reset_style_settings() -> dict

Reset resume style settings to defaults.

add_always_show_skill ¶

add_always_show_skill(skill: str) -> dict

Add a skill to the always-show list.

remove_always_show_skill ¶

remove_always_show_skill(skill: str) -> dict

Remove a skill from the always-show list.

add_never_show_skill ¶

add_never_show_skill(skill: str) -> dict

Add a skill to the never-show list.

remove_never_show_skill ¶

remove_never_show_skill(skill: str) -> dict

Remove a skill from the never-show list.

replace_always_show_skills ¶

replace_always_show_skills(skills: List[str]) -> dict

Replace the entire always-show skills list.

replace_never_show_skills ¶

replace_never_show_skills(skills: List[str]) -> dict

Replace the entire never-show skills list.

add_can_show_skill ¶

add_can_show_skill(skill: str) -> dict

Add a skill to the can-show list.

remove_can_show_skill ¶

remove_can_show_skill(skill: str) -> dict

Remove a skill from the can-show list.

replace_can_show_skills ¶

replace_can_show_skills(skills: List[str]) -> dict

Replace the entire can-show skills list.

get_job_preferences ¶

get_job_preferences() -> dict

Get job preferences.

update_job_preferences ¶

update_job_preferences(preferences: dict) -> dict

Update all job preferences.

update_job_preference ¶

update_job_preference(key: str, value: Any) -> dict

Update a single job preference.

delete_job_preference ¶

delete_job_preference(key: str) -> dict

Delete a specific job preference.

get_autofill_attributes ¶

get_autofill_attributes() -> dict

Get autofill attributes for job applications.

set_autofill_attributes ¶

set_autofill_attributes(attributes: dict) -> dict

Set autofill attributes.

get_custom_instructions ¶

get_custom_instructions() -> dict

Get custom instructions for resume generation.

set_custom_instructions ¶

set_custom_instructions(text: str) -> dict

Set custom instructions for resume generation.

get_memory ¶

get_memory() -> dict

Get all stored memory points.

clear_memory ¶

clear_memory() -> dict

Clear all memory.

delete_memory_point ¶

delete_memory_point(index: int) -> dict

Delete a specific memory point by index.

check_credit ¶

check_credit(email: str) -> dict

Check credit balance.

check_subscription ¶

check_subscription(email: str) -> dict

Check subscription status.

get_statistics ¶

get_statistics(queue_statistics: bool = False) -> dict

Get user statistics.

get_credit_utilization ¶

get_credit_utilization() -> dict

Get credit utilization history.

get_credit_charges_catalog ¶

get_credit_charges_catalog() -> dict

List standard credit costs and descriptions per operation.

get_ai_insights ¶

get_ai_insights() -> dict

Get AI insights for resume applications.

trigger_ai_insights ¶

trigger_ai_insights() -> dict

Trigger AI insights recalculation.

get_ai_insights_jobs ¶

get_ai_insights_jobs() -> dict

Get AI insights for job database.

trigger_ai_insights_jobs ¶

trigger_ai_insights_jobs() -> dict

Trigger AI insights recalculation for jobs.

get_application_flow ¶

get_application_flow() -> dict

Get application flow data for Sankey chart.

get_resume_timeline ¶

get_resume_timeline() -> dict

Get resume creation timeline analytics.

get_resume_distribution ¶

get_resume_distribution() -> dict

Get resume distribution analytics.

list_recent_resumes ¶

list_recent_resumes(days: int = None, favorites_only: bool = False, queue_only: bool = False, page: int = None, page_size: int = 10) -> dict

List recent resumes with optional filters.

create_resume ¶

create_resume(*, job_url: str = None, job_description: str = None, cover_letter: bool = False, interview_question: bool = False, source: str = 'api') -> dict

Create a tailored resume. Provide job_url OR job_description.

Returns the job_id which you use for all subsequent operations. This is a two-step process: init + create (handled automatically).

get_resume ¶

get_resume(job_id: str) -> dict

Get the final tailored resume JSON.

update_resume ¶

update_resume(job_id: str, resume_data: dict) -> dict

Update a final resume with new data.

get_resume_comparison ¶

get_resume_comparison(job_id: str) -> dict

Get base vs. tailored resume comparison.

get_resume_metadata ¶

get_resume_metadata(job_id: str) -> dict

Get resume metadata (company, title, skills, etc.).

get_resume_insights ¶

get_resume_insights(job_id: str) -> dict

Get AI-generated insights for a resume.

regenerate_insights ¶

regenerate_insights(job_id: str) -> dict

Regenerate AI insights for a resume.

delete_resume ¶

delete_resume(job_id: str) -> dict

Delete a tailored resume.

download_resume ¶

download_resume(s3_url: str, path: Union[str, Path] = None) -> bytes

Download a resume file from its S3 URL.

Parameters:

Name	Type	Description	Default
`s3_url`	`str`	The `resume_file_path` / `download_url` from resume data.	required
`path`	`str or Path`	If provided, save the file to disk.	`None`

export_resume_pdf ¶

export_resume_pdf(job_id: str, document_type: str = 'resume', path: Union[str, Path] = None) -> bytes

Export resume or cover letter as PDF.

regenerate_resume ¶

regenerate_resume(job_id: str) -> dict

Regenerate a tailored resume.

update_job_info ¶

update_job_info(job_id: str, **fields) -> dict

Update job info on a resume.

set_resume_model ¶

set_resume_model(job_id: str, model: str) -> dict

Change the LLM model used for a resume.

Parameters:

Name	Type	Description	Default
`job_id`	`str`	The resume/job ID.	required
`model`	`str`	Model identifier (e.g. `"gpt-4o"`, `"claude-sonnet"`).	required

regenerate_with_model ¶

regenerate_with_model(job_id: str) -> dict

Regenerate a resume preview using the currently selected model.

map_key_skill ¶

map_key_skill(job_id: str, skill: str, **kwargs) -> dict

Map or normalize a key skill on a resume.

create_cover_letter ¶

create_cover_letter(job_id: str) -> dict

Create a cover letter for a resume.

get_cover_letter ¶

get_cover_letter(job_id: str) -> dict

Get the cover letter for a resume.

update_cover_letter ¶

update_cover_letter(job_id: str, data: dict) -> dict

Update a cover letter.

regenerate_cover_letter ¶

regenerate_cover_letter(job_id: str) -> dict

Regenerate a cover letter.

create_interview_questions ¶

create_interview_questions(job_id: str) -> dict

Generate interview questions based on a resume.

get_interview_questions ¶

get_interview_questions(job_id: str) -> dict

Get interview questions for a resume.

check_interview_answer ¶

check_interview_answer(job_id: str, question: str, answer: str) -> dict

Check an interview answer.

rephrase_resume ¶

rephrase_resume(job_id: str, text: str, **kwargs) -> dict

Rephrase resume content with multiple options.

translate_resume ¶

translate_resume(job_id: str, target_language: str) -> dict

Translate a tailored resume.

improve_resume ¶

improve_resume(job_id: str, user_comment: str) -> dict

Improve a tailored resume based on feedback.

chat_with_resume ¶

chat_with_resume(job_id: str, message: str) -> dict

Chat with your resume (AI-assisted editing).

generate_bullet_points ¶

generate_bullet_points(**kwargs) -> dict

Generate bullet points for resume content.

rephrase_text ¶

rephrase_text(text: str, **kwargs) -> dict

Rephrase arbitrary text (user-level rephrase).

favorite_resume ¶

favorite_resume(job_id: str) -> dict

Toggle favorite status on a resume.

unfavorite_resume ¶

unfavorite_resume(job_id: str) -> dict

Remove favorite status from a resume.

add_to_queue ¶

add_to_queue(job_id: str) -> dict

Add a resume to the processing queue.

remove_from_queue ¶

remove_from_queue(job_id: str) -> dict

Remove a resume from the queue.

get_auto_apply_resumes ¶

get_auto_apply_resumes() -> dict

Get auto-apply eligible resumes.

create_public_link ¶

create_public_link(job_id: str, **settings) -> dict

Create a public shareable link for a resume.

get_public_link ¶

get_public_link(job_id: str) -> dict

Get public link info for a resume.

update_public_link ¶

update_public_link(job_id: str, **settings) -> dict

Update public link settings.

delete_public_link ¶

delete_public_link(job_id: str) -> dict

Delete a public link.

research_company ¶

research_company(job_id: str) -> dict

Trigger company research for a resume's job posting.

get_company_research ¶

get_company_research(job_id: str) -> dict

Get company research results.

autofill_application ¶

autofill_application(job_id: str, fields: dict) -> dict

Autofill a job application form.

submit_autofill_feedback ¶

submit_autofill_feedback(job_id: str, feedback: dict) -> dict

Submit feedback on autofill quality.

save_change_summary ¶

save_change_summary(job_id: str, summary: str) -> dict

Save a change summary for a resume and update memory.

get_change_summaries ¶

get_change_summaries(job_id: str) -> dict

Get all change summaries for a resume.

submit_feedback ¶

submit_feedback(job_id: str, feedback: dict) -> dict

Submit feedback on a resume.

send_resume_email ¶

send_resume_email(job_id: str, **kwargs) -> dict

Send resume and/or cover letter via email.

get_inbox_status ¶

get_inbox_status() -> dict

Get inbox initialisation status.

initialize_inbox ¶

initialize_inbox(prefix: str, *, accepted_jupytermail_terms_version: str = '2026-04-05-v1') -> dict

Create a JupyterMail inbox.

Parameters:

Name	Type	Description	Default
`prefix`	`str`	Desired email prefix (e.g. `"john"` for `john@jupytermail.com`).	required
`accepted_jupytermail_terms_version`	`str`	Version string of the acceptable-use terms the end user confirmed (must match a server-allowed value).	`'2026-04-05-v1'`

check_inbox_availability ¶

check_inbox_availability(prefix: str) -> dict

Check if an inbox prefix is available.

list_emails ¶

list_emails(page: int = 1, page_size: int = 25, *, category: str = None, is_read: bool = None, search: str = None) -> dict

List inbox emails with optional filters.

Parameters:

Name	Type	Description	Default
`page`	`int`	Page number (1-based).	`1`
`page_size`	`int`	Results per page (max 100).	`25`
`category`	`str`	Filter by email category.	`None`
`is_read`	`bool`	Filter by read/unread status.	`None`
`search`	`str`	Full-text search query.	`None`

get_email ¶

get_email(email_id: str) -> dict

Get a single email (marks it as read).

toggle_email_read ¶

toggle_email_read(email_id: str, is_read: bool) -> dict

Toggle read/unread status on an email.

toggle_email_star ¶

toggle_email_star(email_id: str, is_starred: bool) -> dict

Toggle starred status on an email.

toggle_email_archive ¶

toggle_email_archive(email_id: str, is_archived: bool) -> dict

Toggle archived status on an email.

delete_email ¶

delete_email(email_id: str) -> dict

Delete an email from your inbox.

reply_to_email ¶

reply_to_email(email_id: str, *, body_html: str = None, body_text: str = None, cc: List[str] = None, bcc: List[str] = None, reply_all: bool = False, attachments: List[Dict[str, Any]] = None) -> dict

Reply to an email.

Parameters:

Name	Type	Description	Default
`email_id`	`str`	The email to reply to.	required
`body_html`	`str`	HTML body of the reply.	`None`
`body_text`	`str`	Plain-text body of the reply.	`None`
`cc`	`list of str`	CC recipients.	`None`
`bcc`	`list of str`	BCC recipients.	`None`
`reply_all`	`bool`	Reply to all recipients.	`False`

compose_email ¶

compose_email(*, to: List[str], subject: str, body_html: str = None, body_text: str = None, cc: List[str] = None, bcc: List[str] = None, attachments: List[Dict[str, Any]] = None) -> dict

Compose and send a new email.

Parameters:

Name	Type	Description	Default
`to`	`list of str`	Recipient email addresses.	required
`subject`	`str`	Email subject line.	required
`body_html`	`str`	HTML body.	`None`
`body_text`	`str`	Plain-text body.	`None`
`cc`	`list of str`	CC recipients.	`None`
`bcc`	`list of str`	BCC recipients.	`None`

get_auto_apply_ats_config ¶

get_auto_apply_ats_config() -> dict

Return ATS execution routing (server vs browser) for backend auto-apply.

get_auto_apply_eligible_jobs ¶

get_auto_apply_eligible_jobs(page: int = 1, page_size: int = 25, *, sort_by: str = 'date', saved_only: bool = False, remote_only: bool = False, match_scores: Optional[List[str]] = None, min_match_score: Optional[float] = None, max_match_score: Optional[float] = None, keyword: Optional[str] = None, queue_status: Optional[str] = None, last_n_days: Optional[int] = None, date_from: Optional[str] = None, date_to: Optional[str] = None, has_salary_info: Optional[bool] = None, work_arrangement: Optional[List[str]] = None, employment_type: Optional[List[str]] = None, min_annual_salary: Optional[int] = None, visa_sponsorship_only: Optional[bool] = None, experience_level: Optional[List[str]] = None, source: Optional[List[str]] = None, query_id: Optional[str] = None) -> dict

List jobs eligible for backend auto-apply.

Query list parameters (match_scores, work_arrangement, etc.) are sent as comma-separated strings, matching the FastAPI multivalue normalizer.

queue_auto_apply ¶

queue_auto_apply(job_id: str, resume_id: str) -> dict

Queue a job for auto-apply.

Parameters:

Name	Type	Description	Default
`job_id`	`str`	The job database ID.	required
`resume_id`	`str`	The tailored resume ID to use.	required

get_auto_apply_status ¶

get_auto_apply_status(job_ids: Optional[List[str]] = None) -> dict

Get auto-apply queue and application status.

Parameters:

Name	Type	Description	Default
`job_ids`	`list of str`	Filter by specific job database IDs (comma-separated on the wire).	`None`

hide_auto_apply_job ¶

hide_auto_apply_job(job_id: str) -> dict

Hide a job from the auto-apply eligible list.

unhide_auto_apply_job ¶

unhide_auto_apply_job(job_id: str) -> dict

Unhide a job previously hidden from the auto-apply eligible list.

get_auto_apply_hidden_jobs ¶

get_auto_apply_hidden_jobs(page: int = 1, page_size: int = 25) -> dict

List jobs the user hid from the auto-apply eligible list.

retry_auto_apply ¶

retry_auto_apply(queue_job_id: str) -> dict

Retry a failed auto-apply job.

cancel_auto_apply ¶

cancel_auto_apply(queue_job_id: str) -> dict

Cancel a queued or in-progress auto-apply job.

auto_apply_browser_generate_fill_plan ¶

auto_apply_browser_generate_fill_plan(payload: Dict[str, Any]) -> dict

Proxy to the auto-apply service for browser-side fill plans (extension workflows).

payload should include at least dom, resume_id, job_id, ats_type. Optional: queue_job_id, page_url.

auto_apply_browser_get_queue ¶

auto_apply_browser_get_queue(*, status: Optional[str] = None, page: int = 1, page_size: int = 50) -> dict

List browser-mode auto-apply queue rows for the current user.

auto_apply_browser_update_job_status ¶

auto_apply_browser_update_job_status(payload: Dict[str, Any]) -> dict

Update browser auto-apply job status (extension).

auto_apply_browser_upload_screenshot ¶

auto_apply_browser_upload_screenshot(payload: Dict[str, Any]) -> dict

Upload a base64 screenshot for a browser auto-apply job (extension).

auto_apply_browser_push_job_log ¶

auto_apply_browser_push_job_log(payload: Dict[str, Any]) -> dict

Append a log entry to a browser auto-apply queue record (extension).

get_autopilot_config ¶

get_autopilot_config() -> dict

Get autopilot configuration for the current user.

enable_autopilot ¶

enable_autopilot(job_queries: List[str], *, min_match_score: int = 60, backfill_days: int = 7, email_after_each_run: Optional[bool] = None, email_daily_digest: Optional[bool] = None, forward_confirmation_emails: Optional[bool] = None) -> dict

Enable autopilot with selected job-search query IDs.

update_autopilot_config ¶

update_autopilot_config(*, job_queries: Optional[List[str]] = None, min_match_score: Optional[int] = None, email_after_each_run: Optional[bool] = None, email_daily_digest: Optional[bool] = None, forward_confirmation_emails: Optional[bool] = None) -> dict

Update autopilot settings (partial update).

pause_autopilot ¶

pause_autopilot() -> dict

Pause autopilot runs.

resume_autopilot ¶

resume_autopilot() -> dict

Resume autopilot after pause.

disable_autopilot ¶

disable_autopilot() -> dict

Disable autopilot.

get_autopilot_dashboard ¶

get_autopilot_dashboard() -> dict

Dashboard aggregates for autopilot.

get_autopilot_activity ¶

get_autopilot_activity(page: int = 1, page_size: int = 25, *, status: Optional[str] = None) -> dict

Paginated autopilot queue activity.

get_autopilot_runs ¶

get_autopilot_runs(page: int = 1, page_size: int = 20) -> dict

Paginated autopilot run history.

search_leads_for_job ¶

search_leads_for_job(job_id: str) -> dict

Run lead search for a tailored resume (resume document job_id).

May return HTTP 403 when the leads workspace feature is disabled for the account.

get_leads_for_job ¶

get_leads_for_job(job_id: str) -> dict

Get cached lead search results for a resume id.

get_job_database_leads ¶

get_job_database_leads(job_database_id: str) -> dict

Get cached leads for a saved job-database card (before a resume exists).

search_leads_for_job_database ¶

search_leads_for_job_database(job_database_id: str) -> dict

Run lead search for a job_database row (pre-resume).

init_batch ¶

init_batch(job_urls: List[str] = None, job_descriptions: List[str] = None, **kwargs) -> dict

Initialize a batch of resumes.

process_batch ¶

process_batch(batch_id: str) -> dict

Start processing a batch.

get_batch ¶

get_batch(batch_id: str) -> dict

Get batch status.

list_batches ¶

list_batches() -> dict

List all batches.

get_batch_resumes ¶

get_batch_resumes(batch_id: str) -> dict

Get all resumes in a batch.

generate_job_search_query ¶

generate_job_search_query() -> dict

Generate a job search query from your base resume.

generate_and_run_search ¶

generate_and_run_search() -> dict

Generate a query and run it immediately.

run_job_search ¶

run_job_search(query_id: str = None) -> dict

Run a job search and fetch results.

get_search_queries ¶

get_search_queries() -> dict

Get all job search queries.

create_search_query ¶

create_search_query(query: dict) -> dict

Create a new job search query.

update_search_query ¶

update_search_query(query_id: str, query: dict) -> dict

Update a job search query.

delete_search_query ¶

delete_search_query(query_id: str) -> dict

Delete a job search query.

get_relevant_jobs ¶

get_relevant_jobs() -> dict

Get relevant jobs list.

get_job_status_stats ¶

get_job_status_stats() -> dict

Get counts and status statistics for relevant jobs.

get_job ¶

get_job(job_id: str) -> dict

Get full details for a single job.

get_related_jobs ¶

get_related_jobs(job_id: str) -> dict

Get related jobs for a given job.

save_job ¶

save_job(job_id: str, save: bool = True) -> dict

Save or unsave a job.

block_job ¶

block_job(job_id: str, block: bool = True) -> dict

Block or unblock a job.

skip_job ¶

skip_job(job_id: str, skip: bool = True) -> dict

Skip or unskip a job.

reset_skipped_jobs ¶

reset_skipped_jobs() -> dict

Reset all skipped jobs.

embed_base_resume ¶

embed_base_resume() -> dict

Create embeddings of your base resume for job matching.

patch_search_query ¶

patch_search_query(query_id: str, **fields) -> dict

Partially update a job search query (merge fields).

get_relevant_jobs_map ¶

get_relevant_jobs_map(**params) -> dict

Get relevant jobs with map coordinates.

get_jobs_status ¶

get_jobs_status(job_ids: List[str]) -> dict

Get resume-creation status for multiple job IDs.

Parameters:

Name	Type	Description	Default
`job_ids`	`list of str`	Job database IDs to check.	required

create_search_agent ¶

create_search_agent(agent: dict) -> dict

Create a new job search agent.

update_search_agent ¶

update_search_agent(agent_id: str, agent: dict) -> dict

Update a job search agent.

get_search_agents ¶

get_search_agents() -> dict

Get all job search agents.

delete_search_agent ¶

delete_search_agent(agent_id: str) -> dict

Delete a job search agent.

parse_and_store_job ¶

parse_and_store_job(raw_text: str) -> dict

Parse raw job text and store in job database.

get_job_match_score ¶

get_job_match_score(job_description: str = None, job_url: str = None) -> dict

Get a job match score against your base resume.

list_templates ¶

list_templates() -> dict

List all available resume templates.

list_standard_templates ¶

list_standard_templates() -> dict

List standard templates.

get_standard_template ¶

get_standard_template(template_id: str) -> dict

Get a single standard template.

list_my_templates ¶

list_my_templates() -> dict

List all template instances for the current user.

create_base_template ¶

create_base_template(template_id: str, **kwargs) -> dict

Create a base-resume template instance.

list_base_templates ¶

list_base_templates() -> dict

List base-resume template instances.

get_base_template ¶

get_base_template(instance_id: str) -> dict

Get a base-resume template instance.

update_base_template_html ¶

update_base_template_html(instance_id: str, html: str) -> dict

Update base-resume template HTML.

reset_base_template ¶

reset_base_template(instance_id: str) -> dict

Reset a base-resume template to original.

revise_base_template ¶

revise_base_template(instance_id: str, feedback: str) -> dict

Revise a base-resume template with AI feedback.

delete_base_template ¶

delete_base_template(instance_id: str) -> dict

Delete a base-resume template instance.

get_base_template_conversation ¶

get_base_template_conversation(instance_id: str) -> dict

Get the AI revision conversation history for a base template.

create_resume_template ¶

create_resume_template(job_id: str, template_id: str, **kwargs) -> dict

Create a template instance for a tailored resume.

list_resume_templates ¶

list_resume_templates(job_id: str) -> dict

List template instances for a tailored resume.

get_resume_template ¶

get_resume_template(job_id: str, instance_id: str) -> dict

Get a template instance for a tailored resume.

update_resume_template_html ¶

update_resume_template_html(job_id: str, instance_id: str, html: str) -> dict

Update a resume template's HTML.

reset_resume_template ¶

reset_resume_template(job_id: str, instance_id: str) -> dict

Reset a resume template to original.

revise_resume_template ¶

revise_resume_template(job_id: str, instance_id: str, feedback: str) -> dict

Revise a resume template with AI feedback.

delete_resume_template ¶

delete_resume_template(job_id: str, instance_id: str) -> dict

Delete a resume template instance.

get_resume_template_conversation ¶

get_resume_template_conversation(job_id: str, instance_id: str) -> dict

Get the AI revision conversation history for a resume template.

render_template ¶

render_template(job_id: str, template_id: str) -> dict

Render a resume template.

compress_content ¶

compress_content(job_id: str) -> dict

Compress resume content to fit template.

convert_template_to_pdf ¶

convert_template_to_pdf(html: str) -> bytes

Convert resume template HTML to PDF.

upload_linkedin_profile ¶

upload_linkedin_profile(profile_data: dict) -> dict

Upload a LinkedIn profile.

optimize_linkedin_profile ¶

optimize_linkedin_profile() -> dict

Get AI optimization suggestions for your LinkedIn profile.

get_linkedin_profile ¶

get_linkedin_profile() -> dict

Get your stored LinkedIn profile.

run_ats_check ¶

run_ats_check(file_path: Union[str, Path]) -> dict

Run an ATS compatibility check on a resume file.

get_ats_report ¶

get_ats_report(analysis_id: str) -> dict

Get an existing ATS check report.

run_resume_roast ¶

run_resume_roast(file_path: Union[str, Path]) -> dict

Get a brutally honest resume roast.

get_resume_roast_report ¶

get_resume_roast_report(analysis_id: str) -> dict

run_career_clock ¶

run_career_clock(file_path: Union[str, Path]) -> dict

Run career clock analysis.

get_career_clock_report ¶

get_career_clock_report(analysis_id: str) -> dict

run_interview_questions_tool ¶

run_interview_questions_tool(file_path: Union[str, Path]) -> dict

Generate interview questions from a resume file (free tool).

get_interview_questions_report ¶

get_interview_questions_report(analysis_id: str) -> dict

run_career_personality_test ¶

run_career_personality_test(file_path: Union[str, Path]) -> dict

Run a career personality test.

get_career_personality_report ¶

get_career_personality_report(analysis_id: str) -> dict

run_skills_gap_analyzer ¶

run_skills_gap_analyzer(file_path: Union[str, Path]) -> dict

Analyze skills gaps in a resume.

get_skills_gap_report ¶

get_skills_gap_report(analysis_id: str) -> dict

run_readability_test ¶

run_readability_test(file_path: Union[str, Path]) -> dict

Run a resume readability test.

get_readability_report ¶

get_readability_report(analysis_id: str) -> dict

run_linkedin_profile_generator ¶

run_linkedin_profile_generator(file_path: Union[str, Path]) -> dict

Generate an optimized LinkedIn profile from a resume.

get_linkedin_profile_generator_report ¶

get_linkedin_profile_generator_report(analysis_id: str) -> dict

run_buzzword_detector ¶

run_buzzword_detector(file_path: Union[str, Path]) -> dict

Detect buzzwords and cliches in a resume.

get_buzzword_report ¶

get_buzzword_report(analysis_id: str) -> dict

run_job_search_keywords ¶

run_job_search_keywords(file_path: Union[str, Path]) -> dict

Extract optimal job search keywords from a resume.

get_job_search_keywords_report ¶

get_job_search_keywords_report(analysis_id: str) -> dict

run_networking_copilot ¶

run_networking_copilot(file_path: Union[str, Path]) -> dict

Get networking strategy recommendations.

get_networking_copilot_report ¶

get_networking_copilot_report(analysis_id: str) -> dict

create_course ¶

create_course(**kwargs) -> dict

Create a personalized learning course.

list_courses ¶

list_courses() -> dict

List all courses.

get_course ¶

get_course(course_id: str) -> dict

Get a course by ID.

revise_slide ¶

revise_slide(course_id: str, **kwargs) -> dict

Revise a slide in a course.

create_mindmap ¶

create_mindmap(course_id: str) -> dict

Create a mindmap for a course.

clarify_course ¶

clarify_course(course_id: str, message: str) -> dict

Ask a clarifying question about course content.

create_knowledge_graph ¶

create_knowledge_graph(course_id: str) -> dict

Build a knowledge graph for a course.

expand_knowledge_graph ¶

expand_knowledge_graph(course_id: str, node_id: str, **kwargs) -> dict

Expand a node in a course knowledge graph.

Parameters:

Name	Type	Description	Default
`course_id`	`str`	The course ID.	required
`node_id`	`str`	The node to expand.	required

list_website_styles ¶

list_website_styles() -> dict

List available website resume styles.

create_website_resume ¶

create_website_resume(**kwargs) -> dict

Generate a new website resume.

list_website_resumes ¶

list_website_resumes() -> dict

List your website resumes.

get_website_resume ¶

get_website_resume(website_resume_id: str) -> dict

Get a website resume by ID.

regenerate_website_resume ¶

regenerate_website_resume(website_resume_id: str, style_id: str) -> dict

Regenerate HTML with a different style.

revise_website_resume ¶

revise_website_resume(website_resume_id: str, feedback: str) -> dict

Revise a website resume based on feedback.

reset_website_resume ¶

reset_website_resume(website_resume_id: str) -> dict

Reset to original generated HTML.

update_website_resume_html ¶

update_website_resume_html(website_resume_id: str, html: str) -> dict

Save HTML directly.

delete_website_resume ¶

delete_website_resume(website_resume_id: str) -> dict

Delete a website resume.

get_website_resume_status ¶

get_website_resume_status() -> dict

Poll website resume generation status (for in-progress builds).

get_website_resume_conversation ¶

get_website_resume_conversation(website_resume_id: str) -> dict

Get the AI revision conversation history for a website resume.

create_affiliate_code ¶

create_affiliate_code() -> dict

Create a new affiliate code.

get_affiliate_stats ¶

get_affiliate_stats() -> dict

Get affiliate statistics.

get_affiliate_transactions ¶

get_affiliate_transactions() -> dict

Get affiliate transaction history.

request_affiliate_payout ¶

request_affiliate_payout() -> dict

Request payout for available earnings.

customer_service_chat ¶

customer_service_chat(message: str) -> dict

Chat with the customer service bot.

transcribe_audio ¶

transcribe_audio(file_path: Union[str, Path]) -> dict

Transcribe an audio file.

report_bug ¶

report_bug(**kwargs) -> dict

Report a bug.

get_latest_announcement ¶

get_latest_announcement() -> dict

Get the latest announcement.

delete_account ¶

delete_account() -> dict

Permanently delete your account.

get_calculator_spec ¶

get_calculator_spec(tool_name: str) -> dict

Get the input specification for a career calculator tool.

Parameters:

Name	Type	Description	Default
`tool_name`	`str`	One of: `career-stability-index`, `promotion-readiness`, `job-change-readiness`, `career-stagnation`, `under-leveling`, `job-hopper-risk`, `resume-structural-strength`, `application-funnel-efficiency`, `negotiation-leverage`, `skill-portfolio-balance`, `application-targeting-precision`.	required

evaluate_calculator ¶

evaluate_calculator(tool_name: str, inputs: dict) -> dict

Evaluate a career calculator tool with the given inputs.

Parameters:

Name	Type	Description	Default
`tool_name`	`str`	The calculator tool name (see :meth:`get_calculator_spec`).	required
`inputs`	`dict`	Input values matching the tool's spec.	required

list_calculator_tools ¶

list_calculator_tools() -> List[str]

Return the list of available career calculator tool names.