Sign in

v56

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

Get an objective tool call by ID

Retrieves a single tool call, including the content the tool returned. Media content (images, audio) is served as short-lived signed URLs.

get/v1/workspaces/{workspaceId}/objectives/{objectiveId}/tool_calls/{toolCallId}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
objectiveIdstring required
Example:obj_01HXKD2E5NQM3T9AYWCFQAZGFV

The ID of the objective. Supports "external_id:" prefix for external IDs.

toolCallIdstring required
Example:toolcall_01HXKD2E5NQM3T9AYWCFTANFGV

The ID of the tool call to retrieve

Response

OK

status'TOOL_CALL_STATUS_UNSPECIFIED' | 'TOOL_CALL_STATUS_AUTO_APPROVED' | 'TOOL_CALL_STATUS_WAITING_FOR_APPROVAL' | 'TOOL_CALL_STATUS_APPROVED' | 'TOOL_CALL_STATUS_DENIED' enum required

Current status of the tool call

executionStatus'TOOL_CALL_EXECUTION_STATUS_UNSPECIFIED' | 'TOOL_CALL_EXECUTION_STATUS_PENDING' | 'TOOL_CALL_EXECUTION_STATUS_RUNNING' | 'TOOL_CALL_EXECUTION_STATUS_COMPLETED' | 'TOOL_CALL_EXECUTION_STATUS_ERRORED' | 'TOOL_CALL_EXECUTION_STATUS_WAITING_FOR_CONTENT' enum required

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "data": {
    "callable": {
      "tool": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    },
    "statusChangedBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  },
  "info": {
    "objective": {
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
    },
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}