UBIK Agent will launch soon, join the waitlist to get access!
API Reference
- Introduction
- GETList available models
- GETList available assistants
- GETList agent sessions
- POSTCreate agent session
- GETGet agent session details
- DELDelete agent session
- PATCHUpdate agent session
- GETList session MCP servers
- GETList session tools
- GETList session skills
- POSTLink skills
- DELUnlink skill
- GETGet session messages
- POSTSend message
- POSTStop agent generation
- POSTRegenerate response
- POSTEdit message and regenerate
- POSTNavigate session
- GETGet message details
- GETList session checkpoints
- POSTNavigate to checkpoint
- GETList session documents
- POSTLink documents
- POSTUpload and link document
- DELUnlink document
- POSTLink workspaces
- DELUnlink workspace
- PUTStar/Unstar document
- GETStream session events
- GETGet tool asset
- GETList skills
- GETGet skill
- GETHealth Check
- GETRead Current User
- GETList available MCP servers
- GETList workspaces
- POSTCreate a workspace
- GETGet workspace details
- DELDelete a workspace
- GETList documents in a workspace
- GETList documents
- POSTIngest documents from files or URLs
- GETGet document details
- DELDelete a document
- GETGet document from chunk
- GETGet chunk details
- POSTReprocess a document
- PATCHUpdate Document Access Metadata
- POSTAdd document to workspaces
- DELRemove document from workspaces
- DELRemove a document from a workspace
- GETList available tools
- GETGet tool details
- GETGet tool embedding information
- POSTGet JWT from API Key
- POSTExecute a tool
- GETGet execution result
- GETStream execution events
- POSTProvide input to a waiting tool
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>"
}Get tool embedding information
Retrieves the necessary details for embedding a tool’s UI, including its schema and allowed domains. Optionally accepts ‘external_user_id’ to scope the returned access token.
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>"
}Documentation Index
Fetch the complete documentation index at: https://docs.ubik-agent.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Path Parameters
The unique identifier or name of the tool.
Query Parameters
Optional external user ID to scope the access token.
Response
Successful Response
The unique identifier for the tool.
The name of the tool.
The JSON schema defining the inputs for the tool.
Hide child attributes
Hide child attributes
An object defining the properties of the input object.
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
The data type of the property (e.g., 'string', 'integer', or ['string', 'null']).
A description of what the property represents.
A list of possible values if the property is an enumeration.
A list of property names that are required.
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
The data type of the property (e.g., 'string', 'integer', or ['string', 'null']).
A description of what the property represents.
A list of possible values if the property is an enumeration.
A list of keys in the output that contain media URLs.
A list of example inputs and their corresponding outputs for the tool.
A list of allowed domains for embedding this tool.
A brief description of what the tool does.
A short-lived JWT access token for authenticating API calls from the embedded UI.
Was this page helpful?