Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check out our upcoming events and meetups! View events →
@telnyx/edge-runtime. Its export is the Agent class. Anything that implements the turn taking runs on the class.
The class is hosted by the Agent Runtime Platform, which invokes it at its entry points; see Entry Points for detail.
| Export | What it is |
|---|---|
@telnyx/edge-runtime | The Agent class, the StatefulActor it extends, and the types of the environment and its bindings. |
@telnyx/edge-runtime/client | AgentClient, documented as The Agent Client SDK. |
@telnyx/edge-runtime/mount | mountAgents, the function entry that serves every instance at one address. |
@telnyx/edge-runtime/agent-socket | AgentSocketServer, the server half of the agent socket protocol. |
@telnyx/edge-runtime/agent-http | AgentHttpServer, the streams and RPC over HTTP. |
@telnyx/edge-runtime/voice | The voice() mixin, with Telnyx STT and TTS for calls. |
@telnyx/edge-runtime/internal | Seams for trusted adapters, such as the harness’s. Not for application code. |
Agent class in two parts.
The Interface is what is exposed to the layer above, the class and what an instance has.
| Group | What it is for |
|---|---|
| Lifecycle | Construct an instance with its options, and erase everything it holds. |
| Values | Reach the message log, the event log, the bindings and the actor context. |
| State | Read and write the instance’s persistent state, and react to its changes. |
| Tasks | Run work after the request returns, now, later or at an interval. |
| Children | Create, list and end child instances. |
| Connections | Decide who may connect, and receive the sockets and requests that arrive. |
| RPC | Make a method callable over the address. |
| Group | What it is |
|---|---|
| Entry Points | The methods the platform invokes on the class. |
| The Address and Transports | Where an instance answers, and over what. |
| Mount | The function entry that serves every instance at one address. |
| AgentSocketServer | The server half of the agent socket protocol. |
| AgentHttpServer | The streams and RPC over HTTP. |
| Limits | The budgets, retries, storage and name lengths an instance works within. |
Was this page helpful?