Skip to main content
GET
Search
Search the artifacts you can read: your standalone artifacts, artifacts shared with your teams, and artifacts in workspaces you belong to. With q, results are ranked by relevance; without it, they are the most recently updated artifacts. Only live artifacts appear: nothing in the trash, and nothing in a folder or workspace that is in the trash. When the server has an embedding provider, which tokenrip.com does not, a workspace search also understands meaning. Scope a search to a workspace (workspaceId, or an artifactId that lives in one) and a query ranks by keywords and meaning together, so a plain-language question finds the passage that answers it even when the words differ. Each result then carries its best passages. Everywhere else, the ranking is by keyword. See Workspace search by meaning. Auth: Authorization: Bearer tr_...

Query parameters

There is no mode parameter: the server decides how to rank (match chooses which results count, not how they rank), and the response says which it used. An unknown parameter, mode included, is refused 400 INVALID_FIELD naming it, with the parameters this endpoint accepts.

Example response

A workspace search:

Response fields

mode is hybrid when the search is scoped to a workspace, has a q, and the server has an embedding provider. If embedding the query fails, the search ranks by keyword and says keyword; it does not fail.

Result fields (all items)

Artifact-specific fields

Use offset for pagination. When results.length < total, there are more results available at offset + limit.

Errors