Create API Key

Create Api Keys

post

Authorizations

Portkey-Key

Path parameters

typestring · enumRequiredPossible values:

sub-typestring · enumRequiredPossible values:

Body

application/json

namestringOptionalExample: Development API Key

descriptionstringOptionalExample: API key for development environment

workspace_idstringOptionalExample: ws-myworkspace

user_idstring · uuidOptionalExample: c3d4e5f6-a7b8-6c7d-0e1f-2a3b4c5d6e7f

scopesstring[]OptionalExample: ["completions.write"]

alert_emailsstring · email[]OptionalExample: [email protected]

expires_atstring · date-timeOptional

Responses

200

OK

application/json

post

DefaultDefaultDefaultSelf-HostedSelf-HostedSelf-Hosted

from portkey_ai import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY",
)

# Create a new API key
api_key = portkey.api_keys.create(
    name="API_KEY_NAME_0909",
    type="organisation",
    sub_type="service",
    workspace_id="WORKSPACE_ID",
    scopes=[
        "logs.export",
        "logs.list",
        "logs.view",
        "configs.create",
        "configs.update",
        "configs.delete",
        "configs.read",
        "configs.list",
        "virtual_keys.create",
        "virtual_keys.update",
        "virtual_keys.delete",
        "virtual_keys.read",
        "virtual_keys.list",
        "virtual_keys.copy"
    ]
)

print(api_key)

200

OK

{
  "id": "183f497a-2a7f-4f47-992e-26213fa863we",
  "key": "abssofjosfjs",
  "object": "api-key"
}