Skip to main content
POST
Render HTML candidate cards
Generates self-contained, responsive HTML/CSS profile cards for up to 10 candidate profile IDs. This endpoint is synchronous — it returns immediately with rendered card snippets.

Overview

The rendered HTML cards are ready to embed directly into your ATS, internal recruitment dashboards, or email templates. Each card includes:
  • Candidate name (gradient-styled heading)
  • Current role and company
  • AI match score badge
  • InstaView rationale summary
  • Primary skills list
  • LinkedIn profile link button
No external CSS or JavaScript dependencies are required — all styling is applied inline.

Themes

Examples

Request

Response (200 OK)

Partial Failure (200 OK)

If a profile ID is not found for the authenticating company, it is returned with success: false — the rest of the batch is still rendered:

Embedding the Card

The htmlContent string can be inserted directly into your HTML via innerHTML or server-side template rendering:
Always sanitize third-party content before inserting it into the DOM if your CSP or security policy restricts inline styles. The HTML is self-contained and uses only inline CSS — no scripts are included.

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Body

application/json
profileIds
string[]
required

Array of profile IDs for which to render HTML cards. Maximum 10 per request.

Required array length: 1 - 10 elements
Example:
theme
enum<string>
default:dark

Visual theme for the rendered HTML cards (default: 'dark').

Available options:
dark,
light
Example:

"dark"

Response

Rendered HTML candidate cards

success
boolean
required

Whether the request succeeded.

Example:

true

renderedCount
integer
required

Number of profiles for which HTML was successfully rendered.

Example:

2

data
object[]
required

Rendered HTML card results per requested profile.