VirtuousAI
Reference

Templates

List Templates

GET
/api/v1/templates

Query Parameters

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

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/templates"
{
  "templates": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "definition": {},
      "description": "string",
      "displayName": "string",
      "iconUrl": "string",
      "id": "string",
      "inputDefaults": {},
      "inputJsonSchema": {},
      "isActive": true,
      "kind": "string",
      "slug": "string",
      "status": "draft",
      "templateType": "connection",
      "updatedAt": "2019-08-24T14:15:22Z",
      "version": 0
    }
  ],
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Template

POST
/api/v1/templates

Header Parameters

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

Request Body

application/json

definition*
description?|
displayName*string
Length1 <= length <= 255
iconUrl?|
inputDefaults?
inputJsonSchema?
kind?|
slug*string
Length1 <= length <= 100
templateType*string

Discriminator for template definition shapes.

Value in"connection" | "action" | "bundle"

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/templates" \  -H "Content-Type: application/json" \  -d '{    "definition": {},    "displayName": "string",    "slug": "string",    "templateType": "connection"  }'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "definition": {},
  "description": "string",
  "displayName": "string",
  "iconUrl": "string",
  "id": "string",
  "inputDefaults": {},
  "inputJsonSchema": {},
  "isActive": true,
  "kind": "string",
  "slug": "string",
  "status": "draft",
  "templateType": "connection",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Template By Slug

GET
/api/v1/templates/slug/{slug}

Path Parameters

slug*string

Query Parameters

version?|

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/templates/slug/string"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "definition": {},
  "description": "string",
  "displayName": "string",
  "iconUrl": "string",
  "id": "string",
  "inputDefaults": {},
  "inputJsonSchema": {},
  "isActive": true,
  "kind": "string",
  "slug": "string",
  "status": "draft",
  "templateType": "connection",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Template

GET
/api/v1/templates/{template_id}

Path Parameters

template_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/templates/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "definition": {},
  "description": "string",
  "displayName": "string",
  "iconUrl": "string",
  "id": "string",
  "inputDefaults": {},
  "inputJsonSchema": {},
  "isActive": true,
  "kind": "string",
  "slug": "string",
  "status": "draft",
  "templateType": "connection",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Template

DELETE
/api/v1/templates/{template_id}

Path Parameters

template_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

Update Template

PUT
/api/v1/templates/{template_id}

Path Parameters

template_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

definition?|
description?|
displayName?|
iconUrl?|
inputDefaults?|
inputJsonSchema?|
status?|

Response Body

application/json

application/json

curl -X PUT "https://loading/api/v1/templates/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "definition": {},
  "description": "string",
  "displayName": "string",
  "iconUrl": "string",
  "id": "string",
  "inputDefaults": {},
  "inputJsonSchema": {},
  "isActive": true,
  "kind": "string",
  "slug": "string",
  "status": "draft",
  "templateType": "connection",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Deprecate Template

POST
/api/v1/templates/{template_id}/deprecate

Path Parameters

template_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/templates/497f6eca-6276-4993-bfeb-53cbbbba6f08/deprecate"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "definition": {},
  "description": "string",
  "displayName": "string",
  "iconUrl": "string",
  "id": "string",
  "inputDefaults": {},
  "inputJsonSchema": {},
  "isActive": true,
  "kind": "string",
  "slug": "string",
  "status": "draft",
  "templateType": "connection",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Publish Template

POST
/api/v1/templates/{template_id}/publish

Path Parameters

template_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/templates/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "definition": {},
  "description": "string",
  "displayName": "string",
  "iconUrl": "string",
  "id": "string",
  "inputDefaults": {},
  "inputJsonSchema": {},
  "isActive": true,
  "kind": "string",
  "slug": "string",
  "status": "draft",
  "templateType": "connection",
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Sync

Previous Page

Users

Next Page