> ## Documentation Index
> Fetch the complete documentation index at: https://docs.instaview.sk/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Agent

> Returns a single agent, ensuring it belongs to the API key's company.

Retrieves a specific agent (interview template) by ID, including all configuration details, questions, and evaluation criteria.

## Overview

The get agent endpoint returns complete information about a single agent, including its name, description, voice settings, interview type, questions, and evaluation criteria. Use this endpoint to review agent configuration before using it in interviews.

## Use Cases

* **Review Agent Configuration**: Inspect agent settings before scheduling interviews
* **Validate Agent Details**: Verify questions and evaluation criteria
* **Agent Auditing**: Review agent configurations for compliance
* **Configuration Reference**: Get agent details for documentation or reporting

## Response Data

The response includes all agent configuration:

```json theme={null}
{
  "id": "agent-uuid",
  "name": "Technical Screening Agent",
  "type": "ONLINE",
  "focus": "SCREENING",
  "language": "EN",
  "duration": 30,
  "questions": [
    "Tell me about your React experience",
    "Explain microservices architecture"
  ],
  "instructions": "Focus on technical depth and accuracy, problem-solving approach",
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-20T14:30:00Z"
}
```

## When to Use

Use this endpoint when you need complete agent details. For listing multiple agents, use the [List Agents](/api-reference/agents/list-agents) endpoint instead.

## Company Isolation

You can only access agents that belong to your API key's company. Attempting to access an agent from another company will result in a `403 Forbidden` error.

## Error Scenarios

* **404 Not Found**: Agent doesn't exist or has been deleted
* **403 Forbidden**: Agent belongs to a different company

## Related Resources

<CardGroup cols={2}>
  <Card title="Agents Resource Guide" icon="robot" href="/guides/resources/agents">
    Learn about agent configuration
  </Card>

  <Card title="Update Agent" icon="pen" href="/api-reference/agents/update-agent">
    Modify agent configuration
  </Card>

  <Card title="List Agents" icon="list" href="/api-reference/agents/list-agents">
    Browse all available agents
  </Card>
</CardGroup>


## OpenAPI

````yaml GET /agents/{id}
openapi: 3.0.0
info:
  title: InstaView API
  description: |-
    InstaView API Documentation

    ## Authentication

    All endpoints require API key authentication using Bearer token:
    ```
    Authorization: Bearer sk_your_api_key_here
    ```

    ## API Key Management

    The API Key module provides comprehensive key management for:
    - **Direct Client Keys**: Company-scoped keys for your applications
    - **ATS Partner Keys**: Resource-scoped keys for ATS integrations

    ### Key Features
    - HMAC-SHA256 hashing for API key storage
    - Configurable rate limiting
    - Comprehensive audit logging
    - Company-level isolation
    - Resource scoping for ATS partners
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.instaview.sk
    description: Production API Gateway
security: []
tags: []
paths:
  /agents/{id}:
    get:
      tags:
        - Agents
      summary: Get agent by ID
      description: Returns a single agent, ensuring it belongs to the API key's company.
      operationId: PublicAgentsController_getById_v1
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
            format: uuid
        - name: companyId
          required: false
          in: query
          description: >-
            Required for ATS API keys to specify which company to access.
            Ignored for standard company API keys.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAgentDto'
      security:
        - bearer: []
components:
  schemas:
    PublicAgentDto:
      type: object
      properties:
        id:
          type: string
          description: Agent ID
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: Agent name
          example: Frontend Developer Interview
        type:
          type: string
          description: Type of the agent
          enum:
            - UNDEFINED
            - ONLINE
            - PHONE
          example: ONLINE
        focus:
          type: string
          description: >-
            Focus of the agent. GENERIC: For jobless interviews where candidates
            don't need job assignments. SCREENING: Initial candidate screening
            and assessment. OUTREACH: Candidate outreach and engagement.
            LANGUAGE_TEST: Language proficiency assessment.
          enum:
            - GENERIC
            - SCREENING
            - OUTREACH
            - LANGUAGE_TEST
          example: SCREENING
        questions:
          description: List of questions for the interview
          example:
            - What is your experience with React?
          type: array
          items:
            type: string
        instructions:
          type: string
          description: Additional instructions for the interview
          example: Focus on technical skills and previous project experience
        language:
          type: string
          description: Language of the interview
          enum:
            - UNDEFINED
            - EN
            - JA
            - ZH
            - DE
            - HI
            - FR
            - KO
            - PT
            - IT
            - ES
            - ID
            - NL
            - TR
            - FIL
            - PL
            - SV
            - BG
            - RO
            - AR
            - CS
            - EL
            - FI
            - HR
            - MS
            - SK
            - DA
            - TA
            - UK
            - RU
            - HU
            - 'NO'
            - VI
          example: EN
        duration:
          type: number
          description: Duration of the interview in minutes
          example: 30
        voiceId:
          type: string
          description: Voice ID for the AI interview
          enum:
            - ALEX
            - PETER
            - MIRIAM
            - SUE
            - VIERA
            - CASANDRA
            - SILVIA
            - MICHAEL
            - LUKE
            - EMMA
            - SARAH
            - EVA
        companyId:
          type: string
          format: uuid
          description: Company ID that owns the agent
          example: 123e4567-e89b-12d3-a456-426614174000
        metadata:
          type: object
          description: Custom metadata
          example:
            department: Sales
        cefrLevel:
          type: string
          description: CEFR level for language test agents
          enum:
            - A1
            - A2
            - B1
            - B2
            - C1
            - C2
          example: B1
        backgroundSound:
          type: string
          description: >-
            Ambient background sound during calls (`OFFICE` or `OFF`). Null
            means no override is set and the default applies.
          enum:
            - 'OFF'
            - OFFICE
          example: OFFICE
          nullable: true
        createdAt:
          type: string
          description: Agent creation timestamp (UTC)
          example: '2025-11-20T10:30:00Z'
          format: date-time
        updatedAt:
          type: string
          description: Agent last update timestamp (UTC)
          example: '2025-11-20T10:30:00Z'
          format: date-time
      required:
        - id
        - name
        - type
        - focus
        - language
        - duration
        - createdAt
        - updatedAt
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: API key for authentication using Bearer scheme

````