Skip to main content
Peec AI
Betav0.1.0
36 actions · 1 auth method

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

36 actions
Action
Description
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
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
The third-party sites a project has actions on, as values for the action list’s platforms filter. A platform is whiche…
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
Rewrite the fields a customer owns, on actions they wrote or ones Peec generated. An edit is stored beside the generated…
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
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
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
List the brands of a project
Create Brand
Create a new brand within a project
List Brand Social Channels
List the social channels configured for a project, optionally filtered to one brand.
Delete Brand
Delete a brand within a project.
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
Replace the complete list of social channels configured for a brand. Pass an empty list to remove them all.
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
Create product categories. Each item takes a name and an optional parent_id (omit or null for a top-level category)…
Update Categories
Rename and/or reparent categories by id. Each item sets name (rename), parent_id (move; null = promote to top level)…
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
List the custom URL classifications defined for a project. These complement the built-in classifications and can be assi…
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
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
List the individual AI model versions a project has answers from. Peec documents this endpoint as deprecated in favour o…
List Products
List a project’s products with headline metrics (mention_count, win_count, avg_position, avg_rating, visibility, share_o…
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
The LLM-extracted attribute comparison grid for a product (scope=product) or the whole catalog (scope=overview), split b…
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
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
List ranked product or category shopping performance over a date range.
List Shopping Demand
List top shopping queries, web-search fan-out queries, or query terms over a date range.
List Merchants
List the merchants (sellers) whose product offers surfaced in AI answers, ranked over a date range: mentions, share of v…
Create Products
Create products. Each item is independent: valid products are created and per-item failures are returned in rejected,…
Update Products
Update products (name, description, image, price overrides, categories). Each item is independent: items with nothing to…
Delete Products
Delete products. Ids that don’t exist in the project are returned in skipped.
List Prompts
List the prompts of a project
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
List the topics of a project