Skip to main content
GET
/
v1
/
agent
!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>")
response: AgentResponse = client.agent.list(skip=0, limit=10)

[
  {
    "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"
  }
]
!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>")
response: AgentResponse = client.agent.list(skip=0, limit=10)

Authorizations

​
Authorization
string
header
required

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

Response

200 - application/json

Successful Response

​
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
Json Schema · object

The JSON schema of the agent's sample response

​
json_sample
Json Sample · object

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