Skip to main content
Create, deploy, and manage voice agents from the command line.

​
Installation

By running the quick install commands, you are accepting Cartesia’s Terms of Service (TOS). Please make sure to review the full TOS here before proceeding.
Install and download from our servers:
Update to the latest version:

​
Quick Start

1

Login with API key

Authenticate with your Cartesia API key. To make an API key, go to play.cartesia.ai/keys and select your organization.
2

Clone an example agent

Clone an example agent from the Line repository.
3

Initialize your agent

Give your agent a name and link it to your organization.
4

Deploy your agent

Deploy your agent to make it available in the playground.

​
Features

​
Initialize a Project

Link any directory to a new or existing Cartesia agent:
Create a project from an example:
Inside a project directory, the CLI auto-detects the agent. Run cartesia status to see the current agent ID.

​
Chat with Your Agent

Test your agent’s text reasoning locally. Terminal 1. Run your text logic fastapi server:
Terminal 2. Run the CLI to chat with your agent:

​
Commands

​
Authentication

To get an API key, go to play.cartesia.ai/keys, select your organization, and generate a new key.
To validate the existing API key:
To logout (clears cached credentials):

​
Voice Agents

Deploy your agent to Cartesia cloud.
List out all the agents in your organization:

​
Managed Deployments

Versions of your agent running on Cartesia’s cloud. Each deployment rebuilds the environment, instantiates your project, and runs a health check. To see all of your deployments:
Check the status of a deployment:

​
Self-Hosted Agent Code

While Cartesia’s managed deployments are the simplest way to deploy low-latency voice agents, if you’d like to manage your own deployments of your agent code, you can pass us a URL for your agent to connect to during calls. Connect an existing agent to your self-hosted code:
Or run without --agent-id to interactively select an existing agent or create a new one:
Disconnect an agent from your self-hosted code:

​
Environment Variables

Create, list, and remove environment variables for your agent. Set environment variables for your agent:
Environment variables are encrypted for storage and can only be accessed by your code.
Port environment variables from a .env file:
.env
Remove an environment variable:

​
Phone Numbers

List all phone numbers in your organization:
Filter by provider type or assigned agent:
Get details for a specific phone number:
Provision a new Cartesia-managed phone number:
Assign a phone number to an agent:
Unassign a phone number from its agent:
Update a phone number’s label:
Delete a phone number:
To import Twilio or SIP trunk numbers, use the Playground or the Phone Numbers API. Once imported, all numbers can be managed with the CLI.

​
Help Menu

For more details on any command: