API Reference

Tool Sets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Tools

Manage tool sets and the tools they contain. Tool sets group related tools, and tools define specific capabilities available to agents.

When a tool set is managed, only API key actors can modify its tools; human (profile) actors cannot.

List tools

client.ToolSets.Tools.List(ctx, workspaceID, toolSetID, query) (*CursorPagination[Tool], error)

GET/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools

Create a new tool

client.ToolSets.Tools.New(ctx, workspaceID, toolSetID, body) (*Tool, error)

POST/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools

Get a tool by ID

client.ToolSets.Tools.Get(ctx, workspaceID, toolSetID, id) (*Tool, error)

GET/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}

Update a tool

client.ToolSets.Tools.Update(ctx, workspaceID, toolSetID, id, body) (*Tool, error)

PUT/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}

Delete a tool

client.ToolSets.Tools.Delete(ctx, workspaceID, toolSetID, id) error

DELETE/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/tools/{id}

ModelsExpand Collapse

type ConfigHTTP struct{…}

RequestMethod ConfigHTTPRequestMethod

formatenum

One of the following:

const ConfigHTTPRequestMethodHTTPMethodUnspecified ConfigHTTPRequestMethod = "HTTP_METHOD_UNSPECIFIED"

const ConfigHTTPRequestMethodGet ConfigHTTPRequestMethod = "GET"

const ConfigHTTPRequestMethodPost ConfigHTTPRequestMethod = "POST"

const ConfigHTTPRequestMethodPut ConfigHTTPRequestMethod = "PUT"

const ConfigHTTPRequestMethodPatch ConfigHTTPRequestMethod = "PATCH"

const ConfigHTTPRequestMethodDelete ConfigHTTPRequestMethod = "DELETE"

Headers map[string, string]Optional

Path stringOptional

Query stringOptional

RequestBodyContentType stringOptional

RequestBodyTemplate stringOptional

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

ToolName stringOptional

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.

type ConfigMcp struct{…}

ToolDescription stringOptional

ToolName stringOptional

ToolTitle stringOptional

type ConfigOpenAPI struct{…}

Method stringOptional

OperationID stringOptional

Path stringOptional

type Tool struct{…}

Metadata ResourceMetadata

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 Time

Timestamp when this resource was created

formatdate-time

Name string

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)

BundleKey stringOptional

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

ExternalID stringOptional

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

Labels map[string, string]Optional

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

Spec ToolSpec

Config ToolSpecConfig

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 ConfigHTTPOptional

RequestMethod ConfigHTTPRequestMethod

formatenum

One of the following:

const ConfigHTTPRequestMethodHTTPMethodUnspecified ConfigHTTPRequestMethod = "HTTP_METHOD_UNSPECIFIED"

const ConfigHTTPRequestMethodGet ConfigHTTPRequestMethod = "GET"

const ConfigHTTPRequestMethodPost ConfigHTTPRequestMethod = "POST"

const ConfigHTTPRequestMethodPut ConfigHTTPRequestMethod = "PUT"

const ConfigHTTPRequestMethodPatch ConfigHTTPRequestMethod = "PATCH"

const ConfigHTTPRequestMethodDelete ConfigHTTPRequestMethod = "DELETE"

Headers map[string, string]Optional

Path stringOptional

Query stringOptional

RequestBodyContentType stringOptional

RequestBodyTemplate stringOptional

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

ToolName stringOptional

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 ConfigMcpOptional

ToolDescription stringOptional

ToolName stringOptional

ToolTitle stringOptional

OpenAPI ConfigOpenAPIOptional

Method stringOptional

OperationID stringOptional

Path stringOptional

Description string

Parameters map[string, unknown]

Status ToolSpecStatus

formatenum

One of the following:

const ToolSpecStatusToolStatusUnspecified ToolSpecStatus = "TOOL_STATUS_UNSPECIFIED"

const ToolSpecStatusToolStatusAvailable ToolSpecStatus = "TOOL_STATUS_AVAILABLE"

const ToolSpecStatusToolStatusOmitted ToolSpecStatus = "TOOL_STATUS_OMITTED"

const ToolSpecStatusToolStatusArchived ToolSpecStatus = "TOOL_STATUS_ARCHIVED"

RequiresApproval boolOptional

Info ToolInfoOptional

CreatedBy ProfileOptional

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

Metadata AccountResourceMetadata

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)

Name string

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

ProfileID string

ExternalID stringOptional

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

Labels map[string, string]Optional

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

Spec ProfileSpec

Configuration for a profile.

Type ProfileSpecType

Whether this profile represents a human user, an API key, or a system principal.

formatenum

One of the following:

const ProfileSpecTypeProfileTypeUnspecified ProfileSpecType = "PROFILE_TYPE_UNSPECIFIED"

const ProfileSpecTypeProfileTypeUser ProfileSpecType = "PROFILE_TYPE_USER"

const ProfileSpecTypeProfileTypeAPIKey ProfileSpecType = "PROFILE_TYPE_API_KEY"

const ProfileSpecTypeProfileTypeSystem ProfileSpecType = "PROFILE_TYPE_SYSTEM"

Email stringOptional

Email address of the profile. Required and unique within an account for user profiles.

Name stringOptional

Display name (e.g., “Bobby Tables”).

ToolSet ResourceMetadataOptional

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 Time

Timestamp when this resource was created

formatdate-time

Name string

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)

BundleKey stringOptional

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

ExternalID stringOptional

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

Labels map[string, string]Optional

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

type ToolInfo struct{…}

CreatedBy ProfileOptional

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

Metadata AccountResourceMetadata

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)

Name string

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

ProfileID string

ExternalID stringOptional

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

Labels map[string, string]Optional

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

Spec ProfileSpec

Configuration for a profile.

Type ProfileSpecType

Whether this profile represents a human user, an API key, or a system principal.

formatenum

One of the following:

const ProfileSpecTypeProfileTypeUnspecified ProfileSpecType = "PROFILE_TYPE_UNSPECIFIED"

const ProfileSpecTypeProfileTypeUser ProfileSpecType = "PROFILE_TYPE_USER"

const ProfileSpecTypeProfileTypeAPIKey ProfileSpecType = "PROFILE_TYPE_API_KEY"

const ProfileSpecTypeProfileTypeSystem ProfileSpecType = "PROFILE_TYPE_SYSTEM"

Email stringOptional

Email address of the profile. Required and unique within an account for user profiles.

Name stringOptional

Display name (e.g., “Bobby Tables”).

ToolSet ResourceMetadataOptional

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 Time

Timestamp when this resource was created

formatdate-time

Name string

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)

BundleKey stringOptional

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

ExternalID stringOptional

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

Labels map[string, string]Optional

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

type ToolSpec struct{…}

Config ToolSpecConfig

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 ConfigHTTPOptional

RequestMethod ConfigHTTPRequestMethod

formatenum

One of the following:

const ConfigHTTPRequestMethodHTTPMethodUnspecified ConfigHTTPRequestMethod = "HTTP_METHOD_UNSPECIFIED"

const ConfigHTTPRequestMethodGet ConfigHTTPRequestMethod = "GET"

const ConfigHTTPRequestMethodPost ConfigHTTPRequestMethod = "POST"

const ConfigHTTPRequestMethodPut ConfigHTTPRequestMethod = "PUT"

const ConfigHTTPRequestMethodPatch ConfigHTTPRequestMethod = "PATCH"

const ConfigHTTPRequestMethodDelete ConfigHTTPRequestMethod = "DELETE"

Headers map[string, string]Optional

Path stringOptional

Query stringOptional

RequestBodyContentType stringOptional

RequestBodyTemplate stringOptional

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

ToolName stringOptional

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 ConfigMcpOptional

ToolDescription stringOptional

ToolName stringOptional

ToolTitle stringOptional

OpenAPI ConfigOpenAPIOptional

Method stringOptional

OperationID stringOptional

Path stringOptional

Description string

Parameters map[string, unknown]

Status ToolSpecStatus

formatenum

One of the following:

const ToolSpecStatusToolStatusUnspecified ToolSpecStatus = "TOOL_STATUS_UNSPECIFIED"

const ToolSpecStatusToolStatusAvailable ToolSpecStatus = "TOOL_STATUS_AVAILABLE"

const ToolSpecStatusToolStatusOmitted ToolSpecStatus = "TOOL_STATUS_OMITTED"

const ToolSpecStatusToolStatusArchived ToolSpecStatus = "TOOL_STATUS_ARCHIVED"

RequiresApproval boolOptional

type ToolSpecConfig struct{…}

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 ConfigHTTPOptional

RequestMethod ConfigHTTPRequestMethod

formatenum

One of the following:

const ConfigHTTPRequestMethodHTTPMethodUnspecified ConfigHTTPRequestMethod = "HTTP_METHOD_UNSPECIFIED"

const ConfigHTTPRequestMethodGet ConfigHTTPRequestMethod = "GET"

const ConfigHTTPRequestMethodPost ConfigHTTPRequestMethod = "POST"

const ConfigHTTPRequestMethodPut ConfigHTTPRequestMethod = "PUT"

const ConfigHTTPRequestMethodPatch ConfigHTTPRequestMethod = "PATCH"

const ConfigHTTPRequestMethodDelete ConfigHTTPRequestMethod = "DELETE"

Headers map[string, string]Optional

Path stringOptional

Query stringOptional

RequestBodyContentType stringOptional

RequestBodyTemplate stringOptional

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

ToolName stringOptional

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 ConfigMcpOptional

ToolDescription stringOptional

ToolName stringOptional

ToolTitle stringOptional

OpenAPI ConfigOpenAPIOptional

Method stringOptional

OperationID stringOptional

Path stringOptional