!pip install vlmrun
from vlmrun.client import VLMRun
from vlmrun.client.types import AgentInfo
client = VLMRun(api_key="<VLMRUN_API_KEY>")
# Lookup by agent id
response: AgentInfo = client.agent.get(id="<agent-id>")
# Lookup by agent name and version
response: AgentInfo = client.agent.get(name="<agent-name>:<agent-version>")
# Lookup by agent name alone (latest version will be returned)
response: AgentInfo = client.agent.get(name="<agent-name>")
# Lookup by agent prompt alone (latest version will be returned)
response: AgentInfo = client.agent.get(prompt="<prompt>")
import { VlmRun } from "vlmrun";
const client = new VlmRun({
baseURL: "https://api.vlm.run/v1",
apiKey: "<VLMRUN_API_KEY>"
});
// Lookup by agent id
const response1 = await client.agent.get({ id: "<agent-id>" });
// Lookup by agent name and version
const response2 = await client.agent.get({ name: "<agent-name>:<agent-version>" });
// Lookup by agent name alone (latest version will be returned)
const response3 = await client.agent.get({ name: "<agent-name>" });
// Lookup by agent prompt alone (latest version will be returned)
const response4 = await client.agent.get({ prompt: "<prompt>" });
console.log(response1);
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"json_schema": {},
"json_sample": {},
"updated_at": "2023-11-07T05:31:56Z",
"status": "pending"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Agent
Lookup Agent
POST
/
v1
/
agent
/
lookup
!pip install vlmrun
from vlmrun.client import VLMRun
from vlmrun.client.types import AgentInfo
client = VLMRun(api_key="<VLMRUN_API_KEY>")
# Lookup by agent id
response: AgentInfo = client.agent.get(id="<agent-id>")
# Lookup by agent name and version
response: AgentInfo = client.agent.get(name="<agent-name>:<agent-version>")
# Lookup by agent name alone (latest version will be returned)
response: AgentInfo = client.agent.get(name="<agent-name>")
# Lookup by agent prompt alone (latest version will be returned)
response: AgentInfo = client.agent.get(prompt="<prompt>")
import { VlmRun } from "vlmrun";
const client = new VlmRun({
baseURL: "https://api.vlm.run/v1",
apiKey: "<VLMRUN_API_KEY>"
});
// Lookup by agent id
const response1 = await client.agent.get({ id: "<agent-id>" });
// Lookup by agent name and version
const response2 = await client.agent.get({ name: "<agent-name>:<agent-version>" });
// Lookup by agent name alone (latest version will be returned)
const response3 = await client.agent.get({ name: "<agent-name>" });
// Lookup by agent prompt alone (latest version will be returned)
const response4 = await client.agent.get({ prompt: "<prompt>" });
console.log(response1);
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"prompt": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"json_schema": {},
"json_sample": {},
"updated_at": "2023-11-07T05:31:56Z",
"status": "pending"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}!pip install vlmrun
from vlmrun.client import VLMRun
from vlmrun.client.types import AgentInfo
client = VLMRun(api_key="<VLMRUN_API_KEY>")
# Lookup by agent id
response: AgentInfo = client.agent.get(id="<agent-id>")
# Lookup by agent name and version
response: AgentInfo = client.agent.get(name="<agent-name>:<agent-version>")
# Lookup by agent name alone (latest version will be returned)
response: AgentInfo = client.agent.get(name="<agent-name>")
# Lookup by agent prompt alone (latest version will be returned)
response: AgentInfo = client.agent.get(prompt="<prompt>")
import { VlmRun } from "vlmrun";
const client = new VlmRun({
baseURL: "https://api.vlm.run/v1",
apiKey: "<VLMRUN_API_KEY>"
});
// Lookup by agent id
const response1 = await client.agent.get({ id: "<agent-id>" });
// Lookup by agent name and version
const response2 = await client.agent.get({ name: "<agent-name>:<agent-version>" });
// Lookup by agent name alone (latest version will be returned)
const response3 = await client.agent.get({ name: "<agent-name>" });
// Lookup by agent prompt alone (latest version will be returned)
const response4 = await client.agent.get({ prompt: "<prompt>" });
console.log(response1);
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful Response
Response to the agent creation request.
ID of the agent
Name of the agent
Description of the agent
The prompt of the agent
Date and time when the agent was created (in UTC timezone)
The JSON schema of the agent's sample response
The sample JSON response from the model.
Date and time when the agent was updated (in UTC timezone)
The status of the job.
Available options:
pending, enqueued, running, completed, failed, paused