tools

Get a tool

Get one tool: its input and output schemas, effect, sign-in needs and integration.

  • A disabled tool, or another account's private tool, is not found. An integration key reaches only its own integration's tools.
  • Without credentials, where allowed, it reads only public tools, and a tool that writes or needs a login answers sign_in_required.
get/v1/tools/{id}

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/tools/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:tool_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

a tool ID: tool_ and 32 lowercase hex digits

Response

The tool

idstring required

a tool ID: tool_ and 32 lowercase hex digits

namestring required
descriptionstring required
integration_idstring required

an integration ID: int_ and 32 lowercase hex digits

effect'read' | 'write' required

read changes nothing on the site; write changes something there

input_schemaobject required

What a run's input takes, as JSON Schema. References are resolved: one left in a recursive schema points at its root $defs

output_schemaobject required

What a succeeded run's result holds, as JSON Schema, in the same form

mcp_namestring required

Its tool name on its integration's MCP, such as get_claim_status

can_changeboolean required

Whether you can request a change to this tool: you can run it and build tools, and you aren't using an integration key

Example response

{
  "id": "tool_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "integration_id": "int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
}

Changes

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