Skip to main content
POST
Create an ingestion API key

Authorizations

Authorization
string
header
required

A fine-grained data plane API key (values begin with hh_fgdp_). Rooted at an organization, workspace, or project, it carries the permissions chosen when it was created, and only the operations whose paths begin with /v1/projects/{project_id}/ accept it. Create one in the HoneyHive app under the project's, workspace's, or organization's Settings → API Keys, on the Data Plane tab.

Path Parameters

project_id
string
required

The unique identifier of the project the key belongs to

Body

application/json
name
string
required

A name for the key, shown in the key list.

Required string length: 1 - 256
description
string

What the key is for.

Maximum string length: 1024

Response

200 - application/json

Ingestion API key created successfully

success
enum<boolean>
required
Available options:
true
data
object
required