GetYourJob Usage API
The usage API from GetYourJob — 2 operation(s) for usage.
The usage API from GetYourJob — 2 operation(s) for usage.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/getyourjob-pro:getyourjob-pro-usage-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: MatchingAgent Usage 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: Usage
paths:
/v1/v1/usage:
get:
tags:
- Usage
summary: Get Current Usage
description: 'Get current billing period usage summary.
Args:
auth: Authentication context
session: Database session
Returns:
Usage summary'
operationId: get_current_usage_v1_v1_usage_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UsageSummaryResponse'
/v1/v1/usage/history:
get:
tags:
- Usage
summary: Get Usage History
description: 'Get paginated usage history.
Args:
page: Page number (1-indexed)
page_size: Records per page (max 100)
start_date: Optional start date filter
end_date: Optional end date filter
auth: Authentication context
session: Database session
Returns:
Paginated usage records'
operationId: get_usage_history_v1_v1_usage_history_get
parameters:
- name: page
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number
default: 1
title: Page
description: Page number
- name: page_size
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
description: Records per page
default: 50
title: Page Size
description: Records per page
- name: start_date
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Filter from date
title: Start Date
description: Filter from date
- name: end_date
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Filter to date
title: End Date
description: Filter to date
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UsageHistoryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
UsageRecordResponse:
properties:
id:
type: string
title: Id
endpoint:
type: string
title: Endpoint
matches_count:
type: integer
title: Matches Count
cost_eur:
type: number
title: Cost Eur
request_id:
anyOf:
- type: string
- type: 'null'
title: Request Id
created_at:
type: string
title: Created At
api_key_prefix:
type: string
title: Api Key Prefix
type: object
required:
- id
- endpoint
- matches_count
- cost_eur
- request_id
- created_at
- api_key_prefix
title: UsageRecordResponse
description: Single usage record.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
UsageHistoryResponse:
properties:
records:
items:
$ref: '#/components/schemas/UsageRecordResponse'
type: array
title: Records
total_count:
type: integer
title: Total Count
page:
type: integer
title: Page
page_size:
type: integer
title: Page Size
has_more:
type: boolean
title: Has More
type: object
required:
- records
- total_count
- page
- page_size
- has_more
title: UsageHistoryResponse
description: Paginated usage history.
UsageSummaryResponse:
properties:
total_matches:
type: integer
title: Total Matches
total_cost_eur:
type: number
title: Total Cost Eur
period_start:
anyOf:
- type: string
- type: 'null'
title: Period Start
period_end:
anyOf:
- type: string
- type: 'null'
title: Period End
plan_tier:
type: string
title: Plan Tier
type: object
required:
- total_matches
- total_cost_eur
- period_start
- period_end
- plan_tier
title: UsageSummaryResponse
description: Summary of current period usage.