Skip to navigation

Retrieve an agent tool

View as Markdown

Returns one active tool of the agent. Credentials (auth_config) are never returned; headers are returned in full, including fixed_value. A deleted tool answers 404.

This endpoint reads only the tool row: it does not check the provider, so use it to inspect configuration, not to confirm the tool is attached to the live agent.

Consistency. Cached per workspace and tool for up to 120 seconds; PATCH and DELETE through this API invalidate the entry immediately.

Access

  • Required scope: read (or write).
  • Rate limit: General API — 120–600 requests/min per workspace depending on plan. See Rate limits.
  • Plan: Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Path parameters

agentIdstringRequiredformat: "uuid"
UUID of the agent that owns the tool.
toolIdstringRequiredformat: "uuid"

UUID of the tool, as returned by POST /api/agents/{agentId}/tools.

Response

The tool.
dataobject

A webhook tool as returned by the API. Keys are snake_case (the request bodies use camelCase). auth_config is never returned.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error