Skip to main content
POST
/
keys
Create an API key
curl --request POST \
  --url https://apix.spotzee.com/api/client/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "CI bot"
}
'
{
  "id": 12,
  "project_id": 123,
  "name": "Production server",
  "scope": "public",
  "role": "support",
  "value": "sk_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "is_system_key": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Body

application/json

Create a new project API key. The full value is returned exactly once — store it immediately; subsequent reads return a masked form.

​
name
string
required

Label for the new API key.

Minimum string length: 1
Example:

"CI bot"

​
scope
enum<string>

Defaults to secret when omitted.

Available options:
public,
secret
​
description
string | null
​
role
enum<string>

Project role granted to the key. Defaults to support when omitted.

Available options:
support,
smtpproxy,
editor,
publisher,
admin

Response

The newly created API key, including its full value.

A project-scoped API key. Scope (public/secret) controls what endpoints it can call; role gates write access.

​
id
integer
required

Numeric API key identifier.

Example:

12

​
project_id
integer
required
​
name
string
required

Human-readable label for the API key.

Example:

"Production server"

​
scope
enum<string>
required

public (pk_) keys are safe to embed in browser/SDK code on an explicit allowlist of endpoints. secret (sk_) keys grant full project-scoped access and must be kept server-side.

Available options:
public,
secret
​
role
enum<string>
required

The caller’s role on this project.

Available options:
support,
smtpproxy,
editor,
publisher,
admin
​
value
string
required

The key value, prefixed with sk_ (secret) or pk_ (public). Returned in full only on creation; subsequent reads return a masked form.

Example:

"sk_01HXY7Z9K8M5J2N4P6Q8R0S1T2"

​
created_at
string | null
required
​
updated_at
string | null
required
​
description
string | null

Optional description.

​
is_system_key
boolean

When true, the key is system-managed and cannot be archived from the API.