Skip to navigation

List knowledge sources

List source metadata. Defaults to owner_type=workspace. owner_type=agent selects agent-owned sources; owner_agent_id then narrows owners. attached_agent_id is a separate any-selected-agent filter. All filters are ANDed. Ownership is not a permission; access follows the key capabilities. ID-list filters use repeated query names. Raw supplied ID count across fields is at most 100. Cursor binds normalized filters; filtered lists are not exact batch retrieval.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Query parameters

limitintegerOptional1-200Defaults to 50

Page size; 50 by default, at most 200.

cursorstringOptional
Opaque cursor bound to the workspace, every filter, grouping and limit. Send them unchanged with it. Expires after 24 hours.
source_idlist of stringsOptional

Repeat the query name for multiple IDs. OR within this field; AND across fields. Maximum 100 raw ID entries total across all ID filters. Blank values are invalid. Unknown/inaccessible IDs produce no rows, not an existence disclosure. An empty array is invalid and refused: SDKs refuse it before sending, and the server refuses an empty or blank value. Omission means no filter.

owner_agent_idlist of stringsOptional

Repeat the query name for multiple IDs. OR within this field; AND across fields. Maximum 100 raw ID entries total across all ID filters. Blank values are invalid. Unknown/inaccessible IDs produce no rows, not an existence disclosure. An empty array is invalid and refused: SDKs refuse it before sending, and the server refuses an empty or blank value. Omission means no filter.

attached_agent_idlist of stringsOptional

Repeat the query name for multiple IDs. OR within this field; AND across fields. Maximum 100 raw ID entries total across all ID filters. Blank values are invalid. Unknown/inaccessible IDs produce no rows, not an existence disclosure. An empty array is invalid and refused: SDKs refuse it before sending, and the server refuses an empty or blank value. Omission means no filter.

owner_typeenumOptionalDefaults to workspace

owner_agent_id requires owner_type=agent.

Allowed values:
statelist of enumsOptional

Omitted excludes archived sources. Repeat for OR within this field; AND with other fields. These are not ID entries; at most 16 values per field, the same bound as the POST form. An empty array is invalid and refused: SDKs refuse it before sending, and the server refuses an empty or blank value. Omission means no filter.

resource_keylist of stringsOptional

Exact resource-key lookup. Repeat the name for several keys (OR). Each key matches zero or one resource of this type. A resource_key filter ignores the default owner and archive scoping of this list: it returns the resource in any owner and any state, so reconciliation never misses an existing resource. Counts toward the 100 raw filter values per request. Unknown keys yield no rows. An empty array is invalid and refused: SDKs refuse it before sending, and the server refuses an empty or blank value. Omission means no filter.

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.

Response

List knowledge sources.
itemslist of objects
next_cursorstring or null
Opaque continuation cursor. Null means the last page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error