SearchStack

Official88 toolsLive

by searchstack

Managed search API: full-text, vector, geo and image search over one JSON API, driven via MCP.

Captured live from the server via tools/list.

search_result_delete

Permanently delete a Search Result.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
id	string	required	Id of the Search Result.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "id": {
      "description": "Id of the Search Result.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName",
    "id"
  ]
}

list_get

Retrieve the details of a List.

Parameters2

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName"
  ]
}

contributors_create

Add a Contributor. Contributors can add fields and search results to a List but cannot make breaking changes.

Parameters1

request

object

required

Add-contributor request body.

Raw schema

{
  "type": "object",
  "properties": {
    "request": {
      "description": "Add-contributor request body.",
      "type": "object",
      "properties": {
        "account_name": {
          "type": "string"
        },
        "list_name": {
          "type": "string"
        },
        "contributor_name": {
          "type": "string"
        }
      },
      "required": [
        "account_name",
        "list_name",
        "contributor_name"
      ]
    }
  },
  "required": [
    "request"
  ]
}

resource_remove

Remove a Resource. Breaking change: bumps the List version.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
resourceName	string	required	Existing Resource name to remove.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "resourceName": {
      "description": "Existing Resource name to remove.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName",
    "resourceName"
  ]
}

search_group_by_image_post

Image-similarity search of a Group using an absolute image URL. POST variant accepting a SearchByImageRequest body.

Parameters4

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	string	required	Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.
request	object	required	Image search body. 'image_path' is required.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.",
      "type": "string"
    },
    "request": {
      "description": "Image search body. 'image_path' is required.",
      "type": "object",
      "properties": {
        "image_path": {
          "description": "Absolute URL of the image to search by",
          "type": "string"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "minimum_text_score": {
          "description": "Minimum text similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_image_score": {
          "description": "Minimum image similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_document_score": {
          "description": "Minimum document similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_video_score": {
          "description": "Minimum video similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_audio_score": {
          "description": "Minimum audio similarity score between 0 and 1, with 1 being an exact match."
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        },
        "ranking": {
          "description": "Ranking strategy to use: 'none' or 'score'. When omitted the server default flag controls behavior.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "image_path"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version",
    "request"
  ]
}

judge_run

Start an asynchronous batch Judge run over a candidate set. Returns a run_id to poll with JudgeRunStatus; results are produced off the request path.

Parameters3

accountName	string	required	Name of the Account.
judgeName	string	required	Name of the Judge.
request	object	required	Run request body: the context (criteria + reference image URIs) and the candidates to judge (or a search to resolve them from). Set batch=true to route through the provider's batch API where one exists (Anthropic: half price, results can take up to an hour — for scheduled/offline runs).

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "judgeName": {
      "description": "Name of the Judge.",
      "type": "string"
    },
    "request": {
      "description": "Run request body: the context (criteria + reference image URIs) and the candidates to judge (or a search to resolve them from). Set batch=true to route through the provider's batch API where one exists (Anthropic: half price, results can take up to an hour — for scheduled/offline runs).",
      "type": "object",
      "properties": {
        "context": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "image_uris": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "text"
          ]
        },
        "candidates": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "image_uris": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "id",
              "text"
            ]
          }
        },
        "search": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "list_name": {
              "type": [
                "string",
                "null"
              ]
            },
            "version": {
              "type": [
                "integer",
                "null"
              ]
            },
            "group_name": {
              "type": [
                "string",
                "null"
              ]
            },
            "group_version": {
              "type": [
                "integer",
                "null"
              ]
            },
            "query": {
              "type": [
                "string",
                "null"
              ]
            },
            "size": {
              "type": [
                "integer",
                "null"
              ]
            },
            "filter": {
              "type": [
                "string",
                "null"
              ]
            },
            "text_fields": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "image_fields": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "batch": {
          "type": "boolean"
        }
      },
      "required": [
        "context"
      ]
    }
  },
  "required": [
    "accountName",
    "judgeName",
    "request"
  ]
}

search_by_image_post

Image-similarity search of a List using an absolute image URL. POST variant accepting a SearchByImageRequest body.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
request	object	required	Image search body. 'image_path' is required.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "request": {
      "description": "Image search body. 'image_path' is required.",
      "type": "object",
      "properties": {
        "image_path": {
          "description": "Absolute URL of the image to search by",
          "type": "string"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "minimum_text_score": {
          "description": "Minimum text similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_image_score": {
          "description": "Minimum image similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_document_score": {
          "description": "Minimum document similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_video_score": {
          "description": "Minimum video similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_audio_score": {
          "description": "Minimum audio similarity score between 0 and 1, with 1 being an exact match."
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        },
        "ranking": {
          "description": "Ranking strategy to use: 'none' or 'score'. When omitted the server default flag controls behavior.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "image_path"
      ]
    }
  },
  "required": [
    "accountName",
    "listName",
    "version",
    "request"
  ]
}

searchable_create

Create a Searchable field.

Parameters1

request

object

required

Create-searchable-field request body.

Raw schema

{
  "type": "object",
  "properties": {
    "request": {
      "description": "Create-searchable-field request body.",
      "type": "object",
      "properties": {
        "account_name": {
          "type": "string"
        },
        "list_name": {
          "type": "string"
        },
        "searchable_field_name": {
          "type": "string"
        },
        "vectorize": {
          "type": "boolean"
        }
      },
      "required": [
        "account_name",
        "list_name",
        "searchable_field_name"
      ]
    }
  },
  "required": [
    "request"
  ]
}

judge_create

Create a bring-your-own LLM judge: a post-search filter that runs your LLM over each candidate and returns a schema-validated verdict. The API key is verified against the provider on create.

Parameters2

accountName	string	required	Name of the Account.
request	object	required	Create-judge request body (provider, model, api_key, instructions, output_schema, optional pass_field/endpoint).

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "request": {
      "description": "Create-judge request body (provider, model, api_key, instructions, output_schema, optional pass_field/endpoint).",
      "type": "object",
      "properties": {
        "provider": {
          "type": "string"
        },
        "model": {
          "type": "string"
        },
        "api_key": {
          "type": "string"
        },
        "instructions": {
          "type": "string"
        },
        "output_schema": {
          "type": "string"
        },
        "pass_field": {
          "type": [
            "string",
            "null"
          ]
        },
        "endpoint": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "provider",
        "model",
        "api_key",
        "instructions",
        "output_schema"
      ]
    }
  },
  "required": [
    "accountName",
    "request"
  ]
}

coordinates_delete

Remove the Coordinates field from a List. Breaking change: bumps the List version.

Parameters2

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName"
  ]
}

get_examples

Get a curated library of worked request/response examples for the Search Stack Public API.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {}
}

group_clone

Clone a Group into a new Group, copying its configuration and member Lists. By default members are re-pinned to their latest version.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the source Group.
request	object	required	Clone-group request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the source Group.",
      "type": "string"
    },
    "request": {
      "description": "Clone-group request body.",
      "type": "object",
      "properties": {
        "new_group_name": {
          "type": "string"
        },
        "pin_latest": {
          "description": "When true (default) each member List is re-pinned to its latest version; when false the source's pinned versions are copied verbatim.",
          "type": "boolean"
        }
      },
      "required": [
        "new_group_name"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

suggest

Typeahead suggestions within a List version. Returns an array of dictionaries (each dictionary is a suggested Search Result's fields).

Parameters8

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
query	string	required	Partial text to suggest from.
size	integer \| null	optional	Page size.
filter	string \| null	optional	OData-style filter expression.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
cache	boolean \| null	optional	Disable cache (true to disable). Defaults to enabled.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "query": {
      "description": "Partial text to suggest from.",
      "type": "string"
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "cache": {
      "description": "Disable cache (true to disable). Defaults to enabled.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "listName",
    "version",
    "query"
  ]
}

judge_try

Synchronously evaluate a Judge against a single sample candidate — the prompt/schema tuner. Does not persist a run.

Parameters3

accountName	string	required	Name of the Account.
judgeName	string	required	Name of the Judge.
request	object	required	Try request body: the context and a single candidate.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "judgeName": {
      "description": "Name of the Judge.",
      "type": "string"
    },
    "request": {
      "description": "Try request body: the context and a single candidate.",
      "type": "object",
      "properties": {
        "context": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "image_uris": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "text"
          ]
        },
        "candidate": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "text": {
              "type": "string"
            },
            "image_uris": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "id",
            "text"
          ]
        }
      },
      "required": [
        "context",
        "candidate"
      ]
    }
  },
  "required": [
    "accountName",
    "judgeName",
    "request"
  ]
}

group_get_versions

List every searchable membership version of a Group. Pass one as group_version to search a frozen set of records.

Parameters2

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName"
  ]
}

search_result_soft_delete_by_filter

Queue a background job to soft delete (set active to false on) every Search Result in a List that matches the filter. A filter is required (an empty filter would match the whole List). Returns 202 Accepted once queued.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
request	object	required	Soft-delete-by-filter request body. 'filter' is an OData-style filter expression and is required.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "request": {
      "description": "Soft-delete-by-filter request body. 'filter' is an OData-style filter expression and is required.",
      "type": "object",
      "properties": {
        "filter": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "request"
  ]
}

search_group_by_image_base64_post

Image-similarity search of a Group using a base64-encoded image. POST variant accepting a SearchByImageBase64Request body.

Parameters4

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	string	required	Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.
request	object	required	Base64 image search body. 'image_base64' is required.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.",
      "type": "string"
    },
    "request": {
      "description": "Base64 image search body. 'image_base64' is required.",
      "type": "object",
      "properties": {
        "image_base64": {
          "description": "Base64 encoded image. Accepts plain base64 or a data URI (e.g. 'data:image/jpeg;base64,...').",
          "type": "string"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "minimum_text_score": {
          "description": "Minimum text similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_image_score": {
          "description": "Minimum image similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_document_score": {
          "description": "Minimum document similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_video_score": {
          "description": "Minimum video similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_audio_score": {
          "description": "Minimum audio similarity score between 0 and 1, with 1 being an exact match."
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        },
        "ranking": {
          "description": "Ranking strategy to use: 'none' or 'score'. When omitted the server default flag controls behavior.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "image_base64"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version",
    "request"
  ]
}

group_get_version_members

Get the member Lists (and pinned versions) that a specific group_version searches.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	integer	required	Group version.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Group version.",
      "type": "integer"
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version"
  ]
}

eval_run_history

Get an eval set's score history, newest first, paged by an opaque continuation token.

Parameters3

accountName	string	required	Name of the Account.
evalSetName	string	required	Name of the eval set.
continuationToken	string \| null	optional	Opaque cursor for the next page, from a prior response. Omit for the first page.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "evalSetName": {
      "description": "Name of the eval set.",
      "type": "string"
    },
    "continuationToken": {
      "description": "Opaque cursor for the next page, from a prior response. Omit for the first page.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "evalSetName"
  ]
}

group_remove_list

Remove a List from a Group.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
listName	string	required	Name of the List.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName",
    "listName"
  ]
}

group_restore_version

Restore a historical membership version as the Group's new current_version (roll-forward, not rewind). Member Lists deleted since that version are skipped and returned in skipped_lists.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	integer	required	The historical group version to restore.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "The historical group version to restore.",
      "type": "integer"
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version"
  ]
}

search_result_delete_by_filter

Queue a background job to permanently delete every Search Result in a List that matches the filter. A filter is required (an empty filter would match the whole List). Returns 202 Accepted once queued.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
request	object	required	Delete-by-filter request body. 'filter' is an OData-style filter expression and is required.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "request": {
      "description": "Delete-by-filter request body. 'filter' is an OData-style filter expression and is required.",
      "type": "object",
      "properties": {
        "filter": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "request"
  ]
}

eval_set_create

Create an eval set against a pinned list/group version. The version is frozen to a concrete number; a pin fixes WHICH RECORDS are searched, not the results (records, embeddings, model and reranker are read live at run time).

Parameters2

accountName	string	required	Name of the Account.
request	object	required	Create-eval-set request body (name, exactly one of list_name+list_version or group_name+group_version, optional judge_name/context_text/context_image_uris, optional auto_run_on = ["media_reimport","model_converged"] to auto-run the set when the pinned records change, and the queries).

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "request": {
      "description": "Create-eval-set request body (name, exactly one of list_name+list_version or group_name+group_version, optional judge_name/context_text/context_image_uris, optional auto_run_on = [\"media_reimport\",\"model_converged\"] to auto-run the set when the pinned records change, and the queries).",
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "list_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "list_version": {
          "type": [
            "integer",
            "null"
          ]
        },
        "group_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "group_version": {
          "type": [
            "integer",
            "null"
          ]
        },
        "judge_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "context_text": {
          "type": [
            "string",
            "null"
          ]
        },
        "context_image_uris": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "auto_run_on": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "queries": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "text": {
                "type": "string"
              },
              "size": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "filter": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "text_fields": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "image_fields": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "text"
            ]
          }
        }
      },
      "required": [
        "name",
        "queries"
      ]
    }
  },
  "required": [
    "accountName",
    "request"
  ]
}

list_create

Create a List. A List is a collection of related Search Results.

Parameters1

request

object

required

Create-list request body.

Raw schema

{
  "type": "object",
  "properties": {
    "request": {
      "description": "Create-list request body.",
      "type": "object",
      "properties": {
        "account_name": {
          "description": "Name of the Account",
          "type": "string"
        },
        "list_name": {
          "description": "Name of the List",
          "type": "string"
        },
        "subscription_name": {
          "description": "Name of the Subscription",
          "type": "string"
        },
        "model_name": {
          "description": "Name of the Model",
          "type": [
            "string",
            "null"
          ]
        },
        "cache_service": {
          "description": "Name of the Cache Service",
          "type": [
            "string",
            "null"
          ]
        },
        "reranker_name": {
          "description": "Name of the Reranker",
          "type": [
            "string",
            "null"
          ]
        },
        "default_ttl_seconds": {
          "description": "Default time-to-live, in seconds, for records created in this list. Records are stamped with an absolute expiry (created time + this value) unless they specify their own. Null means records never expire by default.",
          "type": [
            "integer",
            "null"
          ]
        },
        "media_store": {
          "description": "Name of the media store to attach to the list (e.g. the platform 'default' store). Null leaves the list with no media store.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "account_name",
        "list_name",
        "subscription_name"
      ]
    }
  },
  "required": [
    "request"
  ]
}

searchable_rename

Rename an existing Searchable field. Breaking change: bumps the List version.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
searchableName	string	required	Existing Searchable field name to rename.
request	object	required	Rename-searchable-field request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "searchableName": {
      "description": "Existing Searchable field name to rename.",
      "type": "string"
    },
    "request": {
      "description": "Rename-searchable-field request body.",
      "type": "object",
      "properties": {
        "new_searchable_field_name": {
          "type": "string"
        },
        "vectorize": {
          "type": "boolean"
        }
      },
      "required": [
        "new_searchable_field_name"
      ]
    }
  },
  "required": [
    "accountName",
    "listName",
    "searchableName",
    "request"
  ]
}

search_group_by_image_base64

Image-similarity search of a Group using a base64-encoded image. Hits include 'list_name'.

Parameters14

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	string	required	Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.
imageBase64	string	required	Base64-encoded image. Plain base64 or a data URI.
filter	string \| null	optional	OData-style filter expression.
size	integer \| null	optional	Page size.
skip	integer \| null	optional	Number of results to skip.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
minimumTextScore	number \| null	optional	Minimum text similarity score between 0 and 1.
minimumImageScore	number \| null	optional	Minimum image similarity score between 0 and 1.
minimumDocumentScore	number \| null	optional	Minimum document similarity score between 0 and 1.
minimumVideoScore	number \| null	optional	Minimum video similarity score between 0 and 1.
minimumAudioScore	number \| null	optional	Minimum audio similarity score between 0 and 1.
ranking	string \| null	optional	Ranking strategy: 'none' or 'score'. When omitted the server default applies.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.",
      "type": "string"
    },
    "imageBase64": {
      "description": "Base64-encoded image. Plain base64 or a data URI.",
      "type": "string"
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "skip": {
      "description": "Number of results to skip.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "minimumTextScore": {
      "description": "Minimum text similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumImageScore": {
      "description": "Minimum image similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumDocumentScore": {
      "description": "Minimum document similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumVideoScore": {
      "description": "Minimum video similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumAudioScore": {
      "description": "Minimum audio similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "ranking": {
      "description": "Ranking strategy: 'none' or 'score'. When omitted the server default applies.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version",
    "imageBase64"
  ]
}

group_edit

Edit a Group's default search/suggest size and distance unit.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
request	object	required	Edit-group request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "request": {
      "description": "Edit-group request body.",
      "type": "object",
      "properties": {
        "default_search_size": {
          "type": [
            "integer",
            "null"
          ]
        },
        "default_suggest_size": {
          "description": "Default returned suggestions size",
          "type": [
            "integer",
            "null"
          ]
        },
        "use_miles": {
          "description": "If false, distance will be in kilometers",
          "type": [
            "boolean",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

group_suggest

Typeahead suggestions across all Lists in a Group. Requires the 'list-group:read' permission.

Parameters8

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	integer	required	Membership version of the Group to search. Use the Group's current_version, or an older version to search a frozen set of records.
query	string	required	Partial text to suggest from.
size	integer \| null	optional	Page size.
filter	string \| null	optional	OData-style filter expression.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
cache	boolean \| null	optional	Disable cache (true to disable). Defaults to enabled.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Use the Group's current_version, or an older version to search a frozen set of records.",
      "type": "integer"
    },
    "query": {
      "description": "Partial text to suggest from.",
      "type": "string"
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "cache": {
      "description": "Disable cache (true to disable). Defaults to enabled.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version",
    "query"
  ]
}

group_remove_reranker

Detach the reranker from a Group, reverting to score-based ordering.

Parameters2

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName"
  ]
}

group_transfer

Transfer a Group and its member Lists to a different subscription.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
request	object	required	Transfer-group request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "request": {
      "description": "Transfer-group request body.",
      "type": "object",
      "properties": {
        "new_subscription_name": {
          "type": "string"
        }
      },
      "required": [
        "new_subscription_name"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

record_group_click

Records a click-through on a Group search result for analytics, correlated to its query by query_id.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
request	object	required	Record-click request body. 'list_name' identifies the member List the clicked result belongs to.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "request": {
      "description": "Record-click request body. 'list_name' identifies the member List the clicked result belongs to.",
      "type": "object",
      "properties": {
        "query_id": {
          "description": "The query_id returned by the search response this click belongs to.",
          "type": "string"
        },
        "result_id": {
          "description": "Identifier of the clicked search result.",
          "type": "string"
        },
        "list_name": {
          "description": "For group searches, the member list the clicked result belongs to. Ignored for list searches.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "query_id",
        "result_id"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

judge_run_status

Poll a batch Judge run: status, tally (processed/passed/errored) and the per-candidate verdicts persisted so far.

Parameters2

accountName	string	required	Name of the Account.
runId	string	required	Id of the Judge run to poll.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "runId": {
      "description": "Id of the Judge run to poll.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "runId"
  ]
}

bulk_insert_with_fields

Bulk insert Search Results, also creating any missing fields from the supplied dictionaries.

Parameters2

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName"
  ]
}

group_bump_version

Bump a Group's version: re-pins every member List to its latest version and advances current_version. A no-op when every member is already current.

Parameters2

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName"
  ]
}

search_group_by_image

Image-similarity search of a Group using an absolute, publicly reachable image URL. Hits include 'list_name'.

Parameters14

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	string	required	Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.
imagePath	string	required	Absolute URL of the image to search by.
filter	string \| null	optional	OData-style filter expression.
size	integer \| null	optional	Page size.
skip	integer \| null	optional	Number of results to skip.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
minimumTextScore	number \| null	optional	Minimum text similarity score between 0 and 1.
minimumImageScore	number \| null	optional	Minimum image similarity score between 0 and 1.
minimumDocumentScore	number \| null	optional	Minimum document similarity score between 0 and 1.
minimumVideoScore	number \| null	optional	Minimum video similarity score between 0 and 1.
minimumAudioScore	number \| null	optional	Minimum audio similarity score between 0 and 1.
ranking	string \| null	optional	Ranking strategy: 'none' or 'score'. When omitted the server default applies.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.",
      "type": "string"
    },
    "imagePath": {
      "description": "Absolute URL of the image to search by.",
      "type": "string"
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "skip": {
      "description": "Number of results to skip.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "minimumTextScore": {
      "description": "Minimum text similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumImageScore": {
      "description": "Minimum image similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumDocumentScore": {
      "description": "Minimum document similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumVideoScore": {
      "description": "Minimum video similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumAudioScore": {
      "description": "Minimum audio similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "ranking": {
      "description": "Ranking strategy: 'none' or 'score'. When omitted the server default applies.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version",
    "imagePath"
  ]
}

list_restore_version

Restore a historical schema version (facets, searchable fields, resources) as the List's new latest version (roll-forward, not rewind). Schema only — Search Result data is not versioned.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	The historical list version to restore.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "The historical list version to restore.",
      "type": "integer"
    }
  },
  "required": [
    "accountName",
    "listName",
    "version"
  ]
}

group_add_list

Add a List (at a version) to a Group.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
request	object	required	Add-list-to-group request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "request": {
      "description": "Add-list-to-group request body.",
      "type": "object",
      "properties": {
        "version": {
          "type": "integer"
        },
        "list_name": {
          "type": "string"
        },
        "adapt_to_first_list": {
          "type": "boolean"
        }
      },
      "required": [
        "version",
        "list_name"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

search_list_post

Free-text and/or vector search of a List version. POST variant accepting a SearchOptions body. Use when filter/radius strings are long enough to risk URL limits.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
options	object	required	Search options body. All properties optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "options": {
      "description": "Search options body. All properties optional.",
      "type": "object",
      "properties": {
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "query": {
          "description": "Text to search for",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        },
        "vector_search": {
          "description": "If false, disables vector search",
          "type": [
            "boolean",
            "null"
          ]
        },
        "reranker": {
          "description": "If false, disables the re-ranker. When omitted, the re-ranker attached to the List/Group (if any) is used.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "minimum_text_score": {
          "description": "Minimum text similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_image_score": {
          "description": "Minimum image similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_document_score": {
          "description": "Minimum document similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_video_score": {
          "description": "Minimum video similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_audio_score": {
          "description": "Minimum audio similarity score between 0 and 1, with 1 being an exact match."
        },
        "ranking": {
          "description": "Ranking strategy to use: 'none' or 'score'. When omitted the server default flag controls behavior.",
          "type": [
            "string",
            "null"
          ]
        },
        "order_by": {
          "description": "Sort results by field(s), e.g. 'price asc, modified_utc desc'. Sortable fields: the system fields name, modified_utc, created_utc, plus any typed facet.",
          "type": [
            "string",
            "null"
          ]
        },
        "typo_tolerance": {
          "description": "Typo-tolerance (fuzzy matching). When omitted the list default applies; set false to force exact matching.",
          "type": [
            "boolean",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "version",
    "options"
  ]
}

coordinates_create

Add a Coordinates field to a List, enabling geographical queries.

Parameters2

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName"
  ]
}

eval_run

Start an asynchronous eval run: each query is searched against the pinned records and its hits scored by the judge. Returns a run_id to poll with EvalRunStatus plus an up-front estimate of the billed judge calls.

Parameters2

accountName	string	required	Name of the Account.
evalSetName	string	required	Name of the eval set to run.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "evalSetName": {
      "description": "Name of the eval set to run.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "evalSetName"
  ]
}

extract_document_text

Extract text from PDF documents attached to a Search Result. Only available when the List's model declares a positive MaxDocumentPages limit.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
searchResultName	string	required	Stable name of the Search Result whose PDF resources should be extracted.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "searchResultName": {
      "description": "Stable name of the Search Result whose PDF resources should be extracted.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName",
    "searchResultName"
  ]
}

account_get

Retrieves the details of an Account by name.

Parameters1

accountName

string

required

Name of the Account.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    }
  },
  "required": [
    "accountName"
  ]
}

facet_rename

Rename an existing Facet. Breaking change: bumps the List version.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
facetName	string	required	Existing Facet name to rename.
request	object	required	Rename-facet request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "facetName": {
      "description": "Existing Facet name to rename.",
      "type": "string"
    },
    "request": {
      "description": "Rename-facet request body.",
      "type": "object",
      "properties": {
        "new_facet_name": {
          "description": "New Facet name",
          "type": "string"
        }
      },
      "required": [
        "new_facet_name"
      ]
    }
  },
  "required": [
    "accountName",
    "listName",
    "facetName",
    "request"
  ]
}

bulk_insert

Bulk insert Search Results into an existing List. Each item is a free-form field dictionary matching the List's fields.

Parameters2

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName"
  ]
}

search_result_create

Create a single Search Result.

Parameters1

request

object

required

Create-search-result request body.

Raw schema

{
  "type": "object",
  "properties": {
    "request": {
      "description": "Create-search-result request body.",
      "type": "object",
      "properties": {
        "account_name": {
          "type": "string"
        },
        "list_name": {
          "type": "string"
        },
        "search_result_name": {
          "type": "string"
        },
        "active": {
          "type": "boolean"
        },
        "ttl_seconds": {
          "type": [
            "integer",
            "null"
          ]
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "latitude": {
          "type": [
            "number",
            "null"
          ]
        },
        "longitude": {
          "type": [
            "number",
            "null"
          ]
        },
        "facets": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "value": true
            },
            "required": [
              "name",
              "value"
            ]
          }
        },
        "searchable_fields": {
          "type": "array",
          "items": {
            "$ref": "#/properties/request/properties/facets/items"
          }
        },
        "resources": {
          "type": "array",
          "items": {
            "$ref": "#/properties/request/properties/facets/items"
          }
        }
      },
      "required": [
        "account_name",
        "list_name",
        "search_result_name"
      ]
    }
  },
  "required": [
    "request"
  ]
}

get_api_info

Get the Public API self-describing manifest (auth, error codes, MCP integration guidance). Call once per session.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {}
}

group_get

Get a Group's configuration, member Lists and IP whitelist.

Parameters2

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName"
  ]
}

eval_run_status

Poll one eval run: lifecycle status, the environment it ran under (model/reranker/judge), the tally counts and rates, and the per-query rows.

Parameters3

accountName	string	required	Name of the Account.
evalSetName	string	required	Name of the eval set.
runId	string	required	Id of the eval run to poll.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "evalSetName": {
      "description": "Name of the eval set.",
      "type": "string"
    },
    "runId": {
      "description": "Id of the eval run to poll.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "evalSetName",
    "runId"
  ]
}

group_add_ip_address

Add an IP address to a Group's access whitelist.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
request	object	required	Add-IP-address request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "request": {
      "description": "Add-IP-address request body.",
      "type": "object",
      "properties": {
        "ip_address": {
          "type": "string"
        }
      },
      "required": [
        "ip_address"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

analytics_get_group

Search analytics for a Group over a UTC date range: total searches, zero-result searches, click-through rate, and the top searches / top zero-result searches. Dates are yyyy-MM-dd; defaults to the last 30 days when omitted.

Parameters4

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
from	string \| null	optional	Start of the range (UTC date yyyy-MM-dd, inclusive). Optional.
to	string \| null	optional	End of the range (UTC date yyyy-MM-dd, inclusive). Optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "from": {
      "description": "Start of the range (UTC date yyyy-MM-dd, inclusive). Optional.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "to": {
      "description": "End of the range (UTC date yyyy-MM-dd, inclusive). Optional.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "groupName"
  ]
}

group_set_reranker

Attach a bring-your-own reranker to a Group.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
request	object	required	Set-group-reranker request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "request": {
      "description": "Set-group-reranker request body.",
      "type": "object",
      "properties": {
        "reranker": {
          "type": "string"
        }
      },
      "required": [
        "reranker"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

group_remove_ip_address

Remove an IP address from a Group's access whitelist.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
ipAddress	string	required	IP address to remove.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "ipAddress": {
      "description": "IP address to remove.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName",
    "ipAddress"
  ]
}

resource_rename

Rename an existing Resource. Breaking change: bumps the List version.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
resourceName	string	required	Existing Resource name to rename.
request	object	required	Rename-resource request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "resourceName": {
      "description": "Existing Resource name to rename.",
      "type": "string"
    },
    "request": {
      "description": "Rename-resource request body.",
      "type": "object",
      "properties": {
        "resource_name": {
          "type": "string"
        },
        "new_resource_name": {
          "type": "string"
        },
        "vectorize": {
          "type": "boolean"
        }
      },
      "required": [
        "resource_name",
        "new_resource_name"
      ]
    }
  },
  "required": [
    "accountName",
    "listName",
    "resourceName",
    "request"
  ]
}

media_store_delete_media

Permanently delete a media item from a media store.

Parameters3

accountName	string	required	Name of the Account.
storeName	string	required	Name of the media store.
mediaName	string	required	Name of the media item to delete.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "storeName": {
      "description": "Name of the media store.",
      "type": "string"
    },
    "mediaName": {
      "description": "Name of the media item to delete.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "storeName",
    "mediaName"
  ]
}

search_result_edit_vector

Directly update the text and image vectors of an existing Search Result. The List must not be attached to a model.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
searchResultName	string	required	Stable name of the Search Result.
request	object	required	Update-search-result-vector request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "searchResultName": {
      "description": "Stable name of the Search Result.",
      "type": "string"
    },
    "request": {
      "description": "Update-search-result-vector request body.",
      "type": "object",
      "properties": {
        "text_vector": {
          "type": "array",
          "items": {
            "type": "number"
          }
        },
        "image_vector": {
          "type": "array",
          "items": {
            "type": "number"
          }
        },
        "document_vector": {
          "type": "array",
          "items": {
            "type": "number"
          }
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "searchResultName",
    "request"
  ]
}

resource_create

Create a Resource. A Resource is a non-searchable, non-filterable field (often a URL).

Parameters1

request

object

required

Create-resource request body.

Raw schema

{
  "type": "object",
  "properties": {
    "request": {
      "description": "Create-resource request body.",
      "type": "object",
      "properties": {
        "account_name": {
          "type": "string"
        },
        "list_name": {
          "type": "string"
        },
        "resource_name": {
          "type": "string"
        },
        "vectorize": {
          "type": "boolean"
        }
      },
      "required": [
        "account_name",
        "list_name",
        "resource_name"
      ]
    }
  },
  "required": [
    "request"
  ]
}

get_api_catalog

Get the Public API discovery catalog (IETF API Catalog draft) with links to OpenAPI, docs, manifest and examples.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {}
}

eval_set_delete

Delete an eval set and cascade its runs and per-query rows.

Parameters2

accountName	string	required	Name of the Account.
evalSetName	string	required	Name of the eval set.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "evalSetName": {
      "description": "Name of the eval set.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "evalSetName"
  ]
}

judge_delete

Delete a Judge.

Parameters2

accountName	string	required	Name of the Account.
judgeName	string	required	Name of the Judge.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "judgeName": {
      "description": "Name of the Judge.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "judgeName"
  ]
}

related_post

Find Search Results within a List that are vector-similar to a given seed Search Result. POST variant accepting a RelatedOptions body.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
searchResultName	string	required	Stable name of the seed Search Result.
options	object	required	Related options body. All properties optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "searchResultName": {
      "description": "Stable name of the seed Search Result.",
      "type": "string"
    },
    "options": {
      "description": "Related options body. All properties optional.",
      "type": "object",
      "properties": {
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "minimum_text_score": {
          "description": "Minimum text similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_image_score": {
          "description": "Minimum image similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_document_score": {
          "description": "Minimum document similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_video_score": {
          "description": "Minimum video similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_audio_score": {
          "description": "Minimum audio similarity score between 0 and 1, with 1 being an exact match."
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        },
        "ranking": {
          "description": "Ranking strategy to use: 'none' or 'score'. When omitted the server default flag controls behavior.",
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "searchResultName",
    "options"
  ]
}

group_search_post

Free-text and/or vector search across a Group of Lists. POST variant accepting a SearchOptions body.

Parameters4

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	string	required	Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.
options	object	required	Search options body. All properties optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.",
      "type": "string"
    },
    "options": {
      "description": "Search options body. All properties optional.",
      "type": "object",
      "properties": {
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "query": {
          "description": "Text to search for",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        },
        "vector_search": {
          "description": "If false, disables vector search",
          "type": [
            "boolean",
            "null"
          ]
        },
        "reranker": {
          "description": "If false, disables the re-ranker. When omitted, the re-ranker attached to the List/Group (if any) is used.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "minimum_text_score": {
          "description": "Minimum text similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_image_score": {
          "description": "Minimum image similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_document_score": {
          "description": "Minimum document similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_video_score": {
          "description": "Minimum video similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_audio_score": {
          "description": "Minimum audio similarity score between 0 and 1, with 1 being an exact match."
        },
        "ranking": {
          "description": "Ranking strategy to use: 'none' or 'score'. When omitted the server default flag controls behavior.",
          "type": [
            "string",
            "null"
          ]
        },
        "order_by": {
          "description": "Sort results by field(s), e.g. 'price asc, modified_utc desc'. Sortable fields: the system fields name, modified_utc, created_utc, plus any typed facet.",
          "type": [
            "string",
            "null"
          ]
        },
        "typo_tolerance": {
          "description": "Typo-tolerance (fuzzy matching). When omitted the list default applies; set false to force exact matching.",
          "type": [
            "boolean",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version",
    "options"
  ]
}

contributors_delete

Remove a Contributor from a List.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
contributorName	string	required	Name of the Contributor.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "contributorName": {
      "description": "Name of the Contributor.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName",
    "contributorName"
  ]
}

search_by_image_base64_post

Image-similarity search of a List using a base64-encoded image. Use when the image cannot be fetched by URL.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
request	object	required	Base64 image search body. 'image_base64' is required.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "request": {
      "description": "Base64 image search body. 'image_base64' is required.",
      "type": "object",
      "properties": {
        "image_base64": {
          "description": "Base64 encoded image. Accepts plain base64 or a data URI (e.g. 'data:image/jpeg;base64,...').",
          "type": "string"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "minimum_text_score": {
          "description": "Minimum text similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_image_score": {
          "description": "Minimum image similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_document_score": {
          "description": "Minimum document similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_video_score": {
          "description": "Minimum video similarity score between 0 and 1, with 1 being an exact match."
        },
        "minimum_audio_score": {
          "description": "Minimum audio similarity score between 0 and 1, with 1 being an exact match."
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        },
        "ranking": {
          "description": "Ranking strategy to use: 'none' or 'score'. When omitted the server default flag controls behavior.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "image_base64"
      ]
    }
  },
  "required": [
    "accountName",
    "listName",
    "version",
    "request"
  ]
}

eval_set_view

Get an eval set's configuration (pinned target, judge, context and query cases).

Parameters2

accountName	string	required	Name of the Account.
evalSetName	string	required	Name of the eval set.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "evalSetName": {
      "description": "Name of the eval set.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "evalSetName"
  ]
}

judge_view

Get a Judge's configuration (provider, model, instructions, output schema, pass field).

Parameters2

accountName	string	required	Name of the Account.
judgeName	string	required	Name of the Judge.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "judgeName": {
      "description": "Name of the Judge.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "judgeName"
  ]
}

suggest_post

Typeahead suggestions within a List version. POST variant accepting a SuggestOptions body. Use when filter/radius strings are long enough to risk URL limits.

Parameters5

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
query	string	required	Partial text to suggest from.
options	object	required	Suggest options body. All properties optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "query": {
      "description": "Partial text to suggest from.",
      "type": "string"
    },
    "options": {
      "description": "Suggest options body. All properties optional.",
      "type": "object",
      "properties": {
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "version",
    "query",
    "options"
  ]
}

facet_values

List the distinct values of a Facet on a List version. Useful for building filter UIs before searching. Requires the search-result:read permission, like the search tools.

Parameters5

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
facetName	string	required	Name of the Facet whose values to list.
cache	boolean \| null	optional	Disable cache (true to disable). Defaults to enabled.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "facetName": {
      "description": "Name of the Facet whose values to list.",
      "type": "string"
    },
    "cache": {
      "description": "Disable cache (true to disable). Defaults to enabled.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "listName",
    "version",
    "facetName"
  ]
}

analytics_get_list

Search analytics for a List over a UTC date range: total searches, zero-result searches, click-through rate, and the top searches / top zero-result searches. Dates are yyyy-MM-dd; defaults to the last 30 days when omitted. Useful for finding zero-result queries to improve.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
from	string \| null	optional	Start of the range (UTC date yyyy-MM-dd, inclusive). Optional.
to	string \| null	optional	End of the range (UTC date yyyy-MM-dd, inclusive). Optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "from": {
      "description": "Start of the range (UTC date yyyy-MM-dd, inclusive). Optional.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "to": {
      "description": "End of the range (UTC date yyyy-MM-dd, inclusive). Optional.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "listName"
  ]
}

search_by_image

Image-similarity search of a List using an absolute, publicly reachable image URL.

Parameters14

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
imagePath	string	required	Absolute URL of the image to search by.
filter	string \| null	optional	OData-style filter expression.
size	integer \| null	optional	Page size.
skip	integer \| null	optional	Number of results to skip.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
minimumTextScore	number \| null	optional	Minimum text similarity score between 0 and 1.
minimumImageScore	number \| null	optional	Minimum image similarity score between 0 and 1.
minimumDocumentScore	number \| null	optional	Minimum document similarity score between 0 and 1.
minimumVideoScore	number \| null	optional	Minimum video similarity score between 0 and 1.
minimumAudioScore	number \| null	optional	Minimum audio similarity score between 0 and 1.
ranking	string \| null	optional	Ranking strategy: 'none' or 'score'. When omitted the server default applies.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "imagePath": {
      "description": "Absolute URL of the image to search by.",
      "type": "string"
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "skip": {
      "description": "Number of results to skip.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "minimumTextScore": {
      "description": "Minimum text similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumImageScore": {
      "description": "Minimum image similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumDocumentScore": {
      "description": "Minimum document similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumVideoScore": {
      "description": "Minimum video similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumAudioScore": {
      "description": "Minimum audio similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "ranking": {
      "description": "Ranking strategy: 'none' or 'score'. When omitted the server default applies.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "listName",
    "version",
    "imagePath"
  ]
}

facet_create

Create a Facet. A Facet is a filterable field (e.g. brand, color, price, category).

Parameters1

request

object

required

Create-facet request body.

Raw schema

{
  "type": "object",
  "properties": {
    "request": {
      "description": "Create-facet request body.",
      "type": "object",
      "properties": {
        "account_name": {
          "description": "Name of the Account",
          "type": "string"
        },
        "list_name": {
          "description": "Name of the List",
          "type": "string"
        },
        "facet_name": {
          "description": "Name of the Facet",
          "type": "string"
        },
        "field_type": {
          "description": "Data type of the Facet: String (default), Number, Date or Boolean. Determines typed filtering and sorting.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "account_name",
        "list_name",
        "facet_name"
      ]
    }
  },
  "required": [
    "request"
  ]
}

list_delete

Permanently delete a List.

Parameters2

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName"
  ]
}

judge_list

List the bring-your-own LLM judges configured for an Account (secret API keys omitted).

Parameters1

accountName

string

required

Name of the Account.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    }
  },
  "required": [
    "accountName"
  ]
}

search_result_edit

Edit the properties of an existing Search Result.

Parameters4

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
id	string	required	Id of the Search Result.
request	object	required	Update-search-result request body. All properties optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "id": {
      "description": "Id of the Search Result.",
      "type": "string"
    },
    "request": {
      "description": "Update-search-result request body. All properties optional.",
      "type": "object",
      "properties": {
        "search_result_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "active": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "ttl_seconds": {
          "type": [
            "integer",
            "null"
          ]
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "latitude": {
          "type": [
            "number",
            "null"
          ]
        },
        "longitude": {
          "type": [
            "number",
            "null"
          ]
        },
        "facets": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "value": true
            },
            "required": [
              "name",
              "value"
            ]
          }
        },
        "searchable_fields": {
          "type": "array",
          "items": {
            "$ref": "#/properties/request/properties/facets/items"
          }
        },
        "resources": {
          "type": "array",
          "items": {
            "$ref": "#/properties/request/properties/facets/items"
          }
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "id",
    "request"
  ]
}

list_edit

Edit List defaults and settings.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
request	object	required	Update-list request body. All properties optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "request": {
      "description": "Update-list request body. All properties optional.",
      "type": "object",
      "properties": {
        "default_suggest_size": {
          "description": "Default returned suggestions size",
          "type": [
            "integer",
            "null"
          ]
        },
        "default_search_size": {
          "description": "Default returned search results size",
          "type": [
            "integer",
            "null"
          ]
        },
        "use_miles": {
          "description": "If false, distance will be in kilometers",
          "type": [
            "boolean",
            "null"
          ]
        },
        "typo_tolerance": {
          "description": "Default typo-tolerance (fuzzy matching) for searches. When true, misspelled queries still match.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "default_ttl_seconds": {
          "description": "Default time-to-live, in seconds, for records subsequently created in this list. Applies to future writes only — existing records are not retroactively stamped. Null leaves the current default unchanged.",
          "type": [
            "integer",
            "null"
          ]
        },
        "purge_inactive_after_days": {
          "description": "Opt-in retention: permanently purge deactivated (inactive) records once they have been inactive this many days. A non-positive value opts out. Null leaves the current setting unchanged.",
          "type": [
            "integer",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "listName",
    "request"
  ]
}

search_list

Free-text and/or vector search of a List version. Returns a SearchResponse JSON document with a 'results' array and 'count'.

Parameters16

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
version	integer	required	List version (integer).
query	string \| null	optional	Free-text query.
size	integer \| null	optional	Page size.
skip	integer \| null	optional	Number of results to skip.
filter	string \| null	optional	OData-style filter expression.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
cache	boolean \| null	optional	Disable cache (true to disable). Defaults to enabled.
vectorSearch	boolean \| null	optional	If false, disables vector search.
ranking	string \| null	optional	Ranking strategy: 'none' or 'score'. When omitted the server default flag controls behavior.
minimumTextScore	number \| null	optional	Minimum text similarity score between 0 and 1.
minimumImageScore	number \| null	optional	Minimum image similarity score between 0 and 1.
minimumDocumentScore	number \| null	optional	Minimum document similarity score between 0 and 1.
minimumVideoScore	number \| null	optional	Minimum video similarity score between 0 and 1.
minimumAudioScore	number \| null	optional	Minimum audio similarity score between 0 and 1.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "version": {
      "description": "List version (integer).",
      "type": "integer"
    },
    "query": {
      "description": "Free-text query.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "skip": {
      "description": "Number of results to skip.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "cache": {
      "description": "Disable cache (true to disable). Defaults to enabled.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    },
    "vectorSearch": {
      "description": "If false, disables vector search.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    },
    "ranking": {
      "description": "Ranking strategy: 'none' or 'score'. When omitted the server default flag controls behavior.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "minimumTextScore": {
      "description": "Minimum text similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumImageScore": {
      "description": "Minimum image similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumDocumentScore": {
      "description": "Minimum document similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumVideoScore": {
      "description": "Minimum video similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumAudioScore": {
      "description": "Minimum audio similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "listName",
    "version"
  ]
}

account_get_name

Retrieves the account name of the currently authenticated API key.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {}
}

facet_remove

Remove a Facet. Breaking change: bumps the List version.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
facetName	string	required	Existing Facet name to remove.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "facetName": {
      "description": "Existing Facet name to remove.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName",
    "facetName"
  ]
}

group_create

Create a Group. A Group combines multiple Lists for cross-list searching.

Parameters1

request

object

required

Create-group request body.

Raw schema

{
  "type": "object",
  "properties": {
    "request": {
      "description": "Create-group request body.",
      "type": "object",
      "properties": {
        "account_name": {
          "type": "string"
        },
        "subscription_name": {
          "type": "string"
        },
        "group_name": {
          "type": "string"
        },
        "model_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "reranker_name": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "account_name",
        "subscription_name",
        "group_name"
      ]
    }
  },
  "required": [
    "request"
  ]
}

group_suggest_post

Typeahead suggestions across all Lists in a Group. POST variant accepting a SuggestOptions body.

Parameters5

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	integer	required	Membership version of the Group to search. Use the Group's current_version, or an older version to search a frozen set of records.
query	string	required	Partial text to suggest from.
options	object	required	Suggest options body. All properties optional.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Use the Group's current_version, or an older version to search a frozen set of records.",
      "type": "integer"
    },
    "query": {
      "description": "Partial text to suggest from.",
      "type": "string"
    },
    "options": {
      "description": "Suggest options body. All properties optional.",
      "type": "object",
      "properties": {
        "size": {
          "description": "Number of Search Results returned"
        },
        "skip": {
          "description": "Number of Search Results to skip"
        },
        "filter": {
          "description": "Filter Search Results by Facet names and values",
          "type": [
            "string",
            "null"
          ]
        },
        "radius": {
          "description": "Only return Search Results within radius - format: 'latitude,longitude,distance in km'",
          "type": [
            "string",
            "null"
          ]
        },
        "cache": {
          "description": "Disable cache",
          "type": [
            "boolean",
            "null"
          ]
        }
      }
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version",
    "query",
    "options"
  ]
}

eval_set_bootstrap

Bootstrap an eval set from prior retrieve-then-judge runs: each source run replays its search as one eval query, and the pinned target and judge are taken from those runs (which must all share one target and one judge). Judge runs whose candidates were supplied explicitly are skipped.

Parameters2

accountName	string	required	Name of the Account.
request	object	required	Bootstrap request body (name, source_run_ids of the judge runs to seed queries from, and optional context_text/context_image_uris for the judge ideal).

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "request": {
      "description": "Bootstrap request body (name, source_run_ids of the judge runs to seed queries from, and optional context_text/context_image_uris for the judge ideal).",
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "source_run_ids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "context_text": {
          "type": [
            "string",
            "null"
          ]
        },
        "context_image_uris": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "name",
        "source_run_ids"
      ]
    }
  },
  "required": [
    "accountName",
    "request"
  ]
}

group_search

Free-text and/or vector search across a Group of Lists. Hits include 'list_name' so you can tell which list each hit came from.

Parameters16

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
version	string	required	Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.
query	string \| null	optional	Free-text query.
size	integer \| null	optional	Page size.
skip	integer \| null	optional	Number of results to skip.
filter	string \| null	optional	OData-style filter expression.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
cache	boolean \| null	optional	Disable cache (true to disable). Defaults to enabled.
vectorSearch	boolean \| null	optional	If false, disables vector search.
ranking	string \| null	optional	Ranking strategy: 'none' or 'score'. When omitted the server default flag controls behavior.
minimumTextScore	number \| null	optional	Minimum text similarity score between 0 and 1.
minimumImageScore	number \| null	optional	Minimum image similarity score between 0 and 1.
minimumDocumentScore	number \| null	optional	Minimum document similarity score between 0 and 1.
minimumVideoScore	number \| null	optional	Minimum video similarity score between 0 and 1.
minimumAudioScore	number \| null	optional	Minimum audio similarity score between 0 and 1.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "version": {
      "description": "Membership version of the Group to search. Pass 'latest' to always search the Group's current version, the Group's current_version to pin it, or an older version to search a frozen set of records.",
      "type": "string"
    },
    "query": {
      "description": "Free-text query.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "skip": {
      "description": "Number of results to skip.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "cache": {
      "description": "Disable cache (true to disable). Defaults to enabled.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    },
    "vectorSearch": {
      "description": "If false, disables vector search.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    },
    "ranking": {
      "description": "Ranking strategy: 'none' or 'score'. When omitted the server default flag controls behavior.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "minimumTextScore": {
      "description": "Minimum text similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumImageScore": {
      "description": "Minimum image similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumDocumentScore": {
      "description": "Minimum document similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumVideoScore": {
      "description": "Minimum video similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumAudioScore": {
      "description": "Minimum audio similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "groupName",
    "version"
  ]
}

group_remove_model

Remove the embedding model from a Group, reverting it to keyword search.

Parameters2

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName"
  ]
}

group_set_model

Set the embedding model for a Group. Member Lists are re-embedded asynchronously.

Parameters3

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.
request	object	required	Set-group-model request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    },
    "request": {
      "description": "Set-group-model request body.",
      "type": "object",
      "properties": {
        "model_name": {
          "type": "string"
        }
      },
      "required": [
        "model_name"
      ]
    }
  },
  "required": [
    "accountName",
    "groupName",
    "request"
  ]
}

Find Search Results within a List that are vector-similar to a given seed Search Result. Use for 'related items' / 'more like this' flows.

Parameters14

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
searchResultName	string	required	Stable name of the seed Search Result to find related items for.
filter	string \| null	optional	OData-style filter expression.
size	integer \| null	optional	Page size.
skip	integer \| null	optional	Number of results to skip.
radius	string \| null	optional	Radius filter: 'latitude,longitude,distance in km'.
minimumTextScore	number \| null	optional	Minimum text similarity score between 0 and 1.
minimumImageScore	number \| null	optional	Minimum image similarity score between 0 and 1.
minimumDocumentScore	number \| null	optional	Minimum document similarity score between 0 and 1.
minimumVideoScore	number \| null	optional	Minimum video similarity score between 0 and 1.
minimumAudioScore	number \| null	optional	Minimum audio similarity score between 0 and 1.
cache	boolean \| null	optional	Set to false to bypass the cache.
ranking	string \| null	optional	Ranking strategy: 'none' or 'score'. When omitted the server default applies.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "searchResultName": {
      "description": "Stable name of the seed Search Result to find related items for.",
      "type": "string"
    },
    "filter": {
      "description": "OData-style filter expression.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "size": {
      "description": "Page size.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "skip": {
      "description": "Number of results to skip.",
      "type": [
        "integer",
        "null"
      ],
      "default": null
    },
    "radius": {
      "description": "Radius filter: 'latitude,longitude,distance in km'.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "minimumTextScore": {
      "description": "Minimum text similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumImageScore": {
      "description": "Minimum image similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumDocumentScore": {
      "description": "Minimum document similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumVideoScore": {
      "description": "Minimum video similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "minimumAudioScore": {
      "description": "Minimum audio similarity score between 0 and 1.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "cache": {
      "description": "Set to false to bypass the cache.",
      "type": [
        "boolean",
        "null"
      ],
      "default": null
    },
    "ranking": {
      "description": "Ranking strategy: 'none' or 'score'. When omitted the server default applies.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "accountName",
    "listName",
    "searchResultName"
  ]
}

group_delete

Remove a Group.

Parameters2

accountName	string	required	Name of the Account.
groupName	string	required	Name of the Group.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "groupName": {
      "description": "Name of the Group.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "groupName"
  ]
}

searchable_remove

Remove a Searchable field. Breaking change: bumps the List version.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
searchableName	string	required	Existing Searchable field name to remove.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "searchableName": {
      "description": "Existing Searchable field name to remove.",
      "type": "string"
    }
  },
  "required": [
    "accountName",
    "listName",
    "searchableName"
  ]
}

eval_set_list

List the eval sets configured for an Account. An eval set is a named relevance test: query cases pinned to a list/group version and scored by a judge, with a score history.

Parameters1

accountName

string

required

Name of the Account.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    }
  },
  "required": [
    "accountName"
  ]
}

record_list_click

Records a click-through on a List search result for analytics, correlated to its query by query_id.

Parameters3

accountName	string	required	Name of the Account.
listName	string	required	Name of the List.
request	object	required	Record-click request body.

Raw schema

{
  "type": "object",
  "properties": {
    "accountName": {
      "description": "Name of the Account.",
      "type": "string"
    },
    "listName": {
      "description": "Name of the List.",
      "type": "string"
    },
    "request": {
      "description": "Record-click request body.",
      "type": "object",
      "properties": {
        "query_id": {
          "description": "The query_id returned by the search response this click belongs to.",
          "type": "string"
        },
        "result_id": {
          "description": "Identifier of the clicked search result.",
          "type": "string"
        },
        "list_name": {
          "description": "For group searches, the member list the clicked result belongs to. Ignored for list searches.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "query_id",
        "result_id"
      ]
    }
  },
  "required": [
    "accountName",
    "listName",
    "request"
  ]
}

Install

Tools (88)

search_result_deletelist_getcontributors_createresource_removesearch_group_by_image_postjudge_runsearch_by_image_postsearchable_create

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

https://mcp.searchstack.dev

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "searchstack": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.searchstack.dev"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.