tools.tool.read

Generated at from openvibe-contracts v0.114.0 and openvibe-sdk v0.35.1.

Grantable to apps: request it for an app on its project page. Network approves it only inside the project's allowance.

Read the tool registry (ADR-027): every tool's descriptor (tools.tool@1: execution, whether the run API exposes it, how to call it, input and output schemas, files, limits, auth, quota class, cost, egress, hosts, docs), filtered by family, execution, api, status or text. GET /api/v1/tools answers tools.tool-list@1 with schemas as { $ref }; GET /api/v1/tools/:id has them embedded; GET /api/v1/tools/:id/schema answers { $schema, $id, $defs: { input, output } }, with $defs.input false for a tool without an API. The gateway (https://openvibe.tools) answers for every tool, and each satellite for its own tools with its own live status. Open to everyone, anonymous callers included, from any origin (CORS *); cacheable (ETag, 304). A bad filter value is 400 tools.query.invalid; an unknown, planned or mirror id is 404 tools.tool.not_found, whose detail says which.

Owner
tools (token audience openvibe.tools)
Version
1.0
Status
active
Visibility
public
Resource constraints
none
Quota class
tools-read
Permissions
tools:catalog:read
Input
common.no-body@1
Output
tools.tool-read-result@1
Events
—
Implemented by
  • GET /api/v1/tools
  • GET /api/v1/tools/:id
  • GET /api/v1/tools/:id/schema

These routes in the API explorer