Skip to main content
POST
/
api
/
auth
/
api_key
/
create
Create an API key
curl --request POST \
  --url https://{customer-tenant}.nuwacom.ai/api/auth/api_key/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": {},
  "expiration": "<string>"
}
'
{
  "id": "<string>",
  "key": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Name for the API key (e.g., "Zapier integration").

Minimum string length: 1
permissions
object
required

A map of space IDs to permissions. Each space ID is associated with an array of permissions that the API key will have access to in that space.

expiration

Optional expiration value (ISO timestamp or UNIX seconds) after which the API key becomes invalid.

Response

API key created successfully

id
string
required

Unique ID of the newly created API key.

key
string
required

The API secret itself. This is confidential and should be stored securely.