Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.

Setup

  1. Create a Portkey account: Go to https://app.portkey.ai and sign up - the free developer plan is enough to test the gateway and analytics.
  2. Create an Admin API key: In the Portkey dashboard, open API Keys (https://app.portkey.ai/api-keys) and create an Admin API key. Admin keys grant organization-wide access; workspace keys cannot call the analytics endpoints. You need the Organization Owner or Admin role.
  3. Store the key: Add it to your .env file as PORTKEY_API_KEY=…
  4. Find your workspace slug: The workspace slug is visible in the Portkey dashboard URL and workspace settings; analytics tools require it as the workspace_slug parameter.
  5. Verify access: Run Get Cost Analytics with a recent date range. A 401 means the key is invalid; a 403 usually means you used a workspace key instead of an Admin key.
  • Analytics only covers traffic routed through the Portkey gateway - direct provider calls won’t appear
  • Time range parameters (time_of_generation_min/max) are required on all analytics endpoints and must be ISO8601 timestamps
  • The virtual keys API is deprecated in favor of the newer Providers API, but existing virtual keys still work and remain listable
Provider API reference: https://portkey.ai/docs/api-reference/admin-api/introduction

Tools

Example prompts

  • Pull my Portkey cost analytics for the last 30 days and summarize spend trends by model.
  • Show me Portkey request and token usage for the last week and flag any unusual spikes or error rates.
  • List my Portkey virtual keys and flag any that are exhausted or close to expiry.