---
title: "Get started in five minutes"
method: POST
path: "/v1/quickstart"
---

# Get started in five minutes

`POST /v1/quickstart`

## Request

- Base URL: `https://api.reqbeat.com`
- URL: `https://api.reqbeat.com/v1/quickstart`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

5-min quickstart: curl/Python/TS/MCP/Clay snippets with the caller's
own live key injected, plus an auto-created watch on a high-motion
company on `body.webhook_url` so a webhook fires shortly after signup.
Not billable -- getting started must never cost quota. Idempotent:
re-opening the quickstart never mints a second watch or webhook
endpoint.

## Request body

- QuickstartRequest
  - `webhook_url` string, required
  - `domain` string, nullable

## Response `200`

Successful Response

- QuickstartResponse
  - `snippets` object, required
  - `company_id` integer, required
  - `watch_id` integer, required
  - `webhook_endpoint_id` integer, required

## Other responses

- `401`: No API key was sent.
- `403`: A key was sent, but it is unknown or revoked.
- `422`: Validation Error

---

[API](https://skmtc.dev/reqbeat/apis/reqbeat-api.md) · [All operations](https://skmtc.dev/reqbeat/apis/reqbeat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/reqbeat/apis/reqbeat-api/revisions/4758e5957e8c?raw)
