Use this endpoint when a search result looks relevant and you need more of the surrounding text. Pass the pointer from a search result passage.Use direction to choose which side to read: around (default), before, or after. Use maxTokens to limit the size of the response. It defaults to 2000 and cannot exceed 32000. At least one chunk is always returned, even if that chunk alone is larger than maxTokens.The response includes prev and next pointers for the neighboring chunks, or null at the start or end of the document. Pass either one back to this endpoint to keep reading in that direction.If the pointer doesn’t exist or the user doesn’t have access to it, the request returns a 404 with the error code RESOURCE_NOT_FOUND. Run a new search to get a fresh pointer.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paragon Documentation","colors":{"primary":"#6645e6","light":"#6747e7","dark":"#6645e6"},"logo":{"light":"https://mintcdn.com/paragon/VsFfcYgo5-Qm6khT/logo/light.svg?fit=max\u0026auto=format\u0026n=VsFfcYgo5-Qm6khT\u0026q=85\u0026s=348909bc26f6451e89f4010d965f6e3f","dark":"https://mintcdn.com/paragon/VsFfcYgo5-Qm6khT/logo/dark.svg?fit=max\u0026auto=format\u0026n=VsFfcYgo5-Qm6khT\u0026q=85\u0026s=94df13e90b5d4116e55d031d5583fa1b","href":"https://docs.useparagon.com/"},"favicon":"https://mintcdn.com/paragon/jHdUQ3U2jexiiVjS/favicon.png?fit=max\u0026auto=format\u0026n=jHdUQ3U2jexiiVjS\u0026q=85\u0026s=92cb5c619d517e9c751282890f36033e","api":{"playground":{"proxy":false}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://dashboard.useparagon.com/signup","label":"Sign up"}],"primary":{"type":"button","label":"Book a demo","href":"https://www.useparagon.com/book-demo"}},"footer":{"links":[{"header":"Home","items":[{"label":"Home","href":"https://www.useparagon.com"},{"label":"Sign Up","href":"https://dashboard.useparagon.com/signup"},{"label":"Book Demo","href":"https://www.useparagon.com/book-demo"},{"label":"Pricing","href":"https://www.useparagon.com/pricing"},{"label":"Careers","href":"https://www.useparagon.com/careers"}]},{"header":"Resources","items":[{"label":"Blog","href":"https://www.useparagon.com/blog"},{"label":"Case Studies","href":"https://www.useparagon.com/customers"},{"label":"ActionKit Playground","href":"https://try.actions.useparagon.com"},{"label":"Sync Playground","href":"https://try.sync.useparagon.com"},{"label":"Product Tour","href":"https://www.useparagon.com/product-tour-landing"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://www.useparagon.com/privacy-policy"},{"label":"Terms of Service","href":"https://www.useparagon.com/terms-of-service"},{"label":"Your Privacy Choices","href":"/optout"}]}]},"fonts":{"heading":{"family":"Helvetica Now Display Medium","weight":400,"source":"https://framerusercontent.com/assets/OKeqk0lRqQ5xtPOYZPiID295g.woff2","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-DH6VCLG1X6"},"gtm":{"tagId":"GTM-WCJFR4H"},"cookies":{"key":"paragon_docs_integrations_consent","value":"granted"}},"errors":{"404":{"redirect":false}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paragon","hasAudioNarration":false,"actualSubdomain":"paragon","customDomains":["docs.useparagon.com"],"gitSource":{"type":"github","owner":"useparagon-internal","repo":"docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3c95c97b1ae3164b1afaa","collectionId":"0d0c583a-8145-4f79-88fb-810e552b4378","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3c95c97b1ae3164b1afaa"},"feedback":{"edits":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3c95c97b1ae3164b1afaa","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"ActionKit","count":1114},{"language":"default","tag":"Integrations Reference","count":1103},{"language":"default","tag":"Tools","count":863},{"language":"default","tag":"Triggers","count":147},{"language":"default","tag":"Integrations","count":126},{"language":"default","tag":"Integration Providers","count":126},{"language":"default","tag":"Managed Sync","count":67},{"language":"default","tag":"Platform","count":56},{"language":"default","tag":"Workflows","count":54},{"language":"default","tag":"Salesforce","count":51}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#top-aligned-table td{vertical-align:top;padding:8px}#footer a[href='/optout']{overflow:auto;max-width:100%}footer>div{padding-top:4rem!important}a.nav-tabs-item[href=\"/resources/integrations\"]{margin-left:auto}div.nav-tabs{width:100%}"}],"page":{"pagePath":"agent-os/context/read-segment","slug":"/agent-os/context/read-segment","pageMetadata":{"title":"Read Segment Context","openapi":"agent-os/openapi/context.json GET /api/context/projects/{projectId}/segments/{pointer}/context","description":"Read the text before and after a passage returned by search.","href":"/agent-os/context/read-segment","hidden":true},"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: \"Read the text before and after a passage returned by search.\"\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={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Use this endpoint when a search result looks relevant and you need more of the surrounding text. Pass the `,_jsx(_components.code,{children:`pointer`}),` from a search result passage.`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`direction`}),` to choose which side to read: `,_jsx(_components.code,{children:`around`}),` (default), `,_jsx(_components.code,{children:`before`}),`, or `,_jsx(_components.code,{children:`after`}),`. Use `,_jsx(_components.code,{children:`maxTokens`}),` to limit the size of the response. It defaults to 2000 and cannot exceed 32000. At least one chunk is always returned, even if that chunk alone is larger than `,_jsx(_components.code,{children:`maxTokens`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The response includes `,_jsx(_components.code,{children:`prev`}),` and `,_jsx(_components.code,{children:`next`}),` pointers for the neighboring chunks, or `,_jsx(_components.code,{children:`null`}),` at the start or end of the document. Pass either one back to this endpoint to keep reading in that direction.`]}),`\n`,_jsxs(_components.p,{children:[`If the pointer doesn’t exist or the user doesn’t have access to it, the request returns a `,_jsx(_components.code,{children:`404`}),` with the error code `,_jsx(_components.code,{children:`RESOURCE_NOT_FOUND`}),`. Run a new search to get a fresh pointer.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`javascript`,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:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\" `https://agentos.useparagon.com/api/context/projects/\"}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`projectId`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/segments/`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`pointer`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/context?direction=around\u0026maxTokens=2000\u0026identity=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`encodeURIComponent`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"[email protected]\"`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#D4D4D4`},children:`)`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},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:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:\" `Bearer \"}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:\"${\"}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`paragonUserToken`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#569CD6`},children:`}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},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`]})})})]})}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":"Read Segment Context","openapi":"agent-os/openapi/context.json GET /api/context/projects/{projectId}/segments/{pointer}/context","description":"Read the text before and after a passage returned by search.","href":"/agent-os/context/read-segment","hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paragon/b66e6962cf6c82d8/cookiebot-mintlify-consent.js"],"openApiReferenceData":{"operation":{"operationId":"readSegmentContext","summary":"Read Segment Context","parameters":["c9822558-11c6-40f0-a11e-eb048f5b887e","cac3e186-4a73-4ca8-8cc7-b2ec4fd5ce8a","e28ca601-1037-4f7e-bb0f-0dbe3547f4a0","e58a1f11-d5bb-4f00-a21f-e742d6622034","6480da7f-2f26-46ac-95ad-66914fd08474","e51f6e49-56b6-467b-8b5d-a7d339bdf629"],"responses":{"200":"db85269c-9694-4aa5-8ab7-45b7ac0459b7","400":"80b41794-a48c-434e-b748-0e13a3e99fb5","401":"7669f4a8-62cf-484d-8188-f3da36ac9f42","403":"b4db0b55-7e98-405f-8da1-457f19f3c6be","404":"7ed9207d-acec-4387-997b-2b78399d4edc"},"method":"get","type":"path","servers":["fc5612b4-9e2f-4bee-858a-bbb4fd535e91","e1dcb1e7-e971-4515-b2ca-f116dc91bf8e"],"security":["4262337b-503e-4835-bfce-3b78856e25f1"],"path":"/api/context/projects/{projectId}/segments/{pointer}/context","baseUrlOptions":["https://agentos.useparagon.com","https://agentos.eu.paragon.so"],"title":"Read Segment Context","description":"Read the text before and after a passage returned by search.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"c9822558-11c6-40f0-a11e-eb048f5b887e":{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Your Paragon Project ID. Must match the Project ID in your Paragon User Token.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Your Paragon Project ID. Must match the Project ID in your Paragon User Token."},"cac3e186-4a73-4ca8-8cc7-b2ec4fd5ce8a":{"name":"pointer","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The pointer from a passage in a search result.","uniqueKey":"","typeLabel":"string"},"description":"The pointer from a passage in a search result."},"e28ca601-1037-4f7e-bb0f-0dbe3547f4a0":{"name":"direction","in":"query","description":"Which side of the pointer to read: around it, before it, or after it.","schema":{"type":"string","enum":["around","before","after"],"default":"around","description":"Which side of the pointer to read: around it, before it, or after it.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"e58a1f11-d5bb-4f00-a21f-e742d6622034":{"name":"maxTokens","in":"query","description":"The maximum number of tokens to return. At least one chunk is always returned, even if it is larger than this limit.","schema":{"type":"integer","minimum":1,"maximum":32000,"default":2000,"description":"The maximum number of tokens to return. At least one chunk is always returned, even if it is larger than this limit.","uniqueKey":"","typeLabel":"integer"}},"6480da7f-2f26-46ac-95ad-66914fd08474":{"name":"identity","in":"query","schema":{"type":"string","maxLength":1024,"description":"The account whose access applies, used on every source. Unlike search, this endpoint accepts a single string only.","uniqueKey":"","typeLabel":"string"},"description":"The account whose access applies, used on every source. Unlike search, this endpoint accepts a single string only."},"e51f6e49-56b6-467b-8b5d-a7d339bdf629":{"name":"email","in":"query","description":"Deprecated. Use identity instead.","schema":{"type":"string","maxLength":1024,"deprecated":true,"description":"Deprecated. Use identity instead.","uniqueKey":"","typeLabel":"string"}}},"responses":{"db85269c-9694-4aa5-8ab7-45b7ac0459b7":{"description":"The text around the pointer.","content":{"application/json":{"schema":{"type":"object","required":["id","text","prev","next","tokenBudget","tokenizer"],"properties":{"id":{"type":"string","description":"Unique ID for the record, in the format {syncId}.{recordId}.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"text":{"type":"string","description":"The text around the pointer.","isRequired":true,"uniqueKey":"text","typeLabel":"string"},"prev":{"oneOf":[{"type":"string","description":"Pointer to the chunk before this text, or null if this is the start of the record.","isRequired":true,"uniqueKey":"prev.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pointer to the chunk before this text, or null if this is the start of the record.","isRequired":true,"uniqueKey":"prev.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prev","typeLabel":"string | null"},"next":{"oneOf":[{"type":"string","description":"Pointer to the chunk after this text, or null if this is the end of the record.","isRequired":true,"uniqueKey":"next.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pointer to the chunk after this text, or null if this is the end of the record.","isRequired":true,"uniqueKey":"next.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next","typeLabel":"string | null"},"tokenBudget":{"type":"object","required":["returnedTokens"],"description":"How much text was returned.","properties":{"returnedTokens":{"type":"integer","description":"The number of tokens in text.","isRequired":true,"uniqueKey":"tokenBudget.returnedTokens","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"tokenBudget","typeLabel":"object"},"tokenizer":{"type":"string","enum":["o200k_base"],"description":"The tokenizer used to count tokens.","isRequired":true,"uniqueKey":"tokenizer","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"6f1c0b2e-1a2b-4c3d-8e9f-0a1b2c3d4e5f.rec_1","text":"# Q2 roadmap\nThe Q2 roadmap covers launch dates.","prev":null,"next":"chk_next","tokenBudget":{"returnedTokens":18},"tokenizer":"o200k_base"},"examples":{"Example":{"title":"Example","value":{"id":"6f1c0b2e-1a2b-4c3d-8e9f-0a1b2c3d4e5f.rec_1","text":"# Q2 roadmap\nThe Q2 roadmap covers launch dates.","prev":null,"next":"chk_next","tokenBudget":{"returnedTokens":18},"tokenizer":"o200k_base"}}},"exampleType":"examples"}},"exampleType":"examples"},"80b41794-a48c-434e-b748-0e13a3e99fb5":{"description":"The request failed. See the error object for details.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","hint","retryable","requestId"],"properties":{"code":{"type":"string","description":"A stable error code you can handle in your code, such as REQUEST_INVALID.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"hint":{"type":"string","description":"Suggested next step to resolve the error.","isRequired":true,"uniqueKey":"error.hint","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the same request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"Include this ID when contacting Paragon support about a request.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"retryAfterMs":{"type":"integer","description":"How long to wait before retrying, in milliseconds. Only present when retryable is true.","uniqueKey":"error.retryAfterMs","typeLabel":"integer"},"details":{"type":"array","description":"Present on validation errors. Lists the fields that failed validation.","items":{"type":"object","required":["field","issue"],"properties":{"field":{"type":"string","description":"The field that failed validation.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"What was wrong with the field.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","hint":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","retryAfterMs":123,"details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"7669f4a8-62cf-484d-8188-f3da36ac9f42":{"description":"The request failed. See the error object for details.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","hint","retryable","requestId"],"properties":{"code":{"type":"string","description":"A stable error code you can handle in your code, such as REQUEST_INVALID.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"hint":{"type":"string","description":"Suggested next step to resolve the error.","isRequired":true,"uniqueKey":"error.hint","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the same request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"Include this ID when contacting Paragon support about a request.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"retryAfterMs":{"type":"integer","description":"How long to wait before retrying, in milliseconds. Only present when retryable is true.","uniqueKey":"error.retryAfterMs","typeLabel":"integer"},"details":{"type":"array","description":"Present on validation errors. Lists the fields that failed validation.","items":{"type":"object","required":["field","issue"],"properties":{"field":{"type":"string","description":"The field that failed validation.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"What was wrong with the field.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","hint":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","retryAfterMs":123,"details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"b4db0b55-7e98-405f-8da1-457f19f3c6be":{"description":"The request failed. See the error object for details.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","hint","retryable","requestId"],"properties":{"code":{"type":"string","description":"A stable error code you can handle in your code, such as REQUEST_INVALID.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"hint":{"type":"string","description":"Suggested next step to resolve the error.","isRequired":true,"uniqueKey":"error.hint","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the same request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"Include this ID when contacting Paragon support about a request.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"retryAfterMs":{"type":"integer","description":"How long to wait before retrying, in milliseconds. Only present when retryable is true.","uniqueKey":"error.retryAfterMs","typeLabel":"integer"},"details":{"type":"array","description":"Present on validation errors. Lists the fields that failed validation.","items":{"type":"object","required":["field","issue"],"properties":{"field":{"type":"string","description":"The field that failed validation.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"What was wrong with the field.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","hint":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","retryAfterMs":123,"details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"7ed9207d-acec-4387-997b-2b78399d4edc":{"description":"The request failed. See the error object for details.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","hint","retryable","requestId"],"properties":{"code":{"type":"string","description":"A stable error code you can handle in your code, such as REQUEST_INVALID.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"hint":{"type":"string","description":"Suggested next step to resolve the error.","isRequired":true,"uniqueKey":"error.hint","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether retrying the same request may succeed.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"requestId":{"type":"string","description":"Include this ID when contacting Paragon support about a request.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"retryAfterMs":{"type":"integer","description":"How long to wait before retrying, in milliseconds. Only present when retryable is true.","uniqueKey":"error.retryAfterMs","typeLabel":"integer"},"details":{"type":"array","description":"Present on validation errors. Lists the fields that failed validation.","items":{"type":"object","required":["field","issue"],"properties":{"field":{"type":"string","description":"The field that failed validation.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"issue":{"type":"string","description":"What was wrong with the field.","isRequired":true,"uniqueKey":"error.details.items.[INDEX].issue","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","hint":"\u003cstring>","retryable":true,"requestId":"\u003cstring>","retryAfterMs":123,"details":[{"field":"\u003cstring>","issue":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4262337b-503e-4835-bfce-3b78856e25f1":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Your [Paragon User Token](/getting-started/installing-the-connect-sdk#setup) (JWT), which you can generate using your project's signing keys.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"fc5612b4-9e2f-4bee-858a-bbb4fd535e91":{"url":"https://agentos.useparagon.com","description":"Production US Cloud"},"e1dcb1e7-e971-4515-b2ca-f116dc91bf8e":{"url":"https://agentos.eu.paragon.so","description":"Production EU Cloud"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Your [Paragon User Token](/getting-started/installing-the-connect-sdk#setup) (JWT), which you can generate using your project's signing keys.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your [Paragon User Token](/getting-started/installing-the-connect-sdk#setup) (JWT), which you can generate using your project's signing keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"agent-os/openapi/context.json"},"subdomain":"paragon","siteName":"Paragon Documentation","title":"Read Segment Context - Paragon Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T04:53:18.129Z","originalFileLocation":"agent-os/context/read-segment.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=\"Read the text before and after a passage returned by search.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paragon Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_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/paragon/jEl23Mfv0t0lim0x/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_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/paragon/jEl23Mfv0t0lim0x/_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/paragon/jEl23Mfv0t0lim0x/_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/paragon/jEl23Mfv0t0lim0x/_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/paragon/jEl23Mfv0t0lim0x/_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/paragon/jEl23Mfv0t0lim0x/_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/paragon/jEl23Mfv0t0lim0x/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read Segment Context - Paragon Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read the text before and after a passage returned by search.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paragon Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useparagon.com/agent-os/context/read-segment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paragon.mintlify.app/_mintlify/api/og/v2?division=Context\u0026amp;title=Read+Segment+Context\u0026amp;description=Read+the+text+before+and+after+a+passage+returned+by+search.\u0026amp;theme=13788743c298c81ac0d08ae9\u0026amp;signature=d4e8a78261ba8e20d409ba23188320b4c8b90024b0c31581b9a4c9a73e268bf9\">\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=\"Read Segment Context - Paragon Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read the text before and after a passage returned by search.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paragon.mintlify.app/_mintlify/api/og/v2?division=Context\u0026amp;title=Read+Segment+Context\u0026amp;description=Read+the+text+before+and+after+a+passage+returned+by+search.\u0026amp;theme=13788743c298c81ac0d08ae9\u0026amp;signature=d4e8a78261ba8e20d409ba23188320b4c8b90024b0c31581b9a4c9a73e268bf9\">\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/paragon/jEl23Mfv0t0lim0x/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paragon Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6645e6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.useparagon.com/agent-os/context/read-segment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/agent-os/context/read-segment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.useparagon.com/#organization\",\"name\":\"Paragon Documentation\",\"url\":\"https://docs.useparagon.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paragon/VsFfcYgo5-Qm6khT/logo/light.svg?fit=max\u0026auto=format\u0026n=VsFfcYgo5-Qm6khT\u0026q=85\u0026s=348909bc26f6451e89f4010d965f6e3f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.useparagon.com#website\",\"name\":\"Paragon Documentation\",\"url\":\"https://docs.useparagon.com\",\"publisher\":{\"@id\":\"https://docs.useparagon.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.useparagon.com/agent-os/context/read-segment#webpage\",\"url\":\"https://docs.useparagon.com/agent-os/context/read-segment\",\"name\":\"Read Segment Context\",\"description\":\"Read the text before and after a passage returned by search.\",\"dateModified\":\"2026-10-29T04:53:18.129Z\",\"isPartOf\":{\"@id\":\"https://docs.useparagon.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useparagon.com/agent-os/context/read-segment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useparagon.com/agent-os/context/read-segment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Context\",\"item\":\"https://docs.useparagon.com/agent-os/context/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read Segment Context\",\"item\":\"https://docs.useparagon.com/agent-os/context/read-segment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.useparagon.com/agent-os/context/read-segment#apireference\",\"headline\":\"Read Segment Context\",\"name\":\"Read Segment Context\",\"description\":\"Read the text before and after a passage returned by search.\",\"url\":\"https://docs.useparagon.com/agent-os/context/read-segment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useparagon.com/agent-os/context/read-segment#webpage\"},\"dateModified\":\"2026-10-29T04:53:18.129Z\",\"publisher\":{\"@id\":\"https://docs.useparagon.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.useparagon.com#website\"}}]}\u003c/script>","siteName":"Paragon Documentation","nav":{"global":null,"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":"/overview"}]},{"tab":"Agent OS","hidden":true,"groups":[{"group":"Agent OS","pages":[{"title":"Agent OS","sidebarTitle":"Overview","mode":"wide","description":"Build agents that can retrieve context, choose tools, and take action across your users' connected apps.","href":"/agent-os/overview"},{"title":"Getting Started","description":"Authenticate your users, send them a Setup Link, and make your first Context API and Tools API calls.","href":"/agent-os/getting-started"}]},{"group":"Context","pages":[{"title":"Context API","sidebarTitle":"Overview","description":"Search your users' synced content and read the text around a search result.","href":"/agent-os/context/overview"},{"title":"Create Setup Link","openapi":"agent-os/openapi/context.json POST /projects/{projectId}/setup-links","description":"Create a hosted link where a user connects the sources Agent OS can search.","href":"/agent-os/context/create-setup-link"},{"title":"Search Context","openapi":"agent-os/openapi/context.json POST /api/context/projects/{projectId}/search","description":"Search your users' synced content and return the best matching passages.","href":"/agent-os/context/search"},{"title":"Read Segment Context","openapi":"agent-os/openapi/context.json GET /api/context/projects/{projectId}/segments/{pointer}/context","href":"/agent-os/context/read-segment"}]},{"group":"Tools","pages":[{"title":"Tools API","sidebarTitle":"Overview","description":"Give your agent the capabilities it needs to act across your users' connected apps.","href":"/agent-os/tools/overview"},{"title":"Search Tools","openapi":"agent-os/openapi/tools.json POST /api/tools/projects/{projectId}/tools/search","description":"Search the Paragon catalog for relevant Tools to use for a conversation turn.","href":"/agent-os/tools/search"},{"title":"Run Tool","openapi":"agent-os/openapi/tools.json POST /api/tools/projects/{projectId}/executions","description":"Run a tool on behalf of a Connected User.","href":"/agent-os/tools/create-execution"},{"title":"Get Result","openapi":"agent-os/openapi/tools.json GET /api/tools/projects/{projectId}/results/{resultId}","description":"Read the envelope for a stored tool result.","href":"/agent-os/tools/get-result"},{"title":"Get Result Rows","openapi":"agent-os/openapi/tools.json GET /api/tools/projects/{projectId}/results/{resultId}/rows","description":"Filter and page through records in a stored tool result.","href":"/agent-os/tools/get-result-rows"},{"title":"Get Result Content","openapi":"agent-os/openapi/tools.json GET /api/tools/projects/{projectId}/results/{resultId}/content","description":"Read a character slice of a text-shaped stored result.","href":"/agent-os/tools/get-result-content"},{"title":"Get Execution","openapi":"agent-os/openapi/tools.json GET /api/tools/projects/{projectId}/executions/{executionId}","description":"Read an execution, optionally waiting while it is still running.","href":"/agent-os/tools/get-execution"},{"title":"Cancel Execution","openapi":"agent-os/openapi/tools.json POST /api/tools/projects/{projectId}/executions/{executionId}/cancel","description":"Cancel a running execution.","href":"/agent-os/tools/cancel-execution"},{"title":"Get Tool","openapi":"agent-os/openapi/tools.json GET /api/tools/projects/{projectId}/tools/{intentName}","description":"Fetch one tool definition by its tool name.","href":"/agent-os/tools/get-tool"}]}]},{"tab":"Managed Sync","icon":"https://mintlify.s3.us-west-1.amazonaws.com/paragon/assets/sync-icon-light.svg","pages":[{"title":"Managed Sync","href":"/managed-sync/overview"}]},{"tab":"ActionKit","icon":"https://mintlify.s3.us-west-1.amazonaws.com/paragon/assets/actions-icon-light.svg","pages":[{"title":"ActionKit","href":"/actionkit/overview"}]},{"tab":"Workflows","icon":"https://mintlify.s3.us-west-1.amazonaws.com/paragon/assets/workflow-icon-light.svg","pages":[{"title":"Workflows","href":"/workflows/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/resources/integrations"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/apis/api-reference"}]},{"tab":"Guides","menu":[{"item":"Home","pages":[{"title":"Home","href":"/guides"}]},{"item":"Authentication","groups":[{"group":"Authentication","pages":[{"title":"Authentication","href":"/tutorials/building-an-in-app-integrations-catalog"}]}],"global":{"anchors":[{"anchor":"Back to all guides","icon":"arrow-left","href":"/guides"}]}},{"item":"Deploying Integrations","groups":[{"group":"Deploying Integrations","pages":[{"title":"Deploying Integrations","href":"/knowledge-base/git-sync-missing-commits"}]}],"global":{"anchors":[{"anchor":"Back to all guides","icon":"arrow-left","href":"/guides"}]}},{"item":"Custom Integrations or Webhooks","groups":[{"group":"Custom Integrations or Webhooks","pages":[{"title":"Custom Integrations or Webhooks","href":"/knowledge-base/api-base-url-ip-403"}]}],"global":{"anchors":[{"anchor":"Back to all guides","icon":"arrow-left","href":"/guides"}]}},{"item":"Billing and Account Management","groups":[{"group":"Billing and Account Management","pages":[{"title":"Billing and Account Management","href":"/knowledge-base/email-invite-404"}]}],"global":{"anchors":[{"anchor":"Back to all guides","icon":"arrow-left","href":"/guides"}]}},{"item":"ActionKit","groups":[{"group":"ActionKit","pages":[{"title":"ActionKit","href":"/actionkit/actionkit-for-tool-calling"}]}],"global":{"anchors":[{"anchor":"Back to all guides","icon":"arrow-left","href":"/guides"}]}},{"item":"Workflows","groups":[{"group":"Workflows","pages":[{"title":"Workflows","href":"/tutorials/building-a-salesforce-integration"}]}],"global":{"anchors":[{"anchor":"Back to all guides","icon":"arrow-left","href":"/guides"}]}}],"pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/changelog/product-updates"}]}]},"title":"Read Segment Context - Paragon Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}