# BytePilot

> White-label AI services platform for agencies and resellers. Credit-based
> billing (GBP pence), named API keys with scopes and per-key spend caps.

There are TWO APIs, on two hosts, sharing ONE key:
- Platform API — https://bytepilot.ai/api/v1 — Read and control your account.
- Model API — https://models.bytepilot.ai/v1 — Call AI models directly, on your account.

Auth: X-API-Key header (or Authorization: Bearer) with a business API key
from your dashboard Developers page. Keys carry scopes and optional per-key
daily/monthly spend caps (HTTP 402 when hit).

Scopes:
- agents: Agents & clients
- calls: Calls & transcripts
- billing: Balance, ledger & usage reports
- models: Model API (the OpenAI-compatible endpoint)
- outbound: Outbound calls & schedules
- visibility: AI visibility checks & reports
- leads: Lead intelligence campaigns & prospects

## Docs
- Full endpoint reference: https://bytepilot.ai/llms-full.txt
- OpenAPI spec: https://bytepilot.ai/openapi.json
- Human docs: https://bytepilot.ai/developers

## Platform API (https://bytepilot.ai/api/v1)
- GET https://bytepilot.ai/api/v1/agents — List your agents [scope: agents]
- POST https://bytepilot.ai/api/v1/agents/:id/status — Pause or resume an agent [scope: agents]
- GET https://bytepilot.ai/api/v1/clients — List your clients [scope: agents]
- POST https://bytepilot.ai/api/v1/clients — Create a client (idempotent by name) [scope: agents]
- GET https://bytepilot.ai/api/v1/visibility/targets — List tracked websites [scope: visibility]
- POST https://bytepilot.ai/api/v1/visibility/targets — Track a website (idempotent by domain) [scope: visibility]
- POST https://bytepilot.ai/api/v1/visibility/targets/:id/run — Run a visibility check [scope: visibility]
- GET https://bytepilot.ai/api/v1/visibility/targets/:id/reports — List a website's reports [scope: visibility]
- GET https://bytepilot.ai/api/v1/visibility/reports/:id — Get a report [scope: visibility]
- GET https://bytepilot.ai/api/v1/visibility/reports/:id/pdf — Download a report as PDF [scope: visibility]
- GET https://bytepilot.ai/api/v1/leads/campaigns — List lead campaigns [scope: leads]
- POST https://bytepilot.ai/api/v1/leads/campaigns — Start a lead campaign [scope: leads]
- GET https://bytepilot.ai/api/v1/leads/campaigns/:id — Get a campaign [scope: leads]
- GET https://bytepilot.ai/api/v1/leads/campaigns/:id/prospects — List a campaign's scored prospects [scope: leads]
- GET https://bytepilot.ai/api/v1/leads/prospects/:id — Get a prospect in full [scope: leads]
- GET https://bytepilot.ai/api/v1/leads/campaigns/:id/pdf — Download a campaign report as PDF [scope: leads]
- GET https://bytepilot.ai/api/v1/calls — List calls in a date range [scope: calls]
- GET https://bytepilot.ai/api/v1/calls/:id — One call with transcript and message [scope: calls]
- GET https://bytepilot.ai/api/v1/balance — Current credit balance [scope: billing]
- GET https://bytepilot.ai/api/v1/ledger — Credit ledger entries in a date range [scope: billing]
- GET https://bytepilot.ai/api/v1/usage — Usage report: units + cost per client, agent and channel [scope: billing]
- POST https://bytepilot.ai/api/v1/outbound/calls — Ring someone now [scope: outbound]
- GET https://bytepilot.ai/api/v1/outbound/calls — Outbound call history, including refused ones [scope: outbound]
- POST https://bytepilot.ai/api/v1/outbound/schedules — Schedule recurring calls [scope: outbound]
- GET https://bytepilot.ai/api/v1/outbound/schedules — List your schedules [scope: outbound]
- POST https://bytepilot.ai/api/v1/outbound/schedules/:id/cancel — Stop a schedule [scope: outbound]
- POST https://bytepilot.ai/api/v1/outbound/do-not-call — Add a number to the do-not-call list [scope: outbound]
- GET https://bytepilot.ai/api/v1/outbound/do-not-call — List do-not-call entries [scope: outbound]

## Model API (https://models.bytepilot.ai/v1)
- POST https://models.bytepilot.ai/v1/chat/completions — Create a chat completion [scope: models]
- GET https://models.bytepilot.ai/v1/models — List the models you can call [scope: models]