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

# API Introduction

> Introduction to the OmniAI API

# API Introduction

Welcome to the OmniAI API. This API allows you to programmatically manage leads, documents, and webhooks in your AI Lending workspace.

## Base URL

```
https://api-v2.getomni.ai
```

## Authentication

All API requests require authentication using an API key. Include your API key in the request header:

```
x-api-key: YOUR_API_KEY
```

## Getting Your API Key

You can get your API Key in [workspace settings](https://platform.getomni.ai/settings/api).

## API Version

The current API version is `v1`. All endpoints are prefixed with `/api/v1/`.

## Request Format

All requests should use:

* **Content-Type**: `application/json`
* **Headers**: Include `x-api-key` for authentication

## Response Format

All responses are returned in JSON format. Successful responses include a `200` status code.

## Rate Limits

API rate limits apply to prevent abuse. Contact support if you need higher limits.

## Error Handling

Errors are returned with appropriate HTTP status codes:

* `400`: Bad Request - Invalid parameters
* `401`: Unauthorized - Invalid or missing API key
* `404`: Not Found - Resource doesn't exist
* `500`: Internal Server Error - Server error

## Endpoints Overview

<CardGroup cols={2}>
  <Card title="Leads" href="/api-reference/leads/list-leads">
    Manage leads and retrieve lead data
  </Card>

  <Card title="Documents" href="/api-reference/documents/get-document">
    Retrieve and manage documents
  </Card>

  <Card title="Webhooks" href="/api-reference/webhooks/list-webhooks">
    Configure webhooks for real-time events
  </Card>
</CardGroup>