Mint a scoped search token

getapi.modelmatch.com/v1/search-token

Returns a short-lived scoped search token plus the host to query, so a trusted client can search the entity indexes directly with per-query controls (e.g. attributesToSearchOn for name-only matching).

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Responses

200objectScoped search token

Show attributes

expiresAtstringrequired

ISO-8601 expiry

hoststringrequired

Search host to query directly

indexesstring[]required

Index names the token may search

tokenstringrequired

Scoped search token

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch backend not configured

curl -X GET "https://api.modelmatch.com/v1/search-token" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.search.getSearchToken();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/search-token",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "expiresAt": "<string>",
  "host": "<string>",
  "indexes": [
    "<string>"
  ],
  "token": "<string>"
}