Skip to main content
POST
/
v1
/
organization
/
app-keys
cURL
curl --request POST \
  --url https://api.buildwithchirp.com/v1/organization/app-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My App Key",
  "appId": "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"
}
'
{
  "id": "key_app_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "key": "sk_live_app_1234567890abcdef",
  "name": "My App Key",
  "appId": "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "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 app key

Minimum string length: 1
Example:

"My App Key"

​
appId
string
required

ID of the app this key belongs to

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

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Create a new app key

​
id
string
required

Unique identifier for a App Key. Format: key_app_[test_]{ksuid}

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

"key_app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
key
string
required

The app key (only shown once on creation)

Example:

"sk_live_app_1234567890abcdef"

​
name
string
required

Human-readable name

Example:

"My App Key"

​
appId
string
required

Unique identifier for a App. Format: app_[test_]{ksuid}

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

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
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"