# Peec.ai Docs

## Docs

- [Peec AI for Agencies: Getting started](https://docs.peec.ai/agencies/agency-getting-started.md)
- [Managing your projects](https://docs.peec.ai/agencies/managing-your-projects.md)
- [Understanding credits](https://docs.peec.ai/agencies/understanding_credits.md): How agencies can use credits to allocate prompts and models to their projects
- [List Projects](https://docs.peec.ai/api-reference/company/list-projects.md): List the projects of a company
- [Accept Brand Suggestion](https://docs.peec.ai/api-reference/project/accept-brand-suggestion.md): Accept a brand suggestion by ID, converting it into a brand within the project
- [Accept Prompt Suggestion](https://docs.peec.ai/api-reference/project/accept-prompt-suggestion.md): Accept a prompt suggestion by ID, creating a new prompt from it
- [Accept Topic Suggestion](https://docs.peec.ai/api-reference/project/accept-topic-suggestion.md): Accept a topic suggestion by ID, converting it into a regular topic
- [Create Brand](https://docs.peec.ai/api-reference/project/create-brand.md): Create a new brand within a project
- [Create Prompt](https://docs.peec.ai/api-reference/project/create-prompt.md): Create a new prompt within a project
- [Create Tag](https://docs.peec.ai/api-reference/project/create-tag.md): Create a new tag within a project
- [Create Topic](https://docs.peec.ai/api-reference/project/create-topic.md): Create a new topic within a project
- [Delete Brand](https://docs.peec.ai/api-reference/project/delete-brand.md): Soft-delete a brand within a project.
- [Delete Prompt](https://docs.peec.ai/api-reference/project/delete-prompt.md): Soft-delete a prompt and cascade to related chats
- [Delete Tag](https://docs.peec.ai/api-reference/project/delete-tag.md): Soft-delete a tag within a project
- [Delete Topic](https://docs.peec.ai/api-reference/project/delete-topic.md): Soft-delete a topic, detaching all associated prompts and deleting prompt suggestions
- [Get Chat](https://docs.peec.ai/api-reference/project/get-chat.md): Get a single chat
- [Get Project Profile](https://docs.peec.ai/api-reference/project/get-project-profile.md): Read the project's brand profile (description, industry, brand identity, target markets, audience distribution, products & services). Returns `{ profile: null }` if the project hasn't been profiled yet.
- [List Brand Suggestions](https://docs.peec.ai/api-reference/project/list-brand-suggestions.md): List the open brand suggestions of a project
- [List Brands](https://docs.peec.ai/api-reference/project/list-brands.md): List the brands of a project
- [List Chats](https://docs.peec.ai/api-reference/project/list-chats.md): List the chats of a project
- [List Fanout Search Queries](https://docs.peec.ai/api-reference/project/list-fanout-search-queries.md): List the fanout search queries of a project
- [List Fanout Shopping Queries](https://docs.peec.ai/api-reference/project/list-fanout-shopping-queries.md): List the fanout shopping queries of a project
- [List Model Channels](https://docs.peec.ai/api-reference/project/list-model-channels.md): List the model channels
- [List Models](https://docs.peec.ai/api-reference/project/list-models.md): Deprecated: use List Model Channels instead.
- [List Prompt Suggestions](https://docs.peec.ai/api-reference/project/list-prompt-suggestions.md): List the prompt suggestions of a project
- [List Prompts](https://docs.peec.ai/api-reference/project/list-prompts.md): List the prompts of a project
- [List Tags](https://docs.peec.ai/api-reference/project/list-tags.md): List the tags of a project
- [List Topic Suggestions](https://docs.peec.ai/api-reference/project/list-topic-suggestions.md): List the topic suggestions of a project
- [List Topics](https://docs.peec.ai/api-reference/project/list-topics.md): List the topics of a project
- [Reject Brand Suggestion](https://docs.peec.ai/api-reference/project/reject-brand-suggestion.md): Reject a brand suggestion by ID, removing it from the project and preventing it from being re-suggested
- [Reject Prompt Suggestion](https://docs.peec.ai/api-reference/project/reject-prompt-suggestion.md): Reject a prompt suggestion by ID, soft-deleting it
- [Reject Topic Suggestion](https://docs.peec.ai/api-reference/project/reject-topic-suggestion.md): Reject a topic suggestion by ID, soft-deleting it and its associated prompt suggestions
- [Set Project Profile](https://docs.peec.ai/api-reference/project/set-project-profile.md): Replace the project's brand profile. All fields are required — the entire profile is overwritten. Triggers a background refresh of prompt suggestions. Audience distribution percentages must sum to 100. The project's display name is not part of the profile and cannot be changed via this endpoint. Ret…
- [Update Brand](https://docs.peec.ai/api-reference/project/update-brand.md): Update a brand within a project. Changes to name, regex, or aliases trigger a background recalculation of metrics. While recalculation is in progress, further updates to these fields are blocked (409 Conflict) until it completes.
- [Update Prompt](https://docs.peec.ai/api-reference/project/update-prompt.md): Update a prompt's topic and tags within a project
- [Update Tag](https://docs.peec.ai/api-reference/project/update-tag.md): Update a tag within a project
- [Update Topic](https://docs.peec.ai/api-reference/project/update-topic.md): Update a topic within a project
- [Get Brands Report](https://docs.peec.ai/api-reference/reports/get-brands-report.md): Get a report on Brands.
- [Get Domains Report](https://docs.peec.ai/api-reference/reports/get-domains-report.md): Get a report on Source Domains.
- [Get URL Content](https://docs.peec.ai/api-reference/reports/get-url-content.md): Return the scraped markdown content of a source URL. Use the URLs report to discover URLs.
- [Get URLs Report](https://docs.peec.ai/api-reference/reports/get-urls-report.md): Get a report on Source URLs.
- [Authentication for Peec API](https://docs.peec.ai/api/authentication.md)
- [Changelog](https://docs.peec.ai/api/changelog.md): Track updates, improvements, and breaking changes to the Peec API.
- [Introduction to Peec API](https://docs.peec.ai/api/introduction.md)
- [Model Channels](https://docs.peec.ai/api/model-channels.md): A stable way to reference AI surfaces as underlying models evolve.
- [Rate Limits for Peec API](https://docs.peec.ai/api/ratelimits.md)
- [Crawl Insights](https://docs.peec.ai/crawl-insights.md)
- [Crawlability](https://docs.peec.ai/crawlability.md)
- [Domains](https://docs.peec.ai/domains.md)
- [Get inspired by Actions](https://docs.peec.ai/get-inspired-by-actions.md): Learn how Actions translate source-level data into clear opportunities to improve your AI visibility.
- [Identifying your competitors](https://docs.peec.ai/identifying-your-competitors.md): Track competitive performance and see who AI is promoting alongside (or instead of) you.
- [Welcome to Peec AI](https://docs.peec.ai/intro-to-peec-ai.md): The #1 AI search analytics tool for marketing teams and agencies.
- [Looker Studio connector](https://docs.peec.ai/looker/introduction.md): Complete guide to connecting and using Peec AI data in Looker Studio.
- [Manage your project](https://docs.peec.ai/manage-your-project.md)
- [MCP Server](https://docs.peec.ai/mcp/introduction.md): Connect AI assistants like Claude, Cursor, and other MCP-compatible tools directly to your Peec AI data. Ask questions in plain language and get answers from the same data the dashboard shows.
- [Prompts](https://docs.peec.ai/mcp/prompts.md): Peec AI ships native MCP prompts: ready-to-run analysis workflows exposed as slash commands in your AI tool. Each prompt runs a scripted sequence of tool calls and formats the output for you.
- [Setup Guide](https://docs.peec.ai/mcp/setup.md): Step-by-step instructions for connecting the Peec AI MCP Server to Claude, Cursor, and other AI tools. Stuck? Email support@peec.ai.
- [Tools Reference](https://docs.peec.ai/mcp/tools.md): Every tool the Peec AI MCP Server exposes, with parameters and response fields.
- [Use Cases](https://docs.peec.ai/mcp/use-cases.md): Example prompts and workflows for the Peec AI MCP Server. Browse by type if you need ideas on what to ask.
- [Metrics Overview](https://docs.peec.ai/metrics-overview.md): Understanding all the key metrics that drive your AI search optimization strategy.
- [Position](https://docs.peec.ai/metrics/brand-metrics/position.md): How your brand ranks in AI responses.
- [Sentiment](https://docs.peec.ai/metrics/brand-metrics/sentiment.md): The tone and sentiment of your brand mentions.
- [Share of Voice](https://docs.peec.ai/metrics/brand-metrics/share-of-voice.md)
- [Visibility](https://docs.peec.ai/metrics/brand-metrics/visibility.md): How often your brand is mentioned in AI responses.
- [Organizing your setup](https://docs.peec.ai/organizing-your-setup.md): Keep your prompts manageable and analysis-ready with smart organization.
- [Brand profile](https://docs.peec.ai/project-profile.md)
- [Quickstart Guide](https://docs.peec.ai/quickstart-guide.md): The fastest way to understand your brand’s AI search presence.
- [Setting up your prompts](https://docs.peec.ai/setting-up-your-prompts.md): Our in-depth guide to building your prompt and competitor tracking system.
- [Sidebar Navigation ](https://docs.peec.ai/sidebar-navigation.md): Quick reference to all navigation sections and their key features.
- [Understanding chats](https://docs.peec.ai/understanding-chats.md): Learn how to read the AI responses that form the foundation of all your analytics.
- [Understanding sources](https://docs.peec.ai/understanding-sources.md): Discover which websites AI models trust and learn how to optimize your presence across them.
- [Understanding your performance](https://docs.peec.ai/understanding-your-performance.md): Your main analytics hub for tracking AI search performance across prompts and competitors.
- [URLs](https://docs.peec.ai/urls.md)
- [Use Cases](https://docs.peec.ai/use-cases.md)
- [Video Library](https://docs.peec.ai/video-library.md): For those who prefer the video format, this is a collection of all of the videos we've linked in this Product Documentation.

## OpenAPI Specs

- [json](https://api.peec.ai/customer/v1/openapi/json)