> ## 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.

# Export an object of the workspace

> Creates an export (a report of type `export`) in `pending` status and starts the bender flow that builds the export files, as CSVs or XLSXs, and emails the requester a download link. `export_type` says what is exported and `target_id` which object; `params` holds what that type needs beside the target, passed to the flow as-is. For `search_project`, `target_id` is the Search project and `params` the Search page state when the user clicked Export All. Requires read access to the workspace.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/exports
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


    Every read-only (`GET`) endpoint of this specification and of the Search API
    specification is exposed as an MCP tool, except account administration (API
    keys, platform integrations and accounts, user roles, favourites, SSO and
    SCIM).


    Write endpoints are exposed only when they are marked for agents: creating
    and pricing brand analyses, Search analyses and GEO audits, creating
    personas, and managing asset evaluations. Write tools act with the role of
    the signed-in user, so creating requires the Organization Editor or Owner
    role, or Workspace Editor in the target workspace. Before creating an
    analysis or a GEO audit, the assistant shows the full setup and its cost and
    waits for an explicit confirmation.


    ### 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."_

    - _"Set up a brand analysis for brand A in France."_


    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}/exports:
    post:
      tags:
        - Analyses
      summary: Export an object of the workspace
      description: >-
        Creates an export (a report of type `export`) in `pending` status and
        starts the bender flow that builds the export files, as CSVs or XLSXs,
        and emails the requester a download link. `export_type` says what is
        exported and `target_id` which object; `params` holds what that type
        needs beside the target, passed to the flow as-is. For `search_project`,
        `target_id` is the Search project and `params` the Search page state
        when the user clicked Export All. Requires read access to the workspace.
      operationId: create_export
      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/CreateExportRequest'
            examples:
              ExportASearchProjectAsCSVs:
                value:
                  export_type: search_project
                  target_id: '10000'
                  format: csv
                  params:
                    version: 1
                    date_stamp: '2026-11-10'
                    current_collect_id: c-42
                    current_collect_date: '2026-11-09'
                    previous_collect_id: c-41
                    filters:
                      sources:
                        - chatgpt
                        - gemini
                      thematics:
                        - t-1
                      topics:
                        - tp-1
                        - tp-2
                      personas: []
                      website_category:
                        - brand
                        - media
                      collect_ids_applied: []
                      previous_collect_ids_applied: []
                      date_range_start: null
                      date_range_end: null
                      date_breakdown: weekly
                      keyword_type: []
                      funnel_stage: []
                      strength: []
                      weakness: []
                      is_neutral: false
                summary: Export a Search project as CSVs
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateExportRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateExportRequest'
          '*/*':
            schema:
              $ref: '#/components/schemas/CreateExportRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaselineReport'
          description: Export created in `pending` status, flow started.
        '400':
          description: Invalid body, or no email known for the user.
        '401':
          description: Not authenticated.
        '403':
          description: The user's role has no read access.
        '404':
          description: >-
            The user is not in this organization or workspace, or the target is
            not in it.
        '502':
          description: >-
            The flow could not be started; the export is kept in `failed`
            status.
        '503':
          description: The target could not be checked.
      security:
        - Bearer: []
components:
  schemas:
    CreateExportRequest:
      type: object
      properties:
        export_type:
          enum:
            - search_project
          type: string
          x-spec-enum-id: 7812fd88922b3bd1
          description: |-
            What is exported.

            * `search_project` - search project
        target_id:
          type: string
          description: >-
            Id of the exported object, in the workspace of the URL; for
            `search_project`, the Search project.
          maxLength: 255
        format:
          enum:
            - csv
            - xlsx
          type: string
          x-spec-enum-id: b48a7dc2cc239c88
          description: |-
            Format of every file in the export.

            * `csv` - csv
            * `xlsx` - xlsx
        params:
          allOf:
            - $ref: '#/components/schemas/ExportParams'
          description: >-
            What the export needs beside the target; its shape depends on
            `export_type`.
      required:
        - export_type
        - format
        - params
        - target_id
    BaselineReport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        report_type:
          enum:
            - baseline_report
            - export
          type: string
          description: |-
            * `baseline_report` - baseline report
            * `export` - export
          x-spec-enum-id: 1397501dd15dfc16
        url:
          type: string
          nullable: true
          maxLength: 255
        search_project_id:
          type: string
          nullable: true
          maxLength: 255
        workspace_id:
          type: string
          format: uuid
          nullable: true
        status:
          enum:
            - pending
            - in_progress
            - completed
            - failed
          type: string
          description: |-
            * `pending` - pending
            * `in_progress` - in progress
            * `completed` - completed
            * `failed` - failed
          x-spec-enum-id: 64946b94206e095b
        created_by:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Created
        name:
          type: string
          nullable: true
          maxLength: 255
        export_type:
          enum:
            - search_project
            - ''
            - null
          type: string
          description: '* `search_project` - search project'
          x-spec-enum-id: 7812fd88922b3bd1
          nullable: true
        target_id:
          type: string
          nullable: true
          maxLength: 255
        analysis:
          type: string
          format: uuid
          nullable: true
      required:
        - created_at
        - created_by
        - id
        - status
    ExportParams:
      oneOf:
        - $ref: '#/components/schemas/SearchProjectExportParams'
    SearchProjectExportParams:
      type: object
      description: >-
        `params` of a `search_project` export: what bender needs, beside the
        project id, to build the same zip as

        the browser. Stored as the params JSON.
      properties:
        version:
          enum:
            - 1
          type: integer
          x-spec-enum-id: 5cbac499fd8bfedb
          description: |-
            Shape version of these params, read by bender.

            * `1` - 1
        date_stamp:
          type: string
          format: date
          description: The requester's local date, used in the file names.
        current_collect_id:
          type: string
          nullable: true
          description: Collect shown in the project.
          maxLength: 255
        current_collect_date:
          type: string
          format: date
          nullable: true
          description: Date of `current_collect_id`.
        previous_collect_id:
          type: string
          nullable: true
          description: Collect the project compares to.
          maxLength: 255
        filters:
          $ref: '#/components/schemas/SearchProjectExportFilters'
      required:
        - current_collect_date
        - current_collect_id
        - date_stamp
        - filters
        - previous_collect_id
        - version
    SearchProjectExportFilters:
      type: object
      description: >-
        The Search filter bar state when the user clicked Export All, sent as-is
        (in snake_case).


        bender turns it into each section's query params, so the export
        reproduces what the user had on screen.
      properties:
        sources:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected LLM sources.
          maxItems: 1000
        thematics:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected thematic ids.
          maxItems: 1000
        topics:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected topic ids.
          maxItems: 1000
        personas:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected persona ids.
          maxItems: 1000
        website_category:
          type: array
          items:
            type: string
            maxLength: 255
          description: >-
            Selected website categories; every category when the filter is not
            narrowed.
          maxItems: 1000
        collect_ids_applied:
          type: array
          items:
            type: string
            maxLength: 255
          description: >-
            Collect ids picked in the date picker; empty to use
            `current_collect_id`.
          maxItems: 1000
        previous_collect_ids_applied:
          type: array
          items:
            type: string
            maxLength: 255
          description: Comparison collect ids picked in the date picker.
          maxItems: 1000
        date_range_start:
          type: string
          format: date
          nullable: true
          description: Start of the date picker window.
        date_range_end:
          type: string
          format: date
          nullable: true
          description: End of the date picker window.
        date_breakdown:
          enum:
            - daily
            - weekly
            - monthly
          type: string
          description: |-
            * `daily` - daily
            * `weekly` - weekly
            * `monthly` - monthly
          x-spec-enum-id: ca494d1fcff4104f
        keyword_type:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected prompt types.
          maxItems: 1000
        funnel_stage:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected funnel stages.
          maxItems: 1000
        strength:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected strengths.
          maxItems: 1000
        weakness:
          type: array
          items:
            type: string
            maxLength: 255
          description: Selected weaknesses.
          maxItems: 1000
        is_neutral:
          type: boolean
      required:
        - collect_ids_applied
        - date_breakdown
        - date_range_end
        - date_range_start
        - funnel_stage
        - is_neutral
        - keyword_type
        - personas
        - previous_collect_ids_applied
        - sources
        - strength
        - thematics
        - topics
        - weakness
        - website_category
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.