Marketplace

Update Marketplace Listing

Changed on

Update an existing marketplace listing.

patch/v1/marketplace/listings/{listing_id}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/marketplace/listings/{listing_id}
  • Auth: HTTP bearer

Path parameters

listing_idstring required

Request body

object required

Response

Successful Response

listing_idstring

Unique identifier for the listing

internal_idstring required

Organization that owns this listing (provider)

namespace_idstring required

Namespace containing the retriever

retriever_idstring required

Retriever being offered in the marketplace

titlestring required

Public display title

descriptionstring required

Public description of what this listing provides

public_namestring required

Public URL-safe slug for the listing (e.g., 'video-search'). Used in public URL: mxp.co/m/{public_name}. Must be globally unique.

categorystring nullable

Catalog category. One of: Brand Safety, Advertising, Media, Faces & People, Art & Archives, Personalization, Content Safety, Spatial, Ecommerce. Writes also accept the slug form (e.g., 'faces-and-people') and store the label.

groupsstring[]

Curated groups this listing belongs to, as lowercase slugs (e.g., 'ip-screening'). Filter the catalog by one with ?group=.

tagsstring[]

Tags for discovery

logo_urlstring nullable

URL to listing logo/icon

app_urlstring nullable

Optional URL to a live canvas app powered by this retriever (e.g., 'https://nga.mxp.co'). When set, the listing appears in the public showcase at mixpeek.com/showcase.

icon_base64string nullable

Base64 encoded icon/favicon (data URI format). Max size: ~200KB encoded. Use for small icons.

display_configobject nullable

JSON-based UI configuration for the public interface. Follows a component-based schema (inspired by json-render): { 'components': [...], 'theme': {...}, 'layout': {...} }. If not provided, a default UI is generated from retriever input_schema.

password_secret_namestring nullable

Optional organization secret name containing password for access protection. If set, users must provide password to subscribe (even for free tier).

status'draft' | 'published' | 'archived' | 'suspended'

Status of a marketplace listing.

visibility'listed' | 'unlisted'

Visibility level for a marketplace listing.

  • LISTED: Appears in marketplace catalog, homepage showcase, and sitemap.
  • UNLISTED: Accessible via direct link but hidden from catalog/showcase.
is_activeboolean

DEPRECATED: Use 'status' field instead. Computed from status (True if PUBLISHED, False otherwise).

featured_rankinteger nullable

Editorial ordering for the catalog. Lower sorts first (1 = top slot). Listings without a rank fall back to subscriber-count ordering and always sort after ranked ones. This is the single source of truth for catalog order — the homepage showcase, the homepage landing-page showcase strip, and the Studio marketplace all read it, so ordering never has to be hardcoded per-surface.

created_atstring date-time

When the listing was created

updated_atstring date-time

When the listing was last updated

published_atstring date-time nullable

When the listing was first published

total_subscribersinteger

Total number of active subscribers

total_queriesinteger

Total queries executed across all subscribers

Example response

{
  "title": "Brand Safety Classification API",
  "public_name": "brand-safety-api",
  "category": "Brand Safety",
  "groups": [
    "ip-screening"
  ],
  "app_url": "https://nga.mxp.co",
  "icon_base64": "data:image/png;base64,iVBORw0KGgoAAAANS...",
  "display_config": {
    "components": [
      {
        "props": {
          "field": "video_url",
          "label": "Enter video URL"
        },
        "type": "SearchInput"
      },
      {
        "props": {
          "fields": [
            "title",
            "description",
            "score"
          ],
          "layout": "grid"
        },
        "type": "ResultCard"
      }
    ],
    "theme": {
      "fontFamily": "Inter, sans-serif",
      "primaryColor": "#007AFF"
    }
  },
  "password_secret_name": "marketplace_password",
  "featured_rank": 1
}

Changes

  • 24540a9a39c0Revision changes
    • info

      added the optional property to the response with the status

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status