Sign in
ObjectiveEventStreamsService
Objectives

Stream objective events

Streams events for an objective in real-time using server-sent events (SSE)

get/v1/workspaces/{workspaceId}/objectives/{objectiveId}/events:stream

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
objectiveIdstring required
Example:obj_01HXKD2E5NQM3T9AYWCFQAZGFV

Response

A stream of Server-Sent Events

Changes

Changed in 8 of the 57 revisions of this API.31810

  • ac1a7f08406811See the full diff
    • ▲

      added ObjectiveEventData_Reasoning to the data response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added reasoning discriminator mapping keys to the data response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cf00ce9538ec1See the full diff
    • ○

      added the optional property startedAt to the response with the 200 status

      response-optional-property-added

  • 1933c0d0512f1See the full diff
    • ○

      added the optional property duration to the response with the 200 status

      response-optional-property-added

  • 3ecc1debabfa2181See the full diff
    • ▲

      added ObjectiveEventData_UserMessage ObjectiveEventData_ToolApprovalRequested ObjectiveEventData_ToolApproved ObjectiveEventData_ToolDenied ObjectiveEventData_ToolCalled ObjectiveEventData_Error ObjectiveEventData_AssistantMessage ObjectiveEventData_ToolResult ObjectiveEventData_ToolError ObjectiveEventData_ContextWindowCompacted ObjectiveEventData_MemoryRead ObjectiveEventData_Cancelled ObjectiveEventData_SubAgentSpawned ObjectiveEventData_SubAgentUpdated ObjectiveEventData_Finalized ObjectiveEventData_Notice ObjectiveEventData_TimedOut to the data response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the data response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property data/assistantMessage from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/cancelled from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/contextWindowCompacted from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/error from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/finalized from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/memoryRead from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/notice from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/subAgentSpawned from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/subAgentUpdated from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/timedOut from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/toolApprovalRequested from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/toolApproved from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/toolCalled from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/toolDenied from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/toolError from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/toolResult from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/userMessage from the response with the 200 status

      response-optional-property-removed

    • ○

      added discriminator to data response property for the response status 200

      response-property-discriminator-added

  • 63210c2f71dc1See the full diff
    • ○

      added the optional property data/timedOut to the response with the 200 status

      response-optional-property-added

  • ca78d3d0b7c23See the full diff
    • ○

      added the optional property data/toolCalled/arguments to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/toolCalled/config to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/toolCalled/tool to the response with the 200 status

      response-optional-property-added

  • 02498bf606f01See the full diff
    • ○

      added the optional property data/notice to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 06e0e37c14991See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog