Passer au contenu principal
GET
/
tools
/
{tool_id}
/
embed-info
Obtenir les informations d'intégration d'un outil
import requests

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

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "input_schema": {
    "type": "<unknown>",
    "properties": {},
    "required": [
      "<string>"
    ],
    "additionalProperties": false,
    "$defs": {}
  },
  "media_output_keys": [
    "<string>"
  ],
  "example_responses": [
    {}
  ],
  "allowed_origins": [
    "<string>"
  ],
  "description": "<string>",
  "access_token": "<string>"
}

Autorisations

​
X-API-KEY
string
header
requis

Paramètres de chemin

​
tool_id
string
requis

L'identifiant unique ou le nom de l'outil. The unique identifier or name of the tool.

Paramètres de requête

​
external_user_id
string | null

ID utilisateur externe optionnel pour limiter la portée du jeton d'accès. Optional external user ID to scope the access token.

Réponse

Successful Response

​
id
string<uuid>
requis

L'identifiant unique de l'outil.

​
name
string
requis

Le nom de l'outil.

​
input_schema
ToolInputSchema · object
requis

Le schéma JSON définissant les entrées pour l'outil.

​
media_output_keys
string[]
requis

Une liste de clés dans la sortie qui contiennent des URL de médias.

​
example_responses
Example Responses · object[]
requis

Une liste d'exemples d'entrées et de leurs sorties correspondantes pour l'outil.

​
allowed_origins
string[]
requis

Une liste de domaines autorisés pour l'intégration de cet outil.

​
description
string | null

Une brève description de ce que fait l'outil.

​
access_token
string | null

Un jeton d'accès JWT de courte durée pour authentifier les appels API depuis l'interface utilisateur intégrée.