Skip to content

Create api keys

POST
/api-keys
curl --request POST \
--url https://api.testzilla.ai/v1/api-keys \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "label": "example" }'
Media type application/json
object
label
required

A non-empty human label for the key (max 100 chars), e.g. “CI pipeline”.

string
>= 1 characters <= 100 characters
Example generated
{
"label": "example"
}

Key created. The raw apiKey is returned here and nowhere else, ever.

Media type application/json

One-time response carrying the raw secret API key. Returned ONLY on create and rotate, and never again — the raw key is not stored and cannot be retrieved later.

object
success
required
boolean
id
required

Key identifier (Firestore doc id).

string
label
required

The key label.

string
prefix
required

Non-secret display prefix, e.g. “tz_a1b2c3d4”.

string
apiKey
required

The raw secret API key. Shown EXACTLY ONCE. Store it immediately; it cannot be recovered afterwards.

string
warning
required

Human-readable reminder that the key will not be shown again.

string
Example
{
"success": true
}

Missing or invalid label.

Media type application/json
object
error
required

Human-readable error message.

string
Example generated
{
"error": "example"
}

Unauthorized (missing or invalid API key)

Not found

Per-user active-key limit reached (max 25). Revoke one before creating another.

Media type application/json
object
error
required

Human-readable error message.

string
Example generated
{
"error": "example"
}