Docs/Help/Custom API

Custom API

API Library Management

Add New APICreates a new custom API action entry that can be used by the agent.
Edit API DefinitionOpens a side panel editor for existing API actions.
Delete API DefinitionRemoves API actions from the in-memory tool list before save-all commit.
Enable or Disable APISupports per-action enable state to control runtime availability.
Save All ChangesPersists API actions and category structure to agent tools configuration in one commit step.

Category Organization

Category CreationAdds named categories to group API actions.
Category RenameRenames category labels and remaps linked API entries.
Category Deletion GuardPrevents deleting categories that still contain APIs.
Drag-and-drop ReorderingReorders APIs within a category using sortable interactions.
Move API Across CategoriesSupports moving APIs between categories, including uncategorized group.

API Definition Model

Basic ConfigurationDefines action name, description, rules, response prompt, HTTP method, and target URI.
Authentication OptionsSupports none, bearer, basic, custom header, and OAuth-based authentication settings.
Request Parameters SchemaDefines parameter properties including type, requirement, location, and optional enumeration.
Additional Properties FlagControls whether undeclared parameters are allowed in request payloads.
Metadata ForwardingOptional setting to append runtime metadata fields to outgoing API calls.

Import and Validation Surface

OpenAPI Schema ImportImports action definitions from OpenAPI content in JSON or YAML format.
Schema EditorUses code-editor input for schema payload and conversion flow.
Import Merge BehaviorAppends imported API actions into the current tool collection before persistence.

Test Console

API Test ModeOpens a dedicated test interface per API action without leaving the configuration context.
Parameter Input RunnerGenerates test input controls from the configured parameter schema.
Metadata Test FieldsExposes metadata fields when metadata forwarding is enabled for the API.
Response InspectorDisplays status code, headers, and body with structured rendering and copy actions.