Skip to main content
POST
/
agents
/
{agentId}
/
integrations
/
{kind}
/
bindings
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "agentId": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "parametersSchema": {},
    "requiredParams": [
      "<string>"
    ],
    "executionConfig": {},
    "dataEgressMap": {},
    "allowedFields": [
      "<string>"
    ],
    "isWrite": true,
    "requiresVerifiedIdentity": true,
    "requiresConfirmation": true,
    "nonParallelizable": true,
    "channels": [],
    "errorHandling": {},
    "isEnabled": true,
    "expectedLatencyMs": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

​
agentId
string
required
​
kind
enum<string>
required
Available options:
google_calendar,
google_sheets,
calendly,
hubspot,
square,
opentable,
shopify,
postgres,
mysql

Body

application/json
​
toolName
string
required

The LLM-facing tool/function name.

​
operation
string
required

The provider operation to bind (a read e.g. clients

​
description
string

The LLM-facing tool description.

​
isWrite
boolean

Bind a MUTATION. Gated (confirm + non-parallel; verified-identity for update/delete); the skill lands DISABLED for review.

​
enabled
boolean

Start enabled (reads only; a write always lands disabled).

​
inputs
object[]

READ: LLM param → provider operation argument.

​
inputObjectMap
object[]

WRITE: map a caller param OR an operator-pinned constant onto a field of the mutation's input object. Every required input field must be bound-or-const; sensitive PII classes are rejected.

​
projection
object[]

Provider field path → canonical output leaf (leaf must be a scalar; a write may project the created id; userErrors is never projectable). For a SQL one-hop FK join, use path [relationshipField, targetColumn].

​
sqlSearch
object

native_sql READ (deterministic, LLM-free): exactly ONE filter on a LEADING-INDEX column. The transport (native_sql vs /native_rest) is determined by the connected provider's schema; use sqlSearch for postgres/mysql reads.

​
sqlWrite
object

native_sql WRITE (deterministic): a single-row INSERT, or an UPDATE-by-unique-key (set keyColumn+keyParam). Gated; lands DISABLED for review. PII-classed columns are rejected.

Response

The created skill (, native_rest, or native_sql per the connected provider).

​
success
boolean
required
​
data
object
required
​
message
string
​
errors
object[]