Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Retell AI Agent Playground Completion API

The Agent Playground Completion API from Retell AI — 1 operation(s) for agent playground completion.

Retell AI Agent Playground Completion API is one of 78 APIs that Retell AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Agent Playground Completion. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and pricing.

This API exposes 1 operation across 1 path, and defines 14 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://api.retellai.com.

1 operations 1 paths 14 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://api.retellai.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Retell AI Agent Playground Completion API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (string) (api_key). By default, every request must be authenticated.

  • api_key — Authentication header containing API key (find it in dashboard). The format is "Bearer YOURAPIKEY"

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Agent Playground Completion 1
POST
/agent-playground-completion/{agent_id}
Stateless playground completion. Send the full conversation history (same shape as chat completion messages) and receive only the newly generated messages. Nothing is persisted server-side — the call…
agentPlaygroundCompletion 2 params body → 200400401402422429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are NodeTransitionMessageBase (8 properties), ToolCallInvocationMessageBase (7 properties), ToolCallResultMessageBase (6 properties), StateTransitionMessageBase (5 properties). Each schema is shown below with its type and property counts.

ToolMock
object
4 properties 3 required
Message
NodeTransitionMessageBase
object
8 properties 1 required
ToolCallInvocationMessage
ToolCallResultMessageBase
object
6 properties 3 required
MessageBase
object
4 properties 2 required
ChatMessageInput
Same shape as chat completion messages. messageid and createdtimestamp are optional — server generates them if omitted.
MessageOrToolCall
NodeTransitionMessage
ToolMockInputMatchRule
ToolCallResultMessage
StateTransitionMessage
ToolCallInvocationMessageBase
object
7 properties 4 required
StateTransitionMessageBase
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

retell-ai-agent-playground-completion-api-openapi.yml Raw ↑

Other APIs Retell AI publishes across the network.

Retell AI Add Community Voice API
Retell AI Add Knowledge Base Sources API
Retell AI Clone Voice API
Retell AI Create Agent API
Retell AI Create Agent Version API
Retell AI Create Batch Call API
Retell AI Create Batch Test API
Retell AI Create Chat Agent API
Retell AI Create Chat API
Retell AI Create Chat Completion API
Retell AI Create Conversation Flow API
Retell AI Create Conversation Flow Component API