Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: MatchingAgent Health API
description: 'AI-powered candidate-job matching API.
## Features
- **Match candidates against offers** - Get scored matches with detailed analysis
- **Explainable results** - Understand why a match is good or bad
- **Flexible input** - Accept various data formats
## MVP Endpoints
- `POST /v1/match` - Match a candidate against multiple offers
- `GET /v1/health` - Health check
## Coming Soon
- `POST /v1/enrich` - Enrich candidate profiles with external data
- `POST /v1/parse-document` - Parse CV/resume documents'
version: mvp-1.0.0
tags:
- name: Health
paths:
/v1/health:
get:
tags:
- Health
summary: Health check
description: Check the health status of the API and its components.
operationId: health_check_v1_health_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
components:
schemas:
HealthResponse:
properties:
status:
type: string
title: Status
description: Overall health status
version:
type: string
title: Version
description: API version
timestamp:
type: string
format: date-time
title: Timestamp
description: Current timestamp
components:
additionalProperties:
type: string
type: object
title: Components
description: Component statuses
type: object
required:
- status
- version
- timestamp
- components
title: HealthResponse
description: Response from the health check endpoint.
example:
components:
api: ok
llm: ok
status: healthy
timestamp: '2025-01-08T15:30:00Z'
version: mvp-1.0.0