User

Developer API Reference

Build powerful integrations with our platform APIs.

← Back to Dashboard

Manage API Keys

Templates

Dynamic API reference synchronized with our latest backend endpoints.

GET

Get template details

/api/v1/templates/{id}

Returns the full configuration of an interview template, including its structured questions.

Parameters

idRequiredstring

The template UUID

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/templates/{id}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

{
  "id": "tpl-123e4567-e89b-12d3-a456-426614174000",
  "title": "Frontend Behavioral Screen",
  "description": "Standard culture-fit questions for engineers",
  "initial_message": "Welcome to the interview!",
  "ending_message": "Thanks for your time.",
  "structure_template": [
    {
      "id": "1",
      "text": "Tell me about a time you failed.",
      "type": "behavioral"
    }
  ],
  "created_at": "2026-02-25T08:00:00Z"
}

POST

AI auto-generate template

/api/v1/templates/generate

Suggests interview questions and structure based on a job description.

Parameters

job_descriptionRequiredstring

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/templates/generate" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"job_description":"string"}'

Example Response

json

{
  "job_description_received": "We are looking for a Senior Frontend Engineer with Next.js...",
  "suggestions": {
    "title": "Generated Interview Template",
    "avatar_id": "ava-123",
    "language": "en",
    "questions": [
      {
        "text": "Can you describe your experience with React hooks?",
        "behavioral_intent": "Assess technical depth",
        "expected_answer": "Specific projects where hooks managed state."
      }
    ]
  }
}

GET

List interview templates

/api/v1/templates

Returns all interview question templates for the authenticated tenant.

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/templates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

[
  {
    "id": "tpl-123e4567-e89b-12d3-a456-426614174000",
    "title": "Frontend Behavioral Screen",
    "description": "Standard culture-fit questions for engineers",
    "created_at": "2026-02-25T08:00:00Z"
  }
]

POST

Create an interview template

/api/v1/templates

Creates a new interview question template (e.g., Tech Assessment, Culture Fit).

Parameters

titleRequiredstring

descriptionRequiredstring

initial_messagestring

ending_messagestring

structure_templatearray

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/templates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","initial_message":"string","ending_message":"string","structure_template":[{}]}'

Example Response

json

{
  "id": "tpl-123e4567-e89b-12d3-a456-426614174000",
  "title": "Frontend Behavioral Screen",
  "description": "Standard culture-fit questions for engineers",
  "initial_message": "Welcome to the interview!",
  "ending_message": "Thanks for your time.",
  "structure_template": [
    {
      "id": "1",
      "text": "Tell me about a time you failed.",
      "type": "behavioral"
    }
  ],
  "created_at": "2026-02-25T08:00:00Z"
}

Fetching data...

📊 Analytics

User

⚙️ Settings

Developer API Reference

Build powerful integrations with our platform APIs.

← Back to Dashboard

Developer API Reference

Build powerful integrations with our platform APIs.

← Back to Dashboard

Manage API Keys

Templates

Dynamic API reference synchronized with our latest backend endpoints.

GET

Get template details

/api/v1/templates/{id}

Returns the full configuration of an interview template, including its structured questions.

Parameters

idRequiredstring

The template UUID

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/templates/{id}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

{
  "id": "tpl-123e4567-e89b-12d3-a456-426614174000",
  "title": "Frontend Behavioral Screen",
  "description": "Standard culture-fit questions for engineers",
  "initial_message": "Welcome to the interview!",
  "ending_message": "Thanks for your time.",
  "structure_template": [
    {
      "id": "1",
      "text": "Tell me about a time you failed.",
      "type": "behavioral"
    }
  ],
  "created_at": "2026-02-25T08:00:00Z"
}

POST

AI auto-generate template

/api/v1/templates/generate

Suggests interview questions and structure based on a job description.

Parameters

job_descriptionRequiredstring

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/templates/generate" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"job_description":"string"}'

Example Response

json

{
  "job_description_received": "We are looking for a Senior Frontend Engineer with Next.js...",
  "suggestions": {
    "title": "Generated Interview Template",
    "avatar_id": "ava-123",
    "language": "en",
    "questions": [
      {
        "text": "Can you describe your experience with React hooks?",
        "behavioral_intent": "Assess technical depth",
        "expected_answer": "Specific projects where hooks managed state."
      }
    ]
  }
}

GET

List interview templates

/api/v1/templates

Returns all interview question templates for the authenticated tenant.

Example Request

bash

curl -X GET "https://your-tenant.peoplelensai.com/api/v1/templates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"

Example Response

json

[
  {
    "id": "tpl-123e4567-e89b-12d3-a456-426614174000",
    "title": "Frontend Behavioral Screen",
    "description": "Standard culture-fit questions for engineers",
    "created_at": "2026-02-25T08:00:00Z"
  }
]

POST

Create an interview template

/api/v1/templates

Creates a new interview question template (e.g., Tech Assessment, Culture Fit).

Parameters

titleRequiredstring

descriptionRequiredstring

initial_messagestring

ending_messagestring

structure_templatearray

Example Request

bash

curl -X POST "https://your-tenant.peoplelensai.com/api/v1/templates" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","initial_message":"string","ending_message":"string","structure_template":[{}]}'

Example Response

json

{
  "id": "tpl-123e4567-e89b-12d3-a456-426614174000",
  "title": "Frontend Behavioral Screen",
  "description": "Standard culture-fit questions for engineers",
  "initial_message": "Welcome to the interview!",
  "ending_message": "Thanks for your time.",
  "structure_template": [
    {
      "id": "1",
      "text": "Tell me about a time you failed.",
      "type": "behavioral"
    }
  ],
  "created_at": "2026-02-25T08:00:00Z"
}