Skip to main content
POST
/
v1
/
agent
/
lookup
!pip install vlmrun

from vlmrun.client import VLMRun
from vlmrun.client.types import AgentResponse

client = VLMRun(base_url="https://agent.vlm.run/v1", api_key="<VLMRUN_API_KEY>")

# Lookup by agent id
response: AgentResponse = client.agent.get(id="<agent-id>")

# Lookup by agent name and version
response: AgentResponse = client.agent.get(name="<agent-name>:<agent-version>")

# Lookup by agent name alone (latest version will be returned)
response: AgentResponse = client.agent.get(name="<agent-name>")

# Lookup by agent prompt alone (latest version will be returned)
response: AgentResponse = client.agent.get(prompt="<prompt>")

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "json_schema": {},
  "json_sample": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "pending"
}
!pip install vlmrun

from vlmrun.client import VLMRun
from vlmrun.client.types import AgentResponse

client = VLMRun(base_url="https://agent.vlm.run/v1", api_key="<VLMRUN_API_KEY>")

# Lookup by agent id
response: AgentResponse = client.agent.get(id="<agent-id>")

# Lookup by agent name and version
response: AgentResponse = client.agent.get(name="<agent-name>:<agent-version>")

# Lookup by agent name alone (latest version will be returned)
response: AgentResponse = client.agent.get(name="<agent-name>")

# Lookup by agent prompt alone (latest version will be returned)
response: AgentResponse = client.agent.get(prompt="<prompt>")

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to get agent info.

​
name
string | null

The full name of the agent (e.g. 'accounting-invoice:latest')

​
id
string | null

The ID of the agent (lookup either by name + version or by id alone)

​
prompt
string | null

The prompt of the agent (if not provided, the latest version will be returned).

Response

Successful Response

Response to the agent creation request.

​
id
string
required

ID of the agent

​
name
string
required

Name of the agent

​
description
string
required

Description of the agent

​
prompt
string
required

The prompt of the agent

​
created_at
string<date-time>
required

Date and time when the agent was created (in UTC timezone)

​
json_schema
object | null

The JSON schema of the agent's sample response

​
json_sample
object | null

The sample JSON response from the model.

​
updated_at
string<date-time> | null

Date and time when the agent was updated (in UTC timezone)

​
status
enum<string>
default:pending

The status of the job.

Available options:
pending,
enqueued,
running,
completed,
failed,
paused
⌘I