Returns a permission-filtered, read-only projection. Globally unconfigured, disabled, unentitled, unacknowledged, empty-scope, and out-of-scope Knowledge conditions use the empty state; unavailable is reserved for genuine retrieval/currentness failures after eligibility. Neither state blocks the owning Task workflow. Indexed subjects may discover Documents through shared distinctive title terms without a cross-domain link generation. Inferred suggestions explain their shared terms and never create or change canonical Task relations.
Path Parameters
workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
task_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
Query Parameters
include_code
boolean·default false
Opt in to read-only indexed code references from repositories bound to this Task Project. Uses deterministic Cognee identifier matching, not semantic model ranking. Code references have no feedback entity ID; open their revision-pinned GitHub URL to review them. Defaults to false for compatibility.
include_commit_mentions
boolean·default false
Opt in to verified GitHub commit findings from Task comments. Defaults to false so older clients continue receiving only Task and Document findings. Commit lookup runs in the background and does not require Workspace Knowledge indexing to be enabled.
Header Parameters
X-Assign-Realtime-Baseline
string
Upcoming browser-session derived read. Set to '1' to capture an authorized Workspace replay boundary before remote Knowledge retrieval. Core joins occur in newer snapshots; the result can still report index lag. Apply retained results before acknowledging the socket checkpoint. Failed reads return no cursor.
Values
1
Responses
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Assign-Realtime-Cursor
string·max 4096
Signed Workspace/User/session-bound replay custody; present only after a successful requested canonical baseline.
X-Assign-Realtime-Position
string
Decimal-string snapshot position; present only with a successful baseline cursor.
stateRequired
string
Values
readyemptyunavailable
resultsRequired
object[]·max 25
At most five pending findings followed by at most twenty confirmed ones.
staleRequired
boolean
observed_atRequired
string <date-time>
truncatedRequired
boolean
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
