Sign in

v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
ObjectiveService
Objectives

List objectives

Lists all objectives in the workspace

get/v1/workspaces/{workspaceId}/objectives

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Query parameters

limitinteger

Maximum number of results to return

cursorstring

Pagination cursor from previous response

agentIdstring
Example:agent_01HXKD2E5NQM3T9AYWCFMGWT9Y

Agent ID for filtering

parentObjectiveIdstring

Optional filters

state'STATE_UNSPECIFIED' | 'STATE_PENDING' | 'STATE_RUNNING' | 'STATE_WAITING' | 'STATE_FAILED' | 'STATE_CANCELLED' | 'STATE_FINALIZED' | 'STATE_TIMED_OUT' enum

Filter by state

profileIdstring
Example:profile_01HXKD2E5NQM3T9AYWCFS0AP08
sortOrderstring

Sort order for results (asc or desc by creation time)

includeInfoboolean

When set to true you may use more of your alloted API rate-limit

agentScheduleIdstring

Filter to objectives produced by a specific AgentSchedule. Accepts canonical as_… form or external_id:<value> form.

labelsstring

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

tenantIdstring

Filter to objectives associated with a tenant. Accepts the canonical tenant_… form or the external_id:<value> form.

subjectIdstring

Filter to objectives associated with a subject. Accepts the canonical subj_… form or the external_id:<value> form; the external_id form is scoped within a tenant and requires tenant_id to also be set.

widgetIdstring

Filter to objectives whose conversation ran through a widget. Accepts the canonical wgt_… form or the external_id:<value> form.

widgetSessionIdstring

Filter to objectives created by a specific widget session.

Response

OK