Skip to main content
POST
/
tools
/
{tool_id}
/
execute
Execute a tool
import requests

url = "https://app.ubik-agent.com/api/v1/tools/{tool_id}/execute"

payload = { "inputs": {
        "stock_symbol": "ACME",
        "report_year": 2023
    } }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "execution_id": "<string>",
  "status": "<string>",
  "tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "details_url": "<string>",
  "stream_url": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
X-End-User-ID
string | null

Path Parameters

​
tool_id
string
required

The unique identifier or name of the tool to execute.

Body

application/json
​
inputs
Inputs · object
required

A dictionary of inputs for the tool, matching its input_schema.

Response

Successful Response

​
execution_id
string
required

The unique identifier for this tool execution instance.

​
status
string
required

The current status of the execution.

​
tool_id
string<uuid>
required

The ID of the tool being executed.

​
details_url
string
required

The URL to poll for the final execution result.

​
stream_url
string
required

The URL to stream real-time events for this execution.