Skip to content

Issue a project key for the data plane. The secret is returned once.

POST
/v0/projects/{id}/keys
curl --request POST \
--url https://infra-hyphae.run/v0/projects/example/keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "label": "example" }'
id
required
string
/^prj_[0-9a-f]{16}$/
Media typeapplication/json
object
label
string | null
<= 64 characters
Examplegenerated
{
"label": "example"
}

Key issued.

Media typeapplication/json
object
key_id
required
string
/^[0-9a-f]{32}$/
key
required

Shown once. The control plane keeps a verifier, not the secret.

string
/^hyp1_[0-9a-f]{32}_[0-9a-f]{64}$/
label
string | null
created_at
required

RFC 3339, UTC.

string format: date-time
Examplegenerated
{
"key_id": "example",
"key": "example",
"label": "example",
"created_at": "2026-04-15T12:00:00Z"
}

Malformed or out-of-bounds input (invalid_request).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal
message
required
string
Example
{
"error": {
"code": "invalid_request"
}
}

Missing, malformed, duplicate, or unknown credential (authentication_required).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal
message
required
string
Example
{
"error": {
"code": "invalid_request"
}
}
WWW-Authenticate
string
Allowed value: Bearer realm="hyphae-cloud"

Unknown route, or a project the caller does not own (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal
message
required
string
Example
{
"error": {
"code": "invalid_request"
}
}