> This page is for version v2 (default).
> For other versions, use one of these documentation indexes:
> - v2 (default): https://docs.paid.ai/v-2/llms.txt
> - v1: https://docs.paid.ai/v-1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.paid.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.paid.ai/_mcp/server.

# Quickstart

> Authenticate and make your first Paid API call from the command line.

The Paid CLI is a command line interface for the Paid API.

## Prerequisites

* Node.js and npm available on your machine.
* A [Paid API key](https://app.paid.ai/settings/api-keys).

## Install

```bash
npm install -g @paid-ai/cli
```

## Authenticate

Create an API key from the Paid app, then initialize the CLI:

```bash
paid init
```

By default, the CLI creates a `sandbox` profile labelled `Sandbox` and makes it active.

You can also pass the key directly:

```bash
paid init --api-key paid_xxx
```

## Check Your Environment

Show the active profile and API URL:

```bash
paid env
```

Add or switch profiles by running `init` with `--env`:

```bash
paid init --env production --env-type Production --api-key paid_xxx
paid env
```

## Common Options

```bash
paid product list \
  --api-key paid_xxx \
  --base-url https://api.agentpaid.io/api/v2 \
  --timeout-ms 30000
```

* `--api-key` overrides `PAID_API_KEY` and saved config.
* `--base-url` overrides the API URL for the request.
* `--env` selects a saved profile.
* `--timeout-ms` sets the HTTP timeout.