Create an API key
1
Open API keys
Sign in at hiresweep.com, open Settings and select API keys under Developers.
2
Select Create API key
In the dialog, fill in:
- Name: a label that tells you what the key is for, up to 64 characters.
- Expires in: 1 month (the default), 3 months, 6 months or 1 year.
3
Copy the key
Select Copy API key and store the key somewhere safe, such as a password manager or your deployment’s secrets.
Authenticate requests
Send the key in thex-api-key header. The API is served under https://hiresweep.com/api/openapi.
401 Unauthorized.
Rate limits
The per-minute limits return
429 Too Many Requests.
Calls that use Hiresweep AI also use AI actions from your plan, the same as in the app. See Plans and usage.
Delete an API key
In Settings → API keys, select Delete API key next to the key and confirm. Scripts and integrations using the key lose access at once. This can’t be undone.Related
- Using the Patch API for small, targeted changes to a resume.
- JSON resume schema for the shape of resume data.
- Using the MCP server to connect AI assistants.