agent

Lookup Agent

post/v1/agent/lookup

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/lookup
  • Auth: HTTP bearer

Request body

namestring nullable

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

idstring nullable

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

promptstring nullable

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

Response

Successful Response

idstring required

ID of the agent

namestring required

Name of the agent

descriptionstring required

Description of the agent

promptstring required

The prompt of the agent

json_schemaobject nullable

The JSON schema of the agent's sample response

json_sampleobject nullable

The sample JSON response from the model.

created_atstring date-time required

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

updated_atstring date-time nullable

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

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

The status of the job.

Changes

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