---
title: "Lookup Agent"
method: POST
path: "/v1/agent/lookup"
tags: ["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

- AgentLookupRequest: Request to get agent info.
  - `name` string, nullable: The full name of the agent (e.g. 'accounting-invoice:latest')
  - `id` string, nullable: The ID of the agent (lookup either by name + version or by id alone)
  - `prompt` string, nullable: The prompt of the agent (if not provided, the latest version will be returned).

## Response `200`

Successful Response

- AgentInfoResponse: 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
  - `json_schema` object, nullable: The JSON schema of the agent's sample response
  - `json_sample` object, nullable: The sample JSON response from the model.
  - `created_at` string, date-time, required: Date and time when the agent was created (in UTC timezone)
  - `updated_at` string, 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.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/vlm/apis/vlm-run-unified-server.md) · [All operations](https://skmtc.dev/vlm/apis/vlm-run-unified-server/llms.txt) · [OpenAPI document](https://skmtc.dev/vlm/apis/vlm-run-unified-server/revisions/4a68ab36546b?raw)