POST
/
api-keys
/
{type}
/
{sub-type}
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)
{
  "id": "183f497a-2a7f-4f47-992e-26213fa863we",
  "key": "abssofjosfjs",
  "object": "api-key"
}

Authorizations

x-portkey-api-key
string
header
required

Path Parameters

type
enum<string>
required
Available options:
organisation,
workspace
sub-type
enum<string>
required
Available options:
user,
service

Body

application/json
name
string
Example:

"Development API Key"

description
string
Example:

"API key for development environment"

workspace_id
string
Example:

"ws-myworkspace"

user_id
string<uuid>
Example:

"c3d4e5f6-a7b8-6c7d-0e1f-2a3b4c5d6e7f"

rate_limits
object[]
usage_limits
object
Example:
{
"credit_limit": 10,
"periodic_reset": "monthly",
"alert_threshold": 8
}
scopes
string[]
Example:
["completions.write"]
defaults
object
alert_emails
string<email>[]
expires_at
string<date-time>

Response

200 - application/json

OK

id
string<uuid>
Example:

"183f497a-2a7f-4f47-992e-26213fa863we"

key
string
Example:

"abssofjosfjs"

object
enum<string>
Available options:
api-key
Example:

"api-key"