HirePlus Docs

Get a CV generation

GET
/v1/generations/{id}

Retrieve a single CV generation with full details including structured CV data and signed download URLs for PDF and DOCX files.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication. Pass your key in the x-api-key request header.

In: header

Path Parameters

id*string

Resource UUID

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/generations/123"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "analysis_id": "6ad457ea-9426-4897-bff8-c6f3fe690582",
  "template_type": "executive",
  "region": "US",
  "language": "string",
  "target_role": "string",
  "target_industry": "string",
  "structured_cv": null,
  "improved_cv": null,
  "pdf_url": "string",
  "docx_url": "string",
  "created_at": "string"
}
{
  "error": "Invalid request parameters"
}
{
  "error": "Invalid or expired API key"
}
{
  "error": "API key does not have required scope"
}
{
  "error": "string"
}
{
  "error": "Rate limit exceeded. Max 100 requests per minute."
}
{
  "error": "Internal server error"
}

Get analysis status GET

Check whether an analysis has completed processing. Useful for polling in asynchronous workflows. Returns the current status along with timestamps.

Get an interview preparation GET

Retrieve a single interview preparation set by ID, including all generated questions, interview structure, and key areas to probe.