List Providers

from portkey_ai import Portkey

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

# List providers
# Optional workspace_id
providers = portkey.providers.list(workspace_id="")

print(providers)

{
  "object": "list",
  "total": 123,
  "data": [
    {
      "name": "Open AI Workspace",
      "integration_id": "<string>",
      "note": "randomness",
      "status": "active",
      "usage_limits": {
        "credit_limit": 10,
        "periodic_reset": "monthly",
        "alert_threshold": 8
      },
      "reset_usage": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "slug": "<string>",
      "rate_limits": [
        {
          "type": "requests",
          "unit": "rpd",
          "value": 123
        }
      ],
      "expires_at": "2023-11-07T05:31:56Z",
      "object": "provider"
    }
  ]
}

GET

providers

from portkey_ai import Portkey

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

# List providers
# Optional workspace_id
providers = portkey.providers.list(workspace_id="")

print(providers)

{
  "object": "list",
  "total": 123,
  "data": [
    {
      "name": "Open AI Workspace",
      "integration_id": "<string>",
      "note": "randomness",
      "status": "active",
      "usage_limits": {
        "credit_limit": 10,
        "periodic_reset": "monthly",
        "alert_threshold": 8
      },
      "reset_usage": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "slug": "<string>",
      "rate_limits": [
        {
          "type": "requests",
          "unit": "rpd",
          "value": 123
        }
      ],
      "expires_at": "2023-11-07T05:31:56Z",
      "object": "provider"
    }
  ]
}

Authorizations

x-portkey-api-key

string

header

required

Query Parameters

current_page

integer

Current page, defaults to 0

page_size

integer

Page size, default to 50

workspace_id

string

Not required when using workspace API keys. Required when using organisation admin keys

Response

200 - application/json

Successful response

object

enum<string>

Available options:

list

total

integer

Total number of providers

data

object[]

Show child attributes

data.name

string

Example:

"Open AI Workspace"

data.integration_id

string

data.note

string | null

Example:

"randomness"

data.status

enum<string>

Available options:

active,

exhausted,

expired

data.usage_limits

object

Show child attributes

data.usage_limits.credit_limit

integer

Credit Limit. Used for tracking usage

Required range: x >= 1

data.usage_limits.type

enum<string>

Type of credit limit

Available options:

cost,

tokens

data.usage_limits.alert_threshold

integer

Alert Threshold. Used for alerting when usage reaches more than this

Required range: x >= 1

data.usage_limits.periodic_reset

enum<string>

Reset the usage periodically.

Available options:

monthly,

weekly

Example:

{
  "credit_limit": 10,
  "periodic_reset": "monthly",
  "alert_threshold": 8
}

data.reset_usage

number | null

Example:

0

data.created_at

string<date-time>

data.slug

string

data.rate_limits

object[] | null

Show child attributes

data.rate_limits.type

enum<string>

Available options:

requests,

tokens

data.rate_limits.unit

enum<string>

Available options:

rpd,

rph,

rpm

data.rate_limits.value

integer

data.expires_at

string<date-time>

data.object

enum<string>

Available options:

provider

Create Provider Retrieve Provider

⌘I

API Reference

Configs

Integrations

Providers

Virtual Keys

Prompts

API Keys

Analytics [BETA]

Users

User Invites

Workspaces

Workspace Members

Audit Logs

Guardrails

Policies

OpenAPI

Authorizations

Query Parameters

Response