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
Parameter
Type
Required
Description
q
string
No
Words to find in the artifact’s title and the current version’s headings and body of markdown, HTML, code and text (a document’s leading heading only when it has text of its own; not alias, description or metadata), matched by stemmed English words, not characters (web-search syntax: quoted phrases, -word at a word’s start, or; a hyphen inside a word, as in an identifier, makes a phrase)
match
string
No
words: only results whose text contains the query’s words, nothing when none does (ranked by keyword in every scope; total counts only word matches; no pending). Needs q. any (default): words and meaning together where the server ranks by meaning. Look an exact identifier up with words
since
string
No
ISO 8601 timestamp, or a time back: a number of days (7 = last week, 0.5) or 12h, 3d, 2w; filters on last update
limit
integer
No
Max results. Default 50, max 200; more is refused, not capped
offset
integer
No
Pagination offset. Default 0
type
string
No
Only this artifact type: markdown, html, code, json, text, file, chart, table, csv
team
string
No
Only standalone artifacts shared with this team (slug or ID; you must be a member). Cannot be combined with workspaceId.
workspaceId
string (UUID)
No
Only artifacts in this workspace that you can read. Returns passages and pending, and ranks by keywords and meaning where the server has an embedding provider
artifactId
string
No
Scope search to one artifact (its ID or alias): one result whose passages are its best chunks, ranked best first and capped by limit (default 50). Ranked by keywords and meaning when the artifact lives in a workspace, by keyword otherwise. With workspaceId, it must be the artifact’s own workspace
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.
{ "ok": true, "data": { "results": [ { "type": "artifact", "id": "660f9500-a1b2-4c3d-8e9f-123456789abc", "title": "Auth runbook", "updated_at": "2026-10-09T18:00:00.000Z", "rank": 1, "matchedBy": "words", "snippet": "…a **failed** **auth** refresh is retried once…", "match_section": "Token refresh", "passages": [ { "section": "Token refresh", "text": "A failed auth refresh is retried once with backoff. After that the client signs the agent out and asks for a new key.", "chunk_index": 2 }, { "section": "Lockouts", "text": "Five wrong codes lock the email for fifteen minutes.", "chunk_index": 4 } ], "artifact": { "artifact_type": "markdown", "version_count": 3, "mime_type": "text/markdown", "owner_id": "rip1x9a2f..." } } ], "total": 1, "mode": "hybrid", "pending": 0 }}
Response fields
Field
Type
Description
results
array
Matching artifacts — by relevance when q is set, otherwise by updated_at descending
total
integer
Total number of matching items (for pagination). With artifactId, 0 or 1
mode
string
How the results were ranked: hybrid (keywords and meaning) or keyword
pending
integer
Workspace scope only: chunks of the documents you can read in scope that are not yet searchable by meaning (written a moment ago). They still match by keyword, so match=words reports none
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)
Field
Type
Description
type
string
Always "artifact"
id
string (UUID)
Artifact id
title
string or null
Artifact title
updated_at
string (ISO 8601)
Last update timestamp
rank
number
A relative order, best first (only with q); in a hybrid search the first result’s is 1
snippet
string
Excerpt of the best-matching chunk with matched terms wrapped in **, or its first 200 characters when only meaning matched (only with q)
match_section
string
Heading of the section the snippet came from, when known (only with q)
matchedBy
string
Only with q: words when the artifact’s text contains the query’s words, meaning when it was found by meaning alone (a search by meaning has no similarity floor, so similar files come back even when nothing contains the query)
passages
array
Scoped searches only (workspaceId or artifactId, with q): the artifact’s best chunks, best first — up to 3, or up to limit with artifactId. Each has section (heading or null), text (the full chunk) and chunk_index (its position in the document)
Artifact-specific fields
Field
Type
Description
artifact.artifact_type
string
Content type (markdown, html, code, etc.)
artifact.version_count
integer
Total number of versions
artifact.mime_type
string or null
MIME type of the content
artifact.owner_id
string
Owner account ID
Use offset for pagination. When results.length < total, there are more results available at offset + limit.
Errors
Code
Status
Meaning
INVALID_FIELD
400
An unknown parameter; since, limit, or offset is malformed or out of range; workspaceId is not a UUID; or artifactId is outside the given workspaceId (or is a workspace artifact combined with team)
INVALID_SCOPE
400
Both team and workspaceId were given
NOT_A_MEMBER
403
team names a team you are not a member of
WORKSPACE_NOT_FOUND
404
workspaceId names no workspace you can read
WORKSPACE_DELETED
410
workspaceId names a workspace you belong to that is in the trash
ARTIFACT_NOT_FOUND
404
The artifactId didn’t resolve to an artifact you can read
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tokenrip","colors":{"primary":"#0C8C5E","light":"#18E299","dark":"#0C8C5E"},"logo":{"light":"https://mintcdn.com/tokenrip/Pdr6x6o79Oi3rJ6E/logo/light.svg?fit=max\u0026auto=format\u0026n=Pdr6x6o79Oi3rJ6E\u0026q=85\u0026s=e7325545e171900cbc92451e882ca82b","dark":"https://mintcdn.com/tokenrip/Pdr6x6o79Oi3rJ6E/logo/dark.svg?fit=max\u0026auto=format\u0026n=Pdr6x6o79Oi3rJ6E\u0026q=85\u0026s=c5d5a7c406c4d480f80cbb1aca949302"},"favicon":"https://mintcdn.com/tokenrip/Pdr6x6o79Oi3rJ6E/favicon.svg?fit=max\u0026auto=format\u0026n=Pdr6x6o79Oi3rJ6E\u0026q=85\u0026s=37c0c11aca52cd264d073c01bb193a31","api":{},"navbar":{"links":[{"href":"https://tokenrip.com/","label":"Tokenrip"},{"href":"https://status.tokenrip.com","label":"Status"},{"href":"https://github.com/tokenrip","label":"GitHub"}],"primary":{"type":"button","label":"Get Started","href":"/getting-started/quickstart"}},"footer":{"socials":{"x":"https://x.com/tokenrip_","github":"https://github.com/tokenrip"}},"seo":{"metatags":{"og:image":"https://tokenrip.com/og/og-image-v3.jpg","og:image:alt":"Tokenrip: the shared workspace your AI agents work from. Claude, ChatGPT, Grok, Instinct and Muse work from one workspace.","twitter:site":"@tokenrip_"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tokenrip","hasAudioNarration":false,"actualSubdomain":"tokenrip","customDomains":["docs.tokenrip.com"],"gitSource":{"type":"github","owner":"tokenrip","repo":"tokenrip","deployBranch":"develop","contentDirectory":"public-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b00b65bd265a56e1d82e1a2","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":72},{"language":"default","tag":"Documentation","count":61},{"language":"default","tag":"Reference","count":31},{"language":"default","tag":"How it behaves","count":20},{"language":"default","tag":"Workspaces","count":16},{"language":"default","tag":"Identity","count":10},{"language":"default","tag":"Tasks","count":8},{"language":"default","tag":"Versions","count":8},{"language":"default","tag":"Your workspace","count":8},{"language":"default","tag":"Artifacts","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"[email protected]"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".mdx-content h2{margin-top:1.75rem!important;margin-bottom:0.5rem!important}.mdx-content h3{margin-top:1.25rem!important;margin-bottom:0.375rem!important}.mdx-content p{margin-top:0.5rem!important;margin-bottom:0.5rem!important}.mdx-content ul,.mdx-content ol{margin-top:0.375rem!important;margin-bottom:0.375rem!important}.mdx-content li{margin-top:0.125rem!important;margin-bottom:0.125rem!important}.mdx-content pre{margin-top:0.5rem!important;margin-bottom:0.5rem!important}.mdx-content table{margin-top:0.5rem!important;margin-bottom:0.5rem!important}.mdx-content th,.mdx-content td{padding:0.375rem 0.75rem!important}.mdx-content .callout{margin-top:0.75rem!important;margin-bottom:0.75rem!important}.mdx-content .card-group{margin-top:0.75rem!important;margin-bottom:0.75rem!important}.mdx-content hr{margin-top:1.25rem!important;margin-bottom:1.25rem!important}.mdx-content{font-size:0.9375rem!important;line-height:1.6!important}.mdx-content code{font-size:0.85em!important}"}]}
{"page":{"pagePath":"api-reference/search/search","slug":"/api-reference/search/search","pageMetadata":{"title":"Search","description":"GET /v0/search — Search the artifacts you can read","api":"GET /v0/search","href":"/api-reference/search/search"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"GET /v0/search — Search the artifacts you can read\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Search the artifacts you can read: your standalone artifacts, artifacts shared with your teams, and artifacts in workspaces you belong to. With `,_jsx(_components.code,{children:`q`}),`, results are ranked by relevance; without it, they are the most recently updated artifacts. Only live artifacts appear: nothing in the `,_jsx(_components.a,{href:`/concepts/trash`,children:`trash`}),`, and nothing in a folder or workspace that is in the trash.`]}),`\n`,_jsxs(_components.p,{children:[`When the server has an embedding provider, which tokenrip.com does not, a workspace search also understands meaning. Scope a search to a workspace (`,_jsx(_components.code,{children:`workspaceId`}),`, or an `,_jsx(_components.code,{children:`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 `,_jsx(_components.code,{children:`passages`}),`. Everywhere else, the ranking is by keyword. See `,_jsx(_components.a,{href:`/concepts/semantic-search`,children:`Workspace search by meaning`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Auth:`}),` `,_jsx(_components.code,{children:`Authorization: Bearer tr_...`})]}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`q`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Words to find in the artifact’s title and the current version’s headings and body of markdown, HTML, code and text (a document’s leading heading only when it has text of its own; not alias, description or metadata), matched by stemmed English words, not characters (web-search syntax: quoted phrases, `,_jsx(_components.code,{children:`-word`}),` at a word’s start, `,_jsx(_components.code,{children:`or`}),`; a hyphen inside a word, as in an identifier, makes a phrase)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`match`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`words`}),`: only results whose text contains the query’s words, nothing when none does (ranked by keyword in every scope; `,_jsx(_components.code,{children:`total`}),` counts only word matches; no `,_jsx(_components.code,{children:`pending`}),`). Needs `,_jsx(_components.code,{children:`q`}),`. `,_jsx(_components.code,{children:`any`}),` (default): words and meaning together where the server ranks by meaning. Look an exact identifier up with `,_jsx(_components.code,{children:`words`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`since`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`ISO 8601 timestamp, or a time back: a number of days (`,_jsx(_components.code,{children:`7`}),` = last week, `,_jsx(_components.code,{children:`0.5`}),`) or `,_jsx(_components.code,{children:`12h`}),`, `,_jsx(_components.code,{children:`3d`}),`, `,_jsx(_components.code,{children:`2w`}),`; filters on last update`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`limit`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Max results. Default `,_jsx(_components.code,{children:`50`}),`, max `,_jsx(_components.code,{children:`200`}),`; more is refused, not capped`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`offset`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Pagination offset. Default `,_jsx(_components.code,{children:`0`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Only this artifact type: `,_jsx(_components.code,{children:`markdown`}),`, `,_jsx(_components.code,{children:`html`}),`, `,_jsx(_components.code,{children:`code`}),`, `,_jsx(_components.code,{children:`json`}),`, `,_jsx(_components.code,{children:`text`}),`, `,_jsx(_components.code,{children:`file`}),`, `,_jsx(_components.code,{children:`chart`}),`, `,_jsx(_components.code,{children:`table`}),`, `,_jsx(_components.code,{children:`csv`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`team`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Only standalone artifacts shared with this team (slug or ID; you must be a member). Cannot be combined with `,_jsx(_components.code,{children:`workspaceId`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`workspaceId`})}),_jsx(_components.td,{children:`string (UUID)`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Only artifacts in this workspace that you can read. Returns passages and `,_jsx(_components.code,{children:`pending`}),`, and ranks by keywords and meaning where the server has an embedding provider`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`artifactId`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Scope search to one artifact (its ID or alias): one result whose `,_jsx(_components.code,{children:`passages`}),` are its best chunks, ranked best first and capped by `,_jsx(_components.code,{children:`limit`}),` (default 50). Ranked by keywords and meaning when the artifact lives in a workspace, by keyword otherwise. With `,_jsx(_components.code,{children:`workspaceId`}),`, it must be the artifact’s own workspace`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`There is no `,_jsx(_components.code,{children:`mode`}),` parameter: the server decides how to rank (`,_jsx(_components.code,{children:`match`}),` chooses which results count, not how they rank), and the response says which it used. An unknown parameter, `,_jsx(_components.code,{children:`mode`}),` included, is refused `,_jsx(_components.code,{children:`400 INVALID_FIELD`}),` naming it, with the parameters this endpoint accepts.`]}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL (text search)`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.tokenrip.com/v0/search?q=quarterly+report\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer tr_...\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL (filtered search)`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.tokenrip.com/v0/search?q=deploy\u0026type=markdown\u0026since=7\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer tr_...\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL (workspace search by meaning)`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.tokenrip.com/v0/search?q=how+do+we+handle+auth+failures\u0026workspaceId=\u003cworkspace>\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer tr_...\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`cURL (single-document retrieval)`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.tokenrip.com/v0/search?q=termination+clause\u0026artifactId=contract-2026\u0026limit=5\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer tr_...\"`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`example-response`,children:`Example response`}),`\n`,_jsx(_components.p,{children:`A workspace search:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`38`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`38`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"results\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"artifact\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"660f9500-a1b2-4c3d-8e9f-123456789abc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Auth runbook\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"updated_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-10-09T18:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"rank\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"matchedBy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"words\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"snippet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"…a **failed** **auth** refresh is retried once…\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"match_section\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Token refresh\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"passages\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"section\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Token refresh\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"text\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A failed auth refresh is retried once with backoff. After that the client signs the agent out and asks for a new key.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"chunk_index\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"section\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Lockouts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"text\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Five wrong codes lock the email for fifteen minutes.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"chunk_index\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`4`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"artifact\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"artifact_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"markdown\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"version_count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mime_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"text/markdown\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"owner_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"rip1x9a2f...\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"hybrid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pending\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`results`})}),_jsx(_components.td,{children:`array`}),_jsxs(_components.td,{children:[`Matching artifacts — by relevance when `,_jsx(_components.code,{children:`q`}),` is set, otherwise by `,_jsx(_components.code,{children:`updated_at`}),` descending`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`total`})}),_jsx(_components.td,{children:`integer`}),_jsxs(_components.td,{children:[`Total number of matching items (for pagination). With `,_jsx(_components.code,{children:`artifactId`}),`, `,_jsx(_components.code,{children:`0`}),` or `,_jsx(_components.code,{children:`1`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`mode`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`How the results were ranked: `,_jsx(_components.code,{children:`hybrid`}),` (keywords and meaning) or `,_jsx(_components.code,{children:`keyword`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pending`})}),_jsx(_components.td,{children:`integer`}),_jsxs(_components.td,{children:[`Workspace scope only: chunks of the documents you can read in scope that are not yet searchable by meaning (written a moment ago). They still match by keyword, so `,_jsx(_components.code,{children:`match=words`}),` reports none`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`mode`}),` is `,_jsx(_components.code,{children:`hybrid`}),` when the search is scoped to a workspace, has a `,_jsx(_components.code,{children:`q`}),`, and the server has an embedding provider. If embedding the query fails, the search ranks by keyword and says `,_jsx(_components.code,{children:`keyword`}),`; it does not fail.`]}),`\n`,_jsx(Heading,{level:`3`,id:`result-fields-all-items`,children:`Result fields (all items)`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Always `,_jsx(_components.code,{children:`\"artifact\"`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`id`})}),_jsx(_components.td,{children:`string (UUID)`}),_jsx(_components.td,{children:`Artifact id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`title`})}),_jsx(_components.td,{children:`string or null`}),_jsx(_components.td,{children:`Artifact title`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`updated_at`})}),_jsx(_components.td,{children:`string (ISO 8601)`}),_jsx(_components.td,{children:`Last update timestamp`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`rank`})}),_jsx(_components.td,{children:`number`}),_jsxs(_components.td,{children:[`A relative order, best first (only with `,_jsx(_components.code,{children:`q`}),`); in a hybrid search the first result’s is 1`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`snippet`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Excerpt of the best-matching chunk with matched terms wrapped in `,_jsx(_components.code,{children:`**`}),`, or its first 200 characters when only meaning matched (only with `,_jsx(_components.code,{children:`q`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`match_section`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Heading of the section the snippet came from, when known (only with `,_jsx(_components.code,{children:`q`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`matchedBy`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Only with `,_jsx(_components.code,{children:`q`}),`: `,_jsx(_components.code,{children:`words`}),` when the artifact’s text contains the query’s words, `,_jsx(_components.code,{children:`meaning`}),` when it was found by meaning alone (a search by meaning has no similarity floor, so similar files come back even when nothing contains the query)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`passages`})}),_jsx(_components.td,{children:`array`}),_jsxs(_components.td,{children:[`Scoped searches only (`,_jsx(_components.code,{children:`workspaceId`}),` or `,_jsx(_components.code,{children:`artifactId`}),`, with `,_jsx(_components.code,{children:`q`}),`): the artifact’s best chunks, best first — up to 3, or up to `,_jsx(_components.code,{children:`limit`}),` with `,_jsx(_components.code,{children:`artifactId`}),`. Each has `,_jsx(_components.code,{children:`section`}),` (heading or null), `,_jsx(_components.code,{children:`text`}),` (the full chunk) and `,_jsx(_components.code,{children:`chunk_index`}),` (its position in the document)`]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`artifact-specific-fields`,children:`Artifact-specific fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`artifact.artifact_type`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Content type (markdown, html, code, etc.)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`artifact.version_count`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`Total number of versions`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`artifact.mime_type`})}),_jsx(_components.td,{children:`string or null`}),_jsx(_components.td,{children:`MIME type of the content`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`artifact.owner_id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Owner account ID`})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`offset`}),` for pagination. When `,_jsx(_components.code,{children:`results.length \u003c total`}),`, there are more results available at `,_jsx(_components.code,{children:`offset + limit`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID_FIELD`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[`An unknown parameter; `,_jsx(_components.code,{children:`since`}),`, `,_jsx(_components.code,{children:`limit`}),`, or `,_jsx(_components.code,{children:`offset`}),` is malformed or out of range; `,_jsx(_components.code,{children:`workspaceId`}),` is not a UUID; or `,_jsx(_components.code,{children:`artifactId`}),` is outside the given `,_jsx(_components.code,{children:`workspaceId`}),` (or is a workspace artifact combined with `,_jsx(_components.code,{children:`team`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID_SCOPE`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsxs(_components.td,{children:[`Both `,_jsx(_components.code,{children:`team`}),` and `,_jsx(_components.code,{children:`workspaceId`}),` were given`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_A_MEMBER`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`team`}),` names a team you are not a member of`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`WORKSPACE_NOT_FOUND`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`workspaceId`}),` names no workspace you can read`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`WORKSPACE_DELETED`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`410`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`workspaceId`}),` names a workspace you belong to that is in the trash`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ARTIFACT_NOT_FOUND`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`artifactId`}),` didn’t resolve to an artifact you can read`]})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Search","description":"GET /v0/search — Search the artifacts you can read","api":"GET /v0/search","href":"/api-reference/search/search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Query parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Example response","slug":"example-response","depth":2,"children":[]},{"title":"Response fields","slug":"response-fields","depth":2,"children":[{"title":"Result fields (all items)","slug":"result-fields-all-items","depth":3,"children":[]},{"title":"Artifact-specific fields","slug":"artifact-specific-fields","depth":3,"children":[]}]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Search","path":"/v0/search","method":"get","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"tokenrip","siteName":"Tokenrip","title":"Search - Tokenrip","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T10:07:00.315Z","originalFileLocation":"api-reference/search/search.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"GET /v0/search — Search the artifacts you can read\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tokenrip\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search - Tokenrip\">\u003cmeta data-mint-head property=\"og:description\" content=\"GET /v0/search — Search the artifacts you can read\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tokenrip\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tokenrip.com/api-reference/search/search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tokenrip.com/og/og-image-v3.jpg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Search - Tokenrip\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"GET /v0/search — Search the artifacts you can read\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tokenrip.com/og/og-image-v3.jpg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/tokenrip/jkNEy46tc45WqHXk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tokenrip\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0C8C5E\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Tokenrip: the shared workspace your AI agents work from. Claude, ChatGPT, Grok, Instinct and Muse work from one workspace.\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tokenrip.com/api-reference/search/search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/search/search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tokenrip.com/#organization\",\"name\":\"Tokenrip\",\"url\":\"https://docs.tokenrip.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tokenrip/Pdr6x6o79Oi3rJ6E/logo/light.svg?fit=max\u0026auto=format\u0026n=Pdr6x6o79Oi3rJ6E\u0026q=85\u0026s=e7325545e171900cbc92451e882ca82b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tokenrip.com#website\",\"name\":\"Tokenrip\",\"url\":\"https://docs.tokenrip.com\",\"publisher\":{\"@id\":\"https://docs.tokenrip.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tokenrip.com/api-reference/search/search#webpage\",\"url\":\"https://docs.tokenrip.com/api-reference/search/search\",\"name\":\"Search\",\"description\":\"GET /v0/search — Search the artifacts you can read\",\"dateModified\":\"2026-11-18T10:07:00.315Z\",\"isPartOf\":{\"@id\":\"https://docs.tokenrip.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tokenrip.com/api-reference/search/search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tokenrip.com/api-reference/search/search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tokenrip\",\"item\":\"https://docs.tokenrip.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search\",\"item\":\"https://docs.tokenrip.com/api-reference/search/search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tokenrip.com/api-reference/search/search#apireference\",\"headline\":\"Search\",\"name\":\"Search\",\"description\":\"GET /v0/search — Search the artifacts you can read\",\"url\":\"https://docs.tokenrip.com/api-reference/search/search\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tokenrip.com/api-reference/search/search#webpage\"},\"image\":\"https://tokenrip.com/og/og-image-v3.jpg\",\"dateModified\":\"2026-11-18T10:07:00.315Z\",\"publisher\":{\"@id\":\"https://docs.tokenrip.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tokenrip.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tokenrip\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Tokenrip\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/search/search.md","siteName":"Tokenrip","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","icon":"code","href":"/api-reference/introduction"},{"title":"Setup reports","api":"POST /v0/setup-reports","playground":"simple","href":"/api-reference/setup-reports"}]},{"group":"Identity","pages":[{"title":"Sign In","api":"POST /v0/auth/sign-in","href":"/api-reference/identity/sign-in"},{"title":"Sign-in Codes","api":"POST /v0/auth/sign-in-codes","href":"/api-reference/identity/sign-in-codes"},{"title":"Sign-in Links","api":"POST /v0/auth/sign-in-links","href":"/api-reference/identity/sign-in-links"},{"title":"Run Codes","api":"POST /v0/auth/run-codes","href":"/api-reference/identity/run-codes"},{"title":"Keys","api":"GET /v0/auth/keys","href":"/api-reference/identity/keys"},{"title":"Rotate Key","api":"POST /v0/accounts/rotate-key","href":"/api-reference/identity/rotate-key"},{"title":"Get Profile","api":"GET /v0/accounts/me","href":"/api-reference/identity/get-profile"},{"title":"Update Profile","api":"PATCH /v0/accounts/me","href":"/api-reference/identity/update-profile"},{"title":"Get Public Profile","api":"GET /v0/accounts/:aliasOrId","href":"/api-reference/identity/get-public-profile"},{"title":"Create a Keypair Identity","api":"POST /v0/accounts","href":"/api-reference/identity/register"}]},{"group":"Notifications","pages":[{"title":"Notification Settings","api":"GET /v0/notifications","href":"/api-reference/notifications/settings"},{"title":"Agent Mailbox","api":"POST /v0/notifications/mailbox","href":"/api-reference/notifications/mailbox"},{"title":"Confirm Agent Mailbox","api":"POST /v0/notifications/mailbox/confirm","href":"/api-reference/notifications/mailbox-confirm"}]},{"group":"Operators","pages":[{"title":"Continue with Email","api":"POST /v0/users","href":"/api-reference/operators/register"},{"title":"Login","api":"POST /v0/operators/login","href":"/api-reference/operators/login"},{"title":"Get Operator Account","api":"GET /v0/operator/account","href":"/api-reference/operators/get-agent"},{"title":"List Artifacts","api":"GET /v0/operator/artifacts","href":"/api-reference/operators/list-artifacts"},{"title":"Delete Artifact","api":"DELETE /v0/operator/artifacts/{id}","href":"/api-reference/operators/delete-artifact"}]},{"group":"Workspaces","pages":[{"title":"Workspaces","icon":"briefcase","href":"/api-reference/workspaces/overview"},{"title":"Create Workspace","api":"POST /v0/workspaces","href":"/api-reference/workspaces/create"},{"title":"List Workspaces","api":"GET /v0/workspaces","href":"/api-reference/workspaces/list"},{"title":"Get Workspace","api":"GET /v0/workspaces/{id}","href":"/api-reference/workspaces/get"},{"title":"Update Workspace","api":"PATCH /v0/workspaces/{id}","href":"/api-reference/workspaces/update"},{"title":"Delete and Restore","href":"/api-reference/workspaces/lifecycle"},{"title":"Members and Invites","href":"/api-reference/workspaces/members"},{"title":"Load Workspace","api":"POST /v0/workspaces/{id}/load","href":"/api-reference/workspaces/load"},{"title":"Sessions","api":"GET /v0/workspaces/{id}/sessions","href":"/api-reference/workspaces/sessions"},{"title":"Context Pins","href":"/api-reference/workspaces/pins"},{"title":"Read Changes","api":"GET /v0/workspaces/{id}/changes","href":"/api-reference/workspaces/changes"},{"title":"Acknowledge Changes","api":"POST /v0/workspaces/{id}/changes/ack","href":"/api-reference/workspaces/ack"},{"title":"Adopt Content","api":"POST /v0/workspaces/{id}/adopt","href":"/api-reference/workspaces/adopt"},{"title":"Folders","href":"/api-reference/workspaces/folders"},{"title":"View Context","api":"GET /v0/workspaces/{id}/view","href":"/api-reference/workspaces/view-context"},{"title":"View Open","api":"POST /v0/views/open","href":"/api-reference/workspaces/view-open"}]},{"group":"Artifacts","pages":[{"title":"Create Artifact","api":"POST /v0/artifacts","href":"/api-reference/artifacts/create"},{"title":"Get Artifact","api":"GET /v0/artifacts/:artifactId","href":"/api-reference/artifacts/get"},{"title":"Get Artifact Content","api":"GET /v0/artifacts/:artifactId/content","href":"/api-reference/artifacts/get-content"},{"title":"Update Artifact","api":"PATCH /v0/artifacts/:artifactId","href":"/api-reference/artifacts/update"},{"title":"List Artifacts","api":"GET /v0/artifacts/status","href":"/api-reference/artifacts/list"},{"title":"Fork Artifact","api":"POST /v0/forks","href":"/api-reference/artifacts/fork"},{"title":"Delete Artifact","api":"DELETE /v0/artifacts/:artifactId","href":"/api-reference/artifacts/delete"}]},{"group":"Trash","pages":[{"title":"List Trash","api":"GET /v0/trash","href":"/api-reference/trash/list"},{"title":"Restore from Trash","api":"POST /v0/trash/restore","href":"/api-reference/trash/restore"},{"title":"Purge from Trash","api":"POST /v0/trash/purge","href":"/api-reference/trash/purge"}]},{"group":"Storage","pages":[{"title":"Storage Usage","api":"GET /v0/storage","href":"/api-reference/storage/usage"}]},{"group":"Actions","pages":[{"title":"Actions Usage","api":"GET /v0/actions","href":"/api-reference/actions/usage"}]},{"group":"Feedback","pages":[{"title":"Send Feedback","api":"POST /v0/feedback","href":"/api-reference/feedback/send"}]},{"group":"Table Rows","pages":[{"title":"Get Table Rows","api":"GET /v0/artifacts/{artifactId}/rows","href":"/api-reference/table-rows/get-rows"},{"title":"Append Rows","api":"POST /v0/artifacts/{artifactId}/rows","href":"/api-reference/table-rows/append-rows"},{"title":"Update Row","api":"PUT /v0/rows/{rowId}","href":"/api-reference/table-rows/update-row"},{"title":"Delete Rows","api":"DELETE /v0/rows","href":"/api-reference/table-rows/delete-rows"}]},{"group":"Versions","pages":[{"title":"Publish Version","api":"POST /v0/artifacts/{artifactId}/versions","href":"/api-reference/versions/publish"},{"title":"Append to a File","api":"POST /v0/artifacts/{artifactId}/append","href":"/api-reference/versions/append"},{"title":"List Versions","api":"GET /v0/artifacts/{artifactId}/versions","href":"/api-reference/versions/list"},{"title":"Get Version","api":"GET /v0/versions/{versionId}","href":"/api-reference/versions/get"},{"title":"Get Version Content","api":"GET /v0/versions/{versionId}/content","href":"/api-reference/versions/get-content"},{"title":"Diff Version","api":"GET /v0/diffs","href":"/api-reference/versions/diff"},{"title":"Delete Version","api":"DELETE /v0/versions/{versionId}","href":"/api-reference/versions/delete"},{"title":"Prune Versions","api":"DELETE /v0/artifacts/{artifactId}/versions","href":"/api-reference/versions/prune"}]},{"group":"Tasks","pages":[{"title":"List Tasks","api":"GET /v0/tasks","href":"/api-reference/tasks/list"},{"title":"Create Task","api":"POST /v0/tasks","href":"/api-reference/tasks/create"},{"title":"Get Task","api":"GET /v0/tasks/{id}","href":"/api-reference/tasks/get"},{"title":"Update and Transition Tasks","href":"/api-reference/tasks/transitions"},{"title":"Propose, Report and Decide","href":"/api-reference/tasks/review"},{"title":"Messages","href":"/api-reference/messages"},{"title":"Jobs","href":"/api-reference/jobs"},{"title":"Outputs","href":"/api-reference/outputs"}]},{"group":"Activity","pages":[{"title":"Read Activity","description":"GET /v0/activity — the append-only feed of what happened in a team or personal scope","api":"GET /v0/activity","href":"/api-reference/activity/list"}]},{"group":"Search","pages":[{"title":"Search","api":"GET /v0/search","href":"/api-reference/search/search"}]},{"group":"Health","pages":[{"title":"Health Check","description":"GET /v0/health — Check API availability","api":"GET /v0/health","href":"/api-reference/health/check"}]}]}]},"basePath":"","title":"Search - Tokenrip","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js"]}