Tools Reference

Integrations

Connect agents to external APIs, extract structured data from JSON responses, manage calendar events, and handle file storage.


api_call Premium

Make HTTP API requests to external services. Supports GET, POST, PUT, PATCH, and DELETE methods with custom headers and request bodies.

TypeScript
tools.apiCall

Parameters

ParameterTypeRequiredDescription
urlstringAPI endpoint URL
methodstringHTTP method: GET, POST, PUT, PATCH, DELETE (default: GET)
headersRecord<string, string>HTTP headers (Authorization, etc.)
bodyanyRequest body (auto-serialized to JSON)

Returns

TypeScript
{
  status: 200,
  headers: { "content-type": "application/json" },
  data: { /* parsed response body */ }
}

Security

  • Requests are made from the server — API keys are never exposed to users
  • URL allow-lists can restrict which domains the tool can access
  • Response size is limited to prevent memory issues
  • Timeouts are enforced (30-second default)

json_extract Standard

Extract specific values from JSON data using dot-notation paths and wildcard selectors. Ideal for processing API responses.

TypeScript
tools.jsonExtract

Parameters

ParameterTypeRequiredDescription
jsonstring | objectJSON data (string or parsed object)
pathstringDot-notation path (e.g., data.items[0].name)

Path Syntax

  • data.name — Access nested property
  • items[0] — Array index access
  • items[*].name — Wildcard: extract name from all items
  • data.users[*].email — Nested wildcard extraction

Example: API + Extract Chain

TypeScript
// 1. Call API
{ name: "api_call", args: { url: "https://api.example.com/users" } }
// Returns: { data: { users: [{ name: "A", email: "a@x.com" }, ...] } }

// 2. Extract emails
{ name: "json_extract", args: { json: apiResult.data, path: "users[*].email" } }
// Returns: ["a@x.com", "b@x.com", ...]

calendar Premium

Google Calendar integration for reading and creating calendar events. Requires the user to have Google Calendar connected via integrations.

TypeScript
tools.calendar

Operations

OperationParametersDescription
list_eventsstartDate, endDateList events within a date range
create_eventtitle, description, startTime, endTime, attendeesCreate a new calendar event
find_free_slotsdate, durationMinutesFind available time slots

Integration Requirement

The user must enable Google Calendar in their integrations:

TypeScript
// Check integration status in onMessage
onMessage: async (message, context) => {
  if (!input.integrations.googleCalendar) {
    return "Please connect Google Calendar in Settings → Integrations.";
  }
  return null;
}

file_storage Standard

Upload, download, list, and delete files using Google Cloud Platform (GCP) storage. Files are scoped to the task execution.

TypeScript
tools.fileStorage

Operations

OperationParametersDescription
uploadfilename, content, mimeTypeUpload a file
downloadfileIdDownload a file
listprefixList files (optional prefix filter)
deletefileIdDelete a file
getUrlfileIdGet signed URL for direct access

Next Steps