Skip to main content

Overview

Jinba Toolbox exposes a REST API built on Hono.js. Every resource — organizations, toolsets, tools, versions, runs, webhooks, and API keys — is accessible through conventional HTTP endpoints under the /v1 prefix. Base URL:

Authentication

All API requests (except explore routes) require authentication via a Bearer token. API keys are scoped to an organization and follow the jtb_ prefix convention. Include the key in the Authorization header:
1

Create an API key

Navigate to your organization settings and create a new API key. Give it a descriptive name such as production or ci-cd.
2

Store the key securely

Copy the key immediately after creation — it will not be displayed again. Store it in an environment variable or secrets manager.
3

Include the key in requests

Pass the key as a Bearer token in every API request.

Endpoint Reference

Organization Routes

These endpoints require organization membership. The authenticated API key must belong to the target organization.

ToolSet Routes

Tool Routes

Execution Routes

Version Routes

Run History Routes

Other Organization Routes

Public Routes

Public routes allow external consumers to execute tools using an API key, without requiring organization membership context.

Explore Routes

Explore routes are unauthenticated and allow browsing public toolsets.

Request & Response Examples

Execute a Tool

Request:
Response (success):

Execute via Public Endpoint

Create a ToolSet

Publish a Version

Error Handling

The API uses RFC 9457 Problem Details format for errors:

Common Status Codes

Best Practices

  • Store API keys in environment variables — never hard-code them in source code or commit them to version control.
  • Implement retry logic with exponential backoff for transient failures and 429 responses.
  • Use the public endpoint (/v1/public/...) when integrating external systems that only need to execute tools.
  • Pin a specific version in the run request body when reproducibility matters.
  • SDK — Type-safe client library wrapping these endpoints
  • MCP Integration — Model Context Protocol endpoints
  • Webhooks — Receive event notifications for tool runs and more