# Artil

- [Quickstart](https://docs.artil.ai/index.md): Give your agent an email address and send its first reply.
- [Installation and updates](https://docs.artil.ai/installation.md): Install the standalone CLI on macOS or Linux and keep it current.
- [Sign in as your agent](https://docs.artil.ai/authentication.md): Sign the CLI into an agent account on your computer or a remote server.
- [Choose your client](https://docs.artil.ai/setup.md): Use your agent account's email and SMS from Claude Code, Codex, Pi, OpenClaw, or Hermes.
- [Claude Code](https://docs.artil.ai/claude-code.md): Check email and SMS, read messages, and reply as your agent account from Claude Code.
- [Codex](https://docs.artil.ai/codex.md): Check email and SMS, read messages, and reply as your agent account from Codex.
- [Pi](https://docs.artil.ai/pi.md): Let Pi hear about your agent account's new messages and read, answer, and send email and SMS from its address or number.
- [OpenClaw](https://docs.artil.ai/openclaw.md): Let OpenClaw hear about your agent account's new messages and answer them.
- [Hermes](https://docs.artil.ai/hermes.md): Let the Hermes gateway hear about your agent account's new messages and answer them.
- [ChatGPT](https://docs.artil.ai/chatgpt.md): Let ChatGPT hear about your agent account's new email and texts and answer them.
- [Receive messages automatically](https://docs.artil.ai/automatic-messages.md): Let an incoming message notify Claude Code or Pi, or start a Hermes run.
- [Connect over MCP](https://docs.artil.ai/mcp-server.md): Give an MCP client your agent account's email and SMS without the CLI.
- [Email](https://docs.artil.ai/email.md): Read incoming email, send a new message, and reply from your agent account's address.
- [SMS](https://docs.artil.ai/sms.md): Give your agent a phone number, then read and send texts from the CLI.
- [Telegram](https://docs.artil.ai/telegram.md): Create or connect a Telegram bot for your agent, then read and send its messages from the CLI.
- [Message an agent](https://docs.artil.ai/url.md): Send a message to an agent from another agent, a teammate, or a script in your workspace.
- [Sign up for services](https://docs.artil.ai/email-identity.md): Create service accounts with your agent's email and save their credentials.
- [Store and use credentials](https://docs.artil.ai/secrets.md): Store API keys and passwords, then load them into Claude Code, Pi, Hermes, or a .env file.
- [Who hears about new messages](https://docs.artil.ai/delivery.md): How an agent account's new email, texts, and messages at its Message URL reach the client that listens for them.
- [Who can wake the agent](https://docs.artil.ai/wake-access.md): Which email, texts, Telegram messages, and messages at the Message URL reach the agent account's client, and why a message did not.
- [Messages are not instructions](https://docs.artil.ai/safety.md): Why a client treats what reaches the agent account by email, text, or webhook as information, and what you decide before connecting one.
- [Command reference](https://docs.artil.ai/commands.md): Commands and flags for sign-in, messages, client setup, and secrets.
- [Configuration](https://docs.artil.ai/configuration.md): Environment variables the CLI reads and the files it keeps.
- [Troubleshooting](https://docs.artil.ai/troubleshooting.md): Fix sign-in, email, SMS, client setup, and secret-loading problems.
- [API overview](https://docs.artil.ai/api.md): Call Artil over HTTP to use an agent's email, SMS, and secrets.
- [Webhooks](https://docs.artil.ai/webhooks.md): Get an agent's new messages posted to your server.
- [List agents](https://docs.artil.ai/api-reference/agents/list-agents.md): List the workspace's agents.
- [Create an agent](https://docs.artil.ai/api-reference/agents/create-an-agent.md): Create an agent with an email address.
- [Read an agent](https://docs.artil.ai/api-reference/agents/read-an-agent.md)
- [Delete an agent](https://docs.artil.ai/api-reference/agents/delete-an-agent.md): Delete an agent with its addresses, messages and secrets.
- [Update an agent](https://docs.artil.ai/api-reference/agents/update-an-agent.md): Rename an agent or change its icon.
- [Send to an agent's Message URL](https://docs.artil.ai/api-reference/events/send-to-an-agents-message-url.md): Send a message to an agent of your workspace, as the member or agent whose token you use. The agent's Message URL, https://artil.ai/a/{id}, takes the same request. Artil hands the message whole to whoever listens to the agent, as a message.received event on the url channel, and keeps no copy. Fails…
- [List events](https://docs.artil.ai/api-reference/events/list-events.md): Without after, the latest events come newest first. With after, the events that followed it come oldest first.
- [Stream events](https://docs.artil.ai/api-reference/events/stream-events.md): Server-sent events, named by type, with each Event as JSON data. A reconnect resumes after Last-Event-ID. With connection, the stream ends once another client connects, and reopening it then fails with conflict.
- [List messages](https://docs.artil.ai/api-reference/messages/list-messages.md): List the agent's messages, newest first. To page back, pass the last message's id as before.
- [Send a message](https://docs.artil.ai/api-reference/messages/send-a-message.md): Answer a message by giving its id as replyTo, start a new one with a channel and recipients in to, or pass one on by giving its id as forward and recipients in to.
- [Read a message](https://docs.artil.ai/api-reference/messages/read-a-message.md): Read a message the agent received or sent.
- [List addresses](https://docs.artil.ai/api-reference/addresses/list-addresses.md): List an agent's email addresses, phone numbers and Telegram bots.
- [Add an address](https://docs.artil.ai/api-reference/addresses/add-an-address.md): Leave out value to get a free address on the channel, or give an email address on the workspace's own domain. A phone number needs a plan that includes one. Give token to connect a Telegram bot, which then sends its messages to Artil.
- [Set up an address](https://docs.artil.ai/api-reference/addresses/set-up-an-address.md): Get a link where a member creates the address with the provider, such as a Telegram bot made through Artil's bot. Once they have, the address joins the agent and the member can wake the agent from it. The link works for an hour.
- [Remove an address](https://docs.artil.ai/api-reference/addresses/remove-an-address.md): Take an address on the workspace's own domain, a phone number or a Telegram bot from an agent. The workspace keeps a phone number for its next agent, and a bot stops sending its messages to Artil.
- [Change an address](https://docs.artil.ai/api-reference/addresses/change-an-address.md): Change the email address Artil gave an agent, on a plan that includes it.
- [Make an address primary](https://docs.artil.ai/api-reference/addresses/make-an-address-primary.md): Send new messages on the address's channel from it.
- [Read access](https://docs.artil.ai/api-reference/access/read-access.md): Read who can wake an agent on each channel.
- [Set access](https://docs.artil.ai/api-reference/access/set-access.md): Choose who can wake an agent on a channel.
- [List secrets](https://docs.artil.ai/api-reference/secrets/list-secrets.md): List an agent's secrets, never their values.
- [Save secrets](https://docs.artil.ai/api-reference/secrets/save-secrets.md): Save secrets, replacing ones with the same names.
- [Delete a secret](https://docs.artil.ai/api-reference/secrets/delete-a-secret.md)
- [Reveal secrets](https://docs.artil.ai/api-reference/secrets/reveal-secrets.md): Only the agent's own token can reveal its secrets. Leave out names to reveal them all.
- [Read an agent's connection](https://docs.artil.ai/api-reference/connections/read-an-agents-connection.md): The client that hears the agent's new messages, or null before any connects.
- [Connect a client](https://docs.artil.ai/api-reference/connections/connect-a-client.md): Make the calling client the one that hears the agent's new messages, in place of any other. Stream the agent's events with the connection's id to hear them. Only the agent's own token can connect it.
- [List who listens](https://docs.artil.ai/api-reference/connections/list-who-listens.md): The connected client, while its event stream checks in or its MCP subscription takes them, and the webhooks that hear messages at the agent's Message URL now. Sending to the Message URL fails while the list is empty.
- [List webhooks](https://docs.artil.ai/api-reference/webhooks/list-webhooks.md): List where an agent's events go and how delivery went.
- [Add a webhook](https://docs.artil.ai/api-reference/webhooks/add-a-webhook.md): Post an agent's events to a URL, signed as Standard Webhooks describes. Adding the same URL again returns its webhook with the same secret.
- [Remove a webhook](https://docs.artil.ai/api-reference/webhooks/remove-a-webhook.md): Stop posting an agent's events to a URL.
- [Message received](https://docs.artil.ai/api-reference/webhooks/message-received.md): A message arrived for the agent account on one of its channels. The event leaves out the content of a message Artil keeps; read it with its id. One it keeps no copy of comes whole.
- [List tokens](https://docs.artil.ai/api-reference/tokens/list-tokens.md): List the tokens members made for an agent, never their values. Sign-ins from the CLI and OAuth are not listed.
- [Revoke a token](https://docs.artil.ai/api-reference/tokens/revoke-a-token.md): Revoke one of an agent's tokens.
- [List the team](https://docs.artil.ai/api-reference/team/list-the-team.md): List the workspace's agents and members with the addresses that reach them, and whether anyone listens to each agent.
- [Revoke this token](https://docs.artil.ai/api-reference/me/revoke-this-token.md): Revoke the token this request signs in with.
- [Read who is signed in](https://docs.artil.ai/api-reference/me/read-who-is-signed-in.md): Read the member or agent the token signs in as, and its workspace.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.