Skip to main content
POST
Create HTTP tool

Autorizações

X-Api-Key
string
header
obrigatório

Corpo

application/json

Body for creating a new HTTP tool in the workspace.

toolType
enum<string>
obrigatório

Type of HTTP tool to create.

Opções disponíveis:
HTTP_REQUEST,
DATABASE_QUERY,
INTERNAL_VARIABLE,
CUSTOM_INTEGRATION,
PIPEDREAM_MCP
configuration
object

Tool-type-specific configuration object. Shape depends on toolType (URL, headers, body template, etc.).

description
string

Human-readable description of what the tool does.

Maximum string length: 1000
Exemplo:

"Fetches a user's profile information from the CRM by user ID."

name
string

Stable identifier of the tool. Must contain only letters, digits, underscores and hyphens.

Maximum string length: 150
Pattern: ^[a-zA-Z0-9_-]+$
Exemplo:

"fetch-user-profile"

requiresApproval
boolean

Whether invocations of this tool require human approval before execution.

Exemplo:

false

Resposta

Created

HTTP/DB/Custom tool owned by the workspace.

configuration
object

Tool-type-specific configuration; opaque to the public API.

createdAt
string<date-time>
createdBy
object

Creator. {publicId: null, name: "API Key"} for API-key-created tools.

description
string
name
string
publicId
string<uuid>
requiresApproval
boolean
toolType
enum<string>
Opções disponíveis:
HTTP_REQUEST,
DATABASE_QUERY,
INTERNAL_VARIABLE,
CUSTOM_INTEGRATION
updatedAt
string<date-time>