Monkeys
Tools

Use Custom Tools

Import existing APIs as Monkeys tools

Import Methods

Monkeys supports three ways to import custom tools:

  • Monkeys manifest.json.
  • Existing OpenAPI schema.
  • Manual API definition.

Use manifest.json when you control the tool service. Use OpenAPI import when the service already exposes a good schema. Use manual import for one-off APIs or services that do not expose OpenAPI.

Import by manifest.json

Deploy your tool service and make sure Monkeys can reach its manifest URL, for example:

http://tool-service.example.com/manifest.json

Then import it from the tool management page in Studio. The manifest can also define credentials, triggers, health checks, rate limits, and OpenAPI URL.

See Declarative Syntax and Build Custom Tools.

Import by OpenAPI

If an existing service exposes OpenAPI JSON, import the OpenAPI URL directly. Monkeys will parse methods and schemas to generate tool invocation forms.

Manual Import

Manual import is useful for simple HTTP APIs. You define:

  • Display name and description.
  • Request URL and HTTP method.
  • Credential location and key.
  • Request parameters.
  • Expected output fields.

When the API requires credentials, store the secret in a credential configuration instead of hard-coding it in workflows.

On this page