> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create analysis

> Create a new analysis in a workspace. Required permission: `write:analysis`.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses
openapi: 3.0.3
info:
  title: Share Of Model API
  version: v1
  description: >-
    ## Model Context Protocol (MCP)


    In addition to this REST API, Share of Model exposes a **Model Context
    Protocol** server that lets AI assistants (Claude Desktop, Claude Code, MCP
    Inspector, custom agents…) call our endpoints directly as tools. Any
    MCP-compatible client can interact with Share of Model without writing
    custom integration code — connect once with your usual login and start
    asking the assistant to query the data for you.


    ### Connecting from Claude Desktop


    Open **Settings → Connectors**, scroll to the bottom and click **Add custom
    connector**, then paste `https://mcp.shareofmodel.ai/mcp/`. A browser window
    opens for you to log in with your Share of Model account (same login as the
    web app), and the assistant gains access to the tools.


    ### Connecting from Claude Code


    ```bash

    claude mcp add --transport http share-of-model
    https://mcp.shareofmodel.ai/mcp/

    ```


    The first time you call a tool, Claude Code opens your browser to complete
    the login.


    ### Connecting from MCP Inspector


    ```bash

    npx @modelcontextprotocol/inspector

    ```


    In the Inspector UI, pick **Streamable HTTP** as transport, paste
    `https://mcp.shareofmodel.ai/mcp/`, and click **Connect**. The first
    connection prompts you to log in.


    ### Available tools


    Only endpoints tagged `mcp` in this OpenAPI spec are exposed as MCP tools,
    and only read-only (`GET`) routes are exposed. Everything tagged `mcp` below
    is callable from any compliant MCP client.


    ### Example prompts


    Once connected, try asking your assistant things like:


    - _"List the workspaces I have access to."_

    - _"Show me the latest searches in workspace X."_

    - _"Compare the share of model between brand A and brand B over the last 30
    days."_


    For more details on the protocol itself, see the [Model Context Protocol
    specification](https://modelcontextprotocol.io/).
servers:
  - description: Production API
    url: https://api.shareofmodel.ai/
  - description: Development API
    url: https://api.dev.shareofmodel.ai/
security: []
tags:
  - name: Auth
    description: Endpoints needed for API authentication.
  - name: Organizations
    description: Endpoints related to organizations, to list all available organizations.
  - name: Workspaces
    description: Endpoints related to workspaces, to list all available workspaces.
  - name: Analyses
    description: Endpoints related to analyses and analyses management.
  - name: Asset Evaluations
    description: Endpoints related to assets and asset evaluations.
  - name: Brand Catalog
    description: Endpoints related to general brand information.
  - name: Content Briefs
    description: Endpoints related to content briefs generation and optimisation.
  - name: Metrics
    description: >+
      Endpoints related to brand metrics.


      **LEXICON**



      **Brand Awareness**: What opinion the LLMs have concerning specific
      brands, related to certain categories.



      **Brand Perception**: The general sentiment of the LLMs towards a brand,

      based on the pros and cons they mention.

paths:
  /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses:
    post:
      tags:
        - Analyses
      summary: Create analysis
      description: >-
        Create a new analysis in a workspace. Required permission:
        `write:analysis`.
      operationId: create_analysis
      parameters:
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the organization.
          required: true
        - in: path
          name: workspace_id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the workspace.
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnalysisRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateAnalysisRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateAnalysisRequest'
          '*/*':
            schema:
              $ref: '#/components/schemas/CreateAnalysisRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Analysis'
          description: ''
      security:
        - Bearer: []
components:
  schemas:
    CreateAnalysisRequest:
      type: object
      properties:
        countries:
          type: array
          items:
            enum:
              - AE
              - AR
              - AT
              - AU
              - BE
              - BH
              - BR
              - CA
              - CH
              - CL
              - CN
              - CO
              - CZ
              - DE
              - DK
              - EC
              - EG
              - ES
              - FI
              - FR
              - GB
              - GQ
              - GR
              - HK
              - HU
              - IE
              - ID
              - IL
              - IN
              - IQ
              - IT
              - JP
              - KR
              - KW
              - LU
              - MA
              - MX
              - MY
              - NG
              - NL
              - 'NO'
              - NZ
              - PE
              - PH
              - PK
              - PL
              - PT
              - QA
              - RO
              - RU
              - SA
              - SE
              - SG
              - TH
              - TR
              - TW
              - VN
              - US
              - ZA
              - EU
              - NA
              - WW
            type: string
            description: |-
              * `AE` - AE
              * `AR` - AR
              * `AT` - AT
              * `AU` - AU
              * `BE` - BE
              * `BH` - BH
              * `BR` - BR
              * `CA` - CA
              * `CH` - CH
              * `CL` - CL
              * `CN` - CN
              * `CO` - CO
              * `CZ` - CZ
              * `DE` - DE
              * `DK` - DK
              * `EC` - EC
              * `EG` - EG
              * `ES` - ES
              * `FI` - FI
              * `FR` - FR
              * `GB` - GB
              * `GQ` - GQ
              * `GR` - GR
              * `HK` - HK
              * `HU` - HU
              * `IE` - IE
              * `ID` - ID
              * `IL` - IL
              * `IN` - IN
              * `IQ` - IQ
              * `IT` - IT
              * `JP` - JP
              * `KR` - KR
              * `KW` - KW
              * `LU` - LU
              * `MA` - MA
              * `MX` - MX
              * `MY` - MY
              * `NG` - NG
              * `NL` - NL
              * `NO` - NO
              * `NZ` - NZ
              * `PE` - PE
              * `PH` - PH
              * `PK` - PK
              * `PL` - PL
              * `PT` - PT
              * `QA` - QA
              * `RO` - RO
              * `RU` - RU
              * `SA` - SA
              * `SE` - SE
              * `SG` - SG
              * `TH` - TH
              * `TR` - TR
              * `TW` - TW
              * `VN` - VN
              * `US` - US
              * `ZA` - ZA
              * `EU` - EU
              * `NA` - NA
              * `WW` - WW
            x-spec-enum-id: 83d19f936e64915f
          maxItems: 10
          minItems: 0
        llm_providers:
          type: array
          items:
            enum:
              - OpenAI
              - Google AI
              - Google AI Mode
              - Meta AI
              - Anthropic
              - DeepSeek
              - Mistral
              - Perplexity
              - Amazon
            type: string
            description: |-
              * `OpenAI` - OpenAI
              * `Google AI` - Google AI
              * `Google AI Mode` - Google AI Mode
              * `Meta AI` - Meta AI
              * `Anthropic` - Anthropic
              * `DeepSeek` - DeepSeek
              * `Mistral` - Mistral
              * `Perplexity` - Perplexity
              * `Amazon` - Amazon
            x-spec-enum-id: 7c03d3103ca43a77
          maxItems: 15
          minItems: 1
        brand:
          type: string
        category:
          type: string
        name:
          type: string
        competitors:
          type: array
          items:
            type: string
          maxItems: 3
          minItems: 3
        personas:
          type: array
          items:
            type: string
          default:
            - General Population
          maxItems: 8
          minItems: 0
        attributes:
          type: array
          items:
            type: string
          maxItems: 8
          minItems: 0
        collect_end_date:
          type: string
          format: date
        language:
          enum:
            - ar
            - da
            - de
            - en
            - es
            - eu
            - fi
            - fil
            - fr
            - he
            - hi
            - hu
            - id
            - it
            - ja
            - ko
            - nl
            - pl
            - pt
            - ro
            - sv
            - th
            - tr
            - ur
            - vi
            - zh
            - zh-TW
          type: string
          description: |-
            * `ar` - ar
            * `da` - da
            * `de` - de
            * `en` - en
            * `es` - es
            * `eu` - eu
            * `fi` - fi
            * `fil` - fil
            * `fr` - fr
            * `he` - he
            * `hi` - hi
            * `hu` - hu
            * `id` - id
            * `it` - it
            * `ja` - ja
            * `ko` - ko
            * `nl` - nl
            * `pl` - pl
            * `pt` - pt
            * `ro` - ro
            * `sv` - sv
            * `th` - th
            * `tr` - tr
            * `ur` - ur
            * `vi` - vi
            * `zh` - zh
            * `zh-TW` - zh TW
          x-spec-enum-id: eb433b6ba098186f
          default: en
        is_boost:
          type: boolean
          default: false
      required:
        - brand
        - category
        - competitors
    Analysis:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Created
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Modified
        created_by:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 255
        countries:
          type: array
          items:
            type: string
            maxLength: 255
        brand:
          type: string
          maxLength: 255
        category:
          type: string
          maxLength: 255
        competitors:
          type: array
          items:
            type: string
            maxLength: 255
        personas:
          type: array
          items:
            type: string
            maxLength: 255
        attributes:
          type: array
          items:
            type: string
            maxLength: 255
        is_archived:
          type: boolean
        archived_at:
          type: string
          format: date-time
          nullable: true
        active_clustering:
          type: boolean
        collect_end_date:
          type: string
          format: date
          nullable: true
        llm_providers:
          type: array
          items:
            type: string
            maxLength: 255
        llm_provider_versions: {}
        language:
          enum:
            - ar
            - da
            - de
            - en
            - es
            - eu
            - fi
            - fil
            - fr
            - he
            - hi
            - hu
            - id
            - it
            - ja
            - ko
            - nl
            - pl
            - pt
            - ro
            - sv
            - th
            - tr
            - ur
            - vi
            - zh
            - zh-TW
            - ''
          type: string
          description: |-
            * `ar` - ar
            * `da` - da
            * `de` - de
            * `en` - en
            * `es` - es
            * `eu` - eu
            * `fi` - fi
            * `fil` - fil
            * `fr` - fr
            * `he` - he
            * `hi` - hi
            * `hu` - hu
            * `id` - id
            * `it` - it
            * `ja` - ja
            * `ko` - ko
            * `nl` - nl
            * `pl` - pl
            * `pt` - pt
            * `ro` - ro
            * `sv` - sv
            * `th` - th
            * `tr` - tr
            * `ur` - ur
            * `vi` - vi
            * `zh` - zh
            * `zh-TW` - zh TW
          x-spec-enum-id: eb433b6ba098186f
        is_boost:
          type: boolean
        generation_cost:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
      required:
        - brand
        - category
        - created_at
        - created_by
        - id
        - name
        - updated_at
        - workspace_id
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````