create_account
Create a Keywordise account
Register a new Keywordise account from the terminal and receive an API key for it. Requires accept_terms=true: the person accepts the Terms and Privacy Policy (https://keywordise.com/terms) and authorises Keywordise to apply for jobs on their behalf. A confirmation email is sent; applying opens once the address is confirmed. Trial: 7 days and 27 applications, then Starter at $24.99/month (500 applications) or Pro at $49/month (1,000).
輸入參數email必填password必填accept_terms必填
login
Log in and get an API key
Exchange the account's email and password for a new API key, so a terminal or an assistant can act on the account. The key is shown once; keep it. Up to five keys may be active per account (revoke_api_key frees a slot).
輸入參數email必填labelpassword必填
get_account
My account and plan
The account behind this key: email and whether it is confirmed, plan state (trial days left, applications used and remaining, subscription), and how many API keys are active.
無需輸入參數。
resend_verification_email
Resend the confirmation email
Send the email-confirmation link again to this account's address. Applying is blocked until the address is confirmed; nothing else is.
無需輸入參數。
get_upgrade_link
Upgrade (checkout link)
A checkout link for a paid plan from the active payment provider: Starter ($24.99/month, 500 applications a month) or Pro ($49/month, 1,000 a month; the default). The person opens it in a browser to pay; the account upgrades automatically when the payment lands.
輸入參數plan
get_billing_portal_link
Manage my subscription (portal link)
A link to the payment provider's customer portal for this account's subscription, where invoices, the payment method and cancellation live.
無需輸入參數。
cancel_subscription
Cancel my subscription at period end
Cancel the Pro subscription at the end of the current billing period. Access stays until then. Irreversible from here; the person can resubscribe later.
無需輸入參數。
The active API keys on this account: prefix, label, created and last used. Never the key itself.
無需輸入參數。
create_api_key
Mint another API key
Mint an additional API key for this account, for another machine or assistant. Shown once. Five active keys maximum.
輸入參數label
revoke_api_key
Revoke an API key
Revoke one of this account's API keys immediately. Any terminal or assistant using it stops working at once. Revoking the key you are calling with ends this session.
輸入參數key_id必填
export_my_data
Export everything Keywordise holds about me
The account's complete data as one JSON file (profile, targeting, matched jobs, applications, saved answers, run history, audit trail). Returned as a file; large accounts are told to download it in the app instead.
無需輸入參數。
delete_my_account
Delete my account permanently
Erase the account and everything in it: profile, CV files, matches, applications, answers, keys. Irreversible. Requires confirm_email equal to the account's address.
輸入參數confirm_email必填
get_my_profile
Who am I acting for
Use when the person asks what is on their profile or CV. Not needed before searching or applying: those tools read the saved CV themselves. The CV profile Keywordise holds for this account (name, contact, summary, skills, roles, education), the job-targeting rules (countries, remote preference, keywords) and the plan status (applications remaining). Call this first.
無需輸入參數。
upload_cv
Upload my CV (PDF or DOCX)
Use when the person shares or mentions their resume/CV ('here's my resume', 'use my CV'). Upload a CV file and turn it into the account's profile: the same parser the app uses reads the document into name, contact, summary, roles, skills, languages and education. With save=true (default) the profile is saved and the job feed is built from it; with save=false the parsed profile is returned for review only. Max 8 MB.
輸入參數savefilename必填content_base64必填
update_profile
Edit my profile
Change fields of the saved profile without re-uploading the CV. Send only the fields to change (full_name, contact_email, phone, location, city, address, postcode, professional_summary, skills, pinned_skills, languages, experience, education, projects, certifications, links, …); everything else is untouched. The feed is re-ranked against the new CV.
輸入參數patch必填
get_profile_gaps
What my CV is missing
The gaps in the saved profile that weaken applications (missing dates on a role, no contact phone, empty summary, …), each with a severity, so they can be fixed with update_profile.
無需輸入參數。
suggest_keywords
Keywords my CV suggests
Search keywords derived from the saved profile, useful as include_keywords in update_targeting (jobs that mention one are ranked first; nothing is filtered out).
無需輸入參數。
list_cv_designs
Available CV designs
The CV designs a tailored CV can be rendered in, with the account's current pick.
無需輸入參數。
set_cv_design
Choose my CV design
Set the design every tailored CV is rendered in (a key from list_cv_designs).
輸入參數design必填
get_my_cv_pdf
Render my CV as a PDF
The account's base CV (the saved profile, untailored) rendered as a PDF in the chosen design, returned as a file. No model call.
輸入參數design
get_targeting
My job targeting
Every targeting rule the feed and the apply run obey: remote mode, geo scope and countries, locations, include/exclude keywords, title allow/block lists, seniority, salary, languages, work authorisation, company allow/block, daily and per-company caps, cover-letter and CV settings, screening defaults.
無需輸入參數。
update_targeting
Change my job targeting
Change targeting rules; send only the keys to change (remote_mode any|remote|hybrid|onsite, geo_scope worldwide|region|country, geo_countries [ISO-2], locations, include_keywords, exclude_keywords, title_allow, title_block, seniority, salary_min, currency, languages, company_block, max_apps_per_day, max_apps_per_company, cover_letter_enabled, cv_tone, tailor_instructions, years_experience, salary_expectation, notice_period, …). The feed re-matches in the background.
輸入參數patch必填
describe_what_i_want
Set targeting from one sentence
Use when the person says what they are looking for in their own words ('senior remote data roles in the US, no agencies'). Turn a plain sentence ('remote data roles in Germany or the Netherlands, senior, not agencies') plus the saved CV into concrete targeting rules. Returns the inferred rules and the chips a person would confirm; with apply=true they are saved and the feed re-matches. preset: balanced | broad | focused.
輸入參數applypresetsentence必填
get_feed_reach
What my targeting is costing me
How many jobs the current targeting shows versus how many each single rule is hiding, and which one change would widen the feed most. Every number comes from re-asking the feed's own predicate with one control relaxed.
無需輸入參數。
list_countries_with_jobs
Countries with live jobs
The countries the live pool actually has inventory in (ISO-2, name, job count), for choosing geo_countries in update_targeting.
無需輸入參數。
list_matching_jobs
Jobs that match my CV right now
Use when the person wants jobs or their best matches: 'find me jobs', 'my top matches', 'remote marketing jobs that fit my resume', 'what's new for me this week'. It already uses the saved CV, so there is no need to read the profile first. Live vacancies matched to this account's CV, ranked. Each job carries a calibrated match percentage, a recruiter-pass verdict with a one-line reason, whether we apply to it automatically from start to finish, whether it waits on an answer from the person, and whether an application was already sent. Jobs that apply automatically come first. Filter by match tier, freshness and applies-automatically; page with offset.
輸入參數sortfreshlimitmatchoffsetappliedauto_only
get_job_posting
Read one job posting
The full description of one matched vacancy, with a short summary and highlights, plus the link that opens the posting from the app.
輸入參數job_id必填
explain_job_match
Why this job does or does not fit me
Use for 'is this job a good fit', 'why this match', 'what am I missing for this role'. For one vacancy: the match percentage, the requirements this account's CV covers and the ones it is missing. With narrative=true, also a short written assessment with strengths and gaps (a paid model call; limited to 60 per hour).
輸入參數job_id必填narrative
preview_tailored_cv
Tailor my CV for one job (preview only)
Use for 'tailor my resume for this job' or 'what would you send for this one'. Rewrite this account's CV for one vacancy the way Keywordise would send it: headline, summary, the roles selected for this job with rewritten bullets, curated skills and a cover letter, every segment labelled tailored, verbatim or pinned. Nothing is sent. A paid model call, limited to 20 per hour; the same billing gate as applying.
輸入參數job_id必填
rate_job
Hide, dislike or mark a job interesting
Feedback on one job: hide or dislike removes it from the feed and teaches the matcher what this person rejects; interested is a positive signal. Undo with unhide_job.
輸入參數action必填job_id必填reason
unhide_job
Put a hidden job back
Undo hide or dislike: the job returns to the feed and the negative signal is dropped.
輸入參數job_id必填
list_hidden_jobs
Jobs I hid
The jobs this account hid or disliked, newest first, so one can be put back.
無需輸入參數。
refresh_matches
Refresh my matches
Match the account's CV against the vacancies added since it last looked, in the background. Idempotent and cheap when nothing is new. force=true runs a full re-match regardless. rebuild=true rebuilds the feed from scratch through the same build as the app's Rebuild button (use it when the feed looks wrong). Every answer carries `feed_build`: poll get_match_status until its state is `ready` before reading list_matching_jobs, because a feed that is still building is not an empty feed.
輸入參數forcerebuild
get_match_status
Is a match run in progress
Only for checking on a match or feed rebuild that is already running (after upload_cv, update_targeting or refresh_matches); to find or show jobs use list_matching_jobs. Live status of the latest match run (scanned, inserted, elapsed), the feed counts it produced, and `feed_build`: where the feed is in its build (queued, building, ready, failed). Poll after upload_cv, update_targeting or refresh_matches; the feed is final only when feed_build.feed_state.state is `ready`.
無需輸入參數。
start_apply_run
Apply to my matching jobs
Use when the person says 'apply for me', 'apply to the best matches' or 'apply to this job' (pass job_id). Show them the jobs first. Start an application run: Keywordise takes up to `limit` of the matching jobs (same filters as list_matching_jobs, best fit first, never one already applied to), tailors the CV and cover letter for each, answers the employer's screening questions from the saved answers, and SUBMITS inside the employer's own system. Real applications leave in the person's name; needs a confirmed email and an active plan; counts against the plan. dry_run=true does everything except submit. Poll get_apply_run_status.
輸入參數freshlimitmatchjob_iddry_run
get_apply_run_status
How my application run is going
Live progress of the latest run: running or not (from a heartbeat, not a status claim), processed of total, the job being worked on now, confirmed, needs review, skipped, closed.
無需輸入參數。
stop_apply_run
Stop my application run
Use for 'stop applying', 'pause', 'hold off'. Ask the running application run to stop after the job it is on. Nothing is left half-done; applications already sent stay sent.
無需輸入參數。
list_my_applications
Applications Keywordise sent for me
Use for 'what did I apply to', 'any replies', 'status of my applications'. Every application sent for this account: company, title, stage, outcome, when it went out, how many screening questions it still waits on, and the employer's acknowledgement where one was received.
輸入參數limitonly_waiting_on_meinclude_cover_letter
list_blocking_questions
Screening questions waiting on me
Questions employers asked on applications that are stalled until this account answers them, grouped by application, each with a suggested answer drawn from what the person answered before. Answer with answer_screening_question.
輸入參數limit
answer_screening_question
Answer an employer's screening question
Record the person's answer to one screening question on one application. The answer is written in the person's name and saved to their answer book, so the same question is never asked again. When it is the last required answer, the application is SUBMITTED to the employer. Only give an answer the person actually stated.
輸入參數answer必填question_id必填application_id必填
get_sent_cv_pdf
The exact CV that was sent
The tailored CV PDF that went to the employer for one application, returned as a file.
輸入參數application_id必填
list_run_history
My recent match and application runs
The last five match runs and the last five application runs, with their counts and status.
無需輸入參數。
list_saved_answers
My saved screening answers
The answer book: every screening answer this account has given or taught, which future applications reuse automatically in any phrasing or language.
無需輸入參數。
save_answer
Teach an answer once, for every application
Add or replace a screening answer in the answer book ('What is your notice period?' → '1 month'). Applications already waiting on that fact are completed and sent in the background. Only save what the person actually stated.
輸入參數kindanswer必填optionsquestion必填
delete_saved_answer
Forget a saved answer
Remove one answer from the answer book (an answer_id from list_saved_answers).
輸入參數answer_id必填
list_facts_to_provide
Facts that would unblock the most applications
The universal screening facts this account has not answered yet (right to work, notice period, salary expectation, …), ranked by how many waiting applications each one unblocks. Answer them with save_answer.
無需輸入參數。
get_tracker
My application tracker
The tracker board: applications grouped by the stage the person set (saved, applied, interview, offer, rejected) with their own notes.
無需輸入參數。
move_tracker_card
Move an application to another stage
Set the tracker stage of one application: saved, applied, interview, offer or rejected.
輸入參數stage必填application_id必填
set_tracker_note
Write a note on an application
Replace the person's own note on one tracked application (interview date, contact, next step).
輸入參數notes必填application_id必填
get_live_job_counts
How many live jobs can I search
Use for 'how many jobs are there' or before quoting a number. The size of the live job pool Keywordise can apply to right now, from the same measurement the keywordise.com homepage prints: all live jobs, how many were found in the last 30 days, how many employers, and how many of them Keywordise applies to start to finish without the person doing anything.
無需輸入參數。
search_live_jobs
Search every live job
Use for 'find remote data engineer jobs', 'nursing jobs in Germany', 'what is new in marketing this week'. Searches the WHOLE live job pool (about two million open jobs), not only the person's matches, and needs no CV. Words must all appear in the title, employer or description. Filters: remote only, a two-letter country code, jobs found within N days. Newest first. Each job has a pool_job_id; jobs that also have a page on keywordise.com/jobs carry a public_id. To apply, call apply_to_public_job (public_id) or apply_to_live_job (pool_job_id). For jobs ranked against this person's CV use list_matching_jobs instead.
輸入參數limitqueryoffsetremotecountryposted_within_days
get_live_job
Read one live job in full
The full posting text of one live job from search_live_jobs (pool_job_id): title, employer, place, date and the description. For a job in the person's own matches use get_job_posting.
輸入參數pool_job_id必填
get_public_job
Read a job by its Keywordise id
Use when the person gives a Keywordise job id (ten characters) or a keywordise.com/jobs link, for example 'tell me about job abcde23456'. Returns what the public page of that job shows: title, employer, place, date and a plain summary of the role. A job that has closed answers that it has closed. Apply with apply_to_public_job.
輸入參數public_id必填
apply_to_public_job
Apply to a job by its Keywordise id
Use for 'Apply to Keywordise job abcde23456' or when the person asks to apply to a job from keywordise.com/jobs. Finds that job, puts it into the person's matches and starts the same application as the Apply button for that ONE job: tailors the CV and cover letter, answers the employer's questions and SUBMITS in the person's name. Needs the saved CV, a confirmed email and an active plan, and counts against the plan. Show the job first (get_public_job) and confirm with the person. dry_run=true prepares everything and sends nothing. Poll get_apply_run_status.
輸入參數dry_runpublic_id必填
apply_to_live_job
Apply to a job found by search
Use after search_live_jobs when the person picks one of the results to apply to. The same as apply_to_public_job, for a pool_job_id: puts the job into the person's matches and starts the application for that ONE job, which SUBMITS in the person's name. Needs the saved CV, a confirmed email and an active plan. Confirm with the person first. dry_run=true prepares and sends nothing.
輸入參數dry_runpool_job_id必填
get_referrals
My referral code and earnings
Use for 'what is my referral code', 'how much did I earn from referrals', 'who signed up through me'. The person's referral code and link, the share they earn (and the discount a friend gets), their stats (signups, paying customers, earned, pending, paid out), recent commissions and payouts, and whether they were referred by someone.
無需輸入參數。
set_referral_code
Choose my referral code
Set or change the person's own referral code (letters, digits and dashes, shown in their referral link). Fails with the app's own sentence when the code is taken or not allowed.
輸入參數code必填
claim_referral_code
Use a friend's referral code
Record that the person was referred by the owner of a referral code, for the discount and the friend's credit. Allowed once, before the first payment; fails with the app's own sentence otherwise.
輸入參數code必填
get_inbox_address
My Keywordise application email address
The email address Keywordise uses on the person's applications (employers reply to it), whether replies are also forwarded to their own mailbox, and whether applying by email is active.
無需輸入參數。
list_inbox
Replies from employers
Use for 'any replies?', 'did anyone get back to me?'. The person's Inbox: one thread per application with the employer's results (interview invitations, rejections, requests), unread count, newest first. Read one with read_inbox_message.
輸入參數limitunread_only
read_inbox_message
Read one email from an employer
The full text of one Inbox message (from list_inbox), the employer's reply thread, and any verification code or link in it. Reading marks the message as read.
輸入參數message_id必填
reply_to_inbox_message
Reply to an employer's email
SENDS an email to the employer in the person's name, as a reply to one Inbox message. Use only with the person's approval of the exact text. Fails with the app's own sentence when the message is not found or the text is empty.
輸入參數text必填message_id必填
Use for 'which CVs do I have', 'is my CV uploaded'. The CVs on the account (a person can keep several; one is the default the matches and applications use) with their labels, plus `cv_state`: whether a usable CV is held and why not when it is not.
無需輸入參數。
get_application_details
The details employers ask for
The facts application forms ask beyond the CV: address, postcode, city, country, phone type, salutation, work authorisation by region, sponsorship, salary expectation, standard screening answers, and which of them are still missing. Read before telling the person what an application may be waiting for.
無需輸入參數。
update_application_details
Update the details employers ask for
Change some of the application details. Only the fields given change; an empty string clears a field. Fields: salutation, address, postcode, city, state, country (two-letter code), phone_type (mobile, home or work), work_auth (object such as {"eu": true}), sponsorship (list of regions), salary_expectation (number). Only values the person actually stated.
輸入參數details必填
get_application_review
Where an application's answers came from
For one application: every field of the form with its value and where the value came from (the CV, a saved answer, the person, or a model). For an application that waits for the person's review (`editable`), these are the answers about to be sent.
輸入參數application_id必填
approve_application
Approve and send a reviewed application
The Send button of the review screen: SUBMITS an application that is waiting for review (get_application_review says editable), in the person's name. `edits` maps a field's label exactly as get_application_review shows it to the new answer; edits are saved to the person's answer book. Use only with the person's approval of the answers.
輸入參數editsapplication_id必填
prepare_external_application
Write the CV and cover letter for a job we do not apply to
For a job the app marks as applied on the employer's own site (apply_to_public_job / start_apply_run answer that they do not apply there for the person): tailors the person's CV and writes the cover letter for that one job, on request, using no application credit. Returns the cover letter text; fetch the two PDFs with get_external_pack_pdf. A paid model call, cached per job. Nothing is sent to the employer.
輸入參數job_id必填
get_external_pack_pdf
The tailored CV or cover letter for a job
The tailored CV or the cover letter PDF written by prepare_external_application for one job, returned as a file.
輸入參數job_id必填document