VirtuousAI
Reference

Agent specs

List Specs

GET
/api/v1/agents/specs

Query Parameters

limit?integer
Default100
Range1 <= value <= 100
offset?integer
Default0
Range0 <= value
lifecycle_scope?string
Default"active"
Value in"active" | "inactive"
tag?array<>|

Filter by tag name(s)

tag_id?array<>|

Filter by tag id(s)

tag_match?string
Default"any"
Value in"any" | "all"

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/agents/specs"
{
  "specs": [
    {
      "activeVersion": 0,
      "activeVersionId": "8f87c9b9-d318-4bd6-b47e-00023d1f191c",
      "contentSha256": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "definitionMarkdown": "string",
      "description": "string",
      "frontmatter": {},
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "lifecycleStatus": "active",
      "name": "string",
      "systemKey": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Spec

POST
/api/v1/agents/specs

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

markdown*string

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/agents/specs" \  -H "Content-Type: application/json" \  -d '{    "markdown": "string"  }'
{
  "activeVersion": 0,
  "activeVersionId": "8f87c9b9-d318-4bd6-b47e-00023d1f191c",
  "contentSha256": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "definitionMarkdown": "string",
  "description": "string",
  "frontmatter": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "lifecycleStatus": "active",
  "name": "string",
  "systemKey": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Spec

GET
/api/v1/agents/specs/{spec_id}

Path Parameters

spec_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "activeVersion": 0,
  "activeVersionId": "8f87c9b9-d318-4bd6-b47e-00023d1f191c",
  "contentSha256": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "definitionMarkdown": "string",
  "description": "string",
  "frontmatter": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "lifecycleStatus": "active",
  "name": "string",
  "systemKey": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Spec

PATCH
/api/v1/agents/specs/{spec_id}

Path Parameters

spec_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

markdown*string

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "markdown": "string"  }'
{
  "activeVersion": 0,
  "activeVersionId": "8f87c9b9-d318-4bd6-b47e-00023d1f191c",
  "contentSha256": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "definitionMarkdown": "string",
  "description": "string",
  "frontmatter": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "lifecycleStatus": "active",
  "name": "string",
  "systemKey": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Spec

DELETE
/api/v1/agents/specs/{spec_id}

Path Parameters

spec_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

curl -X DELETE "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Purge Spec

POST
/api/v1/agents/specs/{spec_id}/purge

Path Parameters

spec_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

curl -X POST "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08/purge"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Restore Spec

POST
/api/v1/agents/specs/{spec_id}/restore

Path Parameters

spec_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore"
{
  "activeVersion": 0,
  "activeVersionId": "8f87c9b9-d318-4bd6-b47e-00023d1f191c",
  "contentSha256": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "definitionMarkdown": "string",
  "description": "string",
  "frontmatter": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "lifecycleStatus": "active",
  "name": "string",
  "systemKey": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Agent Spec Tags

GET
/api/v1/agents/specs/{spec_id}/tags

Path Parameters

spec_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08/tags"
{
  "items": [
    {
      "attributes": {},
      "color": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "namespace": "string",
      "slug": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Set Agent Spec Tags

PUT
/api/v1/agents/specs/{spec_id}/tags

Path Parameters

spec_id*string
Formatuuid

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

tagIds?array<>
tagNames?array<>

Response Body

application/json

application/json

curl -X PUT "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08/tags" \  -H "Content-Type: application/json" \  -d '{}'
{
  "items": [
    {
      "attributes": {},
      "color": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "namespace": "string",
      "slug": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Versions

GET
/api/v1/agents/specs/{spec_id}/versions

Path Parameters

spec_id*string
Formatuuid

Query Parameters

limit?integer
Default50
Range1 <= value <= 100

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/agents/specs/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
[
  {
    "contentSha256": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "definitionMarkdown": "string",
    "frontmatter": {},
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "active",
    "updatedAt": "2019-08-24T14:15:22Z",
    "version": 0
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Admin

Previous Page

Api catalog

Next Page