VirtuousAI
Reference

Agent specs

List Specs

GET
/api/v1/agents/specs

Query Parameters

limit?integer
Default100
Range1 <= value <= 100
offset?integer
Default0
Range0 <= value
owner_scope?|

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/agents/specs"
{
  "specs": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
      "description": "string",
      "frontmatter": {},
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "markdown": "string",
      "name": "string",
      "slug": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
    }
  ],
  "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"  }'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "description": "string",
  "frontmatter": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "markdown": "string",
  "name": "string",
  "slug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}
{
  "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"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "description": "string",
  "frontmatter": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "markdown": "string",
  "name": "string",
  "slug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}
{
  "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"  }'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "description": "string",
  "frontmatter": {},
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "markdown": "string",
  "name": "string",
  "slug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}
{
  "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"
    }
  ]
}

Admin

Previous Page

Auth

Next Page