> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Peec AI

> How to set up the Peec AI connector, plus the actions that are available.

![Peec AI](https://stackone-logos.com/api/peecai/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/peecai/changelog.md)

[36 actions](#actions) · 1 auth method

Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/peecai/guides/connector-profile/api-key.md)
>
> Peec AI authenticates every request with an API key sent in the x-api-key header. Keys are created in the Peec AI app an...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/peecai/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

36 actions

ActionDescription

List Actions`peecai_list_actions`

The project's actions, the ones Peec generated and the ones the customer wrote themselves alike: what to do, on which pa...

Get Action`peecai_get_action`

One action in full: what to do, the fields the customer owns on it — notes, priority, assignee, due date, tags and repea...

List Action Platforms`peecai_list_action_platforms`

The third-party sites a project has actions on, as values for the action list's `platforms` filter. A platform is whiche...

Create Actions`peecai_create_actions`

Record work the customer decided to do themselves as actions, in the same shape as the ones Peec generates, so they sort...

Update Actions`peecai_update_actions`

Rewrite the fields a customer owns, on actions they wrote or ones Peec generated. An edit is stored beside the generated...

Delete Actions`peecai_delete_actions`

Remove actions the customer wrote themselves. A generated action reads here exactly as a missing one does and lands in \`...

Update Action Status`peecai_update_action_status`

Move actions to a status by id: accept, reject, complete, delete, or send one back to `PENDING`. Ids the project publish...

Set Action Step Completion`peecai_set_action_step_completion`

Record which of an action's steps are done. Each entry names one action and either sets `completed` for every step it ho...

List Brands`peecai_list_brands`

List the brands of a project

Create Brand`peecai_create_brand`

Create a new brand within a project

List Brand Social Channels`peecai_list_brand_social_channels`

List the social channels configured for a project, optionally filtered to one brand.

Delete Brand`peecai_delete_brand`

Delete a brand within a project.

Update Brand`peecai_update_brand`

Update a brand within a project. Changes to name, regex, or aliases trigger a background recalculation of metrics. While...

Set Brand Social Channels`peecai_set_brand_social_channels`

Replace the complete list of social channels configured for a brand. Pass an empty list to remove them all.

List Categories`peecai_list_categories`

List a project's product categories. Each row carries its full `path` and its `parent_id`, so the flat list reconstructs...

Create Categories`peecai_create_categories`

Create product categories. Each item takes a `name` and an optional `parent_id` (omit or null for a top-level category)....

Update Categories`peecai_update_categories`

Rename and/or reparent categories by id. Each item sets `name` (rename), `parent_id` (move; null = promote to top level)...

Delete Categories`peecai_delete_categories`

Delete categories by id. Each one's child categories and products move up to its parent, then it is removed. Returns per...

List Custom URL Classifications`peecai_list_custom_url_classifications`

List the custom URL classifications defined for a project. These complement the built-in classifications and can be assi...

List Global Brands`peecai_list_global_brands`

Search Peec's global brand catalog — the shared registry of real-world brands that products attach to via \`global\_brand\_...

List Model Channels`peecai_list_model_channels`

List the model channels a project's reports can be broken down and filtered by. A model channel is a stable identifier f...

List Models`peecai_list_models`

List the individual AI model versions a project has answers from. Peec documents this endpoint as deprecated in favour o...

List Products`peecai_list_products`

List a project's products with headline metrics (mention\_count, win\_count, avg\_position, avg\_rating, visibility, share\_o...

Get Product`peecai_get_product`

Get one product's detail over a date range: headline metrics (visibility, win\_rate, avg\_position, avg\_rating, mention\_co...

Get Shopping Attributes`peecai_get_shopping_attributes`

The LLM-extracted attribute comparison grid for a product (scope=product) or the whole catalog (scope=overview), split b...

Get Shopping Summary`peecai_get_shopping_summary`

Return aggregate shopping metrics over a date range. Delta fields compare against an explicit previous window or the aut...

Get Shopping Trend`peecai_get_shopping_trend`

Return a product or brand shopping time series over a date range. Requires bucket and exactly one of product\_ids or bran...

List Shopping Performance`peecai_list_shopping_performance`

List ranked product or category shopping performance over a date range.

List Shopping Demand`peecai_list_shopping_demand`

List top shopping queries, web-search fan-out queries, or query terms over a date range.

List Merchants`peecai_list_merchants`

List the merchants (sellers) whose product offers surfaced in AI answers, ranked over a date range: mentions, share of v...

Create Products`peecai_create_products`

Create products. Each item is independent: valid products are created and per-item failures are returned in `rejected`,...

Update Products`peecai_update_products`

Update products (name, description, image, price overrides, categories). Each item is independent: items with nothing to...

Delete Products`peecai_delete_products`

Delete products. Ids that don't exist in the project are returned in `skipped`.

List Prompts`peecai_list_prompts`

List the prompts of a project

List Tags`peecai_list_tags`

List the tags of a project. Tags include user-created tags and Peec-managed system tags (is\_system=true). Each tag carri...

List Topics`peecai_list_topics`

List the topics of a project


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.