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
Retrieve analysis baseline report
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports/{id} \
--header 'Authorization: <api-key>'{
"id": "df2a3b6d-4f5c-47d2-92d4-8b17db3b9159",
"analysis": "f41bcbf1-8f7a-46c1-baf3-18c9d1ff1234",
"search_project_id": null,
"status": "COMPLETED",
"url": "https://docs.google.com/presentation/d/1abcXYZ123/view",
"created_by": "e3c7a801-badf-45f2-9113-66a5e1239abc"
}Analyses
Retrieve analysis baseline report
Retrieve details of a single baseline report by ID.
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
{analysis_id}
/
reports
/
{id}
Retrieve analysis baseline report
curl --request GET \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports/{id} \
--header 'Authorization: <api-key>'{
"id": "df2a3b6d-4f5c-47d2-92d4-8b17db3b9159",
"analysis": "f41bcbf1-8f7a-46c1-baf3-18c9d1ff1234",
"search_project_id": null,
"status": "COMPLETED",
"url": "https://docs.google.com/presentation/d/1abcXYZ123/view",
"created_by": "e3c7a801-badf-45f2-9113-66a5e1239abc"
}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 analysis.
A UUID string identifying this baseline report.
A UUID string identifying the organization.
A UUID string identifying the workspace.
Response
200 - application/json
Baseline report details.
⌘I