Tools

Execute a tool by name

Runs the named tool with the provided JSON params. Schema for params varies per tool — fetch it from /public/tools/{name}. File inputs may be referenced by ID (uploaded via /public/files/upload) or sent inline as multipart/form-data.

post/public/tools/{name}/run

Request

  • Base URL: https://api.johnsessentials.com/api/v1
  • URL: https://api.johnsessentials.com/api/v1/public/tools/{name}/run
  • Auth: HTTP bearer

Path parameters

namestring required

Headers

Idempotency-Keystring

Opaque client-chosen string ≤255 chars. Identical key + body replays cached response within 24h.

Request body

object required

Response

Tool ran successfully.

request_idstring uuid required
successboolean required

Example response

{
  "meta": {
    "version": "1.0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.