---
title: "Set up an address"
method: POST
path: "/agents/{id}/addresses/setups"
tags: ["Addresses"]
---

# Set up an address

`POST /agents/{id}/addresses/setups`

## Request

- Base URL: `https://app.artil.ai/api`
- URL: `https://app.artil.ai/api/agents/{id}/addresses/setups`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://mcp.artil.ai/oauth/authorize`
    - Token URL: `https://mcp.artil.ai/oauth/token` scopes: `agent`

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.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `channel` 'email' | 'sms' | 'telegram', required

## Response `201`

The link

- AddressSetup
  - `url` string, required: Where the member creates the address, such as a link to Artil's Telegram bot

## Other responses

- `4XX`: The request failed; the error says why
- `5XX`: The request failed; the error says why

---

[API](https://skmtc.dev/artil/apis/artil-api.md) - [All operations](https://skmtc.dev/artil/apis/artil-api/llms.txt) - [OpenAPI document](https://skmtc.dev/artil/apis/artil-api/revisions/55db0efa0cb8?raw)