Skip to main content
POST
Create a custom AI tool

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Body

application/json
name
string
required
Required string length: 1 - 64
Pattern: ^[a-zA-Z_][a-zA-Z0-9_]{0,63}$
description
string
required
Required string length: 1 - 2000
parameters
object
required

JSON Schema for an object input.

endpoint
object
required
auth
object
active
boolean
default:true
readOnly
boolean
default:true
allowInPlayground
boolean
default:false
propertyIds
string[]

Response

Tool created

tool
object
required