Peec AI
Connect your AI agents to Peec AI.
Authentication: API key. See Magic Link for the runtime auth flow.
List tracked brands in a Peec project. Supports offset pagination. Returns brand IDs, names, domains, aliases, and…
Create a new tracked brand. Provide name, domains, aliases, regex pattern, or color. The brand becomes available for…
Update a brand’s name, domains, aliases, regex, or color. Modifying name, regex, or aliases triggers metric…
Soft-delete a brand. The brand is removed from the project but historical data is retained. Use list_brands to find…
List AI-generated brand suggestions for a project. Each suggestion includes a name, domains, and the count of chats…
Accept an AI-generated brand suggestion. The suggestion becomes a tracked brand. Use list_brand_suggestions to find…
Permanently reject an AI-generated brand suggestion. The suggestion is discarded. Use list_brand_suggestions to find…
List chats (AI model responses) for a project. Filter by date range, brand_id, prompt_id, or model_channel_id. Returns…
Get full content of a chat including the prompt, model channel, all messages (user + assistant), cited source URLs…
List available AI model channels (e.g. ‘openai-0’, ‘perplexity-1’) and the model each currently points at. Channels are…
List Peec AI projects available to the API key. Requires a company-scoped API key — project-scoped keys will get a 403…
Get the brand profile for a project. Returns occupation, industry, brand presentation, products and services, target…
Replace the entire brand profile for a project. WARNING: this is a full replacement — every field is required. Returns…
List configured prompts that Peec runs against AI models. Filter by topic_id or tag_id. Each prompt includes its text…
Create a new prompt to track. Required: text (1-200 chars) and ISO 3166-1 alpha-2 country_code. Optionally attach…
Update a prompt’s topic_id or tag_ids. Pass null topic_id to detach. Use list_prompts to find valid IDs.
Soft-delete a prompt. Cascades to delete related chats. Use list_prompts to find valid IDs.
List AI-generated prompt suggestions. Optionally filter by topic_id. Use accept_prompt_suggestion or…
Accept an AI-generated prompt suggestion. The suggestion becomes a configured prompt. Use list_prompt_suggestions to…
Permanently reject an AI-generated prompt suggestion. Use list_prompt_suggestions to find valid IDs.
List fanout search queries — the underlying search-style queries that AI models issued while answering tracked prompts…
List fanout shopping queries — the product-style queries that AI models issued while answering tracked prompts. Each…
Get a brand-level report with metrics (visibility, sentiment, position, mention_count, share_of_voice) over a date…
Get a source-domain report with metrics (citation_rate, retrieval_count, citation_count) over a date range. Identifies…
Get a source-URL report with metrics (citation_rate, retrieval_count, citation_count) over a date range. Identifies…
Fetch the scraped markdown content of a source URL Peec has indexed. Returns title, domain, content, truncation flag…
List tags in a Peec project. Tags are used to group prompts. Returns tag IDs, names, and colors with offset pagination.
Create a new tag for grouping prompts. Required: name. Optional color (defaults to ‘gray’). Valid colors: gray, red…
Update a tag’s name and/or color. Use list_tags to find valid IDs.
Soft-delete a tag. Use list_tags to find valid IDs.
List topics in a Peec project. Topics are used to organize prompts. Returns topic IDs and names with offset pagination.
Create a new topic to organize prompts. Required: name (1-64 chars). Optionally provide an ISO 3166-1 alpha-2…
Update a topic’s name (1-64 chars). Use list_topics to find valid IDs.
Delete a topic. Use list_topics to find valid IDs.
List AI-generated topic suggestions. Use accept_topic_suggestion or reject_topic_suggestion to triage.
Accept an AI-generated topic suggestion. The suggestion becomes a tracked topic. Use list_topic_suggestions to find…
Permanently reject an AI-generated topic suggestion. Use list_topic_suggestions to find valid IDs.
Validate the Peec AI API key by making a lightweight list_brands call. Works for both project-scoped and company-scoped…