Introduction
The Share of Model API allows you to programmatically access the same AI visibility and perception data available in the platform, and integrate it directly into your own tools, dashboards, and workflows.
Rather than relying solely on the Share of Model UI, the API enables teams to operationalise insights at scale, automate reporting, and connect AI driven signals to their internal analytics and activation systems.
This documentation focuses on the 2 core modules currently exposed through the API :
Search Visibility Module
The Search Visibility module provides access to AI driven visibility signals across answer engines. It allows you to understand how brands, products, or categories surface in AI generated answers, and which sources and citations contribute to that visibility.
For detailed definitions of KPIs and metrics, refer to the dedicated collection:
https://help.shareofmodel.ai/en/collections/15992802-module-search-search-visibility
Brand Perception Module
The Brand Perception module focuses on how AI models describe and interpret a brand. It exposes attributes, narratives, and associations inferred by AI systems, enabling deeper analysis of positioning, strengths, and risks.
For detailed definitions of KPIs and metrics, refer to the dedicated collection:
https://help.shareofmodel.ai/en/collections/10675357-module-models-brand-analysis
Who is this API for
The API is designed for teams who want to go beyond the Share of Model interface and reuse the data in their own environments.
Typical users include:
Product and data teams building internal dashboards
Marketing and brand teams centralising AI signals in BI tools
Technical teams integrating Share of Model data into proprietary platforms
What you can do with the API
Using the API, you can:
Access visibility and citation data across AI answer engines
Retrieve brand perception signals generated by AI models
Extract insights at product and category level for reporting or analysis
All responses are structured and designed to be consumed programmatically.
Before using the API: Generate an API key
Before using the API, you must generate an API key with the appropriate access privileges.
This article explains how to create and manage API keys step by step:
https://help.shareofmodel.ai/en/articles/12608530-creating-and-managing-api-keys
API keys are scoped to your workspace and should be treated as confidential credentials.
API Documentation
Our public API documentation is available here:
https://docs.shareofmodel.ai/
The documentation is split into two distinct APIs:
Brand Analysis Module
Search Visibility Module
You can switch between these APIs using the dropdown menu located in the header of the documentation website.
Making Your First API Call
To make your first API call, you must have a valid API key.
Authentication Flow
Generate your API key via the Help Center.
Use this API key to request a JWT token through our authentication endpoints.
Use the returned JWT token as a Bearer Token in the Authorization header for all subsequent API requests.
First Test Call
A simple way to validate your setup is to call the endpoint that lists the organizations you have access to.
For all other endpoints, simply follow the requirements and parameters described in the API documentation.
Understanding How the Search API Works
The Search Visibility API is structured around Projects and Collects.
What is a Project?
A project can only be created through the user interface. During setup, you define:
A website
A brand
A locale (country and language)
A list of thematics and sub-topics
A list of search queries (prompts)
Each query can include multiple attributes such as funnel stage, thematic, topic, persona, etc. (see Help Center for details)
A collection frequency (once, weekly, or monthly)
A list of sources to monitor (LLMs)
What is a Collect?
A collect is automatically created and associated with a project each time the platform gathers metrics.
A project with a “Once” frequency generates a single collect.
A weekly project generates one collect per week.
A monthly project generates one collect per month.
When a collect’s status is FINISHED, its ID can be used to retrieve metrics through the API.
Collect Metrics, Aggregations, and Evolutions
Most API endpoints support aggregation and comparison across multiple collects.
Single collect metrics
Provide one ID in the collect_ids field.Aggregated metrics across multiple collects
Provide multiple IDs in the collect_ids field.Evolution and comparison over time
Provide one or more IDs in the prev_collect_ids field to compare against a previous set of collects.
This structure allows you to analyze performance snapshots, trends, and evolutions over time.
Additional Notes
Our support team is always available to answer your questions at
[email protected]The API documentation is continuously evolving to provide the best possible experience and capabilities for our users.