For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Call

Let an agent call any HTTP endpoint that has no pre-built connector, with API Call or API Call Advanced.

API Call lets an agent call an HTTP endpoint that isn't in the Apps & Services or MCP Tools catalogs. That might be your CRM, a core banking system, or an internal service.

If the service is in one of those catalogs, use the connector there instead, because it handles authentication for you. Use API Call for everything else.

The Skill Library tab of Add Skill offers two versions:

Skill
Use it when

API Call

A request made of a URL, headers, and query parameters, with no request body

API Call Advanced

Parts of the request change with each call. It adds a Body tab, and supports dynamic variables in headers, query parameters, path parameters, and the request body

A skill you attach is set on that agent only.

Add an API Call skill

  1. On the Builder Canvas, select + Add Skill, and open the Skill Library tab.

  2. Select API Call or API Call Advanced.

  3. Fill in the form. See The form.

  4. Select Attach.

The form

The top of the form holds the request itself:

Field
What to enter

Name

What the planner calls the skill

Description

When to use the skill. The planner reads it to decide whether this skill fits the request

Url

Required. The endpoint to call

Method

Get, the default, Post, Put, Patch, or Delete

Write the description for the planner. The planner uses the skill only when its description matches the request. "Creates a client record in the CRM after an application is approved" works better than "CRM API".

Below the request fields, a set of tabs holds the rest:

Tab
What it holds

Authorization

How the request authenticates. See Authorization

Headers

Headers sent with the request, as Key and Value pairs. Select Add Entry for each one

Params

Query parameters, as Key and Value pairs. Select Add Entry for each one

Body

API Call Advanced only. The request body, as Key and Value pairs. Select Add Mapping for each one

Input Schema

The input the skill expects from the agent. Add fields with Key, Type, Description, and Required, or switch to Advanced to edit it as JSON Schema

Output Schema

The output the skill returns, in the same Basic and Advanced views

Authorization

Option
What you enter

Basic

A Username and a Password

Bearer Token

A Token

API Key

The key, as Key and Value pairs. Select Add Entry for each one

API Call Advanced

API Call Advanced builds each request from the values the agent passes in. Define those values in Input Schema, then reference them in the headers, query parameters, path parameters, or body.

Example: create a client in your CRM

An agent approves loan applications, and your CRM needs each new client's details so the service team can take over.

  1. Add an API Call Advanced skill named Create CRM client, and describe it as "Creates a client record in the CRM after an application is approved."

  2. Set Url to your CRM's create-client endpoint, such as https://api.yourcrm.com/v1/clients, and Method to Post.

  3. On Authorization, choose Bearer Token, and enter the token as a secret reference.

  4. On Headers, add Content-Type with the value application/json.

  5. On Input Schema, add firstName, lastName, and email.

  6. On Body, map each body field to its input.

  7. Select Attach.

When an application is approved, the planner chooses Create CRM client, fills the input from the application, and sends the request.


Maintained by Abhishek Paul AI-assisted, human-approved

Last updated

Was this helpful?