VirtuousAI
Reference

Provenance

Get Provenance Event Detail

GET
/api/v1/provenance/events/{event_id}

Path Parameters

event_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/provenance/events/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "actorType": "human",
  "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
  "claims": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "key": "string",
      "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
      "subjectKind": "chat_turn",
      "subjectRid": "string",
      "validFrom": "2019-08-24T14:15:22Z",
      "validTo": "2019-08-24T14:15:22Z",
      "valueBoolean": true,
      "valueNumber": "string",
      "valueText": "string",
      "valueTimestamp": "2019-08-24T14:15:22Z",
      "valueType": "text"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "details": {},
  "eventKind": "chat_turn_created",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "occurredAt": "2019-08-24T14:15:22Z",
  "refs": [
    {
      "details": {},
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kind": "chat_turn",
      "relationKind": "triggered_by",
      "rid": "string",
      "role": "trigger"
    }
  ],
  "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
  "subjectKind": "chat_turn",
  "subjectRid": "string",
  "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
  "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Resource Accountability

GET
/api/v1/provenance/resources/accountability

Query Parameters

resource_kind*string
Value in"chat_turn" | "data_product_run" | "artifact_version" | "workspace" | "changeset" | "approval_request"
resource_id*string
Formatuuid
limit?integer
Default100
Range1 <= value <= 500
max_depth?integer
Default4
Range1 <= value <= 12

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/provenance/resources/accountability?resource_kind=chat_turn&resource_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "ancestors": [
    {
      "depth": 0,
      "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
      "eventKind": "chat_turn_created",
      "relationKind": "triggered_by",
      "source": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "kind": "chat_turn",
        "rid": "string"
      },
      "target": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "kind": "chat_turn",
        "rid": "string"
      }
    }
  ],
  "events": [
    {
      "actorType": "human",
      "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
      "createdAt": "2019-08-24T14:15:22Z",
      "details": {},
      "eventKind": "chat_turn_created",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "occurredAt": "2019-08-24T14:15:22Z",
      "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
      "subjectKind": "chat_turn",
      "subjectRid": "string",
      "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
      "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
    }
  ],
  "subject": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "kind": "chat_turn",
    "rid": "string"
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Resource Provenance Events

GET
/api/v1/provenance/resources/events

Query Parameters

resource_kind*string
Value in"chat_turn" | "data_product_run" | "artifact_version" | "workspace" | "changeset" | "approval_request"
resource_id*string
Formatuuid
limit?integer
Default100
Range1 <= value <= 500

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/provenance/resources/events?resource_kind=chat_turn&resource_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
[
  {
    "actorType": "human",
    "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
    "createdAt": "2019-08-24T14:15:22Z",
    "details": {},
    "eventKind": "chat_turn_created",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "occurredAt": "2019-08-24T14:15:22Z",
    "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
    "subjectKind": "chat_turn",
    "subjectRid": "string",
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Resource Lineage

GET
/api/v1/provenance/resources/lineage

Query Parameters

resource_kind*string
Value in"chat_turn" | "data_product_run" | "artifact_version" | "workspace" | "changeset" | "approval_request"
resource_id*string
Formatuuid
direction?string
Default"ancestors"
Match^(ancestors|descendants)$
limit?integer
Default100
Range1 <= value <= 500
max_depth?integer
Default4
Range1 <= value <= 12

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/provenance/resources/lineage?resource_kind=chat_turn&resource_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
[
  {
    "depth": 0,
    "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
    "eventKind": "chat_turn_created",
    "relationKind": "triggered_by",
    "source": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kind": "chat_turn",
      "rid": "string"
    },
    "target": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "kind": "chat_turn",
      "rid": "string"
    }
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Resource Support

GET
/api/v1/provenance/resources/support

Query Parameters

resource_kind*string
Value in"chat_turn" | "data_product_run" | "artifact_version" | "workspace" | "changeset" | "approval_request"
resource_id*string
Formatuuid
limit?integer
Default100
Range1 <= value <= 500

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/provenance/resources/support?resource_kind=chat_turn&resource_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "claimEvidence": [
    {
      "claim": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "key": "string",
        "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
        "subjectKind": "chat_turn",
        "subjectRid": "string",
        "validFrom": "2019-08-24T14:15:22Z",
        "validTo": "2019-08-24T14:15:22Z",
        "valueBoolean": true,
        "valueNumber": "string",
        "valueText": "string",
        "valueTimestamp": "2019-08-24T14:15:22Z",
        "valueType": "text"
      },
      "event": {
        "actorType": "human",
        "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
        "createdAt": "2019-08-24T14:15:22Z",
        "details": {},
        "eventKind": "chat_turn_created",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "occurredAt": "2019-08-24T14:15:22Z",
        "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
        "subjectKind": "chat_turn",
        "subjectRid": "string",
        "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
        "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
        "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
      },
      "sources": [
        {
          "details": {},
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "kind": "chat_turn",
          "relationKind": "triggered_by",
          "rid": "string",
          "role": "trigger"
        }
      ]
    }
  ],
  "events": [
    {
      "actorType": "human",
      "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
      "createdAt": "2019-08-24T14:15:22Z",
      "details": {},
      "eventKind": "chat_turn_created",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "occurredAt": "2019-08-24T14:15:22Z",
      "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
      "subjectKind": "chat_turn",
      "subjectRid": "string",
      "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
      "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
    }
  ],
  "subject": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "kind": "chat_turn",
    "rid": "string"
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Thread Provenance Events

GET
/api/v1/provenance/threads/{thread_id}/events

Path Parameters

thread_id*string
Formatuuid

Query Parameters

limit?integer
Default100
Range1 <= value <= 500

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/provenance/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/events"
[
  {
    "actorType": "human",
    "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
    "createdAt": "2019-08-24T14:15:22Z",
    "details": {},
    "eventKind": "chat_turn_created",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "occurredAt": "2019-08-24T14:15:22Z",
    "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
    "subjectKind": "chat_turn",
    "subjectRid": "string",
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Workspace Provenance Events

GET
/api/v1/provenance/workspaces/{workspace_id}/events

Path Parameters

workspace_id*string
Formatuuid

Query Parameters

limit?integer
Default100
Range1 <= value <= 500

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/provenance/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/events"
[
  {
    "actorType": "human",
    "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
    "createdAt": "2019-08-24T14:15:22Z",
    "details": {},
    "eventKind": "chat_turn_created",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "occurredAt": "2019-08-24T14:15:22Z",
    "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b",
    "subjectKind": "chat_turn",
    "subjectRid": "string",
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Organizations

Previous Page

Scheduling

Next Page