List documents for a data source

Retrieve documents for a specific API data source. This endpoint requires a data source ID. To get started:

1. Go to the Data sources page
2. Create a new API data source
3. Copy the data source ID from the data source details page
4. Use this ID in the 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

The endpoint is rate limited to 600 requests per minute.

Rate Limits

600 requests per minute.

GET /documents/{data_source_id}

List documents for a data source

cURL

curl --request GET \
  --url https://{subdomain}.withrealm.com/api/external/alpha/documents/{data_source_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "documents": [
    {
      "title": "<string>",
      "content": "<string>",
      "contentType": "markdown",
      "id": "<string>",
      "url": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "meta": {},
      "readAccess": [
        "<string>"
      ]
    }
  ],
  "nextCursor": "<string>"
}

These endpoints require a custom API data source. See Custom API for setup instructions.

Pagination

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.

1. Make a request without a cursor to get the first page of results
2. Use the nextCursor from the response to get the next page
3. Continue until nextCursor is not present

Rate Limits

600 requests per minute.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

data_source_id · string · required

Query Parameters

fields · enum<string>[]

Comma-separated list of fields to return. If not provided, only document IDs are returned.

Available options: id, title, content, content_type, url, document_created_at, document_updated_at, meta

cursor · string

Cursor for pagination. Required for fetching results beyond the first 100 documents.

Pattern: ^\d+$

limit · number · default: 20

Number of documents to return per page. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100

Response

200

application/json

Success

documents · object[] · required

Show child attributes

nextCursor · string