search

Full-text search across capsules visible to the caller

Changed on
get/api/preview/search

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/search
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Query parameters

qstring required

The search text. Required, at most 500 characters.

tagsstring

Comma-separated tag slugs to filter by.

tagMode'any' | 'all'

How tags combine: any (default) or all.

limitinteger

Page size, a positive integer.

offsetinteger

Number of results to skip, a non-negative integer.

collectionIdstring

Filter to a collection by id.

projectIdstring

Filter to a single Project by id.

sort'best' | 'newest' | 'oldest'

Result order: best (relevance, default), newest or oldest.

typeIdstring

Filter to a single Type by id.

langstring

Filter by programming language (e.g. python).

skill'0' | '1' | 'true' | 'false'

Set to true (or 1) to return only capsules that are Skills.

kindsstring

Comma-separated kinds to search: capsule, type, project, collection. Absent searches capsules only.

kindLimitinteger

Per-kind result cap when kinds is given, a positive integer.

archived'true' | 'false'

Set to true to search archived capsules instead of active ones.

contextstring

Where the search came from. results records a committed full-page search.

afterstring

Legacy alias of created_after.

beforestring

Legacy alias of created_before.

created_withinstring

Relative window on creation date: an integer 1-9999 followed by h, d, or w (e.g. 8h, 3d, 2w).

created_period'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'this_year'

Named calendar window on creation date, resolved in the effective timezone.

created_afterstring

Inclusive lower bound on creation date. An ISO-8601 instant, or an offset-less date or date-time read in the effective timezone.

created_beforestring

Exclusive upper bound on creation date. Same spellings as created_after.

updated_withinstring

Relative window on last-updated date (same grammar as created_within).

updated_period'today' | 'yesterday' | 'this_week' | 'last_week' | 'this_month' | 'last_month' | 'this_year'

Named calendar window on last-updated date, resolved in the effective timezone.

updated_afterstring

Inclusive lower bound on last-updated date. Same spellings as created_after.

updated_beforestring

Exclusive upper bound on last-updated date. Same spellings as created_after.

tzstring

IANA timezone name that named calendar periods resolve in for this request.

wsstring

Optional workspace context for the request. Same value rules as the MCP workspace tool argument. Omit to use the caller's default workspace.

Response

Successful response

best_matchobject nullable
facetsobject required
kind_countsobject
kind_resultsobject
limitinteger required
match_kind'identifier'
offsetinteger required
querystring required
resultsobject[] required
search_idstring
suggestionsstring[]
totalinteger required

Changes

    • warning

      for the query request parameter q, the maxLength was set to 500

    • breaking

      added the new required query request parameter q

    • info

      added the new optional query request parameter after

    • info

      added the new optional query request parameter archived

    • info

      added the new optional query request parameter before

    • info

      added the new optional query request parameter collectionId

    • info

      added the new optional query request parameter context

    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before

    • info

      added the new optional query request parameter created_period

    • info

      added the new optional query request parameter created_within

    • info

      added the new optional query request parameter kindLimit

    • info

      added the new optional query request parameter kinds

    • info

      added the new optional query request parameter lang

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter projectId

    • info

      added the new optional query request parameter skill

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter tagMode

    • info

      added the new optional query request parameter tags

    • info

      added the new optional query request parameter typeId

    • info

      added the new optional query request parameter tz

    • info

      added the new optional query request parameter updated_after

    • info

      added the new optional query request parameter updated_before

    • info

      added the new optional query request parameter updated_period

    • info

      added the new optional query request parameter updated_within

    • info

      added the new optional query request parameter ws