Skip to main content
POST
Use a credential authorized to create keys for the selected team, such as an API key management key. Set expires_at to a future timestamp within your organization’s limit. Omit it or pass null only when your organization allows keys without an expiration. To create an inference key for a model, set BASETEN_API_KEY to your administrative credential. Replace <team-id> with the owning team’s ID, <model-id> with an allowed model, and <expires-at> with a permitted ISO 8601 timestamp, such as 2027-01-15T00:00:00Z. Include Z for UTC or an explicit offset. Run the following request:
Include every allowed model in model_ids. Omitting the field, setting it to null, or passing an empty list grants access to all team models. Copy the returned api_key immediately; you can’t retrieve it again. For more information, see Key types and Key expiration.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

team_id
string
required

Body

application/json

Request to create an API key.

type
enum<string>
required

Type of the API key.

Available options:
PERSONAL,
GRID,
WORKSPACE_MANAGE_ALL,
WORKSPACE_EXPORT_METRICS,
WORKSPACE_INVOKE,
WORKSPACE_MANAGE_API_KEYS
Examples:

"PERSONAL"

"GRID"

"WORKSPACE_MANAGE_API_KEYS"

"WORKSPACE_EXPORT_METRICS"

"WORKSPACE_INVOKE"

"WORKSPACE_MANAGE_ALL"

name
string | null

Optional name for the API key

Example:

"my-api-key"

model_ids
string[] | null

List of model IDs to scope the API key to, only present if type is 'WORKSPACE_EXPORT_METRICS' or 'WORKSPACE_INVOKE'

Example:
expires_at
string<date-time> | null

Expiration time in UTC. Must be in the future. Personal keys must expire within 90 days, or sooner if your organization sets a lower limit. Team and organization keys require an expiration within your organization's limit when one is set; otherwise they may omit it or use null. Organization lifetime limits do not apply to Grid keys.

Example:

"2027-01-01T00:00:00Z"

team_id
string | null

Team ID for a team-scoped key. When omitted, uses the team in the URL if present, otherwise your organization's default team. Must match the URL team when both are provided. Not supported for PERSONAL or WORKSPACE_MANAGE_API_KEYS keys.

Minimum string length: 1

Response

200 - application/json

Represents an API key.

api_key
string
required

The API key string