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

# Introduction

> Start here for the Aurigin API v1 reference

## Welcome to the Aurigin API

The Aurigin API provides powerful audio analysis capabilities for deepfake detection and voice identification. Our REST API is designed for ease of use while providing enterprise-grade performance and reliability.

**Two layers of voice security:**

1. **Deepfake Detection** → Verify if a voice is authentic or AI-generated
2. **Voice Identification (Voice ID)** → Confirm who is speaking by matching against enrolled voiceprints

Together, these capabilities create a comprehensive foundation for voice fraud prevention and identity verification.

## Base URL

All API requests are made to:

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

## Authentication

All endpoints require authentication via API key in the `X-Api-Key` header:

```bash theme={null}
curl https://api.aurigin.ai/v1/predict \
  -H "X-Api-Key: YOUR_API_KEY"
```

<Note>
  Get your API key from the [Aurigin Dashboard](https://app.aurigin.ai/api)
</Note>

## Endpoints Overview

### Deepfake Detection Endpoints

| Endpoint   | Processing   | Use Case             |
| ---------- | ------------ | -------------------- |
| `/predict` | Synchronous  | Direct file analysis |
| `/file`    | Asynchronous | Large files (100MB+) |

### Voice ID Endpoints

| Endpoint          | Description                             | Use Case                               |
| ----------------- | --------------------------------------- | -------------------------------------- |
| `/voiceid/enroll` | Create a voiceprint from a voice sample | Enroll users for identity verification |
| `/voiceid/verify` | Verify voice identity and authenticity  | Authenticate users and prevent fraud   |

## Response Format

All successful API responses return JSON with a consistent structure:

```json theme={null}
{
  "prediction_id": "pred_abc123def456",
  "global": {
    "confidence": 0.9921,
    "result": "spoofed",
    "reason": null
  },
  "segments": [...],
  "model": "stable-latest",
  "processing_time": 1.23,
  "audio_duration": 10.0,
  "warnings": []
}
```

### Key Fields

<ResponseField name="prediction_id" type="string">
  Unique identifier for tracking this prediction
</ResponseField>

<ResponseField name="global" type="object">
  Overall prediction with confidence score and classification result
</ResponseField>

<ResponseField name="segments" type="array">
  Per-segment analysis for timeline-based insights
</ResponseField>

<ResponseField name="model" type="string">
  Model version used for the prediction
</ResponseField>

## Error Handling

All errors return a consistent error response:

```json theme={null}
{
  "error": "error_code",
  "message": "Human-readable error message",
  "correlation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
```

### Common Error Codes

| Code | Description                                    |
| ---- | ---------------------------------------------- |
| 400  | Bad Request - Invalid parameters               |
| 401  | Unauthorized - Invalid or missing API key      |
| 403  | Forbidden - Insufficient permissions           |
| 404  | Not Found - Resource doesn't exist             |
| 413  | Payload Too Large - File exceeds size limit    |
| 422  | Unprocessable Entity - Invalid file format     |
| 429  | Too Many Requests - Rate limit exceeded        |
| 500  | Internal Server Error - Server-side issue      |
| 503  | Service Unavailable - Temporary unavailability |

## Versioning

The API uses URL versioning. The current stable version is `v1`:

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

<Info>
  API versions are maintained for 6 months after deprecation. You'll receive advance notice of any breaking changes.
</Info>

## Next Steps

<Steps>
  <Step title="Get API Key">
    [Create an API key](https://app.aurigin.ai/api) in the dashboard
  </Step>

  <Step title="Make First Request">
    Try the [Quickstart guide](/quickstart) to analyze your first audio file
  </Step>

  <Step title="Explore Endpoints">
    Browse the [Deepfake Detection](/api-reference/v1/endpoint/predict) and [Voice ID](/api-reference/v1/endpoint/enroll) documentation
  </Step>
</Steps>