AI

Execute a server-side tool

Runs one of the built-in server-side tools (weather_info, web_search, web_fetch) and returns its result as JSON. Authenticate with a JWT access token only - API keys are NOT accepted on this endpoint. Rate-limited to 100 requests/hour per user, counted separately from other endpoints. request_id echoes the X-Request-ID response header.

post/api/ai/v1/tools

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/ai/v1/tools
  • Auth: HTTP bearer

Request body

toolName'weather_info' | 'web_search' | 'web_fetch' required
inputobject required

Example request

{
  "toolName": "web_search",
  "input": {
    "query": "how to reset a password"
  }
}

Response

Tool executed successfully (success is always true here).

successboolean required
resultunknown
errorstring
errorTypestring
executionTimeMsnumber
request_idstring required

Example response

{
  "success": true,
  "result": {
    "summary": "Top results for the query."
  },
  "executionTimeMs": 842,
  "request_id": "abc-123"
}

Changes

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