Skip to main content

​
Overview

Jinba Flow can load tools from an external tool registry. Jinba Toolbox exposes every published ToolSet of an organization through a registry manifest, so a single registration makes all of them available as workflow steps. Executions started from Jinba Flow run in the ToolSet’s sandbox like any other run and are metered in credits.

​
One-Click Setup

1

Publish at least one ToolSet

The Connect JinbaFlow button on the Tool Sets list page stays disabled, with the tooltip “Publish a tool set to connect”, until at least one ToolSet has a version published to its default environment. An organization that publishes only to other environment profiles has to use the manual setup below.
2

Click Connect JinbaFlow

A Connect JinbaFlow dialog asks for the Environment the connection should use. The hint explains that a new API key is created in the organization if no matching one exists. Click Connect.
3

Save the registry in Jinba Flow

Jinba Toolbox creates (or reuses) an API key named JinbaFlow Connection ({environment}) and opens Jinba Flow’s workspace settings in a new tab, on the Tool Access tab, with the Add Registry dialog pre-filled: Name (your organization name), Manifest URL and API Key. Review the values and save.
The button is only shown on deployments where Jinba Flow is configured; in the hosted service it opens https://flow.jinba.io.

​
Manual Setup

1

Create an API key

In Jinba Toolbox, create an API key for the environment Jinba Flow should run against (API Key Management).
2

Add the registry in Jinba Flow

Open the workspace Settings, select the Tool Access tab and, under External Tool Registries, click Add Registry. Fill in:
  • Name — any label, for example your organization name
  • Manifest URL — https://toolbox-api.jinba.io/v1/public/jinbaflow/manifest
  • API Key — the key from the previous step
3

Sync

Save the registry. Use Sync on the registry entry whenever you publish new ToolSets or versions, and Activate / Deactivate to control whether its tools are offered in workflows.
The Tool Access tab is only visible to workspace members who may view tool access rules, and Add Registry requires permission to create registries. Ask a workspace administrator if you do not see them.

​
What the Registry Exposes

The manifest is built for the organization that owns the API key; the URL carries no organization ID.
  • All eligible ToolSets are included, private and public alike. There is no per-ToolSet selection; to keep a ToolSet out of Jinba Flow, leave it unpublished for that environment or publish it under a different environment profile than the one the key uses.
  • A ToolSet without a published version, without an environment profile matching the key, or with no tools is skipped. When nothing qualifies the manifest returns 400 with “No published toolsets”.
  • The environment profile chosen for the key decides which published version and which environment variables are used.

​
Credits

Each successful execution from Jinba Flow consumes one credit from the organization that owns the API key.