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

# Ingestion Api Keys

> Create ingestion API keys for a project from a provisioning flow, using an organization-rooted data plane key that is permitted to create keys. An ingestion key is the credential an application sends traces with.

## Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:

* `--show-file-schema`: print the JSON Schema for the full request object (the format `--filename` accepts).
* `--show-argument-schema <flag-name>`: print the JSON Schema for one argument's value. Pass the kebab flag name **without** the leading `--` (e.g. `project-id`, not `--project-id`).

Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

## `create`

Create an ingestion API key

Create an ingestion API key for a project, the credential an application sends traces with. The caller's key must carry `project.ingestion_api_key.post` for the project. Only an organization-rooted data plane key created in the organization's **Settings → API Keys**, on the **Data Plane** tab, can carry it. An ingestion key has no permissions of its own and cannot create keys. The project must already exist on this data plane: a project created on the control plane reaches it asynchronously, and the operation answers 404 until it does. `key_value` is returned once and cannot be retrieved again.

### Usage

```sh theme={null}
honeyhive ingestion-api-keys create [options]
```

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--name` | string | yes | A name for the key, shown in the key list. |
| `--project-id` | string | yes | The unique identifier of the project the key belongs to |
| `--description` | string | no | What the key is for. |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.


## Related topics

- [Ingestion Api Keys Methods](/v2/sdk-reference/typescript/ref/ingestion-api-keys/index.md)
- [API Keys](/v2/workspace/api-keys.md)
- [CreateIngestionApiKeyResponse](/v2/sdk-reference/typescript/ref/ingestion-api-keys/CreateIngestionApiKeyResponse.md)


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