Tool Sets

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 tool sets

GET/v1/workspaces/{workspaceId}/tool_sets

Create a new tool set

POST/v1/workspaces/{workspaceId}/tool_sets

Get a tool set by ID

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

Update a tool set

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

Delete a tool set

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

Get consumed OpenAPI spec

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

List tool set events

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

ModelsExpand Collapse

ApprovalRequirementFilter object { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

Single attribute filter

formatenum

One of the following:

String matching operations

StringMatcher object { caseSensitive, contains, endsWith, 3 more }

String matching operations

caseSensitive: optional boolean

contains: optional string

endsWith: optional string

exact: optional string

regex: optional string

startsWith: optional string

SyncCompleted object { message, toolsSynced }

Emitted when a tool set sync operation completes successfully.

message: optional string

Optional message with additional details.

toolsSynced: optional number

Number of tools synced.

formatint32

SyncFailed object { error, errorType, message }

Emitted when a tool set sync operation fails.

error: optional boolean

Indicates this is an error event.

errorType: optional string

Optional error type/code for programmatic handling.

message: optional string

Error message describing what went wrong.

SyncStarted object { message }

Emitted when a tool set sync operation begins.

message: optional string

Human-readable message describing the start of the sync.

ToolFilter object { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

ToolSet object { metadata, spec, info }

metadata: ResourceMetadata { id, accountId, createdAt, 6 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)

bundleKey: optional string

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: 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: ToolSetSpec { adapter, description }

adapter: optional ToolSetAdapter { http, mcp, openapi }

http: optional ToolSetAdapterHTTP { baseUrl, headers }

baseUrl: optional string

headers: optional map[string]

mcp: optional ToolSetAdapterMcp { excludeTools, headers, includeTools, 2 more }

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

url: optional string

openapi: optional ToolSetAdapterOpenAPI { baseUrl, excludeTools, headers, 5 more }

baseUrl: optional string

Base URL for dispatching tool calls. If set, overrides the server resolved from the spec’s servers array.

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

Headers sent when fetching the spec from a URL and when dispatching tool calls.

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

serverName: optional string

Name of the server entry in the spec’s servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set.

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

uploadId: optional string

ID of a COMPLETE Upload containing the OpenAPI spec document.

url: optional string

URL to fetch the OpenAPI spec from. Synced automatically every hour.

description: optional string

info: optional ToolSetInfo { agentCount, createdBy, lastSync, toolCount }

Tool set information

agentCount: optional number

createdBy: optional Profile { metadata, spec }

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 { 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 }

Configuration for a profile.

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

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

formatenum

One of the following:

"PROFILE_TYPE_UNSPECIFIED"

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

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

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

lastSync: optional string

toolCount: optional number

ToolSetAdapter object { http, mcp, openapi }

http: optional ToolSetAdapterHTTP { baseUrl, headers }

baseUrl: optional string

headers: optional map[string]

mcp: optional ToolSetAdapterMcp { excludeTools, headers, includeTools, 2 more }

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

url: optional string

openapi: optional ToolSetAdapterOpenAPI { baseUrl, excludeTools, headers, 5 more }

baseUrl: optional string

Base URL for dispatching tool calls. If set, overrides the server resolved from the spec’s servers array.

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

Headers sent when fetching the spec from a URL and when dispatching tool calls.

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

serverName: optional string

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

uploadId: optional string

ID of a COMPLETE Upload containing the OpenAPI spec document.

url: optional string

URL to fetch the OpenAPI spec from. Synced automatically every hour.

ToolSetAdapterHTTP object { baseUrl, headers }

baseUrl: optional string

headers: optional map[string]

ToolSetAdapterMcp object { excludeTools, headers, includeTools, 2 more }

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

url: optional string

ToolSetAdapterOpenAPI object { baseUrl, excludeTools, headers, 5 more }

baseUrl: optional string

Base URL for dispatching tool calls. If set, overrides the server resolved from the spec’s servers array.

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

Headers sent when fetching the spec from a URL and when dispatching tool calls.

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

serverName: optional string

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

uploadId: optional string

ID of a COMPLETE Upload containing the OpenAPI spec document.

url: optional string

URL to fetch the OpenAPI spec from. Synced automatically every hour.

ToolSetEvent object { metadata, event, info, toolSetId }

A single event in the tool set’s operation timeline.

metadata: OperationMetadata { id, accountId, createdAt, 4 more }

Metadata for ephemeral operations and activities (e.g., objectives, executions, runs)

id: string

Unique identifier for the operation (prefixed ULID, e.g., “obj_01HXK…”)

accountId: string

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

createdAt: string

Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying

formatdate-time

profileId: string

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

workspaceId: string

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

externalId: optional string

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

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {“priority”: “high”, “source”: “api”, “workflow”: “onboarding”}

event: optional ToolSetEventData { syncCompleted, syncFailed, syncStarted, type }

Event payload for a tool set operation.

syncCompleted: optional SyncCompleted { message, toolsSynced }

Emitted when a tool set sync operation completes successfully.

message: optional string

Optional message with additional details.

toolsSynced: optional number

Number of tools synced.

formatint32

syncFailed: optional SyncFailed { error, errorType, message }

Emitted when a tool set sync operation fails.

error: optional boolean

Indicates this is an error event.

errorType: optional string

Optional error type/code for programmatic handling.

message: optional string

Error message describing what went wrong.

syncStarted: optional SyncStarted { message }

Emitted when a tool set sync operation begins.

message: optional string

Human-readable message describing the start of the sync.

type: optional string

Type of the event (e.g., “sync_started”, “sync_completed”, “sync_failed”).

info: optional object { createdBy, toolSet }

createdBy: optional Profile { metadata, spec }

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 { 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 }

Configuration for a profile.

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

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

formatenum

One of the following:

"PROFILE_TYPE_UNSPECIFIED"

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

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

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

toolSet: optional ResourceMetadata { id, accountId, createdAt, 6 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)

bundleKey: optional 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”}

toolSetId: optional string

The tool set this event is associated with.

ToolSetEventData object { syncCompleted, syncFailed, syncStarted, type }

Event payload for a tool set operation.

syncCompleted: optional SyncCompleted { message, toolsSynced }

Emitted when a tool set sync operation completes successfully.

message: optional string

Optional message with additional details.

toolsSynced: optional number

Number of tools synced.

formatint32

syncFailed: optional SyncFailed { error, errorType, message }

Emitted when a tool set sync operation fails.

error: optional boolean

Indicates this is an error event.

errorType: optional string

Optional error type/code for programmatic handling.

message: optional string

Error message describing what went wrong.

syncStarted: optional SyncStarted { message }

Emitted when a tool set sync operation begins.

message: optional string

Human-readable message describing the start of the sync.

type: optional string

Type of the event (e.g., “sync_started”, “sync_completed”, “sync_failed”).

ToolSetInfo object { agentCount, createdBy, lastSync, toolCount }

agentCount: optional number

createdBy: optional Profile { metadata, spec }

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 { 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 }

Configuration for a profile.

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

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

formatenum

One of the following:

"PROFILE_TYPE_UNSPECIFIED"

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

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

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

lastSync: optional string

toolCount: optional number

ToolSetSpec object { adapter, description }

adapter: optional ToolSetAdapter { http, mcp, openapi }

http: optional ToolSetAdapterHTTP { baseUrl, headers }

baseUrl: optional string

headers: optional map[string]

mcp: optional ToolSetAdapterMcp { excludeTools, headers, includeTools, 2 more }

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

url: optional string

openapi: optional ToolSetAdapterOpenAPI { baseUrl, excludeTools, headers, 5 more }

baseUrl: optional string

Base URL for dispatching tool calls. If set, overrides the server resolved from the spec’s servers array.

excludeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

headers: optional map[string]

Headers sent when fetching the spec from a URL and when dispatching tool calls.

includeTools: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

serverName: optional string

toolApprovals: optional ApprovalRequirementFilter { always, only }

Approval filters that will automatically set the approval requirement on tools synced from an external source

always: optional boolean

only: optional ToolFilter { operator, filters }

Top-level filter with simple boolean logic (no nesting)

operator: "OPERATOR_UNSPECIFIED" or "OPERATOR_AND" or "OPERATOR_OR"

formatenum

One of the following:

"OPERATOR_UNSPECIFIED"

"OPERATOR_AND"

"OPERATOR_OR"

filters: optional array of AttributeFilter { attribute, matcher }

formatenum

One of the following:

String matching operations

uploadId: optional string

ID of a COMPLETE Upload containing the OpenAPI spec document.

url: optional string

URL to fetch the OpenAPI spec from. Synced automatically every hour.

description: optional string

ToolSetGetOpenAPISpecResponse object { spec }

spec: optional string

The consumed OpenAPI specification as a JSON string.

Tool SetsTools

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

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

Create a new tool

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

Get a tool by ID

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

Update a tool

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

Delete a tool

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

ModelsExpand Collapse

ConfigHTTP object { requestMethod, headers, path, 4 more }

requestMethod: "HTTP_METHOD_UNSPECIFIED" or "GET" or "POST" or 3 more

formatenum

One of the following:

"HTTP_METHOD_UNSPECIFIED"

"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.

ConfigMcp object { toolDescription, toolName, toolTitle }

toolDescription: optional string

toolName: optional string

toolTitle: optional string

ConfigOpenAPI object { method, operationId, path }

method: optional string

operationId: optional string

path: optional string

Tool object { metadata, spec, info }

metadata: ResourceMetadata { id, accountId, createdAt, 6 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)

bundleKey: optional 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: ToolSpec { config, description, parameters, 2 more }

config: ToolSpecConfig { http, mcp, openapi }

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: "HTTP_METHOD_UNSPECIFIED" or "GET" or "POST" or 3 more

formatenum

One of the following:

"HTTP_METHOD_UNSPECIFIED"

"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

mcp: optional ConfigMcp { toolDescription, toolName, toolTitle }

toolDescription: optional string

toolName: optional string

toolTitle: optional string

openapi: optional ConfigOpenAPI { method, operationId, path }

method: optional string

operationId: optional string

path: optional string

description: string

parameters: map[unknown]

status: "TOOL_STATUS_UNSPECIFIED" or "TOOL_STATUS_AVAILABLE" or "TOOL_STATUS_OMITTED" or "TOOL_STATUS_ARCHIVED"

formatenum

One of the following:

"TOOL_STATUS_UNSPECIFIED"

"TOOL_STATUS_AVAILABLE"

"TOOL_STATUS_OMITTED"

"TOOL_STATUS_ARCHIVED"

requiresApproval: optional boolean

info: optional ToolInfo { createdBy, toolSet }

createdBy: optional Profile { metadata, spec }

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 { 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 }

Configuration for a profile.

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

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

formatenum

One of the following:

"PROFILE_TYPE_UNSPECIFIED"

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

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

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

toolSet: optional ResourceMetadata { id, accountId, createdAt, 6 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)

bundleKey: optional 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”}

ToolInfo object { createdBy, toolSet }

createdBy: optional Profile { metadata, spec }

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 { 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 }

Configuration for a profile.

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

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

formatenum

One of the following:

"PROFILE_TYPE_UNSPECIFIED"

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

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

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

toolSet: optional ResourceMetadata { id, accountId, createdAt, 6 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)

bundleKey: optional 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”}

ToolSpec object { config, description, parameters, 2 more }

config: ToolSpecConfig { http, mcp, openapi }

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

requestMethod: "HTTP_METHOD_UNSPECIFIED" or "GET" or "POST" or 3 more

formatenum

One of the following:

"HTTP_METHOD_UNSPECIFIED"

"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

mcp: optional ConfigMcp { toolDescription, toolName, toolTitle }

toolDescription: optional string

toolName: optional string

toolTitle: optional string

openapi: optional ConfigOpenAPI { method, operationId, path }

method: optional string

operationId: optional string

path: optional string

description: string

parameters: map[unknown]

status: "TOOL_STATUS_UNSPECIFIED" or "TOOL_STATUS_AVAILABLE" or "TOOL_STATUS_OMITTED" or "TOOL_STATUS_ARCHIVED"

formatenum

One of the following:

"TOOL_STATUS_UNSPECIFIED"

"TOOL_STATUS_AVAILABLE"

"TOOL_STATUS_OMITTED"

"TOOL_STATUS_ARCHIVED"

requiresApproval: optional boolean

ToolSpecConfig object { http, mcp, openapi }

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

requestMethod: "HTTP_METHOD_UNSPECIFIED" or "GET" or "POST" or 3 more

formatenum

One of the following:

"HTTP_METHOD_UNSPECIFIED"

"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

mcp: optional ConfigMcp { toolDescription, toolName, toolTitle }

toolDescription: optional string

toolName: optional string

toolTitle: optional string

openapi: optional ConfigOpenAPI { method, operationId, path }

method: optional string

operationId: optional string

path: optional string