agent

Create Agent

post/v1/agent/create

Request

  • Base URL: https://api.vlm.run (the document declares no server; this is the origin it was published from)
  • URL: https://api.vlm.run/v1/agent/create
  • Auth: HTTP bearer

Request body

idstring

Unique identifier of the request.

created_atstring date-time

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

callback_urlstring uri nullable

The URL to call when the request is completed.

namestring nullable

Name of the agent. If not provided, a pretty-name will be generated.

inputsAgentExecutionInputs

Base class for agent execution inputs.

Users can subclass this to create typed input models for their agents. For example:

class MyAgentInputs(AgentExecutionInputs):
    image: MessageContent
    prompt: str

request = AgentExecutionRequest(
    name="my-agent",
    inputs=MyAgentInputs(image=..., prompt=...)
)

Response

Successful Response

idstring required

ID of the agent

namestring required

Name of the agent

status'pending' | 'enqueued' | 'running' | 'completed' | 'failed' | 'paused'

The status of the job.

created_atstring date-time required

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

updated_atstring date-time required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.