Skip to main content
POST
/
v1
/
organization
/
admin-keys
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/organization/admin-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Admin Key"
}
'
{
  "id": "key_admin_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "key": "sk_admin_1234567890abcdef",
  "name": "My Admin Key",
  "createdAt": "2021-08-01T00:00:00Z",
  "updatedAt": "2021-08-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Body

application/json
​
name
string
required

Human-readable name for the admin key

Minimum string length: 1
Example:

"My Admin Key"

Response

Create a new admin key

​
id
string
required

Unique identifier for a Admin Key. Format: key_admin_[test_]{ksuid}

Pattern: ^key_admin_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"key_admin_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
key
string
required

The admin key (only shown once on creation)

Example:

"sk_admin_1234567890abcdef"

​
name
string
required

Human-readable name

Example:

"My Admin Key"

​
createdAt
string<date-time>
required

When the key was created

Example:

"2021-08-01T00:00:00Z"

​
updatedAt
string<date-time>
required

When the key was last updated

Example:

"2021-08-01T00:00:00Z"