List analyses
Retrieve a paginated list of analyses. Supports optional status filtering. Returns analysis metadata with top-level scores.
Authorization
ApiKeyAuth x-api-key<token>
API key authentication. Pass your key in the x-api-key request header.
In: header
Query Parameters
page?integer
Page number (1-indexed)
limit?integer
Items per page (max 100)
status?string
Filter by analysis status
Value in
"processing" | "completed" | "failed"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://next.hireplus.ai/api/v1/analyses"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "processing",
"file_name": "string",
"target_role": "string",
"target_industry": "string",
"created_at": "string",
"completed_at": "string",
"scores": {
"overall": 100,
"ats": 100,
"keyword": 100,
"formatting": 100,
"impact": 100
}
}
],
"meta": {
"page": 0,
"limit": 0,
"total": 0,
"total_pages": 0,
"has_more": true
}
}{
"error": "Invalid request parameters"
}{
"error": "Invalid or expired API key"
}{
"error": "API key does not have required scope"
}{
"error": "Resource not found"
}{
"error": "Rate limit exceeded. Max 100 requests per minute."
}{
"error": "Internal server error"
}Get usage statistics GET
Retrieve API usage statistics including daily breakdown for the last 7 days, credit balance, monthly spend, and remaining call estimates.
List CV generations GET
Retrieve a paginated list of CV generations. Returns generation metadata without signed download URLs (use the detail endpoint for downloads).