{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Share Of Model","colors":{"primary":"#000000","light":"#E6A202","dark":"#000000"},"logo":{"light":"https://mintcdn.com/jellyfish/oiuNBuQ2NqPF1etD/images/logo-light.svg?fit=max\u0026auto=format\u0026n=oiuNBuQ2NqPF1etD\u0026q=85\u0026s=ae39056cb13b88a23223c26108d49135","dark":"https://mintcdn.com/jellyfish/oiuNBuQ2NqPF1etD/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=oiuNBuQ2NqPF1etD\u0026q=85\u0026s=0baedc756f43b27dda87488baa3f9aea","href":"https://shareofmodel.ai"},"favicon":"https://mintcdn.com/jellyfish/2LIiaNCZbCpqxIgg/images/favicon.png?fit=max\u0026auto=format\u0026n=2LIiaNCZbCpqxIgg\u0026q=85\u0026s=be166baa2bcbae8a5c5d90fdd2971a41","navbar":{"links":[{"href":"https://shareofmodel.ai/contact","label":"Talk to us"}],"primary":{"type":"button","label":"Login","href":"https://console.shareofmodel.ai/"}},"footer":{"socials":{}},"search":{"prompt":"Search Share Of Model docs..."},"integrations":{"gtm":{"tagId":"GTM-5RVMXKPZ"},"intercom":{"appId":"erjcbfk8"}},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"jellyfish","hasAudioNarration":false,"actualSubdomain":"jellyfish","customDomains":["docs.shareofmodel.ai"],"gitSource":{"type":"gitlab","owner":"jellyfish-technology-solutions/shareofmodel","repo":"docs","deployBranch":"mintlify","contentDirectory":"","isPrivate":true,"projectId":76522561,"mountPath":"","label":""},"feedback":{"agentFeedback":true,"thumbs":true},"entitlements":{},"buildId":"6b007b82f9253d723a61b686","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API Reference","count":402},{"language":"default","tag":"Core API","count":336},{"language":"default","tag":"Documentation","count":83},{"language":"default","tag":"Search API","count":61},{"language":"default","tag":"Metrics","count":48},{"language":"default","tag":"Analyses","count":35},{"language":"default","tag":"AI Visibility","count":27},{"language":"default","tag":"Personas","count":21},{"language":"default","tag":"Insights","count":19},{"language":"default","tag":"Platform Basics","count":18}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#sidebar-content{width:16.8rem!important}@media (min-width: 1024px){.lg\\:pl-56{padding-left:16.8rem!important}}.nav-logo{height:2rem!important}.flex.gap-12.justify-between.pt-10.border-t.border-gray-100.sm\\:flex.dark\\:border-gray-800\\/50.pb-28{display:none}"}]}
{"page":{"pagePath":"api-reference/usage-costs/filter-values-of-a-period","slug":"/api-reference/usage-costs/filter-values-of-a-period","pageMetadata":{"title":"Filter values of a period","description":"Codes, providers, modules, services, models and organizations that have events in the period.","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/usage/costs/options","href":"/api-reference/usage-costs/filter-values-of-a-period","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Codes, providers, modules, services, models and organizations that have events in the period.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Filter values of a period","description":"Codes, providers, modules, services, models and organizations that have events in the period.","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/usage/costs/options","href":"/api-reference/usage-costs/filter-values-of-a-period","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/jellyfish/e8681af6e7a77f52/renovate.js"],"openApiReferenceData":{"operation":{"operationId":"get_usage_cost_options","description":"Codes, providers, modules, services, models and organizations that have events in the period.","summary":"Filter values of a period","parameters":["2262bfd8-bbb9-47cb-bfa4-81ed34863867","ec0f1b0d-193b-4f26-8a91-03762ca7e4ec","070b536a-2c34-47ff-84d8-5e5b4e49910a","09d9c6d5-094f-450b-851c-ad2820ab7290","f7fc6646-4cc5-44ec-bb77-c0bfde7dc6dd","c51d6b4b-e822-47cc-a340-4b9b57c747cd","f8000d00-8d81-4b82-96b4-5e16d7acd505","c8af77cb-ce98-4be2-b962-f4e6b015cfaf","bb99b505-438f-4182-a532-4e0c1192570c","3c73eb00-0f33-4f6e-8cc2-e26596de5f12"],"tags":["Usage costs"],"security":["86813526-6925-46c0-b7fe-b33efb568fcc"],"responses":{"200":"11df55aa-72bf-44cd-8ec3-6f84fec0b746","400":"43d4db61-0688-4b8c-ac60-18cc7136f69f","403":"b1fc054a-baa7-4d5e-87bc-c942caf98cb7"},"method":"get","type":"path","servers":["4e836d17-e73a-43b4-a32c-49e2f45c71ab","6b65b1b4-a44f-4cb2-b1be-58014dd633f9"],"path":"/v1/usage/costs/options","baseUrlOptions":["https://api.shareofmodel.ai/","https://api.dev.shareofmodel.ai/"],"title":"Filter values of a period","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2262bfd8-bbb9-47cb-bfa4-81ed34863867":{"in":"query","name":"analysis_id","schema":{"type":"string","maxLength":255,"minLength":1,"uniqueKey":"","typeLabel":"string"}},"ec0f1b0d-193b-4f26-8a91-03762ca7e4ec":{"in":"query","name":"code","schema":{"type":"array","items":{"enum":["llm_cost_usd","tool_cost_usd","compute_cost_usd"],"type":"string","description":"* `llm_cost_usd` - llm cost usd\n* `tool_cost_usd` - tool cost usd\n* `compute_cost_usd` - compute cost usd","x-spec-enum-id":"f427e86f937ee50d","uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"070b536a-2c34-47ff-84d8-5e5b4e49910a":{"in":"query","name":"end","schema":{"type":"string","format":"date","uniqueKey":"","typeLabel":"string\u003cdate>"}},"09d9c6d5-094f-450b-851c-ad2820ab7290":{"in":"query","name":"model","schema":{"type":"string","maxLength":255,"minLength":1,"uniqueKey":"","typeLabel":"string"}},"f7fc6646-4cc5-44ec-bb77-c0bfde7dc6dd":{"in":"query","name":"module","schema":{"type":"string","maxLength":50,"minLength":1,"uniqueKey":"","typeLabel":"string"}},"c51d6b4b-e822-47cc-a340-4b9b57c747cd":{"in":"query","name":"organization_id","schema":{"type":"string","format":"uuid","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"f8000d00-8d81-4b82-96b4-5e16d7acd505":{"in":"query","name":"provider","schema":{"type":"string","maxLength":100,"minLength":1,"uniqueKey":"","typeLabel":"string"}},"c8af77cb-ce98-4be2-b962-f4e6b015cfaf":{"in":"query","name":"service","schema":{"type":"string","maxLength":50,"minLength":1,"uniqueKey":"","typeLabel":"string"}},"bb99b505-438f-4182-a532-4e0c1192570c":{"in":"query","name":"start","schema":{"type":"string","format":"date","uniqueKey":"","typeLabel":"string\u003cdate>"}},"3c73eb00-0f33-4f6e-8cc2-e26596de5f12":{"in":"query","name":"workspace_id","schema":{"type":"string","format":"uuid","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"11df55aa-72bf-44cd-8ec3-6f84fec0b746":{"content":{"application/json":{"schema":{"type":"object","properties":{"codes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"codes.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"codes.items.[INDEX].label","typeLabel":"string"}},"required":["label","value"],"uniqueKey":"codes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"codes","typeLabel":"object[]"},"providers":{"type":"array","items":{"type":"string","uniqueKey":"providers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"providers","typeLabel":"string[]"},"modules":{"type":"array","items":{"type":"string","uniqueKey":"modules.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"modules","typeLabel":"string[]"},"services":{"type":"array","items":{"type":"string","uniqueKey":"services.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"services","typeLabel":"string[]"},"models":{"type":"array","items":{"type":"string","uniqueKey":"models.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"models","typeLabel":"string[]"},"organizations":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"organizations.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"organizations.items.[INDEX].label","typeLabel":"string"}},"required":["label","value"],"uniqueKey":"organizations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"organizations","typeLabel":"object[]"}},"required":["codes","models","modules","organizations","providers","services"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"codes":[{"value":"\u003cstring>","label":"\u003cstring>"}],"providers":["\u003cstring>"],"modules":["\u003cstring>"],"services":["\u003cstring>"],"models":["\u003cstring>"],"organizations":[{"value":"\u003cstring>","label":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"43d4db61-0688-4b8c-ac60-18cc7136f69f":{"description":"Invalid filters.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b1fc054a-baa7-4d5e-87bc-c942caf98cb7":{"description":"Staff users only.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"86813526-6925-46c0-b7fe-b33efb568fcc":{"Bearer":{"type":"apiKey","in":"header","name":"Authorization","scopes":[],"schemeName":"Bearer"}}},"servers":{"4e836d17-e73a-43b4-a32c-49e2f45c71ab":{"description":"Production API","url":"https://api.shareofmodel.ai/"},"6b65b1b4-a44f-4cb2-b1be-58014dd633f9":{"description":"Development API","url":"https://api.dev.shareofmodel.ai/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"https://openapi.shareofmodel.ai/swagger.json"},"subdomain":"jellyfish","siteName":"Share Of Model","title":"Filter values of a period - Share Of Model","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T16:13:56.745Z","originalFileLocation":"api-reference/usage-costs/filter-values-of-a-period.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Codes, providers, modules, services, models and organizations that have events in the period.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Share Of Model\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Filter values of a period - Share Of Model\">\u003cmeta data-mint-head property=\"og:description\" content=\"Codes, providers, modules, services, models and organizations that have events in the period.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Share Of Model\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://jellyfish.mintlify.site/_mintlify/api/og/v2?division=Usage+costs\u0026amp;title=Filter+values+of+a+period\u0026amp;description=Codes%2C+providers%2C+modules%2C+services%2C+models+and+organizations+that+have+events+in+the+period.\u0026amp;theme=6c49a88ac32b95072f8af54c\u0026amp;signature=97e83a4c404fbe5b55034a436c074f9748b0a2287a547d99e427909da8bd1d3b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Filter values of a period - Share Of Model\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Codes, providers, modules, services, models and organizations that have events in the period.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jellyfish.mintlify.site/_mintlify/api/og/v2?division=Usage+costs\u0026amp;title=Filter+values+of+a+period\u0026amp;description=Codes%2C+providers%2C+modules%2C+services%2C+models+and+organizations+that+have+events+in+the+period.\u0026amp;theme=6c49a88ac32b95072f8af54c\u0026amp;signature=97e83a4c404fbe5b55034a436c074f9748b0a2287a547d99e427909da8bd1d3b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/jellyfish/x_-3X7ikHD7n9IFa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Share Of Model\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/usage-costs/filter-values-of-a-period.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shareofmodel.ai/#organization\",\"name\":\"Share Of Model\",\"url\":\"https://docs.shareofmodel.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/jellyfish/oiuNBuQ2NqPF1etD/images/logo-light.svg?fit=max\u0026auto=format\u0026n=oiuNBuQ2NqPF1etD\u0026q=85\u0026s=ae39056cb13b88a23223c26108d49135\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shareofmodel.ai#website\",\"name\":\"Share Of Model\",\"url\":\"https://docs.shareofmodel.ai\",\"publisher\":{\"@id\":\"https://docs.shareofmodel.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period#webpage\",\"url\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period\",\"name\":\"Filter values of a period\",\"description\":\"Codes, providers, modules, services, models and organizations that have events in the period.\",\"dateModified\":\"2026-11-20T16:13:56.745Z\",\"isPartOf\":{\"@id\":\"https://docs.shareofmodel.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://docs.shareofmodel.ai/api-reference/platform-integrations/google-ads-oauth-callback\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Usage costs\",\"item\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/costs-grouped-by-a-dimension\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Filter values of a period\",\"item\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period#apireference\",\"headline\":\"Filter values of a period\",\"name\":\"Filter values of a period\",\"description\":\"Codes, providers, modules, services, models and organizations that have events in the period.\",\"url\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shareofmodel.ai/api-reference/usage-costs/filter-values-of-a-period#webpage\"},\"dateModified\":\"2026-11-20T16:13:56.745Z\",\"publisher\":{\"@id\":\"https://docs.shareofmodel.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shareofmodel.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Share Of Model\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Share Of Model\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/usage-costs/filter-values-of-a-period.md","siteName":"Share Of Model","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/home"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/introduction"},{"title":"Quickstart","icon":"rocket","href":"/api-reference/quickstart"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Rate limits","icon":"gauge-high","href":"/api-reference/rate-limits"},{"title":"MCP Integration","icon":"plug","href":"/api-reference/mcp-integration"}]},{"group":"Core API","pages":[{"group":"Platform Integrations","pages":[{"title":"Google Ads OAuth callback","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/auth/google_ads/callback","href":"/api-reference/platform-integrations/google-ads-oauth-callback"},{"title":"TikTok OAuth callback","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/auth/tiktok/callback","href":"/api-reference/platform-integrations/tiktok-oauth-callback"},{"title":"List platform integrations","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations","href":"/api-reference/platform-integrations/list-platform-integrations"},{"title":"Create a platform integration","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations","href":"/api-reference/platform-integrations/create-a-platform-integration"},{"title":"Retrieve platform integration","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/{id}","href":"/api-reference/platform-integrations/retrieve-platform-integration"},{"title":"Delete platform integration","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/{id}","href":"/api-reference/platform-integrations/delete-platform-integration"},{"title":"List all accounts accessible with the platform integration","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/{id}/accounts","href":"/api-reference/platform-integrations/list-all-accounts-accessible-with-the-platform-integration"},{"title":"List platform integration campaigns for a given account","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/{id}/campaigns","href":"/api-reference/platform-integrations/list-platform-integration-campaigns-for-a-given-account"},{"title":"Initiate Google Ads OAuth flow","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/auth/google_ads","href":"/api-reference/platform-integrations/initiate-google-ads-oauth-flow"},{"title":"Google Ads OAuth callback","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/auth/google_ads/callback","href":"/api-reference/platform-integrations/google-ads-oauth-callback-1"},{"title":"Initiate TikTok OAuth flow","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/auth/tiktok","href":"/api-reference/platform-integrations/initiate-tiktok-oauth-flow"},{"title":"TikTok OAuth callback","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/auth/tiktok/callback","href":"/api-reference/platform-integrations/tiktok-oauth-callback-1"}]},{"group":"Auth","pages":[{"title":"Refresh token","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/auth/refresh_token","href":"/api-reference/auth/refresh-token"},{"title":"Get token","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/auth/token","href":"/api-reference/auth/get-token"}]},{"group":"SSO","pages":[{"title":"Tell whether an email domain is covered by single sign-on","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/auth/sso/discover","href":"/api-reference/sso/tell-whether-an-email-domain-is-covered-by-single-sign-on"},{"title":"Exchange a one-time single sign-on code for a JWT","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/auth/sso/exchange","href":"/api-reference/sso/exchange-a-one-time-single-sign-on-code-for-a-jwt"},{"title":"Get the SSO configuration of an organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/sso","href":"/api-reference/sso/get-the-sso-configuration-of-an-organization"},{"title":"Create or replace the SSO configuration of an organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/organizations/{organization_id}/sso","href":"/api-reference/sso/create-or-replace-the-sso-configuration-of-an-organization"},{"title":"Disable single sign-on for an organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/sso","href":"/api-reference/sso/disable-single-sign-on-for-an-organization"},{"title":"Partially update the SSO configuration of an organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/sso","href":"/api-reference/sso/partially-update-the-sso-configuration-of-an-organization"},{"title":"Activate a tested SSO configuration","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/sso/activate","href":"/api-reference/sso/activate-a-tested-sso-configuration"},{"title":"List identity provider group mappings","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/sso/group_mappings","href":"/api-reference/sso/list-identity-provider-group-mappings"},{"title":"Map an identity provider group to a role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/sso/group_mappings","href":"/api-reference/sso/map-an-identity-provider-group-to-a-role"},{"title":"Delete a group mapping","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/sso/group_mappings/{id}","href":"/api-reference/sso/delete-a-group-mapping"},{"title":"Parse an identity provider metadata document without saving it","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/sso/import_metadata","href":"/api-reference/sso/parse-an-identity-provider-metadata-document-without-saving-it"},{"title":"Generate a new service provider key pair","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/sso/rotate_certificate","href":"/api-reference/sso/generate-a-new-service-provider-key-pair"},{"title":"Start a test sign-on that does not create users nor activate anything","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/sso/test","href":"/api-reference/sso/start-a-test-sign-on-that-does-not-create-users-nor-activate-anything"},{"title":"Get the result of a test sign-on","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/sso/test/{request_id}","href":"/api-reference/sso/get-the-result-of-a-test-sign-on"},{"title":"SAML assertion consumer service","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/sso/{slug}/acs","href":"/api-reference/sso/saml-assertion-consumer-service"},{"title":"OpenID Connect callback","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/sso/{slug}/callback","href":"/api-reference/sso/openid-connect-callback"},{"title":"Start a single sign-on and redirect to the identity provider","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/sso/{slug}/login","href":"/api-reference/sso/start-a-single-sign-on-and-redirect-to-the-identity-provider"},{"title":"Service provider SAML metadata","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/sso/{slug}/metadata","href":"/api-reference/sso/service-provider-saml-metadata"}]},{"group":"Preferences","pages":[{"title":"Get the current user's preferences","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/auth/user/preferences","href":"/api-reference/preferences/get-the-current-users-preferences"},{"title":"Set a preference value for the current user","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/auth/user/preferences/{key}","href":"/api-reference/preferences/set-a-preference-value-for-the-current-user"},{"title":"Remove the current user's value on a preference, falling back to the inherited value","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/auth/user/preferences/{key}","href":"/api-reference/preferences/remove-the-current-users-value-on-a-preference-falling-back-to-the-inherited-value"},{"title":"List preferences (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/preferences","href":"/api-reference/preferences/list-preferences-staff"},{"title":"Create a preference (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/preferences","href":"/api-reference/preferences/create-a-preference-staff"},{"title":"Get a preference (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/preferences/{id}","href":"/api-reference/preferences/get-a-preference-staff"},{"title":"Replace a preference (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/preferences/{id}","href":"/api-reference/preferences/replace-a-preference-staff"},{"title":"Delete a preference and every value set on it (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/preferences/{id}","href":"/api-reference/preferences/delete-a-preference-and-every-value-set-on-it-staff"},{"title":"Update a preference (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/preferences/{id}","href":"/api-reference/preferences/update-a-preference-staff"},{"title":"List preference groups (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/preferences/groups","href":"/api-reference/preferences/list-preference-groups-staff"},{"title":"Create a preference group (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/preferences/groups","href":"/api-reference/preferences/create-a-preference-group-staff"},{"title":"Get a preference group (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/preferences/groups/{id}","href":"/api-reference/preferences/get-a-preference-group-staff"},{"title":"Replace a preference group (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/preferences/groups/{id}","href":"/api-reference/preferences/replace-a-preference-group-staff"},{"title":"Delete a preference group and every value set on it (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/preferences/groups/{id}","href":"/api-reference/preferences/delete-a-preference-group-and-every-value-set-on-it-staff"},{"title":"Update a preference group (staff)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/preferences/groups/{id}","href":"/api-reference/preferences/update-a-preference-group-staff"}]},{"group":"API Key","pages":[{"title":"List user API keys","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/auth/user/tokens","href":"/api-reference/api-key/list-user-api-keys"},{"title":"Create user API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/auth/user/tokens","href":"/api-reference/api-key/create-user-api-key"},{"title":"Delete user API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/auth/user/tokens/{id}","href":"/api-reference/api-key/delete-user-api-key"},{"title":"Rotate user API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/auth/user/tokens/rotate","href":"/api-reference/api-key/rotate-user-api-key"},{"title":"List organization API keys","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/tokens","href":"/api-reference/api-key/list-organization-api-keys"},{"title":"Create organization API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/tokens","href":"/api-reference/api-key/create-organization-api-key"},{"title":"Delete organization API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/tokens/{id}","href":"/api-reference/api-key/delete-organization-api-key"},{"title":"Rotate organization API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/tokens/rotate","href":"/api-reference/api-key/rotate-organization-api-key"},{"title":"List workspace API keys","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/tokens","href":"/api-reference/api-key/list-workspace-api-keys"},{"title":"Create workspace API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/tokens","href":"/api-reference/api-key/create-workspace-api-key"},{"title":"Delete workspace API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/tokens/{id}","href":"/api-reference/api-key/delete-workspace-api-key"},{"title":"Rotate workspace API key","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/tokens/rotate","href":"/api-reference/api-key/rotate-workspace-api-key"}]},{"group":"Favourites","pages":[{"title":"List favourites","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/favourites","href":"/api-reference/favourites/list-favourites"},{"title":"Create favourite","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/favourites","href":"/api-reference/favourites/create-favourite"},{"title":"Replace favourite","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/favourites/{id}","href":"/api-reference/favourites/replace-favourite"},{"title":"Delete favourite","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/favourites/{id}","href":"/api-reference/favourites/delete-favourite"},{"title":"Update favourite","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/favourites/{id}","href":"/api-reference/favourites/update-favourite"},{"title":"List favourite sections","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/favourites/sections","href":"/api-reference/favourites/list-favourite-sections"},{"title":"Create favourite section","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/favourites/sections","href":"/api-reference/favourites/create-favourite-section"},{"title":"Replace favourite section","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/favourites/sections/{id}","href":"/api-reference/favourites/replace-favourite-section"},{"title":"Delete favourite section","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/favourites/sections/{id}","href":"/api-reference/favourites/delete-favourite-section"},{"title":"Update favourite section","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/favourites/sections/{id}","href":"/api-reference/favourites/update-favourite-section"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations","href":"/api-reference/organizations/create-organization"},{"title":"Retrieve member details","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/members/{member_id}","href":"/api-reference/organizations/retrieve-member-details"},{"title":"Retrieve member activity","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/members/{member_id}/activity","href":"/api-reference/organizations/retrieve-member-activity"},{"title":"Retrieve organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{id}","href":"/api-reference/organizations/retrieve-organization"},{"title":"Update organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{id}","href":"/api-reference/organizations/update-organization"},{"title":"Filter organizations","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/filter","href":"/api-reference/organizations/filter-organizations"}]},{"group":"User Organization Roles","pages":[{"title":"List organization roles","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/roles","href":"/api-reference/user-organization-roles/list-organization-roles"},{"title":"Create organization role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/roles","href":"/api-reference/user-organization-roles/create-organization-role"},{"title":"Retrieve organization role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/roles/{id}","href":"/api-reference/user-organization-roles/retrieve-organization-role"},{"title":"Delete organization role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/roles/{id}","href":"/api-reference/user-organization-roles/delete-organization-role"},{"title":"Update organization role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/roles/{id}","href":"/api-reference/user-organization-roles/update-organization-role"},{"title":"Bulk delete organization roles","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/roles/bulk_delete","href":"/api-reference/user-organization-roles/bulk-delete-organization-roles"}]},{"group":"SCIM","pages":[{"title":"Get SCIM provisioning information for an organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/scim","href":"/api-reference/scim/get-scim-provisioning-information-for-an-organization"},{"title":"List SCIM bearer tokens of an organization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/scim/tokens","href":"/api-reference/scim/list-scim-bearer-tokens-of-an-organization"},{"title":"Create a SCIM bearer token, returned only once","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/scim/tokens","href":"/api-reference/scim/create-a-scim-bearer-token-returned-only-once"},{"title":"Delete a SCIM bearer token","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/scim/tokens/{id}","href":"/api-reference/scim/delete-a-scim-bearer-token"},{"title":"Rotate a SCIM bearer token","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/scim/tokens/rotate","href":"/api-reference/scim/rotate-a-scim-bearer-token"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces","href":"/api-reference/workspaces/create-workspace"},{"title":"Retrieve workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{id}","href":"/api-reference/workspaces/retrieve-workspace"},{"title":"Delete workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{id}","href":"/api-reference/workspaces/delete-workspace"},{"title":"Update workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{id}","href":"/api-reference/workspaces/update-workspace"},{"title":"Get all workspaces usage info","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/usage","href":"/api-reference/workspaces/get-all-workspaces-usage-info"},{"title":"Filter workspaces","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/workspaces/filter","href":"/api-reference/workspaces/filter-workspaces"}]},{"group":"Platform Accounts","pages":[{"title":"List platform accounts","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts","href":"/api-reference/platform-accounts/list-platform-accounts"},{"title":"Create platform accounts","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts","href":"/api-reference/platform-accounts/create-platform-accounts"},{"title":"Retrieve platform account","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts/{id}","href":"/api-reference/platform-accounts/retrieve-platform-account"},{"title":"Delete platform account","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts/{id}","href":"/api-reference/platform-accounts/delete-platform-account"},{"title":"Activate platform account","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts/{id}/activate","href":"/api-reference/platform-accounts/activate-platform-account"},{"title":"Deactivate platform account","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts/{id}/deactivate","href":"/api-reference/platform-accounts/deactivate-platform-account"}]},{"group":"User Workspace Roles","pages":[{"title":"List workspace roles","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/roles","href":"/api-reference/user-workspace-roles/list-workspace-roles"},{"title":"Create workspace role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/roles","href":"/api-reference/user-workspace-roles/create-workspace-role"},{"title":"Retrieve workspace role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/roles/{id}","href":"/api-reference/user-workspace-roles/retrieve-workspace-role"},{"title":"Delete workspace role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/roles/{id}","href":"/api-reference/user-workspace-roles/delete-workspace-role"},{"title":"Update workspace role","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/roles/{id}","href":"/api-reference/user-workspace-roles/update-workspace-role"},{"title":"Bulk delete workspace roles","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/roles/bulk_delete","href":"/api-reference/user-workspace-roles/bulk-delete-workspace-roles"}]},{"group":"Usage costs","pages":[{"title":"Costs grouped by a dimension","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/usage/costs/breakdown","href":"/api-reference/usage-costs/costs-grouped-by-a-dimension"},{"title":"Estimated and actual cost per month","description":"Per calendar month of the range (most recent first), the estimated cost of every organization and the actual cost entered by hand in the Django admin (Provider monthly costs), in total and per provider. `actual_cost_usd` is null for a month or provider with no entry. Organization filters do not apply: actual costs are known only for the whole platform. Defaults to the last six months. Staff only.","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/usage/costs/monthly","href":"/api-reference/usage-costs/estimated-and-actual-cost-per-month"},{"title":"Filter values of a period","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/usage/costs/options","href":"/api-reference/usage-costs/filter-values-of-a-period"},{"title":"Cost totals of a period","description":"Totals and the cost of the previous period of the same length. Period from `start` to `end` (inclusive dates, UTC, last 30 days by default, at most 731 days). `code` can be repeated and defaults to every cost type (LLM, tools, compute). Credits are null when a filter they cannot follow is set (analysis, provider, service, model, cost type). Staff only.","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/usage/costs/summary","href":"/api-reference/usage-costs/cost-totals-of-a-period"},{"title":"Cost over time","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/usage/costs/timeseries","href":"/api-reference/usage-costs/cost-over-time"}]},{"group":"Analyses","pages":[{"title":"List the analyses a user created","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/analyses","href":"/api-reference/analyses/list-the-analyses-a-user-created"},{"title":"List Brand Analyses in Workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses","href":"/api-reference/analyses/list-brand-analyses-in-workspace"},{"title":"Create analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses","href":"/api-reference/analyses/create-analysis"},{"title":"List stored prompts","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/prompts","href":"/api-reference/analyses/list-stored-prompts"},{"title":"Retrieve stored prompt","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/prompts/{id}","href":"/api-reference/analyses/retrieve-stored-prompt"},{"title":"List analysis baseline reports","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports","href":"/api-reference/analyses/list-analysis-baseline-reports"},{"title":"Create analysis baseline report","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports","href":"/api-reference/analyses/create-analysis-baseline-report"},{"title":"Retrieve analysis baseline report","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports/{id}","href":"/api-reference/analyses/retrieve-analysis-baseline-report"},{"title":"Get Analysis Configuration \u0026 Details","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}","href":"/api-reference/analyses/get-analysis-configuration-\u0026-details"},{"title":"Delete analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}","href":"/api-reference/analyses/delete-analysis"},{"title":"Update analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}","href":"/api-reference/analyses/update-analysis"},{"title":"Archive analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/archive","href":"/api-reference/analyses/archive-analysis"},{"title":"Create analysis clusters","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/create_clusters","href":"/api-reference/analyses/create-analysis-clusters"},{"title":"Update analysis model versions","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/model-versions","href":"/api-reference/analyses/update-analysis-model-versions"},{"title":"Restore analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/restore","href":"/api-reference/analyses/restore-analysis"},{"title":"List tags on analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/tags","href":"/api-reference/analyses/list-tags-on-analysis"},{"title":"Replace tags on analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/tags","href":"/api-reference/analyses/replace-tags-on-analysis"},{"title":"Assign tag to analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/tags","href":"/api-reference/analyses/assign-tag-to-analysis"},{"title":"Remove tag from analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{id}/tags/{tag_id}","href":"/api-reference/analyses/remove-tag-from-analysis"},{"title":"Compute Brand Analysis cost","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/compute-cost","href":"/api-reference/analyses/compute-brand-analysis-cost"},{"title":"List analysis LLM models with pricing","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/models","href":"/api-reference/analyses/list-analysis-llm-models-with-pricing"},{"title":"Get distinct parameters","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/parameters","href":"/api-reference/analyses/get-distinct-parameters"},{"title":"Get analysis quota","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/quota","href":"/api-reference/analyses/get-analysis-quota"},{"title":"Suggest attributes for a brand and a category","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_attributes_for_brand_and_category","href":"/api-reference/analyses/suggest-attributes-for-a-brand-and-a-category"},{"title":"Suggest category attributes","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_attributes_for_category","href":"/api-reference/analyses/suggest-category-attributes"},{"title":"Suggest brand categories","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_categories_for_brand","href":"/api-reference/analyses/suggest-brand-categories"},{"title":"Suggest brand competitors","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_competitors_for_brand","href":"/api-reference/analyses/suggest-brand-competitors"},{"title":"Suggest brand personas","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_personas_for_brand","href":"/api-reference/analyses/suggest-brand-personas"},{"title":"Suggest personas for a brand and a category","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/suggest_personas_for_brand_and_category","href":"/api-reference/analyses/suggest-personas-for-a-brand-and-a-category"},{"title":"Export an object of the workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/exports","href":"/api-reference/analyses/export-an-object-of-the-workspace"},{"title":"List baseline reports of analysis/search_project","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/reports","href":"/api-reference/analyses/list-baseline-reports-of-analysissearch_project"},{"title":"Create a baseline report for analysis/search project","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/reports","href":"/api-reference/analyses/create-a-baseline-report-for-analysissearch-project"},{"title":"Retrieve a baseline report of analysis/search_project","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/reports/{id}","href":"/api-reference/analyses/retrieve-a-baseline-report-of-analysissearch_project"},{"title":"Delete baseline reports by module type","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/reports/delete","href":"/api-reference/analyses/delete-baseline-reports-by-module-type"},{"title":"List the baseline reports a user created","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/reports","href":"/api-reference/analyses/list-the-baseline-reports-a-user-created"}]},{"group":"Asset Evaluations","pages":[{"title":"List the asset evaluations a user created","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/asset_evaluations","href":"/api-reference/asset-evaluations/list-the-asset-evaluations-a-user-created"},{"title":"List asset evaluations","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations","href":"/api-reference/asset-evaluations/list-asset-evaluations"},{"title":"Create asset evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations","href":"/api-reference/asset-evaluations/create-asset-evaluation"},{"title":"Retrieve asset evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{id}","href":"/api-reference/asset-evaluations/retrieve-asset-evaluation"},{"title":"Destroy asset evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{id}","href":"/api-reference/asset-evaluations/destroy-asset-evaluation"},{"title":"Update asset evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{id}","href":"/api-reference/asset-evaluations/update-asset-evaluation"},{"title":"Archive asset evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{id}/archive","href":"/api-reference/asset-evaluations/archive-asset-evaluation"},{"title":"Restore asset evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{id}/restore","href":"/api-reference/asset-evaluations/restore-asset-evaluation"},{"title":"Retry asset evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{id}/retry","href":"/api-reference/asset-evaluations/retry-asset-evaluation"},{"title":"Get asset evaluation status","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{id}/status","href":"/api-reference/asset-evaluations/get-asset-evaluation-status"},{"title":"Compute Asset Evaluation cost","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/compute-cost","href":"/api-reference/asset-evaluations/compute-asset-evaluation-cost"},{"title":"Get asset evaluations llm models","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/models","href":"/api-reference/asset-evaluations/get-asset-evaluations-llm-models"},{"title":"List asset evaluation LLM models with pricing","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/models/cost","href":"/api-reference/asset-evaluations/list-asset-evaluation-llm-models-with-pricing"},{"title":"Get asset evaluations quota","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/quota","href":"/api-reference/asset-evaluations/get-asset-evaluations-quota"},{"title":"List asset evaluations settings","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/settings","href":"/api-reference/asset-evaluations/list-asset-evaluations-settings"},{"title":"Update workspace image assets ","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/update_images","href":"/api-reference/asset-evaluations/update-workspace-image-assets"},{"title":"Create asset evaluation (v2)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/v2","href":"/api-reference/asset-evaluations/create-asset-evaluation-v2"}]},{"group":"Assets","pages":[{"title":"List the assets a user uploaded","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/assets","href":"/api-reference/assets/list-the-assets-a-user-uploaded"},{"title":"List assets","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets","href":"/api-reference/assets/list-assets"},{"title":"Create asset(s)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets","href":"/api-reference/assets/create-assets"},{"title":"Retrieve asset","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/{id}","href":"/api-reference/assets/retrieve-asset"},{"title":"List tags on asset","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/{id}/tags","href":"/api-reference/assets/list-tags-on-asset"},{"title":"Replace tags on asset","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/{id}/tags","href":"/api-reference/assets/replace-tags-on-asset"},{"title":"Assign tag to asset","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/{id}/tags","href":"/api-reference/assets/assign-tag-to-asset"},{"title":"Remove tag from asset","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/{id}/tags/{tag_id}","href":"/api-reference/assets/remove-tag-from-asset"},{"title":"Archive asset(s)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/archive","href":"/api-reference/assets/archive-assets"},{"title":"Bulk edit asset(s)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/bulk_edit","href":"/api-reference/assets/bulk-edit-assets"},{"title":"Delete asset(s)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/delete","href":"/api-reference/assets/delete-assets"},{"title":"Restore asset(s)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/assets/restore","href":"/api-reference/assets/restore-assets"}]},{"group":"Brand Catalog","pages":[{"title":"List brand catalogs","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/brands","href":"/api-reference/brand-catalog/list-brand-catalogs"}]},{"group":"Tags","pages":[{"title":"List tags in workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/tags","href":"/api-reference/tags/list-tags-in-workspace"},{"title":"Create tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/tags","href":"/api-reference/tags/create-tag"},{"title":"Retrieve tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/tags/{id}","href":"/api-reference/tags/retrieve-tag"},{"title":"Delete tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/tags/{id}","href":"/api-reference/tags/delete-tag"},{"title":"Update tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/tags/{id}","href":"/api-reference/tags/update-tag"},{"title":"List tags in workspace","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/tags","href":"/api-reference/tags/list-tags-in-workspace-1"},{"title":"Create tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/tags","href":"/api-reference/tags/create-tag-1"},{"title":"Retrieve tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/tags/{id}","href":"/api-reference/tags/retrieve-tag-1"},{"title":"Delete tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/tags/{id}","href":"/api-reference/tags/delete-tag-1"},{"title":"Update tag","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/tags/{id}","href":"/api-reference/tags/update-tag-1"}]},{"group":"Content Briefs","pages":[{"title":"List content briefs","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/content_briefs","href":"/api-reference/content-briefs/list-content-briefs"},{"title":"Create content brief","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/content_briefs","href":"/api-reference/content-briefs/create-content-brief"},{"title":"List content brief iterations","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/content_briefs/{content_brief_id}/iterations","href":"/api-reference/content-briefs/list-content-brief-iterations"},{"title":"Create content brief iteration","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/content_briefs/{content_brief_id}/iterations","href":"/api-reference/content-briefs/create-content-brief-iteration"},{"title":"List workspace content briefs","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/content_briefs","href":"/api-reference/content-briefs/list-workspace-content-briefs"}]},{"group":"Campaign Optimizations","pages":[{"title":"List campaign optimizations","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations","href":"/api-reference/campaign-optimizations/list-campaign-optimizations"},{"title":"Create campaign optimization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations","href":"/api-reference/campaign-optimizations/create-campaign-optimization"},{"title":"Get the latest suggestion for a campaign optimization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{campaign_optimization_id}/suggestions","href":"/api-reference/campaign-optimizations/get-the-latest-suggestion-for-a-campaign-optimization"},{"title":"Create optimization results for a campaign optimization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{campaign_optimization_id}/suggestions","href":"/api-reference/campaign-optimizations/create-optimization-results-for-a-campaign-optimization"},{"title":"Retrieve campaign optimization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}","href":"/api-reference/campaign-optimizations/retrieve-campaign-optimization"},{"title":"Delete campaign optimization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}","href":"/api-reference/campaign-optimizations/delete-campaign-optimization"},{"title":"Extend suggestions for a campaign optimization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/extend_suggestions","href":"/api-reference/campaign-optimizations/extend-suggestions-for-a-campaign-optimization"},{"title":"Implement suggestions for a campaign optimization","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/implement_suggestions","href":"/api-reference/campaign-optimizations/implement-suggestions-for-a-campaign-optimization"},{"title":"Refresh asset group info from Google Ads","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/refresh","href":"/api-reference/campaign-optimizations/refresh-asset-group-info-from-google-ads"},{"title":"Restart campaign optimization pipeline","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart","href":"/api-reference/campaign-optimizations/restart-campaign-optimization-pipeline"}]},{"group":"Opportunities","pages":[{"title":"Activate recurring opportunities and trigger pipeline immediately","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/opportunities/activate-recurring","href":"/api-reference/opportunities/activate-recurring-opportunities-and-trigger-pipeline-immediately"},{"title":"Deactivate recurring opportunities scheduler","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/opportunities/deactivate-recurring","href":"/api-reference/opportunities/deactivate-recurring-opportunities-scheduler"},{"title":"Disable opportunities access for non-admin users","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/opportunities/disable-access","href":"/api-reference/opportunities/disable-opportunities-access-for-non-admin-users"},{"title":"Enable opportunities access for non-admin users","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/opportunities/enable-access","href":"/api-reference/opportunities/enable-opportunities-access-for-non-admin-users"},{"title":"Get workspace opportunities settings","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/opportunities/settings","href":"/api-reference/opportunities/get-workspace-opportunities-settings"}]},{"group":"Personas","pages":[{"title":"List personas","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas","href":"/api-reference/personas/list-personas"},{"title":"Create persona","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas","href":"/api-reference/personas/create-persona"},{"title":"Retrieve persona","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}","href":"/api-reference/personas/retrieve-persona"},{"title":"Update persona","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}","href":"/api-reference/personas/update-persona"},{"title":"Delete persona","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}","href":"/api-reference/personas/delete-persona"},{"title":"Archive persona","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}/archive","href":"/api-reference/personas/archive-persona"},{"title":"Duplicate persona to another country and language","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}/duplicate","href":"/api-reference/personas/duplicate-persona-to-another-country-and-language"},{"title":"Launch Google segments collection","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}/launch-google-segments-collection","href":"/api-reference/personas/launch-google-segments-collection"},{"title":"List persona segment details","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}/segments-details","href":"/api-reference/personas/list-persona-segment-details"},{"title":"Unarchive persona","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}/unarchive","href":"/api-reference/personas/unarchive-persona"},{"title":"List persona versions","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/{id}/versions","href":"/api-reference/personas/list-persona-versions"},{"title":"Copy a Smart Audience to the persona library","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/from-smart-audience","href":"/api-reference/personas/copy-a-smart-audience-to-the-persona-library"},{"title":"Generate personas with AI","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/generate","href":"/api-reference/personas/generate-personas-with-ai"},{"title":"Resolve personas by key, creating the missing ones","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/personas/resolve","href":"/api-reference/personas/resolve-personas-by-key-creating-the-missing-ones"},{"title":"Create or update persona Google segment IDs","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/persona/create_persona_google_segments","href":"/api-reference/personas/create-or-update-persona-google-segment-ids"},{"title":"Update persona Google segments status","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/persona/update-persona-google-segments-status","href":"/api-reference/personas/update-persona-google-segments-status"},{"title":"List the personas a user created","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/personas","href":"/api-reference/personas/list-the-personas-a-user-created"}]},{"group":"Actions Groups","pages":[{"title":"List actions groups","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/actions-groups","href":"/api-reference/actions-groups/list-actions-groups"},{"title":"Create an actions group","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/actions-groups","href":"/api-reference/actions-groups/create-an-actions-group"},{"title":"Retrieve an actions group","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/actions-groups/{id}","href":"/api-reference/actions-groups/retrieve-an-actions-group"},{"title":"Delete an actions group","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/actions-groups/{id}","href":"/api-reference/actions-groups/delete-an-actions-group"},{"title":"Trigger an actions group","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/actions-groups/{id}/trigger","href":"/api-reference/actions-groups/trigger-an-actions-group"},{"title":"List actions group launches","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/launches","href":"/api-reference/actions-groups/list-actions-group-launches"},{"title":"Retrieve an actions group launch","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/launches/{id}","href":"/api-reference/actions-groups/retrieve-an-actions-group-launch"},{"title":"Cancel an actions group launch","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/launches/{id}/cancel","href":"/api-reference/actions-groups/cancel-an-actions-group-launch"},{"title":"List the triplets available for actions groups","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/triplets","href":"/api-reference/actions-groups/list-the-triplets-available-for-actions-groups"}]},{"group":"Recommendation Channel","pages":[{"title":"List recommendation channels","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/channels","href":"/api-reference/recommendation-channel/list-recommendation-channels"}]},{"group":"Recommended Action","pages":[{"title":"List recommended actions","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions","href":"/api-reference/recommended-action/list-recommended-actions"},{"title":"Get a single recommended action","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}","href":"/api-reference/recommended-action/get-a-single-recommended-action"},{"title":"Delete an archived recommended action","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}","href":"/api-reference/recommended-action/delete-an-archived-recommended-action"},{"title":"List briefs for a recommended action","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/briefs","href":"/api-reference/recommended-action/list-briefs-for-a-recommended-action"},{"title":"Dismiss recommended action","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/dismiss","href":"/api-reference/recommended-action/dismiss-recommended-action"},{"title":"Generate briefs for a recommended action","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/generate-briefs","href":"/api-reference/recommended-action/generate-briefs-for-a-recommended-action"},{"title":"Reconsider recommended action","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/reconsider","href":"/api-reference/recommended-action/reconsider-recommended-action"},{"title":"Save recommended action to My Plan","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{id}/save-to-plan","href":"/api-reference/recommended-action/save-recommended-action-to-my-plan"},{"title":"Bulk dismiss recommended actions","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/bulk-dismiss","href":"/api-reference/recommended-action/bulk-dismiss-recommended-actions"},{"title":"Bulk save recommended actions to My Plan","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/bulk-save-to-plan","href":"/api-reference/recommended-action/bulk-save-recommended-actions-to-my-plan"},{"title":"Get recommended action counts by workflow status","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/counts","href":"/api-reference/recommended-action/get-recommended-action-counts-by-workflow-status"},{"title":"List opportunity dismissal log","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/dismissal-log","href":"/api-reference/recommended-action/list-opportunity-dismissal-log"},{"title":"List the recommendation runs a user launched","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/recommendation/runs","href":"/api-reference/recommended-action/list-the-recommendation-runs-a-user-launched"},{"title":"List what a user did on recommended actions","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/recommended-actions/activity","href":"/api-reference/recommended-action/list-what-a-user-did-on-recommended-actions"}]},{"group":"Recommended Action Result Task","pages":[{"title":"List tasks for a recommended action result","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks","href":"/api-reference/recommended-action-result-task/list-tasks-for-a-recommended-action-result"},{"title":"Create a task for a recommended action result","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks","href":"/api-reference/recommended-action-result-task/create-a-task-for-a-recommended-action-result"},{"title":"Retrieve a single task","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{id}","href":"/api-reference/recommended-action-result-task/retrieve-a-single-task"},{"title":"Partially update a task (name, description, brief_template_id)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{id}","href":"/api-reference/recommended-action-result-task/partially-update-a-task-name-description-brief_template_id"}]},{"group":"Recommended Action Brief","pages":[{"title":"Retrieve the brief for a task","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief","href":"/api-reference/recommended-action-brief/retrieve-the-brief-for-a-task"},{"title":"Create or fully replace the brief for a task","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json put /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief","href":"/api-reference/recommended-action-brief/create-or-fully-replace-the-brief-for-a-task"},{"title":"Partially update the brief for a task","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief","href":"/api-reference/recommended-action-brief/partially-update-the-brief-for-a-task"},{"title":"Send the brief to Pencil Brief Mode","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/pencil","href":"/api-reference/recommended-action-brief/send-the-brief-to-pencil-brief-mode"},{"title":"Refresh the brief's status from Pencil Brief Mode","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/pencil/refresh","href":"/api-reference/recommended-action-brief/refresh-the-briefs-status-from-pencil-brief-mode"},{"title":"Set the user-facing status of a brief","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/status","href":"/api-reference/recommended-action-brief/set-the-user-facing-status-of-a-brief"},{"title":"List brief status change history (newest first)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/status/log","href":"/api-reference/recommended-action-brief/list-brief-status-change-history-newest-first"},{"title":"List brief versions (newest first)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/versions","href":"/api-reference/recommended-action-brief/list-brief-versions-newest-first"},{"title":"Retrieve a brief version by sequence","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/versions/{sequence}","href":"/api-reference/recommended-action-brief/retrieve-a-brief-version-by-sequence"},{"title":"Retrieve the unified diff into a brief version","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/versions/{sequence}/diff","href":"/api-reference/recommended-action-brief/retrieve-the-unified-diff-into-a-brief-version"}]},{"group":"Reddit Summaries","pages":[{"title":"List reddit summaries","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/reddit/summaries","href":"/api-reference/reddit-summaries/list-reddit-summaries"},{"title":"Retrieve reddit summary","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/reddit/summaries/{id}","href":"/api-reference/reddit-summaries/retrieve-reddit-summary"}]},{"group":"Reddit Listenings","pages":[{"title":"List reddit listenings","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/reddit_listenings","href":"/api-reference/reddit-listenings/list-reddit-listenings"},{"title":"Create reddit listening","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/reddit_listenings","href":"/api-reference/reddit-listenings/create-reddit-listening"},{"title":"Retrieve reddit listening","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/reddit_listenings/{id}","href":"/api-reference/reddit-listenings/retrieve-reddit-listening"},{"title":"List the Reddit listenings a user created","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/reddit_listenings","href":"/api-reference/reddit-listenings/list-the-reddit-listenings-a-user-created"}]},{"group":"Website Evaluation","pages":[{"title":"List website evaluations","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations","href":"/api-reference/website-evaluation/list-website-evaluations"},{"title":"Create website evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations","href":"/api-reference/website-evaluation/create-website-evaluation"},{"title":"Retrieve website evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}","href":"/api-reference/website-evaluation/retrieve-website-evaluation"},{"title":"Destroy website evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}","href":"/api-reference/website-evaluation/destroy-website-evaluation"},{"title":"Archive website evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/archive","href":"/api-reference/website-evaluation/archive-website-evaluation"},{"title":"Restore website evaluation","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/restore","href":"/api-reference/website-evaluation/restore-website-evaluation"},{"title":"Get the HTML of a website evaluation result","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/results/{result_id}/html","href":"/api-reference/website-evaluation/get-the-html-of-a-website-evaluation-result"},{"title":"Get screenshots for website evaluation result","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/screenshots","href":"/api-reference/website-evaluation/get-screenshots-for-website-evaluation-result"},{"title":"Update website evaluation status","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/{id}/update_status","href":"/api-reference/website-evaluation/update-website-evaluation-status"},{"title":"Compute GEO Audit cost","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/compute-cost","href":"/api-reference/website-evaluation/compute-geo-audit-cost"},{"title":"Get GEO Audit quota","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/website_evaluations/quota","href":"/api-reference/website-evaluation/get-geo-audit-quota"},{"title":"List the website evaluations a user created","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/website_evaluations","href":"/api-reference/website-evaluation/list-the-website-evaluations-a-user-created"}]},{"group":"Insights","pages":[{"title":"AI-Generated Strategic Insights","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights","href":"/api-reference/insights/ai-generated-strategic-insights"},{"title":"AI Insights: Brand Ranking Patterns","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/average_position","href":"/api-reference/insights/ai-insights:-brand-ranking-patterns"},{"title":"AI Insights: Brand Awareness Levels","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/mention_rate","href":"/api-reference/insights/ai-insights:-brand-awareness-levels"},{"title":"AI Insights: Complete Brand Awareness Profile","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/mention_rate_and_average_position","href":"/api-reference/insights/ai-insights:-complete-brand-awareness-profile"},{"title":"AI Insights: Brand Awareness Trends","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/mention_rate_timeseries","href":"/api-reference/insights/ai-insights:-brand-awareness-trends"},{"title":"AI Insights: Market Dominance Patterns","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/share_of_voice","href":"/api-reference/insights/ai-insights:-market-dominance-patterns"},{"title":"AI Insights: Platform-Specific Market Share","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/share_of_voice_by_source","href":"/api-reference/insights/ai-insights:-platform-specific-market-share"},{"title":"AI Insights: Market Share Evolution","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_awareness/share_of_voice_timeseries","href":"/api-reference/insights/ai-insights:-market-share-evolution"},{"title":"AI Insights: Brand Attribute Scores","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_guided_sentiments/average_attribute_rating","href":"/api-reference/insights/ai-insights:-brand-attribute-scores"},{"title":"AI Insights: Theme Breakdown Structure","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_perception/attributes_hierarchy_tree","href":"/api-reference/insights/ai-insights:-theme-breakdown-structure"},{"title":"AI Insights: Brand Themes Across AI Models","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_perception/brand_cluster_share_by_source","href":"/api-reference/insights/ai-insights:-brand-themes-across-ai-models"},{"title":"AI Insights: Brand Themes Across AI Models","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_perception/brand_share_by_cluster","href":"/api-reference/insights/ai-insights:-brand-themes-across-ai-models-1"},{"title":"AI Insights: Brand Strengths/Weaknesses","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/insights/brand_perception/cluster_share_by_brand","href":"/api-reference/insights/ai-insights:-brand-strengthsweaknesses"}]},{"group":"Metrics","pages":[{"title":"Brand Ranking Positions","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/average_position","href":"/api-reference/metrics/brand-ranking-positions"},{"title":"Overall Brand Awareness Score","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/awareness_index","href":"/api-reference/metrics/overall-brand-awareness-score"},{"title":"Brand Awareness Score Evolution","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/awareness_index_timeseries","href":"/api-reference/metrics/brand-awareness-score-evolution"},{"title":"Brand Mention Frequency","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/mention_rate","href":"/api-reference/metrics/brand-mention-frequency"},{"title":"Combined Brand Awareness Metrics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/mention_rate_and_average_position","href":"/api-reference/metrics/combined-brand-awareness-metrics"},{"title":"Brand Mention Trends Over Time","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/mention_rate_timeseries","href":"/api-reference/metrics/brand-mention-trends-over-time"},{"title":"Brand Awareness Raw Data","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/raw","href":"/api-reference/metrics/brand-awareness-raw-data"},{"title":"Brand Market Share Metric","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/share_of_voice","href":"/api-reference/metrics/brand-market-share-metric"},{"title":"Brand Market Share by AI Model","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/share_of_voice_by_source","href":"/api-reference/metrics/brand-market-share-by-ai-model"},{"title":"Market Share Trends Over Time","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_awareness/share_of_voice_timeseries","href":"/api-reference/metrics/market-share-trends-over-time"},{"title":"Brand Ratings on Specific Attributes","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_guided_sentiments/average_attribute_rating","href":"/api-reference/metrics/brand-ratings-on-specific-attributes"},{"title":"Hierarchical Perception Tree View","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree","href":"/api-reference/metrics/hierarchical-perception-tree-view"},{"title":"Brand Perception by LLM Source","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/brand_cluster_share_by_source","href":"/api-reference/metrics/brand-perception-by-llm-source"},{"title":"Brand Ownership of Each Theme","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/brand_share_by_cluster","href":"/api-reference/metrics/brand-ownership-of-each-theme"},{"title":"List Pros and Cons Cluster Groups","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/cluster_groups","href":"/api-reference/metrics/list-pros-and-cons-cluster-groups"},{"title":"Overall Cluster Share Distribution","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/cluster_share","href":"/api-reference/metrics/overall-cluster-share-distribution"},{"title":"Cluster Distribution Per Brand","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/cluster_share_by_brand","href":"/api-reference/metrics/cluster-distribution-per-brand"},{"title":"List All Attributes with Cluster Mapping","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/get_cluster_attributes","href":"/api-reference/metrics/list-all-attributes-with-cluster-mapping"},{"title":"Brand Perception Raw Pros And Cons","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/raw_pros_and_cons","href":"/api-reference/metrics/brand-perception-raw-pros-and-cons"},{"title":"Available AI Models List","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/raw_prompt_responses/sources","href":"/api-reference/metrics/available-ai-models-list"},{"title":"All Information Sources","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources","href":"/api-reference/metrics/all-information-sources"},{"title":"Comprehensive Domain Influence Breakdown","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources/detailed_influence_score_by_domain","href":"/api-reference/metrics/comprehensive-domain-influence-breakdown"},{"title":"Top and Bottom Reddit Communities","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources/get_most_and_least_mentioned_subreddits","href":"/api-reference/metrics/top-and-bottom-reddit-communities"},{"title":"Domain Influence Rankings","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources/influence_score_by_domain","href":"/api-reference/metrics/domain-influence-rankings"},{"title":"Domain Influence Trends Over Time","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources/influence_score_evolution_by_domain","href":"/api-reference/metrics/domain-influence-trends-over-time"},{"title":"Individual URL Performance Metrics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources/mention_rate_average_position_by_url","href":"/api-reference/metrics/individual-url-performance-metrics"},{"title":"Citation Rates by Platform Category","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources/mention_rate_by_domain_type","href":"/api-reference/metrics/citation-rates-by-platform-category"},{"title":"Social Media Sources with Context","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/sources/social_sources_with_metadata","href":"/api-reference/metrics/social-media-sources-with-context"},{"title":"Overall Brand Performance Score","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/summary/brand_composite_score_aggregate","href":"/api-reference/metrics/overall-brand-performance-score"},{"title":"Brand Performance by Market/Country","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/summary/brand_composite_score_by_country","href":"/api-reference/metrics/brand-performance-by-marketcountry"},{"title":"Brand Performance by Target Persona","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/summary/brand_composite_score_by_persona","href":"/api-reference/metrics/brand-performance-by-target-persona"},{"title":"Brand Performance by AI Model","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/summary/brand_composite_score_by_source","href":"/api-reference/metrics/brand-performance-by-ai-model"},{"title":"Audience Age Demographics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/age_range_distribution","href":"/api-reference/metrics/audience-age-demographics"},{"title":"Audience Geographic Type Demographics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/area_type_distribution","href":"/api-reference/metrics/audience-geographic-type-demographics"},{"title":"Available Audience Data Dates","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/available_periods","href":"/api-reference/metrics/available-audience-data-dates"},{"title":"Audience Price Sensitivity","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/cost_tolerance_distribution","href":"/api-reference/metrics/audience-price-sensitivity"},{"title":"Audience Gender Demographics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/gender_distribution","href":"/api-reference/metrics/audience-gender-demographics"},{"title":"Google Ads Targeting Categories","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/google_ads_segment_occurrences","href":"/api-reference/metrics/google-ads-targeting-categories"},{"title":"Audience Household Demographics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/household_type_distribution","href":"/api-reference/metrics/audience-household-demographics"},{"title":"Complete Audience Segment Profiles","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/target_audience/segments","href":"/api-reference/metrics/complete-audience-segment-profiles"},{"title":"Detailed Asset Performance Metrics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{evaluation_id}/scores","href":"/api-reference/metrics/detailed-asset-performance-metrics"},{"title":"Retrieve Asset Evaluation Score Batches","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/{evaluation_id}/scores/batches","href":"/api-reference/metrics/retrieve-asset-evaluation-score-batches"},{"title":"All Asset Evaluations Summary","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/asset_evaluations/scores","href":"/api-reference/metrics/all-asset-evaluations-summary"},{"title":"Reddit insights","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/reddit_listenings/{reddit_listening_id}/insights","href":"/api-reference/metrics/reddit-insights"}]}]},{"group":"Search API","pages":[{"group":"Projects","pages":[{"title":"Get Project Creation References","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/references","href":"/api-reference/projects/get-project-creation-references"},{"title":"Estimate Collection Cost","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses/cost-estimate","href":"/api-reference/projects/estimate-collection-cost"},{"title":"List All Analyses","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses","href":"/api-reference/projects/list-all-analyses"},{"title":"Create Analysis","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses","href":"/api-reference/projects/create-analysis"},{"title":"Get Analysis By Id","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses/{project_id}","href":"/api-reference/projects/get-analysis-by-id"}]},{"group":"Insights","pages":[{"title":"Get Aggregated Insights Metrics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics","href":"/api-reference/insights/get-aggregated-insights-metrics"},{"title":"Count Analyses By Frequency","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/analyses-by-frequency","href":"/api-reference/insights/count-analyses-by-frequency"},{"title":"Get Insights Filters","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/filters","href":"/api-reference/insights/get-insights-filters"},{"title":"Get Aggregated Insights Metrics (Organization Level)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/search/insights/metrics","href":"/api-reference/insights/get-aggregated-insights-metrics-organization-level"},{"title":"Count Analyses By Frequency (Organization Level)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/search/insights/analyses-by-frequency","href":"/api-reference/insights/count-analyses-by-frequency-organization-level"},{"title":"Get Insights Filters (Organization Level)","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/search/insights/filters","href":"/api-reference/insights/get-insights-filters-organization-level"}]},{"group":"Creators","pages":[{"title":"Creator List","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creators","href":"/api-reference/creators/creator-list"},{"title":"Creator Stats Summary","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creators/summary","href":"/api-reference/creators/creator-stats-summary"},{"title":"Creator Country Breakdown","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creators/countries","href":"/api-reference/creators/creator-country-breakdown"},{"title":"Creator Filter Options","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creators/filters","href":"/api-reference/creators/creator-filter-options"},{"title":"Creator Card","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creators/{creator_id}","href":"/api-reference/creators/creator-card"},{"title":"Creator Video List","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-videos","href":"/api-reference/creators/creator-video-list"},{"title":"Video Activity Timeline","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-videos/timeline","href":"/api-reference/creators/video-activity-timeline"},{"title":"Creator Video Detail","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-videos/{creator_video_id}","href":"/api-reference/creators/creator-video-detail"},{"title":"Video Domain Metrics","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-videos/{creator_video_id}/domain-metrics","href":"/api-reference/creators/video-domain-metrics"},{"title":"Shortlisted Creators","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/shortlist","href":"/api-reference/creators/shortlisted-creators"},{"title":"Add To Shortlist","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/shortlist","href":"/api-reference/creators/add-to-shortlist"},{"title":"Remove From Shortlist","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/shortlist/{shortlist_id}","href":"/api-reference/creators/remove-from-shortlist"}]},{"group":"Creator Briefs","pages":[{"title":"Creator Brief List","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs","href":"/api-reference/creator-briefs/creator-brief-list"},{"title":"Create Creator Brief","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs","href":"/api-reference/creator-briefs/create-creator-brief"},{"title":"Creator Brief Detail","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs/{brief_id}","href":"/api-reference/creator-briefs/creator-brief-detail"},{"title":"Replace Creator Brief","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json put /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs/{brief_id}","href":"/api-reference/creator-briefs/replace-creator-brief"},{"title":"Delete Creator Brief","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json delete /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs/{brief_id}","href":"/api-reference/creator-briefs/delete-creator-brief"},{"title":"Update Creator Brief","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs/{brief_id}","href":"/api-reference/creator-briefs/update-creator-brief"},{"title":"Creator Brief Version List","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs/{brief_id}/versions","href":"/api-reference/creator-briefs/creator-brief-version-list"},{"title":"Creator Brief Version Detail","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs/{brief_id}/versions/{sequence}","href":"/api-reference/creator-briefs/creator-brief-version-detail"},{"title":"Creator Brief Version Diff","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/creator-briefs/{brief_id}/versions/{sequence}/diff","href":"/api-reference/creator-briefs/creator-brief-version-diff"}]},{"group":"Video Analyses","pages":[{"title":"Estimate Video Analysis Cost","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/video-analyses/cost","href":"/api-reference/video-analyses/estimate-video-analysis-cost"},{"title":"Video Analysis List","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/video-analyses","href":"/api-reference/video-analyses/video-analysis-list"},{"title":"Trigger Video Analyses","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/video-analyses","href":"/api-reference/video-analyses/trigger-video-analyses"},{"title":"Get Video Analysis Usage","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/video-analyses/usage","href":"/api-reference/video-analyses/get-video-analysis-usage"},{"title":"Video Analysis Detail","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/video-analyses/{video_analysis_id}","href":"/api-reference/video-analyses/video-analysis-detail"}]},{"group":"Collects","pages":[{"title":"List Collects For Project","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/collects","href":"/api-reference/collects/list-collects-for-project"},{"title":"Collected Domain Data","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/collects/domains","href":"/api-reference/collects/collected-domain-data"},{"title":"Collected Brand Data","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/collects/brands","href":"/api-reference/collects/collected-brand-data"},{"title":"Collected Search Queries Data","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/collects/search-queries","href":"/api-reference/collects/collected-search-queries-data"},{"title":"Collected Responses","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/collects/responses","href":"/api-reference/collects/collected-responses"}]},{"group":"Overview Metrics","pages":[{"title":"Global Visibility Score","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/visibility-score","href":"/api-reference/overview-metrics/global-visibility-score"},{"title":"Domain Average Ranking","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/average-ranking","href":"/api-reference/overview-metrics/domain-average-ranking"},{"title":"Domain Presence Rate","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/domain-presence-rate","href":"/api-reference/overview-metrics/domain-presence-rate"},{"title":"Brand Presence Rate","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/brands-presence-rate","href":"/api-reference/overview-metrics/brand-presence-rate"},{"title":"Metrics Over Time","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/metrics-over-time","href":"/api-reference/overview-metrics/metrics-over-time"},{"title":"Domain Thematic Overview","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/domain-thematics-overview","href":"/api-reference/overview-metrics/domain-thematic-overview"},{"title":"Brand Thematic Overview","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/brand-thematics-overview","href":"/api-reference/overview-metrics/brand-thematic-overview"},{"title":"Get Ai Visibility Cards","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/ai-visibility-cards","href":"/api-reference/overview-metrics/get-ai-visibility-cards"},{"title":"Get Performance Cards","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/performance-cards","href":"/api-reference/overview-metrics/get-performance-cards"},{"title":"Get Influence Cards","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/influence-cards","href":"/api-reference/overview-metrics/get-influence-cards"}]},{"group":"Metrics","pages":[{"title":"Competitor Sources","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/sources","href":"/api-reference/metrics/competitor-sources"},{"title":"Competitor Brands","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/brands","href":"/api-reference/metrics/competitor-brands"},{"title":"Ranked Urls","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/ranked-urls","href":"/api-reference/metrics/ranked-urls"},{"title":"Query Fan-Out","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/query-fan-out","href":"/api-reference/metrics/query-fan-out"}]},{"group":"Shopping","pages":[{"title":"Get Shopping Overview","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/overview","href":"/api-reference/shopping/get-shopping-overview"},{"title":"List Shopping Products","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/products","href":"/api-reference/shopping/list-shopping-products"},{"title":"List Shopping Brands","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/brands","href":"/api-reference/shopping/list-shopping-brands"},{"title":"List Shopping Merchants","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/merchants","href":"/api-reference/shopping/list-shopping-merchants"},{"title":"Get Shopping Timeseries","deprecated":null,"version":null,"openapi":"https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/timeseries","href":"/api-reference/shopping/get-shopping-timeseries"}]}]}]}]},"basePath":"","title":"Filter values of a period - Share Of Model","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","Page-C8Cg25if.js","CodeSnippet-D1PtG8ed.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","getApiPlaygroundDisplay-Dkx2eNtL.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}