Developers

OikoHire API Reference

Integrate our powerful AI recruitment engine directly into your workflows. Search candidates, score technical skills, and match resumes programmatically.

Overview

The OikoHire API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

https://api.oikohire.com/v2

Data Format

All requests and responses use standard JSON format.

Authentication

The OikoHire API uses API keys to authenticate requests. You can view and manage your API keys in the Developer Settings of your dashboard.

Authentication to the API is performed via HTTP Bearer Auth. Provide your API key as the bearer token value in the Authorization header.

Keep your keys secure

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Example Authorization Header

Code

curl https://api.oikohire.com/v2/jobs \
 -H "Authorization: Bearer oh_prod_1234567890abcdef" \
 -H "Content-Type: application/json"

Rate Limits

We limit the number of requests you can make to our API to ensure stability for all users. The current limits are based on your subscription tier. Standard requests are rate-limited separately from resource-intensive AI operations.

Tier	Standard Endpoints	AI Endpoints (Score/Match)
Free	100 / hour	10 / day
Pro	1,000 / minute	500 / day
Enterprise	Custom	Custom

If you exceed these limits, you will receive a 429 Too Many Requests response. Check the Retry-After header for when to resume.

Core Endpoints

POST

Match Resume to Jobs

POST/v2/ai/match-jobs

Submits a candidate's resume (text or URL) and returns a list of highly relevant job postings from your internal database, scored and explained by our AI.

Parameters

Name	Type	Description
resume_text	string	Raw text content of the candidate resume. Either this or resume_url is required.
resume_url	string	Public URL to a PDF or DOCX resume.
limit	integer	Maximum number of matches to return. Default is 5, max is 20.
min_score	float	Minimum match score (0.0 to 1.0) to filter results.

Example Request

cURL

curl -X POST https://api.oikohire.com/v2/ai/match-jobs \
 -H "Authorization: Bearer YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
 "resume_text": "Experienced Frontend Engineer with 5 years in React, TypeScript, and Tailwind CSS...",
 "limit": 3,
 "min_score": 0.85
 }'

Example Response

JSON

{
 "status": "success",
 "data": {
 "matches": [
 {
 "job_id": "job_9f8a7b6c",
 "title": "Senior React Developer",
 "company": "TechFlow Inc.",
 "match_score": 0.92,
 "rationale": "Strong overlap in React and TypeScript experience."
 }
 ]
 }
}

POST

Score Mock Interview

POST/v2/ai/score-interview

Analyzes a transcript of a technical interview and provides automated scoring across multiple dimensions (technical accuracy, communication, problem-solving).