Core API
- GETList Brand Analyses in Workspace
- POSTCreate analysis
- GETList stored prompts
- GETRetrieve stored prompt
- GETList analysis baseline reports
- POSTCreate analysis baseline report
- GETRetrieve analysis baseline report
- GETGet Analysis Configuration & Details
- DELDelete analysis
- PATCHUpdate analysis
- POSTArchive analysis
- POSTCreate analysis clusters
- POSTRestore analysis
- GETGet distinct parameters
- GETGet analysis quota
- GETSuggest attributes for a brand and a category
- GETSuggest category attributes
- GETSuggest brand categories
- GETSuggest brand competitors
- GETSuggest brand personas
- GETSuggest personas for a brand and a category
- GETList baseline reports of analysis/search_project
- POSTCreate a baseline report for analysis/search project
- GETRetrieve a baseline report of analysis/search_project
- POSTDelete baseline reports by module type
Search API
Suggest brand competitors
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_competitors_for_brand \
--header 'Authorization: <api-key>'[
"<string>"
]Analyses
Suggest brand competitors
Get a list of suggested competitors to track for a given brand. Required permission: write:analysis.
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
suggest_competitors_for_brand
Suggest brand competitors
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_competitors_for_brand \
--header 'Authorization: <api-key>'[
"<string>"
]Documentation Index
Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Path Parameters
A UUID string identifying the organization.
A UUID string identifying the workspace.
Query Parameters
Brand for which to get competitors suggestions
Response
200 - application/json
List of competitors
⌘I