Skip to main content
POST
/
v1
/
api-keys
Create an API key
curl --request POST \
  --url https://api.zeroclick.am/v1/api-keys \
  --header 'Content-Type: application/json' \
  --header 'x-zam-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "scopes": [
    "provider:create"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "keyPrefix": "<string>",
  "plaintextKey": "<string>",
  "scopes": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.zeroclick.am/llms.txt

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

Authorizations

​
x-zam-api-key
string
header
required

ZAM API key. Starts with zam_.

Body

application/json
​
name
string
required

Human-readable name for the key

​
scopes
enum<string>[]
required

Permissions granted to this key

Available options:
provider:create,
provider:read,
provider:update,
provider:delete,
order:create,
order:read,
api_key:create,
api_key:read,
api_key:update,
api_key:delete

Response

Created API key (includes plaintext key — shown only once)

Returned only at creation time. The plaintext key cannot be retrieved later.

​
id
string<uuid>
​
name
string
​
keyPrefix
string
​
plaintextKey
string

The full API key. Store it securely.

​
scopes
string[]
​
createdAt
string<date-time>