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

# Set the user-facing status of a brief



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger.json patch /v1/organizations/{organization_id}/workspaces/{workspace_id}/recommended-actions/{result_id}/tasks/{task_id}/brief/status
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}/recommended-actions/{result_id}/tasks/{task_id}/brief/status:
    patch:
      tags:
        - Recommended Action Brief
      summary: Set the user-facing status of a brief
      operationId: set_recommended_action_brief_status
      parameters:
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          description: Organization identifier
          required: true
        - in: path
          name: result_id
          schema:
            type: string
            format: uuid
          description: Recommended action result identifier
          required: true
        - in: path
          name: task_id
          schema:
            type: string
            format: uuid
          description: Task identifier
          required: true
        - in: path
          name: workspace_id
          schema:
            type: string
            format: uuid
          description: Workspace identifier
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PatchedSetRecommendedActionBriefStatusRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/PatchedSetRecommendedActionBriefStatusRequest
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/PatchedSetRecommendedActionBriefStatusRequest
          '*/*':
            schema:
              $ref: >-
                #/components/schemas/PatchedSetRecommendedActionBriefStatusRequest
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendedActionBrief'
          description: Brief status updated
        '400':
          description: Missing or invalid status
        '401':
          description: Authentication credentials were not provided or are invalid
        '404':
          description: Task or brief not found
      security:
        - Bearer: []
components:
  schemas:
    PatchedSetRecommendedActionBriefStatusRequest:
      type: object
      properties:
        status:
          enum:
            - not_started
            - in_progress
            - implemented
          type: string
          x-spec-enum-id: adebf71289e7c992
          description: >-
            New status for the brief. One of: not_started, in_progress,
            implemented


            * `not_started` - not_started

            * `in_progress` - in_progress

            * `implemented` - implemented
    RecommendedActionBrief:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Brief UUID
        task_id:
          type: string
          format: uuid
          description: Task UUID this brief belongs to
        title:
          type: string
          description: Brief title
        body:
          type: string
          description: Brief body content
        is_user_edited:
          type: boolean
          description: True once a user has edited title or body
        status:
          enum:
            - not_started
            - in_progress
            - implemented
          type: string
          x-spec-enum-id: adebf71289e7c992
          description: |-
            User-facing status. One of: not_started, in_progress, implemented

            * `not_started` - not_started
            * `in_progress` - in_progress
            * `implemented` - implemented
        created_at:
          type: string
          format: date-time
          nullable: true
          description: Creation timestamp
        updated_at:
          type: string
          format: date-time
          nullable: true
          description: Last update timestamp
      required:
        - body
        - id
        - is_user_edited
        - status
        - task_id
        - title
  securitySchemes:
    Bearer:
      type: apiKey
      in: header
      name: Authorization

````