Skip to main content

Tarkflo Developer Handbook

Everything you need to connect, build, and hire with Tarkflo.

A good place to start

Integration guides​

Keep building
BASE URLhttps://api.tarkflo.com/v1
Explore the API overviewThe core flow, code examples, and what you can build.

Tarkflo API

Add candidates to a Tarkflo job from your own system. Send CVs, check what Tarkflo read from them, then save the ones you want into the pipeline. The job's workflow takes it from there.

Base URL
https://api.tarkflo.com/v1

Two calls do the work​

POST/candidates/extract

Upload up to 10 CVs for a job. You get back each candidate's name, email and phone. Nothing is saved, so you can look before you commit.

POST/candidates/submit

Send the details you reviewed. Each candidate enters the job's pipeline, their CV is attached, and the job's workflow starts.

Here is the first call, with the response you get back:

curl -X POST https://api.tarkflo.com/v1/candidates/extract \
-H "Authorization: Bearer $TARKFLO_API_KEY" \
-F "job_id=66f1c2a9b3d4e5f607182934" \
-F "files=@./ananya-rao.pdf"
200 OK
{
"extractions": [
{
"index": 0,
"filename": "ananya-rao.pdf",
"status": "ok",
"cv_id": "cv_7Qm2xN4vKdA9pR1sTe6WbZ",
"name": "Ananya Rao",
"email": "ananya.rao@example.com",
"phone": "+919812345678",
"message": null,
"duplicates": []
}
]
}

Or let Tarkflo run the interview​

Have your own ATS and only want Tarkflo to run the interview? Create an interview instead of Submit candidates: give it a candidate and a job, get back a link the candidate opens to interview on Tarkflo. Poll Get an interview for status, then read Get an interview's report once it is completed: a score, a verdict and a scoped link to the full report. See Interview as a Service for the whole flow.

What the API covers​

You can, with the APIYou do in the Tarkflo dashboard
List the jobs a key can seeCreate and edit jobs
Read name, email and phone out of CVsBuild workflows, interview templates and scoring rubrics
Submit candidates into a job's pipeline, or create a single interview and get a link backRun, watch and review interviews
Tag each candidate with your own ID and metadataManage billing, members, SSO, branding and API keys

The API refers to workflows and templates by ID. It never creates or edits them. That is a choice, not a gap. A workflow is a set of linked settings: stages, pass marks, interview templates, integrity rules. One API call cannot show you the checks the dashboard applies, so that stays where the checks are.

Interviews run through the candidate's own link, in their own browser. The API can create that link (Create an interview) and read status and a result back, but it never drives the interview itself, and never sees its questions or rubric.

Where to go next​