Passer au contenu principal
POST
/
tools
/
{tool_id}
/
execute
Exécuter un outil
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)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({inputs: {stock_symbol: 'ACME', report_year: 2023}})
};

fetch('https://app.ubik-agent.com/api/v1/tools/{tool_id}/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
curl --request POST \
--url https://app.ubik-agent.com/api/v1/tools/{tool_id}/execute \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"inputs": {
"stock_symbol": "ACME",
"report_year": 2023
}
}
'
{
  "execution_id": "<string>",
  "status": "<string>",
  "tool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "details_url": "<string>",
  "stream_url": "<string>"
}
{
"detail": [
{
"loc": [
"body",
"inputs"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}

Autorisations

X-API-KEY
string
header
requis

En-têtes

X-End-User-ID
string | null

Paramètres de chemin

tool_id
string
requis

L'identifiant unique ou le nom de l'outil à exécuter. The unique identifier or name of the tool to execute.

Corps

application/json
inputs
Inputs · object
requis

Un dictionnaire d'entrées pour l'outil, correspondant à son input_schema.

Réponse

Successful Response

execution_id
string
requis

L'identifiant unique de cette instance d'exécution d'outil.

status
string
requis

Le statut actuel de l'exécution.

tool_id
string<uuid>
requis

L'ID de l'outil en cours d'exécution.

details_url
string
requis

L'URL pour interroger le résultat final de l'exécution.

stream_url
string
requis

L'URL pour diffuser en temps réel les événements de cette exécution.