> ## Documentation Index
> Fetch the complete documentation index at: https://activitysmith.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> ActivitySmith API reference

## Features

<CardGroup cols={2}>
  <Card title="Push Notifications" icon="bell" href="/docs/api-reference/endpoint/push-notification" color="FFFFFF">
    Send a push notification to all of your paired devices.
  </Card>

  <Card title="Live Activities" icon="bolt" href="/docs/api-reference/endpoint/live-activity-stream" color="FFFFFF">
    Start, update, and dismiss a Live Activity stream.
  </Card>

  <Card title="Widgets" icon="grid-2" href="/docs/api-reference/endpoint/metric-value-update" color="FFFFFF">
    Update metric values shown in ActivitySmith widgets.
  </Card>

  <Card title="App Icon Badge Count" icon="badge" href="/docs/api-reference/endpoint/app-icon-badge-count" color="FFFFFF">
    Show the number you care about on your ActivitySmith app icon.
  </Card>
</CardGroup>

## Base URL

All requests contain the following base URL:

```bash theme={null}
https://activitysmith.com/api/
```

## Authentication

For authentication, it's required to include an Authorization header. The header should contain `Bearer ask_123456789`, where `ask_123456789` represents your [API Key](/docs/api-keys).

```bash theme={null}
Authorization: Bearer ask_123456789
```

## Response codes

ActivitySmith employs conventional HTTP status codes to signify the outcome of your requests.

Typically, 2xx HTTP status codes denote success, 4xx codes represent failures related to the user, and 5xx codes signal infrastructure problems.

| Status | Description                                  |
| ------ | -------------------------------------------- |
| 200    | Request was successful.                      |
| 400    | Verify the correctness of the parameters.    |
| 401    | The API key is invalid or was not provided.  |
| 404    | The requested resource could not be located. |
| 429    | The rate limit has been surpassed.           |
| 5xx    | Signifies a server error with ActivitySmith. |

Refer to the Error Codes section for a detailed explanation of all potential API errors.

## Channels

Channels let you target specific subsets of recipients instead of broadcasting to everyone in an account.

* Use channels when teams, environments, or workflows need separate delivery groups.
* Keep [API keys](/docs/api-keys) broad or channel-scoped depending on how strict you want targeting to be.

Read the full [channels guide](/docs/channels).

## Rate limit

The ActivitySmith API has a [rate limit](/docs/rate-limits) to ensure the stability and reliability of the service. The rate limit is applied to all endpoints and is based on the number of requests made within a specific time frame.

When you exceed the rate limit, you will receive a 429 response code.