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

# Retrieve an actions group launch

> Returns one launch of the workspace, with its status and its runs by status.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommendation/launches/{id}
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}/recommendation/launches/{id}:
    get:
      tags:
        - Actions Groups
      summary: Retrieve an actions group launch
      description: >-
        Returns one launch of the workspace, with its status and its runs by
        status.
      operationId: retrieve_actions_group_launch
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          description: A UUID string identifying the launch.
          required: true
        - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionsGroupLaunchResponse'
          description: Launch
        '400':
          description: Invalid organization_id or workspace_id
        '401':
          description: Authentication credentials were not provided or are invalid
        '403':
          description: You do not have permission to perform this action
        '404':
          description: Launch not found
      security:
        - Bearer: []
components:
  schemas:
    ActionsGroupLaunchResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Launch UUID
        organization_id:
          type: string
          format: uuid
          description: Organization UUID
        workspace_id:
          type: string
          format: uuid
          description: Workspace UUID
        actions_group_id:
          type: string
          format: uuid
          nullable: true
          description: Actions group launched, or null if the group was deleted since
        trigger:
          enum:
            - group
            - workspace
            - monthly
          type: string
          x-spec-enum-id: 04da9400995c7747
          description: |-
            What started the launch

            * `group` - Group trigger
            * `workspace` - Workspace trigger
            * `monthly` - Monthly run
        status:
          enum:
            - waiting
            - running
            - done
            - done_with_errors
            - no_data
            - failed
          type: string
          x-spec-enum-id: 9fcf34feb27b517a
          description: |-
            Status of the launch, worked out from its runs

            * `waiting` - Waiting
            * `running` - Running
            * `done` - Done
            * `done_with_errors` - Done with errors
            * `no_data` - No data
            * `failed` - Failed
        message:
          type: string
          nullable: true
          description: Why the launch has no data or failed, or null otherwise
        runs:
          allOf:
            - $ref: '#/components/schemas/ActionsGroupLaunchRuns'
          description: Runs of the launch, by status
        created_by:
          type: string
          format: uuid
          nullable: true
          description: UUID of the user who launched, null for monthly
        created_at:
          type: string
          format: date-time
          description: Launch time
        updated_at:
          type: string
          format: date-time
          description: Last status change
      required:
        - actions_group_id
        - created_at
        - created_by
        - id
        - message
        - organization_id
        - runs
        - status
        - trigger
        - updated_at
        - workspace_id
    ActionsGroupLaunchRuns:
      type: object
      properties:
        pending:
          type: integer
          description: Runs not started yet
        in_progress:
          type: integer
          description: Runs in progress
        completed:
          type: integer
          description: Runs completed
        failed:
          type: integer
          description: Runs failed
        total:
          type: integer
          description: All runs of the launch
      required:
        - completed
        - failed
        - in_progress
        - pending
        - total
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````

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