Quickstart: API
Create an API key, list the operations it may call, and run your first one.
Rolling out
API keys are available to selected organizations while they roll out. If you don't see Developers in Settings, ask the Invyte team to turn API keys on for your organization.
Create a key
In Invyte, open Settings → Developers, make sure API access is on, and choose Issue key. Give it a name, a role and an expiry. The role decides what the key can see and do, exactly as it would for a person. You need the Developer role or admin rights.
The key is shown once. Store it in your secret manager; Invyte keeps only a fingerprint of it. More in API keys.
List what the key may call
curl https://www.invyte.ai/api/recruiter/v1/operations \
-H "Authorization: Bearer $INVYTE_API_KEY"You get every operation this key may call right now, each with JSON Schemas for its input and output. The list follows the key's role, so it is the source of truth for what your integration can do.
Call an operation
curl -X POST https://www.invyte.ai/api/recruiter/v1/operations/jobs.list \
-H "Authorization: Bearer $INVYTE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"input": {"status": "open", "limit": 10}}'{
"status": "done",
"output": { "jobs": [ { "id": "job_…", "title": "Senior Backend Engineer", "status": "open" } ] },
"actionId": "act_…"
}Make writes safe to retry
Send an Idempotency-Key header with every write. If the network drops and you retry with the same key and body, you
get the first result back instead of acting twice.
curl -X POST https://www.invyte.ai/api/recruiter/v1/operations/pipeline.setDisposition \
-H "Authorization: Bearer $INVYTE_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: shortlist-app_123-2026-11-07" \
-d '{"input": {"applicationId": "app_123", "disposition": "shortlisted", "reason": "Strong system design interview"}}'Next
- Learn the four outcomes a call can return.
- Browse the API reference.
- See what teams build in Use cases.