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

# Add To Shortlist

> Add a creator or a video to the workspace's shortlist -- exactly one of creator_id / creator_video_id must be given. Adding an already-shortlisted item is a no-op that returns the existing entry, not an error. Restricted to editors and above.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger-sos.json post /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/shortlist
openapi: 3.0.3
info:
  title: Share Of Model API
  version: v1
  description: >-
    ## Search



    The Share of Search API provides visibility, presence, and ranking metrics
    for tracked

    search and AI engine sources. Use it to analyse how a project performs
    across keywords,

    thematics, competitors, and ranked URLs over time.


    For the previous version of the API, see the [v1
    documentation](https://api.shareofsearch.jplus.io/docs/v1).
servers:
  - description: Search - Production API
    url: https://api.shareofsearch.jplus.io/
security: []
tags:
  - name: Projects
    description: >-
      Manage analyses (projects) within a workspace. Create new analyses and
      list existing ones.
  - name: Collects
    description: >-
      Access data collection runs and their raw results. List collect runs for
      an analysis, or retrieve the raw data captured during each run: domain
      rankings, brand mentions, keyword insights, and LLM/SERP responses.
  - name: Overview Metrics
    description: >-
      High-level, aggregated metrics that summarise the overall performance of
      an analysis. Use these endpoints to get a quick picture of visibility,
      presence, andranking across all keywords and sources.
  - name: Metrics
    description: >-
      Detailed, per-entity metrics for deep-diving into specific aspects of an
      analysis. Break down performance by domain, brand, keyword, URL, or
      competitor.
  - name: Insights
    description: >-
      Cross-project KPIs aggregated at the workspace level. These endpoints
      consolidate metrics from all active projects within a workspace to provide
      a unified view of visibility, mentions, citations, sentiment, and ranking.
  - name: Shopping
    description: >-
      Shopping-specific metrics for analyses that track product listings in
      shopping engines. Measure product visibility, pricing, merchant coverage,
      and share of shelf across all tracked keywords and sources.
  - name: Creators
    description: >-
      YouTube creators cited as sources in AI-engine search results, enriched
      with channel metrics and an Influence Score. Browse creators across every
      project in a workspace, narrowed by country, engine, brand, category,
      analysis, and persona filters.
paths:
  /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/shortlist:
    post:
      tags:
        - Creators
      summary: Add To Shortlist
      description: >-
        Add a creator or a video to the workspace's shortlist -- exactly one of
        creator_id / creator_video_id must be given. Adding an
        already-shortlisted item is a no-op that returns the existing entry, not
        an error. Restricted to editors and above.
      operationId: add_to_shortlist
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddToShortlistRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortlistEntryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    AddToShortlistRequest:
      properties:
        creator_id:
          type: string
          nullable: true
          title: Creator Id
          description: Exactly one of creator_id / creator_video_id must be set.
        creator_video_id:
          type: string
          nullable: true
          title: Creator Video Id
          description: Exactly one of creator_id / creator_video_id must be set.
      type: object
      title: AddToShortlistRequest
    ShortlistEntryResponse:
      properties:
        id:
          type: string
          title: Id
        workspace_id:
          type: string
          title: Workspace Id
        creator_id:
          type: string
          nullable: true
          title: Creator Id
        creator_video_id:
          type: string
          nullable: true
          title: Creator Video Id
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - workspace_id
        - created_by
        - created_at
      title: ShortlistEntryResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````