> For the complete documentation index, see [llms.txt](https://docs.delphi.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delphi.ai/advanced/api-immortal-only.md).

# API (Immortal Only)

The Delphi API lets you integrate your Digital Mind directly into your own app, platform, or workflow. You have control to the full experience — create conversations, stream responses, manage tags, and track usage through simple HTTP requests.

**Base URL:** `https://api.delphi.ai`

**Current version:** v3

## Getting started

{% stepper %}
{% step %}

### Get an API key

API access is available on the **Immortal** plan. To get started, reach out to your Delphi contact or email **<support@delphi.ai>**.

> **Important:** Store your key securely. It is only shown once and cannot be retrieved later.
> {% endstep %}

{% step %}

### Authenticate

Include your API key in the `x-api-key` header on every request:

```bash
curl https://api.delphi.ai/v3/conversation/list?email=user@example.com \
  -H "x-api-key: YOUR_API_KEY"
```

{% endstep %}

{% step %}

### Start a conversation

```bash
curl -X POST https://api.delphi.ai/v3/conversation \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"user_email": "user@example.com"}'
```

This returns a `conversation_id` and the clone's initial greeting.
{% endstep %}
{% endstepper %}

## Authentication

All endpoints require an API key passed in the `x-api-key` header. The key is scoped to a single clone — you can only interact with conversations and users belonging to that clone.

| Header      | Value        |
| ----------- | ------------ |
| `x-api-key` | Your API key |

## Rate limits

* **120 requests** per **60 seconds** per API key
* Rate limiting is applied across all endpoints
* If you exceed the limit, you'll receive a `429 Too Many Requests` response

## Available endpoints

* [**Audience**](/advanced/api-immortal-only/audience.md) - Store and manage contextual information about users in your audience.
* [**Conversations**](/advanced/api-immortal-only/conversations.md) — Create conversations, stream responses, view history, and manage conversation lifecycle.
* [**Clone**](/advanced/api-immortal-only/clone.md) - Retrieve your clone's public profile information.
* [**Questions**](/advanced/api-immortal-only/questions.md) — Retrieve suggested questions configured for your clone.
* [**Tags**](/advanced/api-immortal-only/tags.md) — Create tags and organize your audience.
* [**Usage**](/advanced/api-immortal-only/usage.md) — Track consumption metrics and access tiers for your users.
* [**Voice**](/advanced/api-immortal-only/voice.md) — Stream voice responses as real-time PCM audio.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.delphi.ai/advanced/api-immortal-only.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.