The endpoint uses cursor-based pagination. By default, only document IDs are returned. Use the fields parameter to request additional fields like title, content, url, and meta.
Make a request without a cursor to get the first page of results
Use the nextCursor from the response to get the next page
Optional unique identifier for the document. We enforce uniqueness in our end. If not provided, a UUID will be generated automatically and returned in the response. Must be alphanumeric and can include underscores and hyphens. The order of the documents in the response is the same as the order of the documents in the request, so you can match any generated IDs.
Email addresses of the users that have read access to the document. If not provided, the document can be seen by anyone in Realm. Cannot be an empty array — omit the field instead.
When true, marks this document as verified for this upsert. Send true on every upsert while the source system still treats it as authoritative; omitting it or sending false stops asserting source verification.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Realm Docs","colors":{"primary":"#248573","light":"#248573","dark":"#248573"},"logo":{"light":"https://mintcdn.com/realm/Gmuvv21dZKngXNE6/logo/realm-logo-black.png?fit=max\u0026auto=format\u0026n=Gmuvv21dZKngXNE6\u0026q=85\u0026s=054d513f37788181ce2c55d4757fd72e","dark":"https://mintcdn.com/realm/Gmuvv21dZKngXNE6/logo/realm-logo-white.png?fit=max\u0026auto=format\u0026n=Gmuvv21dZKngXNE6\u0026q=85\u0026s=ba6d5d92f3941cd15b037f313d70d71c"},"favicon":"https://mintcdn.com/realm/s807TVS5W6UrVCCb/favicon.svg?fit=max\u0026auto=format\u0026n=s807TVS5W6UrVCCb\u0026q=85\u0026s=7e7e345794f2034275f8165fcf4e2845","api":{"openapi":"api-reference/openapi.json","params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript","go","ruby","php"],"prefill":true,"autogenerate":true},"url":"full"},"navbar":{"links":[{"href":"mailto:support@withrealm.com","label":"Support"}],"primary":{"type":"button","label":"Open Realm","href":"https://app.withrealm.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/withrealm"}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Product updates","icon":"sparkles","href":"/product-updates"},{"anchor":"Changelog","icon":"newspaper","href":"/changelog"},{"anchor":"Status","icon":"signal-bars","href":"https://status.withrealm.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"realm","hasAudioNarration":false,"actualSubdomain":"realm","customDomains":["docs.withrealm.com"],"gitSource":{"type":"github","owner":"realmtechnologies","repo":"realm","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae5b8f8659f6d05f237ce3d","collectionId":"7cf334c3-ab14-4272-a837-e5e834657bfe","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae5b8f8659f6d05f237ce3d"},"entitlements":{},"buildId":"6ae5b8f8659f6d05f237ce3d","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Admin guide","count":41},{"language":"default","tag":"User guide","count":40},{"language":"default","tag":"List of data sources","count":25},{"language":"default","tag":"API docs","count":15},{"language":"default","tag":"API reference","count":14},{"language":"default","tag":"RFP automation","count":11},{"language":"default","tag":"Agents","count":9},{"language":"default","tag":"Organization settings","count":6},{"language":"default","tag":"Use Realm everywhere","count":6},{"language":"default","tag":"Chats","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"full-page-search","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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/documents/list-documents-for-a-connector","slug":"/api-reference/documents/list-documents-for-a-connector","pageMetadata":{"title":"List documents for a connector","description":"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started:\n\n1. Go to the \u003ca href='/admin/connect'>API Connectors page\u003c/a>\n2. Create a new API Connector\n3. Copy the data source ID from the connector details page\n4. Use this ID in the {data_source_id} path parameter\n\n### Pagination\nThe endpoint uses cursor-based pagination to handle large result sets efficiently. Here's how it works:\n\n1. **First Request**: Make a request without a cursor to get the first page of results\n2. **Subsequent Requests**: Use the `nextCursor` from the previous response to get the next page\n3. **Cursor Format**: The cursor is a string containing digits only.\n4. **End of Results**: When `nextCursor` is `undefined`, you've reached the end of the results\n\nExample pagination flow:\n1. First request: `GET /documents/int_21XZai6JGvd1111J` → Returns first page with `nextCursor`\n2. Next request: `GET /documents/int_21XZai6JGvd1111J?cursor=456` → Returns next page\n3. Continue until `nextCursor` is `undefined`\n\n### Field Selection\nBy default, only document IDs are returned. Use the `fields` parameter to request additional fields:\n- Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta\n- Example: `fields=id,title,content`\n\n### Rate Limits\n\n600 requests per minute.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /documents/{data_source_id}","href":"/api-reference/documents/list-documents-for-a-connector","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h3: \"h3\",\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started:\"\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Go to the \", _jsx(\"a\", {\n href: \"/admin/connect\",\n children: \"API Connectors page\"\n })]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Create a new API Connector\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Copy the data source ID from the connector details page\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Use this ID in the \", \" path parameter\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Pagination\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The endpoint uses cursor-based pagination to handle large result sets efficiently. Here’s how it works:\"\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"First Request\"\n }), \": Make a request without a cursor to get the first page of results\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Subsequent Requests\"\n }), \": Use the \", _jsx(_components.code, {\n children: \"nextCursor\"\n }), \" from the previous response to get the next page\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Cursor Format\"\n }), \": The cursor is a string containing digits only.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"End of Results\"\n }), \": When \", _jsx(_components.code, {\n children: \"nextCursor\"\n }), \" is \", _jsx(_components.code, {\n children: \"undefined\"\n }), \", you’ve reached the end of the results\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Example pagination flow:\"\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"First request: \", _jsx(_components.code, {\n children: \"GET /documents/int_21XZai6JGvd1111J\"\n }), \" → Returns first page with \", _jsx(_components.code, {\n children: \"nextCursor\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Next request: \", _jsx(_components.code, {\n children: \"GET /documents/int_21XZai6JGvd1111J?cursor=456\"\n }), \" → Returns next page\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Continue until \", _jsx(_components.code, {\n children: \"nextCursor\"\n }), \" is \", _jsx(_components.code, {\n children: \"undefined\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Field Selection\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"By default, only document IDs are returned. Use the \", _jsx(_components.code, {\n children: \"fields\"\n }), \" parameter to request additional fields:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Example: \", _jsx(_components.code, {\n children: \"fields=id,title,content\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Rate Limits\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"600 requests per minute.\"\n })]\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`,li:`li`,ol:`ol`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`These endpoints require a custom API data source. See `,_jsx(_components.a,{href:`/admin/data-sources/custom-api`,children:`Custom API`}),` for setup instructions.`]}),`\n`,_jsx(Heading,{level:`3`,id:`pagination`,children:`Pagination`}),`\n`,_jsxs(_components.p,{children:[`The endpoint uses cursor-based pagination. By default, only document IDs are returned. Use the `,_jsx(_components.code,{children:`fields`}),` parameter to request additional fields like `,_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`content`}),`, `,_jsx(_components.code,{children:`url`}),`, and `,_jsx(_components.code,{children:`meta`}),`.`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Make a request without a cursor to get the first page of results`}),`\n`,_jsxs(_components.li,{children:[`Use the `,_jsx(_components.code,{children:`nextCursor`}),` from the response to get the next page`]}),`\n`,_jsxs(_components.li,{children:[`Continue until `,_jsx(_components.code,{children:`nextCursor`}),` is not present`]}),`\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":"List documents for a connector","description":"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started:\n\n1. Go to the \u003ca href='/admin/connect'>API Connectors page\u003c/a>\n2. Create a new API Connector\n3. Copy the data source ID from the connector details page\n4. Use this ID in the {data_source_id} path parameter\n\n### Pagination\nThe endpoint uses cursor-based pagination to handle large result sets efficiently. Here's how it works:\n\n1. **First Request**: Make a request without a cursor to get the first page of results\n2. **Subsequent Requests**: Use the `nextCursor` from the previous response to get the next page\n3. **Cursor Format**: The cursor is a string containing digits only.\n4. **End of Results**: When `nextCursor` is `undefined`, you've reached the end of the results\n\nExample pagination flow:\n1. First request: `GET /documents/int_21XZai6JGvd1111J` → Returns first page with `nextCursor`\n2. Next request: `GET /documents/int_21XZai6JGvd1111J?cursor=456` → Returns next page\n3. Continue until `nextCursor` is `undefined`\n\n### Field Selection\nBy default, only document IDs are returned. Use the `fields` parameter to request additional fields:\n- Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta\n- Example: `fields=id,title,content`\n\n### Rate Limits\n\n600 requests per minute.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /documents/{data_source_id}","href":"/api-reference/documents/list-documents-for-a-connector","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Pagination","slug":"pagination","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listDocuments","description":"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started:\n\n1. Go to the \u003ca href='/admin/connect'>API Connectors page\u003c/a>\n2. Create a new API Connector\n3. Copy the data source ID from the connector details page\n4. Use this ID in the {data_source_id} path parameter\n\n### Pagination\nThe endpoint uses cursor-based pagination to handle large result sets efficiently. Here's how it works:\n\n1. **First Request**: Make a request without a cursor to get the first page of results\n2. **Subsequent Requests**: Use the `nextCursor` from the previous response to get the next page\n3. **Cursor Format**: The cursor is a string containing digits only.\n4. **End of Results**: When `nextCursor` is `undefined`, you've reached the end of the results\n\nExample pagination flow:\n1. First request: `GET /documents/int_21XZai6JGvd1111J` → Returns first page with `nextCursor`\n2. Next request: `GET /documents/int_21XZai6JGvd1111J?cursor=456` → Returns next page\n3. Continue until `nextCursor` is `undefined`\n\n### Field Selection\nBy default, only document IDs are returned. Use the `fields` parameter to request additional fields:\n- Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta\n- Example: `fields=id,title,content`\n\n### Rate Limits\n\n600 requests per minute.","summary":"List documents for a connector","tags":["Documents"],"x-mint":{"content":"These endpoints require a custom API data source. See [Custom API](/admin/data-sources/custom-api) for setup instructions.\n\n### Pagination\n\nThe endpoint uses cursor-based pagination. By default, only document IDs are returned. Use the `fields` parameter to request additional fields like `title`, `content`, `url`, and `meta`.\n\n1. Make a request without a cursor to get the first page of results\n2. Use the `nextCursor` from the response to get the next page\n3. Continue until `nextCursor` is not present"},"security":["4a06bce3-8eb7-4619-af86-033aacba6eff"],"parameters":["731c1271-2e0c-4790-9775-8aa7ef5eeb0b","fd8399af-16a7-40b9-b4de-ab83ad250d91","efa803c0-6f6e-443f-9e89-0cc8024a308c","be79d9a7-ad7e-4582-a3ab-773ff7f245e0"],"responses":{"200":"ee93b419-7eb4-4a23-8818-0d364490d0c0","400":"ce4bcdc7-776e-4cde-adcb-4005de4fcd58","401":"0f56ad52-d656-4602-8888-a60826693afb","403":"3abfe126-e6e5-4d8c-beb4-01ffdcf6c5e9","429":"c83756da-f296-4c5b-b73b-7045964f1d4c","500":"a397f6cc-4adc-4cf9-b760-a4500eacb46e"},"method":"get","type":"path","servers":["431afb04-1374-49ce-bbad-67a46887ccd4","b02b8b10-d94b-41f3-a656-a53db0a82ee7"],"path":"/documents/{data_source_id}","baseUrlOptions":["https://app.withrealm.com/api/external/alpha","https://{tenant}.withrealm.com/api/external/alpha"],"title":"List documents for a connector","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go","ruby","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"731c1271-2e0c-4790-9775-8aa7ef5eeb0b":{"schema":{"type":"string","description":"ID of the custom API data source.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"ID of the custom API data source.","in":"path","example":"ds_kb_main","name":"data_source_id"},"fd8399af-16a7-40b9-b4de-ab83ad250d91":{"schema":{"type":"array","items":{"type":"string","enum":["id","title","content","content_type","url","document_created_at","document_updated_at","meta"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Comma-separated list of fields to return. If not provided, only document IDs are returned.","example":"id,title,content","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[]"},"required":false,"description":"Comma-separated list of fields to return. If not provided, only document IDs are returned.","in":"query","style":"form","explode":false,"name":"fields"},"efa803c0-6f6e-443f-9e89-0cc8024a308c":{"schema":{"type":"string","pattern":"^\\d+$","description":"Cursor for pagination. Required for fetching results beyond the first 100 documents.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Cursor for pagination. Required for fetching results beyond the first 100 documents.","in":"query","example":"100","name":"cursor"},"be79d9a7-ad7e-4582-a3ab-773ff7f245e0":{"schema":{"type":"number","minimum":1,"maximum":100,"default":20,"description":"Number of documents to return per page. Defaults to 20, maximum 100.","isRequired":false,"uniqueKey":"","typeLabel":"number"},"required":false,"description":"Number of documents to return per page. Defaults to 20, maximum 100.","in":"query","example":20,"name":"limit"}},"responses":{"ee93b419-7eb4-4a23-8818-0d364490d0c0":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["documents"],"example":{"documents":[{"id":"doc_42","title":"Getting started with Realm","content":"# Getting started\n\nWelcome to Realm.","contentType":"markdown","url":"https://docs.example.com/getting-started","meta":{"category":"guide"},"readAccess":["alice@example.com"],"verified":true}]},"properties":{"documents":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","isRequired":true,"uniqueKey":"documents.items.[INDEX].title","typeLabel":"string"},"content":{"type":"string","isRequired":true,"uniqueKey":"documents.items.[INDEX].content","typeLabel":"string"},"contentType":{"type":"string","enum":["markdown","text","html"],"isRequired":true,"uniqueKey":"documents.items.[INDEX].contentType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"Optional unique identifier for the document. We enforce uniqueness in our end. If not provided, a UUID will be generated automatically and returned in the response. Must be alphanumeric and can include underscores and hyphens. The order of the documents in the response is the same as the order of the documents in the request, so you can match any generated IDs.","uniqueKey":"documents.items.[INDEX].id","typeLabel":"string"},"url":{"type":"string","format":"uri","uniqueKey":"documents.items.[INDEX].url","typeLabel":"string\u003curi>"},"createdAt":{"type":"string","format":"date-time","description":"UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')","uniqueKey":"documents.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')","uniqueKey":"documents.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"meta":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"documents.items.[INDEX].meta.additionalProperties","typeLabel":"string"},"uniqueKey":"documents.items.[INDEX].meta","typeLabel":"object"},"readAccess":{"type":"array","items":{"type":"string","uniqueKey":"documents.items.[INDEX].readAccess.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Email addresses of the users that have read access to the document. If not provided, the document can be seen by anyone in Realm. Cannot be an empty array — omit the field instead.","uniqueKey":"documents.items.[INDEX].readAccess","typeLabel":"string[]"},"verified":{"type":"boolean","description":"When true, marks this document as verified for this upsert. Send true on every upsert while the source system still treats it as authoritative; omitting it or sending false stops asserting source verification.","uniqueKey":"documents.items.[INDEX].verified","typeLabel":"boolean"}},"required":["title","content","contentType"],"example":{"id":"doc_42","title":"Getting started with Realm","content":"# Getting started\n\nWelcome to Realm.","contentType":"markdown","url":"https://docs.example.com/getting-started","createdAt":"2024-03-20T10:00:00Z","updatedAt":"2024-03-20T10:00:00Z","meta":{"category":"guide"},"readAccess":["alice@example.com"],"verified":true},"uniqueKey":"documents.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"documents","typeLabel":"object[]"},"nextCursor":{"type":"string","uniqueKey":"nextCursor","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"documents":[{"id":"doc_42","title":"Getting started with Realm","content":"# Getting started\n\nWelcome to Realm.","contentType":"markdown","url":"https://docs.example.com/getting-started","meta":{"category":"guide"},"readAccess":["alice@example.com"],"verified":true}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ce4bcdc7-776e-4cde-adcb-4005de4fcd58":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0f56ad52-d656-4602-8888-a60826693afb":{"description":"Unauthorized: missing or invalid API token","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3abfe126-e6e5-4d8c-beb4-01ffdcf6c5e9":{"description":"Forbidden: the API token lacks the required scope, or external API access is not available on the organization's plan","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c83756da-f296-4c5b-b73b-7045964f1d4c":{"description":"Too many requests: rate limit exceeded. Retry after the number of seconds in the Retry-After response header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a397f6cc-4adc-4cf9-b760-a4500eacb46e":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4a06bce3-8eb7-4619-af86-033aacba6eff":{"bearerAuth":{"type":"http","scheme":"bearer","x-default":"YOUR_API_TOKEN","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"431afb04-1374-49ce-bbad-67a46887ccd4":{"url":"https://app.withrealm.com/api/external/alpha","description":"Default multi-tenant environment."},"b02b8b10-d94b-41f3-a656-a53db0a82ee7":{"url":"https://{tenant}.withrealm.com/api/external/alpha","description":"Single-tenant deployment.","variables":{"tenant":{"default":"your-tenant","description":"Your organization's tenant subdomain."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","x-default":"YOUR_API_TOKEN","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","default":"YOUR_API_TOKEN","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"realm","siteName":"Realm Docs","title":"List documents for a connector - Realm Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T10:13:53.561Z","originalFileLocation":"api-reference/documents/list-documents-for-a-connector.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=\"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started: 1. Go to the API Connectors page 2. Create a new API Connector 3. Copy the data source ID from the connector details page 4. Use this ID in the {data_source_id} path parameter ### Pagination The endpoint uses cursor-based pagination to handle large result sets efficiently. Here\u0026#x27;s how it works: 1. First Request: Make a request without a cursor to get the first page of results 2. Subsequent Requests: Use the nextCursor from the previous response to get the next page 3. Cursor Format: The cursor is a string containing digits only. 4. End of Results: When nextCursor is undefined, you\u0026#x27;ve reached the end of the results Example pagination flow: 1. First request: GET /documents/int_21XZai6JGvd1111J → Returns first page with nextCursor 2. Next request: GET /documents/int_21XZai6JGvd1111J?cursor=456 → Returns next page 3. Continue until nextCursor is undefined ### Field Selection By default, only document IDs are returned. Use the fields parameter to request additional fields: - Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta - Example: fields=id,title,content ### Rate Limits 600 requests per minute.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Realm Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/realm/dEivnKfuuuk4hLGf/_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/realm/dEivnKfuuuk4hLGf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/realm/dEivnKfuuuk4hLGf/_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/realm/dEivnKfuuuk4hLGf/_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/realm/dEivnKfuuuk4hLGf/_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/realm/dEivnKfuuuk4hLGf/_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/realm/dEivnKfuuuk4hLGf/_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/realm/dEivnKfuuuk4hLGf/_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/realm/dEivnKfuuuk4hLGf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List documents for a connector - Realm Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started: 1. Go to the API Connectors page 2. Create a new API Connector 3. Copy the data source ID from the connector details page 4. Use this ID in the {data_source_id} path parameter ### Pagination The endpoint uses cursor-based pagination to handle large result sets efficiently. Here\u0026#x27;s how it works: 1. First Request: Make a request without a cursor to get the first page of results 2. Subsequent Requests: Use the nextCursor from the previous response to get the next page 3. Cursor Format: The cursor is a string containing digits only. 4. End of Results: When nextCursor is undefined, you\u0026#x27;ve reached the end of the results Example pagination flow: 1. First request: GET /documents/int_21XZai6JGvd1111J → Returns first page with nextCursor 2. Next request: GET /documents/int_21XZai6JGvd1111J?cursor=456 → Returns next page 3. Continue until nextCursor is undefined ### Field Selection By default, only document IDs are returned. Use the fields parameter to request additional fields: - Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta - Example: fields=id,title,content ### Rate Limits 600 requests per minute.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Realm Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://realm.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=List+documents+for+a+connector\u0026amp;description=Retrieve+documents+for+a+specific+API+Connector.+This+endpoint+requires+a+Data+Source+ID.+To+get+started%3A%0A%0A1.+Go+to+the+%3Ca+href%3D%27%2Fadmin%2Fconnect%27%3EAPI+Connectors+\u0026amp;theme=3d9dc63a89e98274c40227ce\u0026amp;signature=dcae9e5acee75824182c2421e198fce3129cfa8e3ce8edcf95d28f1f3c7303fa\">\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=\"List documents for a connector - Realm Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started: 1. Go to the API Connectors page 2. Create a new API Connector 3. Copy the data source ID from the connector details page 4. Use this ID in the {data_source_id} path parameter ### Pagination The endpoint uses cursor-based pagination to handle large result sets efficiently. Here\u0026#x27;s how it works: 1. First Request: Make a request without a cursor to get the first page of results 2. Subsequent Requests: Use the nextCursor from the previous response to get the next page 3. Cursor Format: The cursor is a string containing digits only. 4. End of Results: When nextCursor is undefined, you\u0026#x27;ve reached the end of the results Example pagination flow: 1. First request: GET /documents/int_21XZai6JGvd1111J → Returns first page with nextCursor 2. Next request: GET /documents/int_21XZai6JGvd1111J?cursor=456 → Returns next page 3. Continue until nextCursor is undefined ### Field Selection By default, only document IDs are returned. Use the fields parameter to request additional fields: - Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta - Example: fields=id,title,content ### Rate Limits 600 requests per minute.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://realm.mintlify.app/_mintlify/api/og/v2?division=Documents\u0026amp;title=List+documents+for+a+connector\u0026amp;description=Retrieve+documents+for+a+specific+API+Connector.+This+endpoint+requires+a+Data+Source+ID.+To+get+started%3A%0A%0A1.+Go+to+the+%3Ca+href%3D%27%2Fadmin%2Fconnect%27%3EAPI+Connectors+\u0026amp;theme=3d9dc63a89e98274c40227ce\u0026amp;signature=dcae9e5acee75824182c2421e198fce3129cfa8e3ce8edcf95d28f1f3c7303fa\">\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/realm/dEivnKfuuuk4hLGf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Realm Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#248573\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/documents/list-documents-for-a-connector.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.withrealm.com/#organization\",\"name\":\"Realm Docs\",\"url\":\"https://docs.withrealm.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/realm/Gmuvv21dZKngXNE6/logo/realm-logo-black.png?fit=max\u0026auto=format\u0026n=Gmuvv21dZKngXNE6\u0026q=85\u0026s=054d513f37788181ce2c55d4757fd72e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.withrealm.com#website\",\"name\":\"Realm Docs\",\"url\":\"https://docs.withrealm.com\",\"publisher\":{\"@id\":\"https://docs.withrealm.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector#webpage\",\"url\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector\",\"name\":\"List documents for a connector\",\"description\":\"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started: 1. Go to the API Connectors page 2. Create a new API Connector 3. Copy the data source ID from the connector details page 4. Use this ID in the {data_source_id} path parameter ### Pagination The endpoint uses cursor-based pagination to handle large result sets efficiently. Here's how it works: 1. First Request: Make a request without a cursor to get the first page of results 2. Subsequent Requests: Use the nextCursor from the previous response to get the next page 3. Cursor Format: The cursor is a string containing digits only. 4. End of Results: When nextCursor is undefined, you've reached the end of the results Example pagination flow: 1. First request: GET /documents/int_21XZai6JGvd1111J → Returns first page with nextCursor 2. Next request: GET /documents/int_21XZai6JGvd1111J?cursor=456 → Returns next page 3. Continue until nextCursor is undefined ### Field Selection By default, only document IDs are returned. Use the fields parameter to request additional fields: - Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta - Example: fields=id,title,content ### Rate Limits 600 requests per minute.\",\"dateModified\":\"2026-10-30T10:13:53.561Z\",\"isPartOf\":{\"@id\":\"https://docs.withrealm.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.withrealm.com/api-reference/connectors/list-api-data-sources\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https://docs.withrealm.com/api-reference/documents/get-a-document\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List documents for a connector\",\"item\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector#apireference\",\"headline\":\"List documents for a connector\",\"name\":\"List documents for a connector\",\"description\":\"Retrieve documents for a specific API Connector. This endpoint requires a Data Source ID. To get started: 1. Go to the API Connectors page 2. Create a new API Connector 3. Copy the data source ID from the connector details page 4. Use this ID in the {data_source_id} path parameter ### Pagination The endpoint uses cursor-based pagination to handle large result sets efficiently. Here's how it works: 1. First Request: Make a request without a cursor to get the first page of results 2. Subsequent Requests: Use the nextCursor from the previous response to get the next page 3. Cursor Format: The cursor is a string containing digits only. 4. End of Results: When nextCursor is undefined, you've reached the end of the results Example pagination flow: 1. First request: GET /documents/int_21XZai6JGvd1111J → Returns first page with nextCursor 2. Next request: GET /documents/int_21XZai6JGvd1111J?cursor=456 → Returns next page 3. Continue until nextCursor is undefined ### Field Selection By default, only document IDs are returned. Use the fields parameter to request additional fields: - Available fields: id, title, content, content_type, url, document_created_at, document_updated_at, meta - Example: fields=id,title,content ### Rate Limits 600 requests per minute.\",\"url\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withrealm.com/api-reference/documents/list-documents-for-a-connector#webpage\"},\"dateModified\":\"2026-10-30T10:13:53.561Z\",\"publisher\":{\"@id\":\"https://docs.withrealm.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.withrealm.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Realm Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Realm Docs","nav":{"global":{"anchors":[{"anchor":"Product updates","icon":"sparkles","href":"/product-updates"},{"anchor":"Changelog","icon":"newspaper","href":"/changelog"},{"anchor":"Status","icon":"signal-bars","href":"https://status.withrealm.com/"}]},"tabs":[{"tab":"User guide","pages":[{"title":"User guide","href":"/introduction"}]},{"tab":"Admin guide","pages":[{"title":"Admin guide","href":"/admin/overview"}]},{"tab":"API docs","groups":[{"group":"API documentation","pages":[{"title":"API Introduction","href":"/api-reference/introduction"}]},{"group":"API reference","pages":[{"group":"Data sources","pages":[{"title":"List API data sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /connectors","href":"/api-reference/connectors/list-api-data-sources"}]},{"group":"Chats","pages":[{"title":"List chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chats","href":"/api-reference/chats/list-chats"},{"title":"Create or continue a chat","deprecated":null,"version":null,"sidebarTitle":"Create chat","openapi":"/api-reference/openapi.json post /chats","href":"/api-reference/chats/create-or-continue-a-chat"},{"title":"Create or continue a chat with a streaming response","deprecated":null,"version":null,"sidebarTitle":"Create chat (streaming)","openapi":"/api-reference/openapi.json post /chats-streaming","href":"/api-reference/chats/create-or-continue-a-chat-with-a-streaming-response"},{"title":"Get chat's messages","deprecated":null,"version":null,"sidebarTitle":"Get messages","openapi":"/api-reference/openapi.json get /chats/{chat_id}","href":"/api-reference/chats/get-chats-messages"},{"title":"Delete a chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /chats/{chat_id}","href":"/api-reference/chats/delete-a-chat"},{"title":"Resume a paused chat after tool approval","deprecated":null,"version":null,"sidebarTitle":"Resume approvals","openapi":"/api-reference/openapi.json post /chats/{chat_id}/approvals","href":"/api-reference/chats/resume-a-paused-chat-after-tool-approval"}]},{"group":"Documents","pages":[{"title":"Get a document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /documents/{data_source_id}/{document_id}","href":"/api-reference/documents/get-a-document"},{"title":"Delete a document","description":"Delete a specific document by ID. You need to create an API Connector to use this endpoint. Head over to the \u003ca href='/admin/connect'>Connectors page\u003c/a> to create a new API Connector.\n\n### Rate Limits\n\n600 requests per minute.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /documents/{data_source_id}/{document_id}","href":"/api-reference/documents/delete-a-document"},{"title":"List documents for a connector","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /documents/{data_source_id}","href":"/api-reference/documents/list-documents-for-a-connector"},{"title":"Upsert documents","description":"Create or update one or more documents. This endpoint requires a Data Source ID. To get started:\n\n1. Go to the \u003ca href='/admin/connect'>Connectors page\u003c/a>\n2. Create a new API Connector\n3. Copy the data source ID from the connector details page\n4. Use this ID in the {data_source_id} path parameter\n\nAlternatively, you can use the /connectors endpoint to programmatically fetch available API connectors.\n\nThe writes will be queued and processed in the background.\n\nSend a maximum of 100 documents per request.\n\n### Rate Limits\n\n600 requests per minute.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/{data_source_id}","href":"/api-reference/documents/upsert-documents"},{"title":"Delete documents older than a specified timestamp","deprecated":null,"version":null,"sidebarTitle":"Delete older documents","openapi":"/api-reference/openapi.json delete /documents/{data_source_id}","href":"/api-reference/documents/delete-documents-older-than-a-specified-timestamp"},{"title":"Upload a file","deprecated":null,"version":null,"sidebarTitle":"Upload file","openapi":"/api-reference/openapi.json post /documents/{data_source_id}/upload","href":"/api-reference/documents/upload-a-file"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-agents"}]}]}]}]},"basePath":"","title":"List documents for a connector - Realm Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}