Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.poly.ai/llms.txt

Use this file to discover all available pages before exploring further.

API keys page in Agent Studio API keys control access to PolyAI’s external APIs – including the Agents API, Conversations API, Handoff API, and External Events API. Create and manage keys from the API Keys page in Agent Studio.
API keys require the Conversations API v3. If you are using v1, migrate to v3 first.

​
Creating an API key

  1. Go to the API Keys tab on the workspace homepage in Agent Studio
  2. Select API key
  3. Configure the key:
    • Name – a label to identify this key
    • Agents – choose “All agents” or select specific agents (this cannot be changed after creation)
    • Permissions – select which APIs the key can access:
PermissionGrants access to
Conversations dataConversations API – retrieve conversation transcripts and metadata
HandoffHandoff API – read handoff details
External eventsExternal Events API – send events to active conversations
  1. Select Create to generate the key
Copy your API key immediately after creation. The full key value is only shown once.

​
Viewing and managing keys

Your API keys appear on the API Keys page. Each entry shows:
  • Key name and scope (which agents it covers)
  • Expiry date
  • A masked key value with a copy button
  • Edit and delete options
Keys are independent – modifying or deleting one does not affect others.

​
Configuring metrics

Metrics control what data appears in API responses. Configure them separately from API keys:
  1. Select Configuration at the top of the API Keys page
Configuration button on the API Keys page
  1. Enable the metrics you want available in API responses:
    • Response metrics (e.g., CALL_IN_PROGRESS, CALL_COMPLETED, HANDOFF_REASON, HANDOFF_TO)
    • Conversation transcript access
Metrics configuration panel showing response metrics and conversation transcript options
Metrics are configured at the project level, not per key. For data to appear in an API response, both conditions must be met: the API key must have the relevant permission and the project must have the metric enabled.

​
Using your API key

Include the API key in the x-api-key header of your requests: 
curl -X GET "https://api.poly.ai/v3/conversations" \
  -H "x-api-key: YOUR_API_KEY"
For detailed endpoint documentation, see the API reference.

​
Key lifecycle

  • Keys have an expiry date set at creation time
  • Expired keys stop working immediately
  • You can delete keys at any time from the API Keys page
  • There is no limit to the number of keys you can create

​
Best practices

  • Create separate keys for different integrations (e.g., one for your CRM, one for analytics)
  • Use the most restrictive permissions needed for each integration
  • Rotate keys periodically by creating a new key before deleting the old one
  • Monitor key usage through your API response logs

Conversations API

Retrieve conversation metadata and transcripts programmatically.

Handoff API

Access handoff context and manage transitions.

Agents API

Programmatically configure agents, variants, and deployments.

External Events API

Send events to active conversations.
Last modified on April 22, 2026