Skip to main content

​
Prerequisites

  • Node.js 22.13 or later, and telnyx-edge 0.5.7 or later on the PATH (or TELNYX_EDGE_BIN pointing at it).
  • The CLI, installed and signed in:
telnyx-acp update keeps it current from then on, and the CLI says when a newer release exists; Utilities has both.
Beta. @telnyx/acp is a pre-release, and the control plane has no API of its own yet. See Beta Limitations.

​
1. Create

create with no flags opens the wizard, the recommended way in: it asks one question at a time, checks each answer as it goes (a number is looked up in the account, a model picked from the ones the account can use), and shows what it will write before it writes it. It asks, in order, for:
  • the project name
  • how to build the agent, and the language for a code project
  • the model
  • a phone number
  • email
  • a channel by artifact id
  • a browser page
  • a call greeting, when a number was added
  • memory
  • a step limit
Then it shows what it will write, and writes it.
Name the project:The wizard's Project prompt with support-agent typedChoose configuration, the recommended path, or code:How would you like to build your agent? Define agent in configuration (recommended), Define agent in code, SkipPick the model from what the account can use; type to search. The example picks zai-org/GLM-5.3-Flash:The Model picker filtered by typing, with zai-org/GLM-5.3-Flash selectedSay no to a phone number for now; step 5 adds one:Add a phone number now? with No selected, under a note on where to get a numberSay no to email, to a channel and to a chat page as well; each is one add later.Keep memory on:Remember people with Agent Memory? with Yes selectedSay no to the step limit, which keeps the default of 8. Confirm what create will write, and it writes it:The summary of the files create will write, the Create it? prompt, the created files, and the next commands: dev, chat, deploy, status, logs
zai-org/GLM-5.3-Flash is hosted by Telnyx, so the agent answers with no key added. telnyx-acp models lists what else the account can use; Models and Instructions covers the BYOK scenario. create writes a starter system prompt in instructions.md. Models and Instructions covers customization.

​
2. Run It Locally

In a second terminal, start a session with chat; each line is a turn on the same conversation.
invoke is one turn per command, so turns across sessions can interleave; each conversation keeps its own context.
--stream prints each assistant message as it lands. The outbound calls are the model’s and those of any tools; inbound channels and memory need a deploy; with a number or a voice block, the page’s mic button tries the voice settings locally. Local Development lists what else differs.

​
3. Deploy

The first deploy registers the agent and builds it (a build typically takes about ten minutes; deploy waits up to 25); every deploy after that is a new revision. The agent comes up at its mount, the function’s public URL:
.telnyx/ is written beside the project files by dev and on every deploy; the scaffolded .gitignore already excludes it. After the first deploy agent.json also records the function id, the mount URL, the actor type and the active revision under deployed.

​
4. Invoke the Deployed Agent

Then watch it:

​
5. Give the Agent a Phone Number

Prerequisites:
  1. A number in the account with voice and messaging enabled. telnyx-acp numbers lists them; if there is none, buy one in Mission Control → Numbers → Search & Buy.
  2. The account’s webhook public key (Mission Control → Account → Keys & Credentials → Public Key).
Call the number. Text it from the terminal: telnyx-acp text "hi" sends an SMS from one of the account’s own numbers and prints the reply; both numbers are Telnyx’s, so no 10DLC registration is needed. A text from a personal phone reaches the agent, but a US handset gets the reply only once the number is 10DLC-registered, and a phone outside the US cannot reach a US long code at all; Messaging has the detail.

​
6. Change It, Ship Again

Edit instructions.md, or change one field of agent.json with telnyx-acp set, and run telnyx-acp deploy again. Every deploy is a new revision; telnyx-acp versions support-agent lists them, with the project’s git short SHA when the project is a git repository.

​
7. Tear Down

delete removes the Telnyx resources deploy created and restores the webhooks of pre-existing ones; local project files stay.