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

# Platform API Overview

> The Agent Sentinel cloud platform API for ingesting telemetry and querying data.

The Agent Sentinel Platform API is a cloud service that:

* Accepts SDK telemetry uploads (`POST /api/v1/ingest/`)
* Stores **runs** and **actions** securely in the cloud
* Provides APIs for querying runs/actions, managing policies, and viewing analytics
* Powers the web console with real-time WebSocket updates

**Base URL**: `https://platform.agentsentinel.dev`

## Key endpoints

* **Auth**
  * `POST /api/v1/login/access-token`
* **API keys (recommended for agents)**
  * `POST /api/v1/api-keys/`
* **Ingest**
  * `POST /api/v1/ingest/`
* **Runs/actions**
  * `GET /api/v1/runs/`
  * `GET /api/v1/runs/{run_id}`
  * `GET /api/v1/runs/{run_id}/actions`
* **Activity Ledger (audit trail)**
  * `GET /api/v1/ledger/`
  * `GET /api/v1/ledger/stats`
  * `GET /api/v1/ledger/export`
* **Policies**
  * `GET /api/v1/policies/`
  * `GET /api/v1/policies/sync`
* **Stats**
  * `GET /api/v1/stats/`
  * `GET /api/v1/stats/daily`
* **Replay (analysis/simulation)**
  * `POST /api/v1/replay/{run_id}`
  * `GET /api/v1/replay/analysis/{run_id}`

## Authentication

All API requests require authentication via:

* **API keys** (recommended for SDK integration) - Generated in the web console
* **JWT tokens** (for web console access) - Automatic via Clerk authentication

See [Authentication](/platform/auth) for details.

## Getting started

1. Sign up at [console.agentsentinel.dev](https://console.agentsentinel.dev)
2. Generate an API key in **Settings** → **API Keys**
3. Use the key in your SDK:
   ```python theme={null}
   enable_remote_sync(
       platform_url="https://platform.agentsentinel.dev",
       api_token="as_your_api_key_here"
   )
   ```

## OpenAPI specification

Use this platform section as the API reference entry point. The local FastAPI app also serves generated OpenAPI docs at `/docs` when running.
