List objective tools

GET/v1/objectives/{objectiveId}/tools

Lists all tools that were assigned to an objective

Path ParametersExpand Collapse

objectiveId: string

Query ParametersExpand Collapse

cursor: optional string

Pagination cursor from previous response

limit: optional number

Maximum number of results to return

formatint32

ReturnsExpand Collapse

items: optional array of ObjectiveTool { metadata, snapshot }

metadata: BareMetadata { id, name }

BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves.

id: optional string

Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks).

snapshot: optional Tool { metadata, spec, info }

Snapshot of the tool at the time it was assigned to the objective. Because tools can change over time, snapshots are used to ensure tools don't change unexpectedly during an objective's lifecycle.

metadata: ResourceMetadata { id, accountId, createdAt, 5 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: string

Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this resource was created

formatdate-time

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

ID of the actor (user or service account) that created this resource

workspaceId: string

Workspace this resource belongs to for organizational grouping (prefixed ULID)

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: ToolSpec { config, description, parameters, 2 more }

config: ToolSpecConfig { http, mcp }

Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline.

http: optional ConfigHTTP { requestMethod, headers, path, 4 more }

requestMethod: "GET" or "POST" or "PUT" or 2 more

formatenum

One of the following:

"GET"

"POST"

"PUT"

"PATCH"

"DELETE"

headers: optional map[string]

path: optional string

query: optional string

requestBodyContentType: optional string

requestBodyTemplate: optional string

These are only used when the request method is a POST, PUT, or PATCH

toolName: optional string

The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided.

mcp: optional ConfigMcp { toolDescription, toolName, toolTitle }

toolDescription: optional string

toolName: optional string

toolTitle: optional string

description: string

parameters: map[unknown]

status: "TOOL_STATUS_UNSPECIFIED" or "TOOL_STATUS_AVAILABLE" or "TOOL_STATUS_FILTERED" or "TOOL_STATUS_ARCHIVED"

formatenum

One of the following:

"TOOL_STATUS_UNSPECIFIED"

"TOOL_STATUS_AVAILABLE"

"TOOL_STATUS_FILTERED"

"TOOL_STATUS_ARCHIVED"

requiresApproval: optional boolean

info: optional ToolInfo { createdBy, toolSet }

createdBy: optional Profile { metadata, spec }

Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: ProfileSpec { type, email, name }

ProfileSpec contains the profile-specific fields

type: "PROFILE_TYPE_USER" or "PROFILE_TYPE_API_KEY" or "PROFILE_TYPE_SYSTEM"

Type is the type of profile. User's are humans, API keys are computers. You know the deal.

formatenum

One of the following:

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

Email address of the user (required, unique per account)

Display name for the user (e.g., "Bobby Tables")

toolSet: optional ResourceMetadata { id, accountId, createdAt, 5 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: string

Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this resource was created

formatdate-time

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

ID of the actor (user or service account) that created this resource

workspaceId: string

Workspace this resource belongs to for organizational grouping (prefixed ULID)

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

pagination: optional Page { nextCursor, total }

nextCursor: optional string

total: optional number

List objective tools

curl https://api.cadenya.com/v1/objectives/$OBJECTIVE_ID/tools \
    -H "Authorization: Bearer $CADENYA_API_KEY"

{
  "items": [
    {
      "metadata": {
        "id": "id",
        "name": "name"
      },
      "snapshot": {
        "metadata": {
          "id": "id",
          "accountId": "accountId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "name": "name",
          "profileId": "profileId",
          "workspaceId": "workspaceId",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        },
        "spec": {
          "config": {
            "http": {
              "requestMethod": "GET",
              "headers": {
                "foo": "string"
              },
              "path": "path",
              "query": "query",
              "requestBodyContentType": "requestBodyContentType",
              "requestBodyTemplate": "requestBodyTemplate",
              "toolName": "toolName"
            },
            "mcp": {
              "toolDescription": "toolDescription",
              "toolName": "toolName",
              "toolTitle": "toolTitle"
            }
          },
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "status": "TOOL_STATUS_UNSPECIFIED",
          "requiresApproval": true
        },
        "info": {
          "createdBy": {
            "metadata": {
              "id": "id",
              "accountId": "accountId",
              "name": "name",
              "profileId": "profileId",
              "externalId": "externalId",
              "labels": {
                "foo": "string"
              }
            },
            "spec": {
              "type": "PROFILE_TYPE_USER",
              "email": "email",
              "name": "name"
            }
          },
          "toolSet": {
            "id": "id",
            "accountId": "accountId",
            "createdAt": "2019-12-27T18:11:19.117Z",
            "name": "name",
            "profileId": "profileId",
            "workspaceId": "workspaceId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}

Returns Examples

{
  "items": [
    {
      "metadata": {
        "id": "id",
        "name": "name"
      },
      "snapshot": {
        "metadata": {
          "id": "id",
          "accountId": "accountId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "name": "name",
          "profileId": "profileId",
          "workspaceId": "workspaceId",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        },
        "spec": {
          "config": {
            "http": {
              "requestMethod": "GET",
              "headers": {
                "foo": "string"
              },
              "path": "path",
              "query": "query",
              "requestBodyContentType": "requestBodyContentType",
              "requestBodyTemplate": "requestBodyTemplate",
              "toolName": "toolName"
            },
            "mcp": {
              "toolDescription": "toolDescription",
              "toolName": "toolName",
              "toolTitle": "toolTitle"
            }
          },
          "description": "description",
          "parameters": {
            "foo": "bar"
          },
          "status": "TOOL_STATUS_UNSPECIFIED",
          "requiresApproval": true
        },
        "info": {
          "createdBy": {
            "metadata": {
              "id": "id",
              "accountId": "accountId",
              "name": "name",
              "profileId": "profileId",
              "externalId": "externalId",
              "labels": {
                "foo": "string"
              }
            },
            "spec": {
              "type": "PROFILE_TYPE_USER",
              "email": "email",
              "name": "name"
            }
          },
          "toolSet": {
            "id": "id",
            "accountId": "accountId",
            "createdAt": "2019-12-27T18:11:19.117Z",
            "name": "name",
            "profileId": "profileId",
            "workspaceId": "workspaceId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}