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

# Kovi API Reference — Overview, Base URL, Endpoints

> Kovi's REST API lets you schedule interviews and retrieve scorecards programmatically. All endpoints use HTTPS and return JSON responses.

The Kovi REST API gives you full programmatic control over interview scheduling and scorecard retrieval. All requests use HTTPS, and all responses are JSON.

## Base URL

Every API request is made to the following base URL:

```
https://api.techeval.ai/v1
```

## Authentication

All requests require your API key in the `Authorization` header:

```http theme={null}
Authorization: Bearer YOUR_API_KEY
```

See the [Authentication](/api-reference/authentication) page for full details on obtaining and managing your API key.

## Request Format

For `POST` requests, send a JSON body and include the `Content-Type` header:

```http theme={null}
Content-Type: application/json
```

Pass all parameters as a JSON object in the request body.

## Response Format

All responses return JSON. Successful responses include the requested resource object. Failed responses include the following error fields:

| Field | Type | Description |
| - | - | - |
| `error` | string | Machine-readable error code (e.g., `"unauthorized"`) |
| `message` | string | Human-readable description of the error |

**Example error response:**

```json theme={null}
{
  "error": "unauthorized",
  "message": "Missing or invalid API key. Include a valid Bearer token in the Authorization header."
}
```

## Rate Limits

Standard rate limiting applies to all API endpoints. If you exceed your rate limit, the API returns a `429 Too Many Requests` response. Contact [support@techeval.ai](mailto:support@techeval.ai) to request a higher rate limit for your account.

## Available Endpoints

<CardGroup cols={2}>
  <Card title="Schedule Interview" icon="calendar-plus" href="/api-reference/interviews/schedule">
    **POST /interviews**

    Create a new interview session for a candidate and get a shareable interview URL.
  </Card>

  <Card title="Retrieve Interview" icon="magnifying-glass" href="/api-reference/interviews/retrieve">
    **GET /interviews/\{interview\_id}**

    Fetch the current status and metadata for a specific interview session.
  </Card>

  <Card title="List Interviews" icon="list" href="/api-reference/interviews/list">
    **GET /interviews**

    Retrieve a paginated list of all interview sessions for your account.
  </Card>

  <Card title="Get Scorecard" icon="chart-bar" href="/api-reference/scorecards/get-scorecard">
    **GET /scorecards/\{candidate\_id}**

    Fetch the full evaluation scorecard for a completed interview.
  </Card>

  <Card title="Get Transcript" icon="file-lines" href="/api-reference/scorecards/transcript">
    **GET /transcripts/\{candidate\_id}**

    Retrieve the full question-and-answer transcript URL for a completed interview.
  </Card>
</CardGroup>

<Note>
  The Python SDK (`kovi-sdk`) wraps these REST endpoints. Use the SDK for simpler integration — install it with `pip install kovi-sdk`.
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.