Knowledge Retrieval Notifications

Notifications detailing the lifecycle of knowledge lookups, including progress, completion, cache reuse, and failures. Subscribe to monitor how data is gathered.

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_INITIATED`

Knowledge retrieval started.

{
  "type": "NOTIFICATION_KNOWLEDGE_RETRIEVAL_INITIATED",
  "eventId": "evt_1",
  "threadId": "thread_456",
  "requestId": "req_1",
  "eventMessage": {
    "agent": null,
    "content": "knowledge retrieval started",
    "collaborationId": null,
    "activeAssistantCollaborationRequired": null,
    "toolExecutionApprovalRequest": null,
    "timestamp": "2025-08-12T00:00:00"
  }
}

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_IN_PROGRESS`

Knowledge retrieval in progress.

{
  "type": "NOTIFICATION_KNOWLEDGE_RETRIEVAL_IN_PROGRESS",
  "eventId": "evt_1",
  "threadId": "thread_456",
  "requestId": "req_1",
  "eventMessage": {
    "agent": null,
    "content": "knowledge retrieval in progress",
    "collaborationId": null,
    "activeAssistantCollaborationRequired": null,
    "toolExecutionApprovalRequest": null,
    "timestamp": "2025-08-12T00:00:00"
  }
}

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_COMPLETED`

Knowledge retrieval completed.

{
  "type": "NOTIFICATION_KNOWLEDGE_RETRIEVAL_COMPLETED",
  "eventId": "evt_1",
  "threadId": "thread_456",
  "requestId": "req_1",
  "eventMessage": {
    "agent": null,
    "content": "knowledge retrieval completed",
    "collaborationId": null,
    "activeAssistantCollaborationRequired": null,
    "toolExecutionApprovalRequest": null,
    "timestamp": "2025-08-12T00:00:00"
  }
}

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_FAILED`

Knowledge retrieval failed.

{
  "type": "NOTIFICATION_KNOWLEDGE_RETRIEVAL_FAILED",
  "eventId": "evt_1",
  "threadId": "thread_456",
  "requestId": "req_1",
  "eventMessage": {
    "agent": null,
    "content": "knowledge retrieval failed",
    "collaborationId": null,
    "activeAssistantCollaborationRequired": null,
    "toolExecutionApprovalRequest": null,
    "timestamp": "2025-08-12T00:00:00"
  }
}

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_DUPLICATED_CACHED`

Reused cached knowledge.

{
  "type": "NOTIFICATION_KNOWLEDGE_RETRIEVAL_DUPLICATED_CACHED",
  "eventId": "evt_1",
  "threadId": "thread_456",
  "requestId": "req_1",
  "eventMessage": {
    "agent": null,
    "content": "reused cached knowledge",
    "collaborationId": null,
    "activeAssistantCollaborationRequired": null,
    "toolExecutionApprovalRequest": null,
    "timestamp": "2025-08-12T00:00:00"
  }
}

API Reference

Session Thread APIs

Stream Events

Knowledge Retrieval Notifications

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_INITIATED`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_IN_PROGRESS`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_COMPLETED`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_FAILED`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_DUPLICATED_CACHED`

​NOTIFICATION_KNOWLEDGE_RETRIEVAL_INITIATED

​NOTIFICATION_KNOWLEDGE_RETRIEVAL_IN_PROGRESS

​NOTIFICATION_KNOWLEDGE_RETRIEVAL_COMPLETED

​NOTIFICATION_KNOWLEDGE_RETRIEVAL_FAILED

​NOTIFICATION_KNOWLEDGE_RETRIEVAL_DUPLICATED_CACHED

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_INITIATED`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_IN_PROGRESS`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_COMPLETED`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_FAILED`

`NOTIFICATION_KNOWLEDGE_RETRIEVAL_DUPLICATED_CACHED`