VM0VM0
ReferenceAPI Reference

Agents

Agent listing and retrieval endpoints

List and retrieve agent information.

List Agents

GET /v1/agents

Returns a paginated list of your agents.

Query Parameters

ParameterTypeDefaultDescription
limitinteger20Items per page (1-100)
cursorstring-Pagination cursor
namestring-Filter by agent name

Request

curl https://api.vm0.ai/v1/agents \
  -H "Authorization: Bearer vm0_live_xxx"

Filter by name:

curl "https://api.vm0.ai/v1/agents?name=my-agent" \
  -H "Authorization: Bearer vm0_live_xxx"

Response

{
  "data": [
    {
      "id": "ag_abc123",
      "name": "my-agent",
      "currentVersionId": "v1_xyz789",
      "createdAt": "2024-01-15T00:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}

Get Agent

GET /v1/agents/:id

Retrieves an agent's details.

Path Parameters

ParameterTypeDescription
idstringAgent ID

Request

curl https://api.vm0.ai/v1/agents/ag_abc123 \
  -H "Authorization: Bearer vm0_live_xxx"

Response

{
  "id": "ag_abc123",
  "name": "my-agent",
  "currentVersionId": "v1_xyz789",
  "createdAt": "2024-01-15T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

List Agent Versions

GET /v1/agents/:id/versions

Returns a paginated list of all versions for an agent.

Path Parameters

ParameterTypeDescription
idstringAgent ID

Query Parameters

ParameterTypeDefaultDescription
limitinteger20Items per page (1-100)
cursorstring-Pagination cursor

Request

curl https://api.vm0.ai/v1/agents/ag_abc123/versions \
  -H "Authorization: Bearer vm0_live_xxx"

Response

{
  "data": [
    {
      "id": "v1_xyz789",
      "agentId": "ag_abc123",
      "versionNumber": 2,
      "createdAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "v1_abc123",
      "agentId": "ag_abc123",
      "versionNumber": 1,
      "createdAt": "2024-01-15T00:00:00Z"
    }
  ],
  "pagination": {
    "hasMore": false,
    "nextCursor": null
  }
}

Agent Object

FieldTypeDescription
idstringUnique agent identifier (prefix: ag_)
namestringAgent name
currentVersionIdstringID of the current version
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

Version Object

FieldTypeDescription
idstringUnique version identifier
agentIdstringParent agent ID
versionNumberintegerSequential version number
createdAtstringISO 8601 creation timestamp