Career Agent API is currently in beta

Endpoint structures, limits and response fields may change before general availability. Preview and planned endpoints are not intended for production use.

Recruitment intelligence infrastructure

Build intelligent hiring workflows with one API

Publish jobs, search talent, collect applications and integrate Career Agent's candidate-matching intelligence into your existing recruitment platform.

Unified candidate intelligence

Work with normalized candidate, job and application data through one consistent API.

Context-aware matching

Move beyond keyword filtering with evidence-based candidate ranking and explanations.

Secure integrations

Use scoped API keys, controlled connectors and signed webhook events.

Overview

Introduction

Career Agent exposes modular recruitment capabilities that can be added to applicant-tracking systems, job platforms, internal HR tools and custom hiring workflows.

Base URL

https://careeragentapp.co.za/v1

Security

Authentication

Requests use bearer authentication. API keys should only be stored and used in secure server-side environments.

Bearer API key

Include your secret key in the authorization header of each request. Never expose secret keys inside browser or mobile application code.

Beta access is issued to approved integration partners. Production keys and sandbox keys remain separate.

Authentication headerbash

curl https://careeragentapp.co.za/v1/jobs \
  -H "Authorization: Bearer ca_test_your_api_key" \
  -H "Content-Type: application/json"

Fundamentals

API conventions

The API uses JSON request bodies, predictable resource identifiers and standard HTTP response codes.

JSON

Requests and responses use application/json.

Versioned

Stable endpoints are grouped under /v1.

Asynchronous jobs

Large imports and searches return trackable operation IDs.

Webhooks

Receive signed updates when long-running operations finish.

Reference

API endpoints

Open an endpoint to view its request structure and example response.

Request bodyjson

{
  "candidateIds": [
    "cand_1029",
    "cand_2411",
    "cand_4582"
  ],
  "limit": 25,
  "minimumScore": 60,
  "includeExplanation": true
}

Responsejson

{
  "jobId": "job_8fb2a1",
  "matches": [
    {
      "candidateId": "cand_2411",
      "score": 91,
      "confidence": "high",
      "strengths": [
        "Strong React experience",
        "Relevant fintech background",
        "Meets location preference"
      ],
      "gaps": [
        "Limited GraphQL evidence"
      ]
    }
  ]
}

Responsible AI

Matching supports decisions. It does not replace them.

Match results should be reviewed alongside relevant application evidence. Protected characteristics should not be used to make employment decisions.

Evidence-based explanations

Configurable score thresholds

Human review checkpoints

Auditable integration events

Build intelligent hiring workflows with one API

Unified candidate intelligence

Context-aware matching

Secure integrations

Introduction

Base URL

Authentication

Bearer API key

API conventions

JSON

Versioned

Asynchronous jobs

Webhooks

API endpoints

Publish a job

Match candidates to a job

Search your candidate database

Discover public talent profiles

Find similar candidates

Match candidates to team culture

Collect applications from connected sources

Query the organisational talent graph

Forecast hiring outcomes

Rediscover previous candidates

Matching supports decisions. It does not replace them.