VirtuousAI
Reference

Artifacts

List Artifacts

GET
/api/v1/artifacts

Query Parameters

q?|

Search by name or description

source_kind?|
data_kind?|
source_thread_id?|

Filter by chat thread ID

limit?integer
Default25
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/artifacts"
{
  "hasNext": true,
  "items": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "latestVersion": {
        "actorType": "human",
        "changeReason": "string",
        "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
        "createdAt": "2019-08-24T14:15:22Z",
        "dataKind": "tabular",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "rendererKind": "ag_grid",
        "sourceMetadata": {},
        "sourceScope": "string",
        "sourceSurface": "chat",
        "sourceTable": "string",
        "version": 0
      },
      "name": "string",
      "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
      "sourceKind": "chat_promotion",
      "sourceMetadata": {},
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Artifact

POST
/api/v1/artifacts

Header Parameters

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

Request Body

application/json

changeReason?|
data*
dataKind*string
Value in"tabular" | "markdown"
description?|
name*string
Length1 <= length <= 255
refreshQuery?|
rendererConfig*
rendererKind*string
Value in"ag_grid" | "markdown" | "echarts"
sourceKind?string
Default"manual"
Value in"chat_promotion" | "manual"
sourceMetadata?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/artifacts" \  -H "Content-Type: application/json" \  -d '{    "data": {},    "dataKind": "tabular",    "name": "string",    "rendererConfig": {},    "rendererKind": "ag_grid"  }'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isShared": false,
  "name": "string",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "resolvedVersion": {
    "actorType": "human",
    "changeReason": "string",
    "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
    "createdAt": "2019-08-24T14:15:22Z",
    "data": {},
    "dataKind": "tabular",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "refreshQuery": "string",
    "rendererConfig": {},
    "rendererKind": "ag_grid",
    "sourceMetadata": {},
    "sourceScope": "string",
    "sourceSurface": "chat",
    "sourceTable": "string",
    "version": 0
  },
  "shareRecipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "sharedBy": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "profilePictureUrl": "string"
  },
  "sourceKind": "chat_promotion",
  "sourceMetadata": {},
  "updatedAt": "2019-08-24T14:15:22Z",
  "viewerAccess": "owner"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Shared Artifacts

GET
/api/v1/artifacts/shared

Query Parameters

q?|

Search by name or description

limit?integer
Default25
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/artifacts/shared"
{
  "hasNext": true,
  "items": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "latestVersion": {
        "actorType": "human",
        "changeReason": "string",
        "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
        "createdAt": "2019-08-24T14:15:22Z",
        "dataKind": "tabular",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "rendererKind": "ag_grid",
        "sourceMetadata": {},
        "sourceScope": "string",
        "sourceSurface": "chat",
        "sourceTable": "string",
        "version": 0
      },
      "name": "string",
      "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
      "sourceKind": "chat_promotion",
      "sourceMetadata": {},
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Artifact

GET
/api/v1/artifacts/{artifact_id}

Path Parameters

artifact_id*string
Formatuuid

Query Parameters

version?|

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isShared": false,
  "name": "string",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "resolvedVersion": {
    "actorType": "human",
    "changeReason": "string",
    "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
    "createdAt": "2019-08-24T14:15:22Z",
    "data": {},
    "dataKind": "tabular",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "refreshQuery": "string",
    "rendererConfig": {},
    "rendererKind": "ag_grid",
    "sourceMetadata": {},
    "sourceScope": "string",
    "sourceSurface": "chat",
    "sourceTable": "string",
    "version": 0
  },
  "shareRecipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "sharedBy": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "profilePictureUrl": "string"
  },
  "sourceKind": "chat_promotion",
  "sourceMetadata": {},
  "updatedAt": "2019-08-24T14:15:22Z",
  "viewerAccess": "owner"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Artifact

PATCH
/api/v1/artifacts/{artifact_id}

Path Parameters

artifact_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

description?|
name?|

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isShared": false,
  "name": "string",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "resolvedVersion": {
    "actorType": "human",
    "changeReason": "string",
    "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
    "createdAt": "2019-08-24T14:15:22Z",
    "data": {},
    "dataKind": "tabular",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "refreshQuery": "string",
    "rendererConfig": {},
    "rendererKind": "ag_grid",
    "sourceMetadata": {},
    "sourceScope": "string",
    "sourceSurface": "chat",
    "sourceTable": "string",
    "version": 0
  },
  "shareRecipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "sharedBy": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "profilePictureUrl": "string"
  },
  "sourceKind": "chat_promotion",
  "sourceMetadata": {},
  "updatedAt": "2019-08-24T14:15:22Z",
  "viewerAccess": "owner"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Artifact

DELETE
/api/v1/artifacts/{artifact_id}

Path Parameters

artifact_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

Get Artifact Data

GET
/api/v1/artifacts/{artifact_id}/data

Path Parameters

artifact_id*string
Formatuuid

Query Parameters

version?|
limit?integer
Default100
Range1 <= value <= 5000
offset?integer
Default0
Range0 <= value
sort_column?|
sort_direction?string

Sort direction for pagination.

Default"asc"
Value in"asc" | "desc"

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/data"
{
  "columns": [
    {
      "dataType": "string",
      "displayName": "string",
      "name": "string"
    }
  ],
  "hasNext": true,
  "items": [
    {}
  ],
  "limit": 0,
  "offset": 0,
  "sourceMode": "inline",
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Download Artifact

GET
/api/v1/artifacts/{artifact_id}/download

Path Parameters

artifact_id*string
Formatuuid

Query Parameters

version?|
format?string
Default"csv"
Value in"csv" | "json"

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/download"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Artifact Share

GET
/api/v1/artifacts/{artifact_id}/share

Path Parameters

artifact_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/share"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "recipientUserIds": [
    "string"
  ],
  "recipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "shareId": "string",
  "state": "not_shared",
  "status": "active",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Revoke Artifact Share

DELETE
/api/v1/artifacts/{artifact_id}/share

Path Parameters

artifact_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

Upsert Artifact Share

PUT
/api/v1/artifacts/{artifact_id}/share

Path Parameters

artifact_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

expiresAt?|
recipientUserIds?array<>

Response Body

application/json

application/json

curl -X PUT "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/share" \  -H "Content-Type: application/json" \  -d '{}'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "recipientUserIds": [
    "string"
  ],
  "recipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "shareId": "string",
  "state": "not_shared",
  "status": "active",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Clear Artifact Share

DELETE
/api/v1/artifacts/{artifact_id}/share/clear

Path Parameters

artifact_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

List Artifact Versions

GET
/api/v1/artifacts/{artifact_id}/versions

Path Parameters

artifact_id*string
Formatuuid

Query Parameters

limit?integer
Default25
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/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
{
  "hasNext": true,
  "items": [
    {
      "actorType": "human",
      "changeReason": "string",
      "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
      "createdAt": "2019-08-24T14:15:22Z",
      "dataKind": "tabular",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rendererKind": "ag_grid",
      "sourceMetadata": {},
      "sourceScope": "string",
      "sourceSurface": "chat",
      "sourceTable": "string",
      "version": 0
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Artifact Version

POST
/api/v1/artifacts/{artifact_id}/versions

Path Parameters

artifact_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

changeReason?|
data*
dataKind*string
Value in"tabular" | "markdown"
refreshQuery?|
rendererConfig*
rendererKind*string
Value in"ag_grid" | "markdown" | "echarts"
sourceMetadata?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions" \  -H "Content-Type: application/json" \  -d '{    "data": {},    "dataKind": "tabular",    "rendererConfig": {},    "rendererKind": "ag_grid"  }'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isShared": false,
  "name": "string",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "resolvedVersion": {
    "actorType": "human",
    "changeReason": "string",
    "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
    "createdAt": "2019-08-24T14:15:22Z",
    "data": {},
    "dataKind": "tabular",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "refreshQuery": "string",
    "rendererConfig": {},
    "rendererKind": "ag_grid",
    "sourceMetadata": {},
    "sourceScope": "string",
    "sourceSurface": "chat",
    "sourceTable": "string",
    "version": 0
  },
  "shareRecipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "sharedBy": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "profilePictureUrl": "string"
  },
  "sourceKind": "chat_promotion",
  "sourceMetadata": {},
  "updatedAt": "2019-08-24T14:15:22Z",
  "viewerAccess": "owner"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Artifact Version

GET
/api/v1/artifacts/{artifact_id}/versions/{version}

Path Parameters

artifact_id*string
Formatuuid
version*integer
Range1 <= value

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/artifacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/1"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isShared": false,
  "name": "string",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "resolvedVersion": {
    "actorType": "human",
    "changeReason": "string",
    "changedBy": "48f0a29c-3f20-4b08-af90-5d4b530b5305",
    "createdAt": "2019-08-24T14:15:22Z",
    "data": {},
    "dataKind": "tabular",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "refreshQuery": "string",
    "rendererConfig": {},
    "rendererKind": "ag_grid",
    "sourceMetadata": {},
    "sourceScope": "string",
    "sourceSurface": "chat",
    "sourceTable": "string",
    "version": 0
  },
  "shareRecipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "sharedBy": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "profilePictureUrl": "string"
  },
  "sourceKind": "chat_promotion",
  "sourceMetadata": {},
  "updatedAt": "2019-08-24T14:15:22Z",
  "viewerAccess": "owner"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Artifact comments

Previous Page

Auth

Next Page