Sign in

v1

latestOpenAPI 3.0.12026-07-227292131.4 KB
organizations

Create an API key

Allows a user to generate an API key for their organization.

post/organizations/{orgId}/api-keys

Path parameters

orgIdstring uuid required
Example:a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

The organization's ID.

  • Must be a valid UUID.

Request body

namestring required

The API key name.

scope'ie_model' | 'ce_resource'

The API key scope. Default value is ie_model.

expiresAtinteger

The UNIX timestamp when API key will expire (UTC).

  • Must be a UNIX timestamp in seconds and must be greater than the current time.
  • If not set, the key will not expire.

Example request

{
  "name": "My Service API Key",
  "scope": "ie_model",
  "expiresAt": 1738812775
}

Response

Successfully created an API key.

keystring required

The generated API key (returned only once).

Example response

{
  "key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImM2NDNh..."
}