FIfish
Agent Tools

Get Tool

Changed on

Fetch one tool's full definition. Credential header values are never returned — each credential header reports has_secret instead.

get/v1/agent/tools/{tool_id}

Request

  • Base URL
    https://api.fish.audio
  • URL
    https://api.fish.audio/v1/agent/tools/{tool_id}
  • Auth
    HTTP bearer

Path parameters

tool_idstring required

Response

Request fulfilled, document follows

tool_idstring required
workspace_idstring required
namestring required
descriptionstring
tool_type'webhook' | 'client' required
method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required
urlstring required
used_byinteger

How many agents reference this tool in their draft configuration.

created_atstring date-time required
updated_atstring date-time required
parametersobject required

Call parameters as a JSON Schema object (draft 2020-12): type: object (filled in when omitted), properties, required. Standard meaning throughout: required means the key must be present, type: ["string", "null"] allows null, minLength: 1 makes a string non-empty, enum and pattern constrain the value, default fills a key the model left out. Mutually exclusive with arguments in one request. A tool created with parameters starts in parameter_mode: strict.

parameter_mode'legacy' | 'strict'

Whether the agent runtime checks each call's arguments against parameters before running the tool. legacy (the default for tools created with arguments, and every tool from before this field existed): no check, the model's arguments run as sent. strict (the default for tools created with parameters): a call that does not satisfy the schema is refused and the model is told to ask the caller for the missing information, and the LLM provider's constrained decoding is turned on where the model supports it (OpenAI models and a custom OpenAI-compatible endpoint receive the tool with strict: true, Gemini on the platform's native channel runs validated function calling). Changing parameters never changes the mode, and the mode can be changed on its own.

content_typestring required
body_templatestring
timeout_secondsinteger required
error_handling'passthrough' | 'hide' required
expects_responseboolean
execution_mode'blocking' | 'fire_and_forget' | 'background'

Changes