# Victoria AI API docs

Documentation for Victoria AI, an outbound AI SDR that runs LinkedIn and email sequences from your own accounts. The Help Center covers using the app, the Playbook covers outbound practice with example sequences, and the API reference and guides cover the REST API (leads, campaigns and sequences, analytics, CRM pipelines and deals, reply webhooks) and the MCP server.

## Guides

- [Quickstart](https://docs.versionseven.ai/guides/quickstart): Create an API key, verify it, and add your first lead to a campaign with the Victoria AI REST API.
- [Authentication](https://docs.versionseven.ai/guides/authentication): Create and use API keys, understand the organization and scopes a key covers, and handle authentication errors.
- [Connect your AI](https://docs.versionseven.ai/guides/connect-your-ai): Connect Claude, ChatGPT, Claude Code or any MCP host to your Victoria AI workspace, and what a connected assistant can and can't do.
- [Set up a campaign by API](https://docs.versionseven.ai/guides/set-up-a-campaign): Create a campaign, write its sequence, add AI fields and senders, check the activation preflight, and activate it, all from the REST API.
- [AI Personalization fields](https://docs.versionseven.ai/guides/ai-personalization-fields): What an AI Personalization field is, how Victoria AI fills it for each lead, what happens when the research finds nothing, and the endpoints that manage fields.
- [AI Appointment Setter](https://docs.versionseven.ai/guides/ai-appointment-setter): How the AI Appointment Setter handles a reply, when it hands off to a person, and how integrations configure it and hear about replies.
- [Simple CRM](https://docs.versionseven.ai/guides/crm): The pipelines and deals in Victoria AI's Simple CRM, what a deal links to, what happens on a booked meeting, and the CRM endpoints.
- [Lead database](https://docs.versionseven.ai/guides/lead-database): What the in-app Lead database searches, how emails are verified, what a search costs, and which parts are available over MCP and REST.
- [Credits](https://docs.versionseven.ai/guides/credits): What spends credits in Victoria AI, how balances roll over, and how an API or MCP integration finds out that the balance has run out.
- [Errors](https://docs.versionseven.ai/guides/errors): The error response body, what each HTTP status means, how to read validation errors, and every error code the API returns.
- [Pagination](https://docs.versionseven.ai/guides/pagination): Page through list endpoints with limit and offset, and use has_more to tell when you've reached the last page.
- [Rate limits](https://docs.versionseven.ai/guides/rate-limits): The per-endpoint and overall request limits on the Victoria AI API, the headers that report them, and how to handle a 429.
- [Idempotency](https://docs.versionseven.ai/guides/idempotency): Send an Idempotency-Key header so a retried create request returns the original result instead of doing the work twice.
- [Versioning and deprecation](https://docs.versionseven.ai/guides/versioning): How the Victoria AI API is versioned, how deprecated endpoints are announced, and where to get the OpenAPI specification.
- [Receiving webhooks](https://docs.versionseven.ai/guides/webhooks): Register a webhook on a campaign to hear when a prospect replies, and handle deliveries, retries and duplicates.
- [Verifying webhook signatures](https://docs.versionseven.ai/guides/verifying-webhooks): Check the X-Signature-256 header on each webhook delivery so your endpoint only acts on requests that came from Victoria AI.

## API Reference

- [API Reference](https://docs.versionseven.ai/api-reference): every endpoint, grouped by resource.
- [Auth](https://docs.versionseven.ai/api-reference/auth): Check that an API key works and see which organization it belongs to.
- [Sender accounts](https://docs.versionseven.ai/api-reference/accounts): The LinkedIn and email accounts connected to your organization for outreach, whether each one is still connected, and links that connect or reconnect one.
- [Leads](https://docs.versionseven.ai/api-reference/leads): Create leads, enrol them in campaigns, find them with filters, update them, and remove them from campaigns.
- [Campaigns](https://docs.versionseven.ai/api-reference/campaigns): Create and manage campaigns: their sequences, AI fields, senders, reply agent, activation preflight, analytics, A/B tests, bookings, lead queue, and the webhooks that receive prospect replies.
- [Pipelines](https://docs.versionseven.ai/api-reference/crm-pipelines): Read and update the CRM pipelines that deals move through, along with their stages.
- [Deals](https://docs.versionseven.ai/api-reference/crm-deals): Create, list, retrieve and update deals in the Victoria AI CRM.
- [Reference](https://docs.versionseven.ai/api-reference/reference): Blank sequence templates to start from, and example payloads for building a webhook receiver.

## Cookbook

- [Add CRM contacts to a campaign](https://docs.versionseven.ai/cookbook/add-crm-contacts): A script that adds contacts exported from your CRM to a Victoria AI campaign, safe to re-run, handling existing leads, invalid rows and rate limits.
- [Post prospect replies to Slack](https://docs.versionseven.ai/cookbook/post-replies-to-slack): A small server that receives the prospect_response webhook, verifies its signature, skips duplicates, and posts the reply to a Slack channel.

## Help Center

- [Help Center](https://docs.versionseven.ai/help): How to use the Victoria AI app: senders, leads, campaigns, the Appointment Setter, billing and troubleshooting.

## Playbook

- [Playbook](https://docs.versionseven.ai/playbook): How to run outbound with Victoria AI: targeting, messaging, replies, and example sequences you can copy.

## For AI agents

- [llms.txt](https://docs.versionseven.ai/llms.txt): an index of every page's Markdown.
- [llms-full.txt](https://docs.versionseven.ai/llms-full.txt): the whole documentation in one file.
- [openapi.json](https://docs.versionseven.ai/openapi.json): the OpenAPI specification these docs are generated from.
- Add `.md` to the end of any page's URL for its Markdown.
