Intake API guide

1. Create an intake key

Go to the API & integrations page. Under Intake keys, select the Intake scope and click Create key.

Copy the key immediately — it will not be shown again.

2. Upload a CV

Send a POST request to /intake with your key in the X-API-Key header, the target job ID, and the file.

Example

curl -X POST https://<your-workspace-url>/intake \
  -H "X-API-Key: <your-key>" \
  -F job_id=<uuid> -F file=@resume.pdf

Accepted file types: PDF, Word (.docx) and JPG/PNG/WebP images (up to 10 MB). Image CVs are read with local OCR; if the workspace has opted in to vision transcription in Settings, unreadable images are transcribed with your own Google key.

3. Find your job ID

Open the Jobs page and click into the job you want to upload to. The job ID is the UUID in the page URL, for example: /jobs/abc12345-….

4. Key rotation and revocation

You can create multiple intake keys and revoke any key at any time from the API & integrations page. Revoking a key takes effect immediately — any requests using that key will be rejected.

To rotate a key: create a new key, update your uploader to use it, then revoke the old key.

5. Connectors

The intake API accepts standard multipart form uploads, so any system that can make HTTP requests can serve as a connector. Common patterns include:

A small script that watches a folder or mailbox and uploads new CVs.
A webhook-style integration that triggers on new applications and forwards the file to ShortlistKit.

The connector only needs the intake key and the job ID. No other authentication is required for the upload endpoint.

Stuck on setup? Ask your chatbot

Setting up an API connector can feel technical. If you are stuck, copy the prompt below and paste it into Claude, Gemini, ChatGPT, Grok or any chatbot you like — fill in your three values, and it will walk you through setup step by step, in plain language.

I want to auto-upload candidate CVs to ShortlistKit using its intake API. Here is the exact API spec:
- Endpoint: POST https://[your workspace URL]/intake
- Header: X-API-Key: *** intake key]
- Multipart form fields: job_id=[your job ID] and file=@path/to/resume
- Accepted files: PDF, Word (.docx), JPG/PNG/WebP, up to 10 MB

Please walk me through, step by step, how to upload a CV using this curl command, explaining every part like I am not a developer, and tell me exactly what to replace before running it. Then show me how to check that the upload worked.

Fill in the three brackets from your ShortlistKit pages: workspace URL = your site address; intake key and job ID come from the API & integrations page. Never paste your intake key into a site you don't trust.