# 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
- [Create Categories](https://docs.peec.ai/api-reference/products/create-categories.md): Create product categories. Each item takes a `name` and an optional `parent_id` (omit or null for a top-level category). Items apply in order. Returns per-item results { created, rejected } — the batch never fails as a whole. Rejection reasons: parent_not_found, name_conflict (a sibling already has…
- [Create Global Brand](https://docs.peec.ai/api-reference/products/create-global-brand.md): Create a brand and return its `id` — pass it as a product's `global_brand_id` when creating products. The returned `name` is the brand's canonical name and may differ slightly from the name you sent. This is separate from `POST /brands`, which creates a brand a project tracks for AI-visibility repor…
- [Create Products](https://docs.peec.ai/api-reference/products/create-products.md): Create products. Each item is independent: valid products are created and per-item failures are returned in `rejected`, so the batch never fails as a whole. Optional `category_ids` assigns the product to categories.
- [Delete Categories](https://docs.peec.ai/api-reference/products/delete-categories.md): Delete categories by id. Each one's child categories and products move up to its parent, then it is removed. Returns per-item results { deleted, rejected } — the batch never fails as a whole. Rejection reasons: not_found, name_conflict (a child moving up would clash with an existing sibling name).
- [Delete Products](https://docs.peec.ai/api-reference/products/delete-products.md): Delete products. Ids that don't exist in the project are returned in `skipped`.
- [Get Product](https://docs.peec.ai/api-reference/products/get-product.md): Get one product's detail over a date range: headline metrics (visibility, win_rate, avg_position, avg_rating, mention_count) plus a delta for each against the immediately preceding equal-length period, the catalog metadata (brand, description, image, source, first-seen date), the effective price ran…
- [Get Shopping Attributes](https://docs.peec.ai/api-reference/products/get-shopping-attributes.md): The LLM-extracted attribute comparison grid for a product (scope=product) or the whole catalog (scope=overview), split by tab into characteristics, facts, and dimensions. Columns are competing brands (compare_by=brand) or competing products (compare_by=product, scope=product only). Deltas are comput…
- [Get Shopping Summary](https://docs.peec.ai/api-reference/products/get-shopping-summary.md): Return aggregate shopping metrics over a date range. Delta fields compare against an explicit previous window or the auto-derived previous period.
- [Get Shopping Trend](https://docs.peec.ai/api-reference/products/get-shopping-trend.md): Return a product or brand shopping time series over a date range. Requires bucket and exactly one of product_ids or brand_ids.
- [List Categories](https://docs.peec.ai/api-reference/products/list-categories.md): List a project's product categories. Each row carries its full `path` and its `parent_id`, so the flat list reconstructs the category tree. Use the returned `id` as a `category_id` when creating, updating, or assigning products.
- [List Global Brands](https://docs.peec.ai/api-reference/products/list-global-brands.md): Search Peec's global brand catalog — the shared registry of real-world brands that products attach to via `global_brand_id`. Use it to find the `global_brand_id` for a brand when creating products. This is separate from `GET /brands`, which lists the brands a project tracks for AI-visibility reporti…
- [List Merchants](https://docs.peec.ai/api-reference/products/list-merchants.md): List the merchants (sellers) whose product offers surfaced in AI answers, ranked over a date range: mentions, share of voice against the other merchants, buy-box win rate, average position, and average star rating, each with a delta against the previous window. Scope the population with category_ids…
- [List Products](https://docs.peec.ai/api-reference/products/list-products.md): List a project's products with headline metrics (mention_count, win_count, avg_position, avg_rating, visibility, share_of_voice) over the date range, filterable by category, merchant, brand, country, model channel, topic, and tag. Paginated.
- [List Shopping Demand](https://docs.peec.ai/api-reference/products/list-shopping-demand.md): List top shopping queries, web-search fan-out queries, or query terms over a date range.
- [List Shopping Performance](https://docs.peec.ai/api-reference/products/list-shopping-performance.md): List ranked product or category shopping performance over a date range.
- [Update Categories](https://docs.peec.ai/api-reference/products/update-categories.md): Rename and/or reparent categories by id. Each item sets `name` (rename), `parent_id` (move; null = promote to top level), or both — at least one is required. A combined edit is applied move-then-rename. Returns per-item results { updated, rejected } — the batch never fails as a whole. Rejection reas…
- [Update Products](https://docs.peec.ai/api-reference/products/update-products.md): Update products (name, description, image, price overrides, categories). Each item is independent: items with nothing to apply (not found, no changes, duplicate id) are reported in `skipped`, and unsatisfiable changes (name conflict, unknown category) in `rejected`, so the batch never fails as a who…
- [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. Optionally pass a country_code to override the suggestion's country for the created prompt.
- [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
- [Archive Prompt](https://docs.peec.ai/api-reference/project/archive-prompt.md): Archive a prompt (is_archived = true) so it stops running while keeping its chats and history
- [Create Brand](https://docs.peec.ai/api-reference/project/create-brand.md): Create a new brand within a project
- [Create Custom Domain Classification](https://docs.peec.ai/api-reference/project/create-custom-domain-classification.md): Define a new custom domain classification for a project. Once created, it can be assigned to domains via the assignment endpoint.
- [Create Custom URL Classification](https://docs.peec.ai/api-reference/project/create-custom-url-classification.md): Define a new custom URL classification for a project. Once created, it can be assigned to URLs via the assignment endpoint.
- [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): Delete a brand within a project.
- [Delete Custom Domain Classification](https://docs.peec.ai/api-reference/project/delete-custom-domain-classification.md): Delete a custom domain classification. Cascades through the override table, so any domains currently assigned this classification fall back to their heuristic classification.
- [Delete Custom URL Classification](https://docs.peec.ai/api-reference/project/delete-custom-url-classification.md): Delete a custom URL classification. Cascades through the override table, so any URLs currently assigned this classification fall back to their heuristic classification.
- [Delete Prompt](https://docs.peec.ai/api-reference/project/delete-prompt.md): Delete a prompt and cascade to related chats
- [Delete Tag](https://docs.peec.ai/api-reference/project/delete-tag.md): Delete a tag within a project
- [Delete Tag Group](https://docs.peec.ai/api-reference/project/delete-tag-group.md): Delete a user-defined tag group. By default the tags are kept and simply ungrouped (their `group` becomes null); pass delete_tags=true to delete the tags themselves and detach them from every prompt. System groups (branding/intentType) cannot be deleted.
- [Delete Topic](https://docs.peec.ai/api-reference/project/delete-topic.md): Delete a topic, detaching all associated prompts and deleting prompt suggestions
- [Get Agent Visits](https://docs.peec.ai/api-reference/project/get-agent-visits.md): Aggregate agent access log visits grouped by a chosen dimension (bot, response status, host, path).
- [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 Agent logs](https://docs.peec.ai/api-reference/project/list-agent-logs.md): List Agent access logs from your log provider integration or access file upload
- [List Bots](https://docs.peec.ai/api-reference/project/list-bots.md): List all known AI agent bots from agent analytics.
- [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 Custom Domain Classifications](https://docs.peec.ai/api-reference/project/list-custom-domain-classifications.md): List the custom domain classifications defined for a project. These complement the built-in classifications and can be assigned to domains.
- [List Custom URL Classifications](https://docs.peec.ai/api-reference/project/list-custom-url-classifications.md): List the custom URL classifications defined for a project. These complement the built-in classifications and can be assigned to URLs.
- [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 Tag Groups](https://docs.peec.ai/api-reference/project/list-tag-groups.md): List the user-defined tag groups of a project (distinct non-empty `group` values across the project's tags), each with its shared color and tag count. System groups (branding/intentType) are not included — see List Tags for those.
- [List Tags](https://docs.peec.ai/api-reference/project/list-tags.md): List the tags of a project. Tags include user-created tags and Peec-managed system tags (is_system=true). Each tag carries a `group`: for system tags this is the mutually-exclusive dimension (branding or intentType); for user tags it is the user-defined group name (or null). Pass `group` to filter t…
- [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, deleting it
- [Reject Topic Suggestion](https://docs.peec.ai/api-reference/project/reject-topic-suggestion.md): Reject a topic suggestion by ID, deleting it and its associated prompt suggestions
- [Set Domain Classification](https://docs.peec.ai/api-reference/project/set-domain-classification.md): Assign a built-in or custom classification to a domain (overriding any heuristic classification), or clear the assignment by passing null.
- [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…
- [Set URL Classification](https://docs.peec.ai/api-reference/project/set-url-classification.md): Assign a built-in or custom classification to a URL (overriding any heuristic classification), or clear the assignment by passing null.
- [Unarchive Prompt](https://docs.peec.ai/api-reference/project/unarchive-prompt.md): Unarchive a prompt (is_archived = false), reactivating it. Subject to the project's active-prompt plan limit
- [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 Tag Group](https://docs.peec.ai/api-reference/project/update-tag-group.md): Rename and/or recolor a user-defined tag group. Applies to every tag in the group. System groups (branding/intentType) cannot be modified.
- [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.
- [Filtering and dimensions](https://docs.peec.ai/api/filtering-and-dimensions.md): How dimensions, filters, and having work on report endpoints, and the pitfalls to avoid.
- [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)
- [Connecting your data](https://docs.peec.ai/connecting-your-data.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.
- [Data Studio connector](https://docs.peec.ai/looker/introduction.md): Complete guide to connecting and using Peec AI data in Data Studio (formerly known as 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): How much of the conversation you own.
- [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.
- [Shopping overview](https://docs.peec.ai/overview.md): Track how your products appear across AI models by product, competitor, and week.
- [Products](https://docs.peec.ai/products.md): Every product in your catalog with its AI Shopping metrics, plus the per-product detail view for visibility, competitors, and attributes.
- [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 shopping prompts](https://docs.peec.ai/setting-up-shopping-prompts.md): Build a prompt set for product tracking with strong category coverage as its foundation, then add product-specific prompts where deeper insights are needed.
- [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.
- [Upload and manage your products](https://docs.peec.ai/uploading-products.md): Bring your product catalog into Peec to track AI Shopping visibility at the product level.
- [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)