Browse documents in a knowledge source

GET

knowledge

sources

{sourceId}

documents

Error

A valid request URL is required to generate request examples

{
  "documents": [
    {
      "id": "<string>",
      "title": "<string>",
      "kind": "<string>",
      "url": "<string>",
      "updatedAt": "<string>",
      "workspaceId": "<string>",
      "workspaceLabel": "<string>"
    }
  ],
  "totalCount": 1,
  "hasMore": true,
  "nextCursor": "<string>",
  "workspaceLabel": "<string>",
  "cachedAt": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "code": "browsing_unavailable",
  "detail": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Scopes

knowledge:read

Path Parameters

sourceId

string<uuid>

required

Knowledge source identifier.

Query Parameters

string

Optional provider search text. A search always runs live against the provider and is never cached.

Maximum string length: 500

cursor

string

Opaque continuation value from nextCursor. Pass it back unchanged with the same search text.

Maximum string length: 4096

refresh

enum<string>

Skip the cached list and rebuild it from the provider. Without it, a plain listing produced in the last 15 minutes for the same connected account is returned; cachedAt in the response says when.

Available options:

true,

1

Response

Provider-neutral document list.

documents

object[]

required

Show child attributes

totalCount

integer

required

Required range: x >= 0

hasMore

boolean

required

nextCursor

string | null

required

Opaque continuation value for the next page, or null when there is no next page.

workspaceLabel

string | null

required

cachedAt

string<date-time> | null

required

When this list was produced, if it came from the cache; null when it was produced by this request.

Error

A valid request URL is required to generate request examples

{
  "documents": [
    {
      "id": "<string>",
      "title": "<string>",
      "kind": "<string>",
      "url": "<string>",
      "updatedAt": "<string>",
      "workspaceId": "<string>",
      "workspaceLabel": "<string>"
    }
  ],
  "totalCount": 1,
  "hasMore": true,
  "nextCursor": "<string>",
  "workspaceLabel": "<string>",
  "cachedAt": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "code": "browsing_unavailable",
  "detail": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Domains

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Repositories

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Browse documents in a knowledge source

Authorizations

Scopes

Path Parameters

Query Parameters

Response