VirtuousAI
Reference

Ocp

Get Agent Detail

GET
/api/v1/ocp/agents/{agent_spec_id}

Path Parameters

agent_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/ocp/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "activeVersion": 0,
  "activeVersionId": "string",
  "agentSpecId": "string",
  "contentSha256": "string",
  "conversationCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByEmail": "string",
  "description": "string",
  "frontmatter": {},
  "lifecycleStatus": "active",
  "markdown": "string",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "tenantSlug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Distribute Agent Version

POST
/api/v1/ocp/agents/{agent_spec_id}/versions/{version_id}/distribute

Path Parameters

agent_spec_id*string
Formatuuid
version_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

allTenants?boolean
Defaultfalse
targetTenantIds?array<>

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/distribute" \  -H "Content-Type: application/json" \  -d '{}'
{
  "results": [
    {
      "agentSpecId": "string",
      "agentSpecVersionId": "string",
      "createdProfile": true,
      "createdVersion": true,
      "tenantId": "string",
      "tenantName": "string",
      "version": 0
    }
  ],
  "sourceAgentSpecId": "string",
  "sourceAgentSpecVersionId": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Connections

GET
/api/v1/ocp/connections

Query Parameters

q?|
tenant_id?|
status?|
provider?|
limit?integer
Default50
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/ocp/connections"
{
  "hasNext": true,
  "items": [
    {
      "config": {},
      "id": "string",
      "isDefault": true,
      "lastVerifiedAt": "2019-08-24T14:15:22Z",
      "liveAccess": {
        "allowedSchemas": [
          "string"
        ],
        "deniedSchemas": [
          "string"
        ],
        "discoveryEnabled": true,
        "maxColumns": 0,
        "maxRows": 0,
        "queryEnabled": true,
        "samplingEnabled": true,
        "timeoutSeconds": 0
      },
      "name": "string",
      "provider": "shopify",
      "slug": "string",
      "status": "needs_verification",
      "tenantId": "string",
      "tenantName": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Connection Files

GET
/api/v1/ocp/connections/{connection_id}/files

Path Parameters

connection_id*string
Formatuuid

Query Parameters

path?string

Path or folder ID

Default"/"
page_token?|

Next page token

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/files"
{
  "items": [
    {
      "id": "string",
      "kind": "file",
      "mimeType": "string",
      "modifiedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "path": "string",
      "size": 0
    }
  ],
  "nextPageToken": "string",
  "path": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Validate Ocp Connection File Selection

POST
/api/v1/ocp/connections/{connection_id}/files/validate

Path Parameters

connection_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

rootPath?|
selectedItems*array<>

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/validate" \  -H "Content-Type: application/json" \  -d '{    "selectedItems": [      "string"    ]  }'
{
  "maxDepth": 0,
  "totalBytes": 0,
  "totalItems": 0,
  "valid": true,
  "violations": []
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Ocp Connection Live Access

PATCH
/api/v1/ocp/connections/{connection_id}/live-access

Path Parameters

connection_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

allowedSchemas?array<>|
deniedSchemas?array<>|
discoveryEnabled?|
maxColumns?|
maxRows?|
queryEnabled?|
samplingEnabled?|
timeoutSeconds?|

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/live-access" \  -H "Content-Type: application/json" \  -d '{}'
{
  "config": {},
  "id": "string",
  "isDefault": true,
  "lastVerifiedAt": "2019-08-24T14:15:22Z",
  "liveAccess": {
    "allowedSchemas": [
      "string"
    ],
    "deniedSchemas": [
      "string"
    ],
    "discoveryEnabled": true,
    "maxColumns": 0,
    "maxRows": 0,
    "queryEnabled": true,
    "samplingEnabled": true,
    "timeoutSeconds": 0
  },
  "name": "string",
  "provider": "shopify",
  "slug": "string",
  "status": "needs_verification",
  "tenantId": "string",
  "tenantName": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Schema Columns

GET
/api/v1/ocp/connections/{connection_id}/schema/columns

Path Parameters

connection_id*string
Formatuuid

Query Parameters

schema*string
table*string

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/schema/columns?schema=string&table=string"
{
  "columns": [
    {
      "dataType": "string",
      "name": "string",
      "normalizedName": "string",
      "nullable": true,
      "primaryKey": false
    }
  ],
  "schema": "string",
  "table": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Schema Tables

GET
/api/v1/ocp/connections/{connection_id}/schema/tables

Path Parameters

connection_id*string
Formatuuid

Query Parameters

include_system?boolean

Include system schemas

Defaultfalse

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/schema/tables"
{
  "tables": [
    {
      "normalizedName": "string",
      "schema": "string",
      "spec": "string",
      "table": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Conversation

GET
/api/v1/ocp/conversations/{thread_id}

Path Parameters

thread_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "agentDescription": "string",
  "agentLifecycleStatus": "active",
  "agentName": "string",
  "agentSpecId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "hasReasoning": true,
  "hasToolError": true,
  "id": "string",
  "isShared": true,
  "lastTurnStatus": "pending",
  "memories": [
    {
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "organizationId": "string",
      "source": "explicit",
      "sourceThreadId": "string",
      "sourceTurnId": "string"
    }
  ],
  "memoryCount": 0,
  "messageCount": 0,
  "messages": [
    {
      "cancelled": false,
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "durationSeconds": 0,
      "error": {
        "code": "string",
        "description": "string",
        "referenceId": "string",
        "retryable": true,
        "title": "string"
      },
      "feedback": [],
      "id": "string",
      "memoryCount": 0,
      "rawData": {},
      "role": "user",
      "threadId": "string",
      "turnId": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "shareRecipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "tenantId": "string",
  "tenantName": "string",
  "title": "string",
  "toolCallCount": 0,
  "turns": [
    {
      "agentSpecId": "string",
      "completedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "durationSeconds": 0,
      "error": {},
      "events": [],
      "id": "string",
      "inputMessageId": "string",
      "modelId": "string",
      "outputMessageId": "string",
      "startedAt": "2019-08-24T14:15:22Z",
      "status": "pending",
      "threadId": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "usage": {
        "cacheWriteTokens": 0,
        "cachedInputTokens": 0,
        "inputTokens": 0,
        "outputTokens": 0,
        "totalCost": "string"
      }
    }
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "userEmail": "string",
  "userId": "string",
  "userName": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Data Tables

GET
/api/v1/ocp/data-tables

Query Parameters

tenant_id?|
schema_stable?|
source_type?|
q?|
limit?integer
Default50
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/ocp/data-tables"
{
  "hasNext": true,
  "items": [
    {
      "cleanupSupported": false,
      "columnNames": [],
      "columnTypes": [],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "entityKey": "string",
      "isSyncManaged": false,
      "lastReadAt": "2019-08-24T14:15:22Z",
      "lastWriteAt": "2019-08-24T14:15:22Z",
      "logicalTableName": "string",
      "ownerTaskSlug": "string",
      "ownerWorkspaceKey": "string",
      "rowCount": 0,
      "schemaContract": "evolve",
      "schemaStable": false,
      "schemaStableSince": "2019-08-24T14:15:22Z",
      "schemaVersion": 1,
      "sourceType": "string",
      "syncId": "string",
      "syncName": "string",
      "tableName": "string",
      "tableNamingVersion": "legacy",
      "tenantSchema": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Ocp Data Table

DELETE
/api/v1/ocp/data-tables/{tenant_schema}/{table_name}

Path Parameters

tenant_schema*string
table_name*string

Header Parameters

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

Response Body

application/json

curl -X DELETE "https://loading/api/v1/ocp/data-tables/string/string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Truncate Ocp Data Table

POST
/api/v1/ocp/data-tables/{tenant_schema}/{table_name}/truncate

Path Parameters

tenant_schema*string
table_name*string

Header Parameters

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

Response Body

application/json

curl -X POST "https://loading/api/v1/ocp/data-tables/string/string/truncate"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Documents

GET
/api/v1/ocp/documents

Query Parameters

q?|
tenant_id?|
owner_user_id?|
document_kind?|
status?|
visibility_scope?|
attachment_state?string
Default"all"
Value in"all" | "attached" | "unattached"
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/ocp/documents"
{
  "hasNext": true,
  "items": [
    {
      "contentType": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "documentKind": "string",
      "fileSizeBytes": 0,
      "firstAttachedAt": "2019-08-24T14:15:22Z",
      "hasBeenAttached": true,
      "id": "string",
      "name": "string",
      "ownerUserEmail": "string",
      "ownerUserId": "string",
      "ownerUserName": "string",
      "pageCount": 0,
      "sheetCount": 0,
      "sheetNamesPreview": [
        "string"
      ],
      "status": "uploaded",
      "tenantId": "string",
      "tenantName": "string",
      "textCharCount": 0,
      "textTruncated": true,
      "updatedAt": "2019-08-24T14:15:22Z",
      "visibilityScope": "private"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Document

GET
/api/v1/ocp/documents/{document_id}

Path Parameters

document_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "contentType": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "documentKind": "string",
  "fileSizeBytes": 0,
  "firstAttachedAt": "2019-08-24T14:15:22Z",
  "hasBeenAttached": true,
  "id": "string",
  "name": "string",
  "ownerUserEmail": "string",
  "ownerUserId": "string",
  "ownerUserName": "string",
  "pageCount": 0,
  "sheetCount": 0,
  "sheetNamesPreview": [
    "string"
  ],
  "status": "uploaded",
  "tenantId": "string",
  "tenantName": "string",
  "textCharCount": 0,
  "textTruncated": true,
  "updatedAt": "2019-08-24T14:15:22Z",
  "visibilityScope": "private"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Download Document

GET
/api/v1/ocp/documents/{document_id}/download

Path Parameters

document_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

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

Get Document Usage

GET
/api/v1/ocp/documents/{document_id}/usage

Path Parameters

document_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage"
{
  "attachmentCount": 0,
  "conversationCount": 0,
  "conversations": [
    {
      "attachedAt": "2019-08-24T14:15:22Z",
      "conversationTitle": "string",
      "messageExcerpt": "string",
      "messageId": "string",
      "tenantId": "string",
      "tenantName": "string",
      "threadId": "string",
      "userEmail": "string",
      "userId": "string",
      "userName": "string"
    }
  ],
  "documentId": "string",
  "latestUsedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Feedback

GET
/api/v1/ocp/feedback

Query Parameters

kind?|
reaction?|
tenant_id?|
run_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/ocp/feedback"
{
  "hasNext": true,
  "items": [
    {
      "category": "string",
      "comment": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "kind": "string",
      "messageId": "string",
      "reaction": "string",
      "reasons": [
        "string"
      ],
      "runId": "string",
      "sourceSurface": "string",
      "taskId": "string",
      "taskName": "string",
      "tenantId": "string",
      "tenantName": "string",
      "text": "string",
      "threadId": "string",
      "userEmail": "string",
      "userId": "string",
      "userName": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Feedback

GET
/api/v1/ocp/feedback/{feedback_id}

Path Parameters

feedback_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/feedback/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "category": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "kind": "string",
  "messageId": "string",
  "reaction": "string",
  "reasons": [
    "string"
  ],
  "runId": "string",
  "sourceSurface": "string",
  "taskId": "string",
  "taskName": "string",
  "tenantId": "string",
  "tenantName": "string",
  "text": "string",
  "threadId": "string",
  "userEmail": "string",
  "userId": "string",
  "userName": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Organizations

GET
/api/v1/ocp/organizations

Query Parameters

q?|
tenant_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/ocp/organizations"
{
  "hasNext": true,
  "items": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "memberCount": 0,
      "name": "string",
      "slug": "string",
      "tenantId": "string",
      "tenantName": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Organization

GET
/api/v1/ocp/organizations/{organization_id}

Path Parameters

organization_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "externalId": "string",
  "externalProvider": "string",
  "id": "string",
  "memberCount": 0,
  "members": [
    {
      "email": "string",
      "firstName": "string",
      "joinedAt": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "membershipId": "string",
      "roleId": "string",
      "roleName": "string",
      "userId": "string"
    }
  ],
  "name": "string",
  "slug": "string",
  "tenantId": "string",
  "tenantName": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Organization Agents

GET
/api/v1/ocp/organizations/{organization_id}/agents

Path Parameters

organization_id*string
Formatuuid

Query Parameters

q?|
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/ocp/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents"
{
  "hasNext": true,
  "items": [
    {
      "agentSpecId": "string",
      "conversationCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "createdByEmail": "string",
      "description": "string",
      "lastUsedAt": "2019-08-24T14:15:22Z",
      "lifecycleStatus": "active",
      "name": "string",
      "tenantId": "string",
      "tenantName": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userCount": 0
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Rooms

GET
/api/v1/ocp/rooms

Query Parameters

q?|
tenant_id?|
user_id?|
membership_id?|
state?|
has_agent?|
run_status?|
updated_since?|
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/ocp/rooms"
{
  "hasNext": true,
  "items": [
    {
      "accessPolicy": "invite_only",
      "activeAgentCount": 0,
      "activeHumanCount": 0,
      "activeRunCount": 0,
      "archivedAt": "2019-08-24T14:15:22Z",
      "archivedBy": {
        "displayName": "string",
        "kind": "string",
        "membershipId": "string",
        "roleDisplayName": "string",
        "roleDocumentVersionId": "string",
        "userEmail": "string",
        "userId": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "displayName": "string",
        "kind": "string",
        "membershipId": "string",
        "roleDisplayName": "string",
        "roleDocumentVersionId": "string",
        "userEmail": "string",
        "userId": "string"
      },
      "description": "string",
      "eventCount": 0,
      "failedRunCount": 0,
      "id": "string",
      "latestMessageAt": "2019-08-24T14:15:22Z",
      "latestRunAt": "2019-08-24T14:15:22Z",
      "latestSeq": 0,
      "messageCount": 0,
      "name": "string",
      "noResponseRunCount": 0,
      "pendingInvitationCount": 0,
      "rules": {
        "documentId": "string",
        "documentName": "string",
        "documentVersion": 0,
        "documentVersionId": "string",
        "documentVersionName": "string"
      },
      "runCount": 0,
      "state": "active",
      "tenantId": "string",
      "tenantName": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Room

GET
/api/v1/ocp/rooms/{room_id}

Path Parameters

room_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/rooms/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "accessPolicy": "invite_only",
  "activeAgentCount": 0,
  "activeHumanCount": 0,
  "activeRunCount": 0,
  "archivedAt": "2019-08-24T14:15:22Z",
  "archivedBy": {
    "displayName": "string",
    "kind": "string",
    "membershipId": "string",
    "roleDisplayName": "string",
    "roleDocumentVersionId": "string",
    "userEmail": "string",
    "userId": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "displayName": "string",
    "kind": "string",
    "membershipId": "string",
    "roleDisplayName": "string",
    "roleDocumentVersionId": "string",
    "userEmail": "string",
    "userId": "string"
  },
  "description": "string",
  "eventCount": 0,
  "failedRunCount": 0,
  "id": "string",
  "invitations": [
    {
      "acceptedParticipantId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "expiresAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "invitedByDisplayName": "string",
      "invitedByMembershipId": "string",
      "invitedByUserEmail": "string",
      "invitedByUserId": "string",
      "inviteeDisplayName": "string",
      "inviteeKind": "human",
      "inviteeMembershipId": "string",
      "inviteeUserEmail": "string",
      "inviteeUserId": "string",
      "respondedAt": "2019-08-24T14:15:22Z",
      "roleDocumentId": "string",
      "roleDocumentName": "string",
      "roomId": "string",
      "status": "pending",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "latestMessageAt": "2019-08-24T14:15:22Z",
  "latestRunAt": "2019-08-24T14:15:22Z",
  "latestSeq": 0,
  "messageCount": 0,
  "name": "string",
  "noResponseRunCount": 0,
  "participants": [
    {
      "agentEnabled": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "displayName": "string",
      "id": "string",
      "joinedAt": "2019-08-24T14:15:22Z",
      "lastObservedRoleDocumentVersion": 0,
      "lastObservedRoleDocumentVersionId": "string",
      "leftAt": "2019-08-24T14:15:22Z",
      "membershipId": "string",
      "participantKind": "human",
      "profilePictureUrl": "string",
      "roleDocumentId": "string",
      "roleDocumentName": "string",
      "roomId": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userEmail": "string",
      "userId": "string"
    }
  ],
  "pendingInvitationCount": 0,
  "rules": {
    "documentId": "string",
    "documentName": "string",
    "documentVersion": 0,
    "documentVersionId": "string",
    "documentVersionName": "string"
  },
  "runCount": 0,
  "state": "active",
  "tenantId": "string",
  "tenantName": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Room Events

GET
/api/v1/ocp/rooms/{room_id}/events

Path Parameters

room_id*string
Formatuuid

Query Parameters

beforeSeq?|
afterSeq?|
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/ocp/rooms/497f6eca-6276-4993-bfeb-53cbbbba6f08/events"
{
  "endSeq": 0,
  "hasMoreAfter": true,
  "hasMoreBefore": true,
  "items": [
    {
      "actor": {
        "displayName": "string",
        "kind": "string",
        "membershipId": "string",
        "roleDisplayName": "string",
        "roleDocumentVersionId": "string",
        "userEmail": "string",
        "userId": "string"
      },
      "causationId": "string",
      "correlationId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "idempotencyKey": "string",
      "payload": {},
      "schemaVersion": 0,
      "seq": 0,
      "source": "string",
      "subject": {
        "id": "string",
        "kind": "string"
      },
      "type": "string"
    }
  ],
  "latestSeq": 0,
  "startSeq": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Room Runs

GET
/api/v1/ocp/rooms/{room_id}/runs

Path Parameters

room_id*string
Formatuuid

Query Parameters

status?|
trigger_reason?|
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/ocp/rooms/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs"
{
  "hasNext": true,
  "items": [
    {
      "attentionDecisionEventId": "string",
      "cacheWriteTokens": 0,
      "cachedInputTokens": 0,
      "cancelledReason": "archived",
      "completedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "inputTokens": 0,
      "outputDisposition": "respond",
      "outputMessageId": "string",
      "outputTokens": 0,
      "participantDisplayName": "string",
      "roleDocumentDisplayName": "string",
      "roleDocumentVersion": 0,
      "roleDocumentVersionId": "string",
      "roomId": "string",
      "roomParticipantId": "string",
      "rulesDocumentDisplayName": "string",
      "rulesDocumentVersion": 0,
      "rulesDocumentVersionId": "string",
      "runKind": "agent",
      "startedAt": "2019-08-24T14:15:22Z",
      "status": "queued",
      "tenantId": "string",
      "totalCost": "string",
      "triggerEventId": "string",
      "triggerReason": "mention",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Room Run

GET
/api/v1/ocp/rooms/{room_id}/runs/{run_id}

Path Parameters

room_id*string
Formatuuid
run_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/rooms/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "attentionDecisionEventId": "string",
  "cacheWriteTokens": 0,
  "cachedInputTokens": 0,
  "cancelledReason": "archived",
  "completedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "inputSnapshot": {
    "contentSha256": "string",
    "contextSelection": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "modelId": "string",
    "renderedBlocks": [
      {}
    ],
    "runId": "string",
    "runPromptText": "string",
    "sourceRefs": [
      {}
    ],
    "systemPromptText": "string",
    "tokenEstimate": 0,
    "truncationNotes": [
      {}
    ]
  },
  "inputTokens": 0,
  "outputDisposition": "respond",
  "outputMessageId": "string",
  "outputTokens": 0,
  "participantDisplayName": "string",
  "roleDocumentDisplayName": "string",
  "roleDocumentVersion": 0,
  "roleDocumentVersionId": "string",
  "roomId": "string",
  "roomParticipantId": "string",
  "rulesDocumentDisplayName": "string",
  "rulesDocumentVersion": 0,
  "rulesDocumentVersionId": "string",
  "runKind": "agent",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "queued",
  "tenantId": "string",
  "totalCost": "string",
  "triggerEventId": "string",
  "triggerReason": "mention",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Room Timeline

GET
/api/v1/ocp/rooms/{room_id}/timeline

Path Parameters

room_id*string
Formatuuid

Query Parameters

beforeSeq?|
afterSeq?|
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/ocp/rooms/497f6eca-6276-4993-bfeb-53cbbbba6f08/timeline"
{
  "endSeq": 0,
  "hasMoreAfter": true,
  "hasMoreBefore": true,
  "items": [
    {
      "event": {
        "actor": {
          "displayName": "string",
          "kind": "string",
          "membershipId": "string",
          "roleDisplayName": "string",
          "roleDocumentVersionId": "string",
          "userEmail": "string",
          "userId": "string"
        },
        "causationId": "string",
        "correlationId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "idempotencyKey": "string",
        "payload": {},
        "schemaVersion": 0,
        "seq": 0,
        "source": "string",
        "subject": {
          "id": "string",
          "kind": "string"
        },
        "type": "string"
      },
      "kind": "event",
      "message": {
        "actor": {
          "displayName": "string",
          "kind": "string",
          "membershipId": "string",
          "roleDisplayName": "string",
          "roleDocumentVersionId": "string",
          "userEmail": "string",
          "userId": "string"
        },
        "body": "string",
        "bodyFormat": "plain_text",
        "branchedFromMessageId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "deletedAt": "2019-08-24T14:15:22Z",
        "editedAt": "2019-08-24T14:15:22Z",
        "id": "string",
        "refs": [
          {
            "displayName": "string",
            "targetId": "string",
            "targetKind": "human"
          }
        ],
        "roomId": "string",
        "runSummary": {},
        "seq": 0,
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "seq": 0
    }
  ],
  "latestSeq": 0,
  "startSeq": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Runs

GET
/api/v1/ocp/runs

Query Parameters

tenant_id?|
task_id?|
status?|
triggered_by?|
parent_run_id?|
root_only?boolean
Defaultfalse
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/ocp/runs"
{
  "hasNext": true,
  "items": [
    {
      "childCount": 0,
      "completedAt": "2019-08-24T14:15:22Z",
      "context": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "depth": 0,
      "error": "string",
      "feedbackCount": 0,
      "id": "string",
      "observability": {
        "loadedSkillSlugs": [
          "string"
        ],
        "modelId": "string",
        "provider": "string",
        "traceProvider": "string",
        "usage": {
          "cacheWriteTokens": 0,
          "cachedInputTokens": 0,
          "inputTokens": 0,
          "outputTokens": 0,
          "totalCost": "string"
        }
      },
      "originThreadId": "string",
      "outcome": {
        "artifactId": "string",
        "artifactName": "string",
        "rendererKind": "string",
        "rowCount": 0,
        "summary": "string",
        "version": 0
      },
      "parentRunId": "string",
      "result": {},
      "rootRunId": "string",
      "runTree": [],
      "startedAt": "2019-08-24T14:15:22Z",
      "status": "string",
      "steps": [
        {
          "completedAt": "2019-08-24T14:15:22Z",
          "durationMs": 0,
          "error": "string",
          "id": "string",
          "input": {},
          "output": {},
          "sequence": 0,
          "sourceType": "string",
          "startedAt": "2019-08-24T14:15:22Z",
          "status": "string",
          "stepKey": "string",
          "toolCallId": "string",
          "toolName": "string"
        }
      ],
      "taskDisplayName": "string",
      "taskId": "string",
      "taskName": "string",
      "tenantId": "string",
      "tenantName": "string",
      "transcriptContent": "string",
      "transcriptRawData": {},
      "transcriptUpdatedAt": "2019-08-24T14:15:22Z",
      "triggerRef": "string",
      "triggeredBy": "string",
      "userId": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Run

GET
/api/v1/ocp/runs/{run_id}

Path Parameters

run_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "childCount": 0,
  "completedAt": "2019-08-24T14:15:22Z",
  "context": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "depth": 0,
  "error": "string",
  "feedbackCount": 0,
  "id": "string",
  "observability": {
    "loadedSkillSlugs": [
      "string"
    ],
    "modelId": "string",
    "provider": "string",
    "traceProvider": "string",
    "usage": {
      "cacheWriteTokens": 0,
      "cachedInputTokens": 0,
      "inputTokens": 0,
      "outputTokens": 0,
      "totalCost": "string"
    }
  },
  "originThreadId": "string",
  "outcome": {
    "artifactId": "string",
    "artifactName": "string",
    "rendererKind": "string",
    "rowCount": 0,
    "summary": "string",
    "version": 0
  },
  "parentRunId": "string",
  "result": {},
  "rootRunId": "string",
  "runTree": [],
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "string",
  "steps": [
    {
      "completedAt": "2019-08-24T14:15:22Z",
      "durationMs": 0,
      "error": "string",
      "id": "string",
      "input": {},
      "output": {},
      "sequence": 0,
      "sourceType": "string",
      "startedAt": "2019-08-24T14:15:22Z",
      "status": "string",
      "stepKey": "string",
      "toolCallId": "string",
      "toolName": "string"
    }
  ],
  "taskDisplayName": "string",
  "taskId": "string",
  "taskName": "string",
  "tenantId": "string",
  "tenantName": "string",
  "transcriptContent": "string",
  "transcriptRawData": {},
  "transcriptUpdatedAt": "2019-08-24T14:15:22Z",
  "triggerRef": "string",
  "triggeredBy": "string",
  "userId": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Schedules

GET
/api/v1/ocp/schedules

Query Parameters

q?|
tenant_id?|
task_id?|
sync_id?|
workflow_document_id?|
target_kind?|
run_as_user_id?|
enabled?|
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/ocp/schedules"
{
  "hasNext": true,
  "items": [
    {
      "context": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "createdByEmail": "string",
      "cronExpression": "string",
      "enabled": true,
      "id": "string",
      "lastRunAt": "2019-08-24T14:15:22Z",
      "lastRunId": "string",
      "missedRuns": 0,
      "name": "string",
      "nextRunAt": "2019-08-24T14:15:22Z",
      "runAsUserEmail": "string",
      "runAsUserId": "string",
      "syncId": "string",
      "syncName": "string",
      "syncProviderKey": "string",
      "syncSlug": "string",
      "targetKind": "task",
      "taskDisplayName": "string",
      "taskId": "string",
      "taskName": "string",
      "tenantId": "string",
      "tenantName": "string",
      "timezone": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "workflowDocumentId": "string",
      "workflowDocumentTitle": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Ocp Schedule

POST
/api/v1/ocp/schedules

Header Parameters

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

Request Body

application/json

context?
cronExpression*string
enabled?boolean
Defaulttrue
name*string
Length1 <= length
syncId?|
taskId?|
tenantId*string
timezone?string
Default"UTC"
workflowDocumentId?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/schedules" \  -H "Content-Type: application/json" \  -d '{    "cronExpression": "string",    "name": "string",    "tenantId": "string"  }'
{
  "context": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "createdByEmail": "string",
  "cronExpression": "string",
  "enabled": true,
  "id": "string",
  "lastRunAt": "2019-08-24T14:15:22Z",
  "lastRunId": "string",
  "missedRuns": 0,
  "name": "string",
  "nextRunAt": "2019-08-24T14:15:22Z",
  "runAsUserEmail": "string",
  "runAsUserId": "string",
  "syncId": "string",
  "syncName": "string",
  "syncProviderKey": "string",
  "syncSlug": "string",
  "targetKind": "task",
  "taskDisplayName": "string",
  "taskId": "string",
  "taskName": "string",
  "tenantId": "string",
  "tenantName": "string",
  "timezone": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowDocumentId": "string",
  "workflowDocumentTitle": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Schedule

GET
/api/v1/ocp/schedules/{schedule_id}

Path Parameters

schedule_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "context": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "createdByEmail": "string",
  "cronExpression": "string",
  "enabled": true,
  "id": "string",
  "lastRunAt": "2019-08-24T14:15:22Z",
  "lastRunId": "string",
  "missedRuns": 0,
  "name": "string",
  "nextRunAt": "2019-08-24T14:15:22Z",
  "runAsUserEmail": "string",
  "runAsUserId": "string",
  "syncId": "string",
  "syncName": "string",
  "syncProviderKey": "string",
  "syncSlug": "string",
  "targetKind": "task",
  "taskDisplayName": "string",
  "taskId": "string",
  "taskName": "string",
  "tenantId": "string",
  "tenantName": "string",
  "timezone": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowDocumentId": "string",
  "workflowDocumentTitle": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Ocp Schedule

PATCH
/api/v1/ocp/schedules/{schedule_id}

Path Parameters

schedule_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

context?|
cronExpression?|
enabled?|
name?|
timezone?|

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "context": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "createdByEmail": "string",
  "cronExpression": "string",
  "enabled": true,
  "id": "string",
  "lastRunAt": "2019-08-24T14:15:22Z",
  "lastRunId": "string",
  "missedRuns": 0,
  "name": "string",
  "nextRunAt": "2019-08-24T14:15:22Z",
  "runAsUserEmail": "string",
  "runAsUserId": "string",
  "syncId": "string",
  "syncName": "string",
  "syncProviderKey": "string",
  "syncSlug": "string",
  "targetKind": "task",
  "taskDisplayName": "string",
  "taskId": "string",
  "taskName": "string",
  "tenantId": "string",
  "tenantName": "string",
  "timezone": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowDocumentId": "string",
  "workflowDocumentTitle": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Ocp Schedule

DELETE
/api/v1/ocp/schedules/{schedule_id}

Path Parameters

schedule_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

Trigger Ocp Schedule

POST
/api/v1/ocp/schedules/{schedule_id}/run

Path Parameters

schedule_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/run"
{
  "property1": "string",
  "property2": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Skills

GET
/api/v1/ocp/skills

Query Parameters

q?|
scope?|
tenant_id?|
include_deleted?boolean
Defaultfalse
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/ocp/skills"
{
  "hasNext": true,
  "items": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deletedAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "instructionsMarkdown": "string",
      "name": "string",
      "scope": "string",
      "slug": "string",
      "tenantId": "string",
      "tenantName": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Skill

POST
/api/v1/ocp/skills

Header Parameters

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

Request Body

application/json

description*string
instructionsMarkdown*string
name*string
scope*string
slug*string
tenantId?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/skills" \  -H "Content-Type: application/json" \  -d '{    "description": "string",    "instructionsMarkdown": "string",    "name": "string",    "scope": "string",    "slug": "string"  }'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deletedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "instructionsMarkdown": "string",
  "name": "string",
  "scope": "string",
  "slug": "string",
  "tenantId": "string",
  "tenantName": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Skill

GET
/api/v1/ocp/skills/{skill_id}

Path Parameters

skill_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/skills/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deletedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "instructionsMarkdown": "string",
  "name": "string",
  "scope": "string",
  "slug": "string",
  "tenantId": "string",
  "tenantName": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Skill

PATCH
/api/v1/ocp/skills/{skill_id}

Path Parameters

skill_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

description?|
instructionsMarkdown?|
name?|

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/skills/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deletedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "instructionsMarkdown": "string",
  "name": "string",
  "scope": "string",
  "slug": "string",
  "tenantId": "string",
  "tenantName": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Skill

DELETE
/api/v1/ocp/skills/{skill_id}

Path Parameters

skill_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

List Skill Versions

GET
/api/v1/ocp/skills/{skill_id}/versions

Path Parameters

skill_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/skills/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
[
  {
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "createdByName": "string",
    "diffableText": "string",
    "id": "string",
    "snapshot": {},
    "sourceColorBucket": "string",
    "sourceLabel": "string",
    "sourceType": "string",
    "summary": "string",
    "version": 0
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Sync Provider Catalog

GET
/api/v1/ocp/sync-providers/{provider}/catalog

Path Parameters

provider*string

Supported external system providers.

Value in"shopify" | "http_api" | "flexiroam" | "starlink" | "s3" | "google_drive" | "msft_sharepoint" | "klaviyo" | "amazon_sp" | "salesforce" | "netsuite" | "sqlserver" | "postgres" | "mlflow" | "sftp" | "gmail_inbox" | "dropbox" | "rydership" | "gorgias" | "redo" | "bullhorn"

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/sync-providers/shopify/catalog"
{
  "availableResources": [
    "string"
  ],
  "configSchema": {},
  "defaultResources": [
    "string"
  ],
  "defaults": {},
  "displayName": "string",
  "dynamicResources": false,
  "name": "string",
  "provider": "shopify",
  "resources": [
    {
      "configSchema": {},
      "cursorField": "string",
      "defaultSelected": true,
      "dependsOn": [
        "string"
      ],
      "description": "string",
      "displayName": "string",
      "entityKey": "string",
      "loadMode": "append_event",
      "sizeClass": "xs",
      "slicing": {},
      "storageDescription": "string",
      "storageKind": "postgres"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Interrupted Sync Runs

GET
/api/v1/ocp/sync-runs/interrupted

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/ocp/sync-runs/interrupted"
{
  "hasNext": true,
  "items": [
    {
      "connectionName": "string",
      "run": {
        "attemptNumber": 1,
        "attemptRootRunId": "string",
        "backendStatus": {},
        "cancelReason": "string",
        "cancelRequestedAt": "2019-08-24T14:15:22Z",
        "cancelRequestedBy": "string",
        "completedAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "error": "string",
        "executionBackend": "native",
        "executionMode": "sequential",
        "executorId": "string",
        "id": "string",
        "infraStopCode": "string",
        "infraStopReason": "string",
        "lastHeartbeatAt": "2019-08-24T14:15:22Z",
        "maxAutoResumeAttempts": 5,
        "nextAttemptRunId": "string",
        "previousAttemptRunId": "string",
        "resultClass": "success",
        "resultReasonCode": "heartbeat_timeout",
        "runMode": "incremental",
        "startedAt": "2019-08-24T14:15:22Z",
        "status": "pending",
        "summary": {},
        "triggerRef": "string",
        "triggeredBy": "manual",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "syncId": "string",
      "syncName": "string",
      "syncSlug": "string",
      "tenantId": "string",
      "tenantName": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Cancel Ocp Sync Run

POST
/api/v1/ocp/sync-runs/{run_id}/cancel

Path Parameters

run_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

reason?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/sync-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "Content-Type: application/json" \  -d '{}'
{
  "attemptNumber": 1,
  "attemptRootRunId": "string",
  "backendStatus": {},
  "cancelReason": "string",
  "cancelRequestedAt": "2019-08-24T14:15:22Z",
  "cancelRequestedBy": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "error": "string",
  "executionBackend": "native",
  "executionMode": "sequential",
  "executorId": "string",
  "id": "string",
  "infraStopCode": "string",
  "infraStopReason": "string",
  "lastHeartbeatAt": "2019-08-24T14:15:22Z",
  "maxAutoResumeAttempts": 5,
  "nextAttemptRunId": "string",
  "previousAttemptRunId": "string",
  "resultClass": "success",
  "resultReasonCode": "heartbeat_timeout",
  "runMode": "incremental",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "summary": {},
  "triggerRef": "string",
  "triggeredBy": "manual",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Retry Ocp Sync Run

POST
/api/v1/ocp/sync-runs/{run_id}/retry

Path Parameters

run_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

runMode?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/sync-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/retry" \  -H "Content-Type: application/json" \  -d '{}'
{
  "attemptNumber": 1,
  "attemptRootRunId": "string",
  "backendStatus": {},
  "cancelReason": "string",
  "cancelRequestedAt": "2019-08-24T14:15:22Z",
  "cancelRequestedBy": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "error": "string",
  "executionBackend": "native",
  "executionMode": "sequential",
  "executorId": "string",
  "id": "string",
  "infraStopCode": "string",
  "infraStopReason": "string",
  "lastHeartbeatAt": "2019-08-24T14:15:22Z",
  "maxAutoResumeAttempts": 5,
  "nextAttemptRunId": "string",
  "previousAttemptRunId": "string",
  "resultClass": "success",
  "resultReasonCode": "heartbeat_timeout",
  "runMode": "incremental",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "summary": {},
  "triggerRef": "string",
  "triggeredBy": "manual",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Syncs

GET
/api/v1/ocp/syncs

Query Parameters

q?|
tenant_id?|
status?|
provider?|
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/ocp/syncs"
{
  "hasNext": true,
  "items": [
    {
      "connectionId": "string",
      "connectionName": "string",
      "connectionStatus": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "entityCount": 0,
      "executionBackend": "native",
      "executionMode": "sequential",
      "id": "string",
      "lastError": "string",
      "lastSuccessAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "providerKey": "string",
      "slug": "string",
      "status": "draft",
      "tenantId": "string",
      "tenantName": "string",
      "triggerMode": "manual",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Ocp Sync

POST
/api/v1/ocp/syncs

Header Parameters

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

Request Body

application/json

connectionId*string
entities?array<>
freshnessSlaSeconds?|
name*string
Length1 <= length <= 255
slug?|
sourceConfig?
status?string
Default"active"
Value in"draft" | "active" | "paused" | "error" | "archived"
tableBindings?array<>
tenantId*string

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/syncs" \  -H "Content-Type: application/json" \  -d '{    "connectionId": "string",    "name": "string",    "tenantId": "string"  }'
{
  "connectionId": "string",
  "connectionName": "string",
  "connectionStatus": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "entityCount": 0,
  "executionBackend": "native",
  "executionMode": "sequential",
  "id": "string",
  "lastError": "string",
  "lastSuccessAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "providerKey": "string",
  "slug": "string",
  "status": "draft",
  "tenantId": "string",
  "tenantName": "string",
  "triggerMode": "manual",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Sync

GET
/api/v1/ocp/syncs/{sync_id}

Path Parameters

sync_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/syncs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "connectionId": "string",
  "connectionName": "string",
  "connectionStatus": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "destinationConfig": {},
  "entities": [
    "string"
  ],
  "entityCount": 0,
  "executionBackend": "native",
  "executionConfig": {},
  "executionMode": "sequential",
  "freshnessSlaSeconds": 0,
  "id": "string",
  "lastError": "string",
  "lastSuccessAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "providerCatalog": {
    "availableResources": [
      "string"
    ],
    "configSchema": {},
    "defaultResources": [
      "string"
    ],
    "defaults": {},
    "displayName": "string",
    "dynamicResources": false,
    "name": "string",
    "provider": "shopify",
    "resources": [
      {
        "configSchema": {},
        "cursorField": "string",
        "defaultSelected": true,
        "dependsOn": [
          "string"
        ],
        "description": "string",
        "displayName": "string",
        "entityKey": "string",
        "loadMode": "append_event",
        "sizeClass": "xs",
        "slicing": {},
        "storageDescription": "string",
        "storageKind": "postgres"
      }
    ]
  },
  "providerKey": "string",
  "recentRuns": [
    {
      "attemptNumber": 1,
      "attemptRootRunId": "string",
      "backendStatus": {},
      "cancelReason": "string",
      "cancelRequestedAt": "2019-08-24T14:15:22Z",
      "cancelRequestedBy": "string",
      "completedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "error": "string",
      "executionBackend": "native",
      "executionMode": "sequential",
      "executorId": "string",
      "id": "string",
      "infraStopCode": "string",
      "infraStopReason": "string",
      "lastHeartbeatAt": "2019-08-24T14:15:22Z",
      "maxAutoResumeAttempts": 5,
      "nextAttemptRunId": "string",
      "previousAttemptRunId": "string",
      "resultClass": "success",
      "resultReasonCode": "heartbeat_timeout",
      "runMode": "incremental",
      "startedAt": "2019-08-24T14:15:22Z",
      "status": "pending",
      "summary": {},
      "triggerRef": "string",
      "triggeredBy": "manual",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "slug": "string",
  "sourceConfig": {},
  "status": "draft",
  "tableBindings": [
    {
      "cursorField": "string",
      "entityKey": "string",
      "loadMode": "append_event",
      "logicalTableName": "string",
      "physicalTableName": "string",
      "primaryKeyColumns": [
        "string"
      ],
      "sourceInstanceKey": "string",
      "tableName": "string",
      "tableNamingVersion": "legacy"
    }
  ],
  "tenantId": "string",
  "tenantName": "string",
  "triggerMode": "manual",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Ocp Sync

PATCH
/api/v1/ocp/syncs/{sync_id}

Path Parameters

sync_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

entities?array<>|
freshnessSlaSeconds?|
name?|
sourceConfig?|
status?|
tableBindings?array<>|

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/syncs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "connectionId": "string",
  "connectionName": "string",
  "connectionStatus": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "entityCount": 0,
  "executionBackend": "native",
  "executionMode": "sequential",
  "id": "string",
  "lastError": "string",
  "lastSuccessAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "providerKey": "string",
  "slug": "string",
  "status": "draft",
  "tenantId": "string",
  "tenantName": "string",
  "triggerMode": "manual",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Ocp Sync

DELETE
/api/v1/ocp/syncs/{sync_id}

Path Parameters

sync_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

List Ocp Sync Files

GET
/api/v1/ocp/syncs/{sync_id}/files

Path Parameters

sync_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/ocp/syncs/497f6eca-6276-4993-bfeb-53cbbbba6f08/files"
{
  "hasNext": true,
  "items": [
    {
      "connectionId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "firstSeenAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "lastSeenAt": "2019-08-24T14:15:22Z",
      "latestVersionId": "string",
      "mimeType": "string",
      "missingSince": "2019-08-24T14:15:22Z",
      "provider": "shopify",
      "sourceIdentity": "string",
      "sourceName": "string",
      "sourceParent": "string",
      "sourcePath": "string",
      "sourceUri": "string",
      "status": "active",
      "syncId": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Sync File Versions

GET
/api/v1/ocp/syncs/{sync_id}/files/{asset_id}/versions

Path Parameters

sync_id*string
Formatuuid
asset_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/ocp/syncs/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
{
  "hasNext": true,
  "items": [
    {
      "assetId": "string",
      "contentHash": "string",
      "copiedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "destinationBucket": "string",
      "destinationKey": "string",
      "error": "string",
      "id": "string",
      "sourceIdentity": "string",
      "sourceModifiedAt": "2019-08-24T14:15:22Z",
      "sourceSizeBytes": 0,
      "sourceVersionFingerprint": "string",
      "status": "copying",
      "syncId": "string",
      "syncRunId": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Ocp Sync Table Binding Data

DELETE
/api/v1/ocp/syncs/{sync_id}/table-bindings/{entity_key}/data

Path Parameters

sync_id*string
Formatuuid
entity_key*string

Header Parameters

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

Response Body

application/json

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

Truncate Ocp Sync Table Binding

POST
/api/v1/ocp/syncs/{sync_id}/table-bindings/{entity_key}/truncate

Path Parameters

sync_id*string
Formatuuid
entity_key*string

Header Parameters

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

Response Body

application/json

curl -X POST "https://loading/api/v1/ocp/syncs/497f6eca-6276-4993-bfeb-53cbbbba6f08/table-bindings/string/truncate"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Trigger Ocp Sync

POST
/api/v1/ocp/syncs/{sync_id}/trigger

Path Parameters

sync_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

runMode?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/syncs/497f6eca-6276-4993-bfeb-53cbbbba6f08/trigger" \  -H "Content-Type: application/json" \  -d '{}'
{
  "attemptNumber": 1,
  "attemptRootRunId": "string",
  "backendStatus": {},
  "cancelReason": "string",
  "cancelRequestedAt": "2019-08-24T14:15:22Z",
  "cancelRequestedBy": "string",
  "completedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "error": "string",
  "executionBackend": "native",
  "executionMode": "sequential",
  "executorId": "string",
  "id": "string",
  "infraStopCode": "string",
  "infraStopReason": "string",
  "lastHeartbeatAt": "2019-08-24T14:15:22Z",
  "maxAutoResumeAttempts": 5,
  "nextAttemptRunId": "string",
  "previousAttemptRunId": "string",
  "resultClass": "success",
  "resultReasonCode": "heartbeat_timeout",
  "runMode": "incremental",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "summary": {},
  "triggerRef": "string",
  "triggeredBy": "manual",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Tasks

GET
/api/v1/ocp/tasks

Query Parameters

q?|
tenant_id?|
lifecycle?|
category?|
tag?array<>|
tag_id?array<>|
tag_match?string
Default"any"
Value in"any" | "all"
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/ocp/tasks"
{
  "hasNext": true,
  "items": [
    {
      "category": "string",
      "contextVars": [
        {
          "default": {},
          "description": "string",
          "name": "string",
          "required": true,
          "resolveFrom": "string",
          "type": "string"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "displayName": "string",
      "executionMode": "string",
      "id": "string",
      "instructions": "string",
      "lifecycle": "string",
      "model": "string",
      "name": "string",
      "skillRefs": [
        "string"
      ],
      "tenantId": "string",
      "timeoutSeconds": 0,
      "toolRefs": [
        "string"
      ],
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Ocp Task

POST
/api/v1/ocp/tasks

Header Parameters

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

Request Body

application/json

category?|
contextVars*array<>
description*string
displayName*string
executionMode?string
Default"async"
instructions*string
model?string
Default"claude-sonnet-4-6"
name*string
skillRefs?array<>
tenantId*string
timeoutSeconds?integer
Default3600
toolRefs*array<>

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tasks" \  -H "Content-Type: application/json" \  -d '{    "contextVars": [      {}    ],    "description": "string",    "displayName": "string",    "instructions": "string",    "name": "string",    "tenantId": "string",    "toolRefs": [      "string"    ]  }'
{
  "category": "string",
  "contextVars": [
    {
      "default": {},
      "description": "string",
      "name": "string",
      "required": true,
      "resolveFrom": "string",
      "type": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "displayName": "string",
  "executionMode": "string",
  "id": "string",
  "instructions": "string",
  "lifecycle": "string",
  "model": "string",
  "name": "string",
  "skillRefs": [
    "string"
  ],
  "tenantId": "string",
  "timeoutSeconds": 0,
  "toolRefs": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Ocp Task

GET
/api/v1/ocp/tasks/{task_id}

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "category": "string",
  "contextVars": [
    {
      "default": {},
      "description": "string",
      "name": "string",
      "required": true,
      "resolveFrom": "string",
      "type": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "displayName": "string",
  "executionMode": "string",
  "id": "string",
  "instructions": "string",
  "lifecycle": "string",
  "model": "string",
  "name": "string",
  "skillRefs": [
    "string"
  ],
  "tenantId": "string",
  "timeoutSeconds": 0,
  "toolRefs": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Ocp Task

PATCH
/api/v1/ocp/tasks/{task_id}

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

category?|
contextVars?array<>|
description?|
displayName?|
executionMode?|
instructions?|
model?|
skillRefs?array<>|
timeoutSeconds?|
toolRefs?array<>|

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "category": "string",
  "contextVars": [
    {
      "default": {},
      "description": "string",
      "name": "string",
      "required": true,
      "resolveFrom": "string",
      "type": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "displayName": "string",
  "executionMode": "string",
  "id": "string",
  "instructions": "string",
  "lifecycle": "string",
  "model": "string",
  "name": "string",
  "skillRefs": [
    "string"
  ],
  "tenantId": "string",
  "timeoutSeconds": 0,
  "toolRefs": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Ocp Task

DELETE
/api/v1/ocp/tasks/{task_id}

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

Archive Ocp Task

POST
/api/v1/ocp/tasks/{task_id}/archive

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive"
{
  "category": "string",
  "contextVars": [
    {
      "default": {},
      "description": "string",
      "name": "string",
      "required": true,
      "resolveFrom": "string",
      "type": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "displayName": "string",
  "executionMode": "string",
  "id": "string",
  "instructions": "string",
  "lifecycle": "string",
  "model": "string",
  "name": "string",
  "skillRefs": [
    "string"
  ],
  "tenantId": "string",
  "timeoutSeconds": 0,
  "toolRefs": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Publish Ocp Task

POST
/api/v1/ocp/tasks/{task_id}/publish

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish"
{
  "category": "string",
  "contextVars": [
    {
      "default": {},
      "description": "string",
      "name": "string",
      "required": true,
      "resolveFrom": "string",
      "type": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "displayName": "string",
  "executionMode": "string",
  "id": "string",
  "instructions": "string",
  "lifecycle": "string",
  "model": "string",
  "name": "string",
  "skillRefs": [
    "string"
  ],
  "tenantId": "string",
  "timeoutSeconds": 0,
  "toolRefs": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Restore Ocp Task

POST
/api/v1/ocp/tasks/{task_id}/restore

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore"
{
  "category": "string",
  "contextVars": [
    {
      "default": {},
      "description": "string",
      "name": "string",
      "required": true,
      "resolveFrom": "string",
      "type": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "displayName": "string",
  "executionMode": "string",
  "id": "string",
  "instructions": "string",
  "lifecycle": "string",
  "model": "string",
  "name": "string",
  "skillRefs": [
    "string"
  ],
  "tenantId": "string",
  "timeoutSeconds": 0,
  "toolRefs": [
    "string"
  ],
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Task Tags

GET
/api/v1/ocp/tasks/{task_id}/tags

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tasks/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 Ocp Task Tags

PUT
/api/v1/ocp/tasks/{task_id}/tags

Path Parameters

task_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/ocp/tasks/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 Ocp Task Versions

GET
/api/v1/ocp/tasks/{task_id}/versions

Path Parameters

task_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
[
  {
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "createdByName": "string",
    "diffableText": "string",
    "id": "string",
    "snapshot": {},
    "sourceColorBucket": "string",
    "sourceLabel": "string",
    "sourceType": "string",
    "summary": "string",
    "version": 0
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Tenants

GET
/api/v1/ocp/tenants

Query Parameters

q?|
status?|
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/ocp/tenants"
{
  "hasNext": true,
  "items": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "name": "string",
      "slug": "string",
      "status": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Tenant

GET
/api/v1/ocp/tenants/{tenant_id}

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "name": "string",
  "organizationCount": 0,
  "slug": "string",
  "status": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Tenant Agents

GET
/api/v1/ocp/tenants/{tenant_id}/agents

Path Parameters

tenant_id*string
Formatuuid

Query Parameters

q?|
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/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents"
{
  "hasNext": true,
  "items": [
    {
      "agentSpecId": "string",
      "conversationCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "createdByEmail": "string",
      "description": "string",
      "lastUsedAt": "2019-08-24T14:15:22Z",
      "lifecycleStatus": "active",
      "name": "string",
      "tenantId": "string",
      "tenantName": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userCount": 0
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Tenant Agent

POST
/api/v1/ocp/tenants/{tenant_id}/agents

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

markdown*string
systemKey?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents" \  -H "Content-Type: application/json" \  -d '{    "markdown": "string"  }'
{
  "activeVersion": 0,
  "activeVersionId": "string",
  "agentSpecId": "string",
  "contentSha256": "string",
  "conversationCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByEmail": "string",
  "description": "string",
  "frontmatter": {},
  "lifecycleStatus": "active",
  "markdown": "string",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "tenantSlug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Activate Tenant Agent

POST
/api/v1/ocp/tenants/{tenant_id}/agents/{agent_spec_id}/activate

Path Parameters

tenant_id*string
Formatuuid
agent_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/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/activate"
{
  "activeVersion": 0,
  "activeVersionId": "string",
  "agentSpecId": "string",
  "contentSha256": "string",
  "conversationCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByEmail": "string",
  "description": "string",
  "frontmatter": {},
  "lifecycleStatus": "active",
  "markdown": "string",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "tenantSlug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Deactivate Tenant Agent

POST
/api/v1/ocp/tenants/{tenant_id}/agents/{agent_spec_id}/deactivate

Path Parameters

tenant_id*string
Formatuuid
agent_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/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/deactivate"
{
  "activeVersion": 0,
  "activeVersionId": "string",
  "agentSpecId": "string",
  "contentSha256": "string",
  "conversationCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByEmail": "string",
  "description": "string",
  "frontmatter": {},
  "lifecycleStatus": "active",
  "markdown": "string",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "tenantSlug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Tenant Agent Versions

GET
/api/v1/ocp/tenants/{tenant_id}/agents/{agent_spec_id}/versions

Path Parameters

tenant_id*string
Formatuuid
agent_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/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
[
  {
    "agentSpecId": "string",
    "contentSha256": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "definitionMarkdown": "string",
    "frontmatter": {},
    "id": "string",
    "status": "active",
    "tenantId": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "version": 0
  }
]
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Tenant Agent Version

POST
/api/v1/ocp/tenants/{tenant_id}/agents/{agent_spec_id}/versions

Path Parameters

tenant_id*string
Formatuuid
agent_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 POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions" \  -H "Content-Type: application/json" \  -d '{    "markdown": "string"  }'
{
  "activeVersion": 0,
  "activeVersionId": "string",
  "agentSpecId": "string",
  "contentSha256": "string",
  "conversationCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByEmail": "string",
  "description": "string",
  "frontmatter": {},
  "lifecycleStatus": "active",
  "markdown": "string",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "tenantSlug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Activate Tenant Agent Version

POST
/api/v1/ocp/tenants/{tenant_id}/agents/{agent_spec_id}/versions/{version_id}/activate

Path Parameters

tenant_id*string
Formatuuid
agent_spec_id*string
Formatuuid
version_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/activate"
{
  "activeVersion": 0,
  "activeVersionId": "string",
  "agentSpecId": "string",
  "contentSha256": "string",
  "conversationCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByEmail": "string",
  "description": "string",
  "frontmatter": {},
  "lifecycleStatus": "active",
  "markdown": "string",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "tenantSlug": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Tenant Authz Events

GET
/api/v1/ocp/tenants/{tenant_id}/authz-events

Path Parameters

tenant_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/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/authz-events"
{
  "hasNext": true,
  "items": [
    {
      "capability": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "details": {},
      "eventKind": "string",
      "id": "string",
      "outcome": "string",
      "resourceId": "string",
      "resourceType": "string",
      "surface": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Communication Messages

GET
/api/v1/ocp/tenants/{tenant_id}/communications/messages

Path Parameters

tenant_id*string
Formatuuid

Query Parameters

direction?|
limit?integer
Default25
Range1 <= value <= 100

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/messages"
{
  "items": [
    {
      "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
      "approvalRequestId": "62a09f2a-7fb7-4e24-a2af-6c58e85c4c08",
      "authorType": "human",
      "authorUserId": "ea75109d-c5c5-4407-b0ab-0da27cd41c18",
      "bodySnippet": "string",
      "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
      "chatThreadId": "cc32daea-1d16-4c2c-bc52-fa2ca8b61829",
      "createdAt": "2019-08-24T14:15:22Z",
      "direction": "outbound",
      "dispatchedAt": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "idempotencyKey": "string",
      "latestDispatch": {
        "acceptedAt": "2019-08-24T14:15:22Z",
        "attemptNumber": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "errorCode": "string",
        "errorMessage": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "providerMessageId": "string",
        "responsePayload": {},
        "status": "string",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "onBehalfOfUserId": "1d30051c-0b13-448c-8447-1e62c4438eee",
      "processedAt": "2019-08-24T14:15:22Z",
      "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
      "purpose": "string",
      "queuedAt": "2019-08-24T14:15:22Z",
      "recipients": [
        {
          "address": "string",
          "deliveryStatus": "string",
          "displayName": "string",
          "role": "string"
        }
      ],
      "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
      "roomRunId": "4a86e5ed-d88f-4064-a313-f4ee545a4eb6",
      "routeId": "fef0741a-9185-417e-be48-b4fe23a36919",
      "runId": "78c33d18-170c-44d3-a227-b3194f134f73",
      "state": "draft",
      "subject": "string",
      "toolCallId": "string",
      "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
      "updatedAt": "2019-08-24T14:15:22Z",
      "workflowKey": "string",
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Send Ocp Communication Email

POST
/api/v1/ocp/tenants/{tenant_id}/communications/messages/send

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

approvalRequestId?|
authorType?string
Default"human"
Value in"human" | "agent" | "system" | "provider"
authorUserId?|
bcc?array<>
bodyHtml?|
bodyText*string
Length1 <= length
cc?array<>
chatThreadId?|
idempotencyKey*string
Length1 <= length <= 255
onBehalfOfUserId?|
profileId?|
purpose*string
Length1 <= length <= 128
replyTo?|
runId?|
subject*string
Length1 <= length
templateKey?|
templatePayload?
templateVersion?|
to*array<>
Items1 <= items
toolCallId?|
turnId?|
workflowKey?|
workspaceId?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/messages/send" \  -H "Content-Type: application/json" \  -d '{    "bodyText": "string",    "idempotencyKey": "string",    "purpose": "string",    "subject": "string",    "to": [      {        "address": "user@example.com"      }    ]  }'
{
  "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
  "approvalRequestId": "62a09f2a-7fb7-4e24-a2af-6c58e85c4c08",
  "authorType": "human",
  "authorUserId": "ea75109d-c5c5-4407-b0ab-0da27cd41c18",
  "bodySnippet": "string",
  "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
  "chatThreadId": "cc32daea-1d16-4c2c-bc52-fa2ca8b61829",
  "createdAt": "2019-08-24T14:15:22Z",
  "direction": "outbound",
  "dispatchedAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "idempotencyKey": "string",
  "onBehalfOfUserId": "1d30051c-0b13-448c-8447-1e62c4438eee",
  "processedAt": "2019-08-24T14:15:22Z",
  "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  "purpose": "string",
  "queuedAt": "2019-08-24T14:15:22Z",
  "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  "roomRunId": "4a86e5ed-d88f-4064-a313-f4ee545a4eb6",
  "routeId": "fef0741a-9185-417e-be48-b4fe23a36919",
  "runId": "78c33d18-170c-44d3-a227-b3194f134f73",
  "state": "draft",
  "subject": "string",
  "toolCallId": "string",
  "turnId": "7513f73d-27ec-455d-85b7-7bd021b4dccf",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowKey": "string",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Communication Profiles

GET
/api/v1/ocp/tenants/{tenant_id}/communications/profiles

Path Parameters

tenant_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/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/profiles"
{
  "items": [
    {
      "address": "string",
      "authorizedAt": "2019-08-24T14:15:22Z",
      "authorizedBy": "dde19a8c-029a-482f-ac49-c7a319b34b12",
      "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
      "createdAt": "2019-08-24T14:15:22Z",
      "displayName": "string",
      "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isDefault": true,
      "kind": "platform",
      "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
      "policy": {},
      "replyToAddress": "string",
      "scope": "tenant",
      "status": "pending_verification",
      "updatedAt": "2019-08-24T14:15:22Z",
      "workflowKey": "string",
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Ocp Communication Profile

POST
/api/v1/ocp/tenants/{tenant_id}/communications/profiles

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

address*string
Formatemail
displayName*string
kind?string
Default"user"
Value in"platform" | "user" | "team" | "workflow"
policy?
replyToAddress?|
scope?string
Default"tenant"
Value in"tenant" | "workspace" | "workflow" | "user"
workflowKey?|
workspaceId?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/profiles" \  -H "Content-Type: application/json" \  -d '{    "address": "user@example.com",    "displayName": "string"  }'
{
  "address": "string",
  "authorizedAt": "2019-08-24T14:15:22Z",
  "authorizedBy": "dde19a8c-029a-482f-ac49-c7a319b34b12",
  "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayName": "string",
  "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "kind": "platform",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "policy": {},
  "replyToAddress": "string",
  "scope": "tenant",
  "status": "pending_verification",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowKey": "string",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Ocp Communication Profile Grant

POST
/api/v1/ocp/tenants/{tenant_id}/communications/profiles/{profile_id}/grants

Path Parameters

tenant_id*string
Formatuuid
profile_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

constraints?
principalKind*string
Value in"user" | "tenant" | "workflow" | "system"
principalUserId?|
workflowKey?|

Response Body

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/profiles/497f6eca-6276-4993-bfeb-53cbbbba6f08/grants" \  -H "Content-Type: application/json" \  -d '{    "principalKind": "user"  }'
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Refresh Ocp Communication Profile Verification

POST
/api/v1/ocp/tenants/{tenant_id}/communications/profiles/{profile_id}/refresh-verification

Path Parameters

tenant_id*string
Formatuuid
profile_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/profiles/497f6eca-6276-4993-bfeb-53cbbbba6f08/refresh-verification"
{
  "address": "string",
  "authorizedAt": "2019-08-24T14:15:22Z",
  "authorizedBy": "dde19a8c-029a-482f-ac49-c7a319b34b12",
  "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayName": "string",
  "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "kind": "platform",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "policy": {},
  "replyToAddress": "string",
  "scope": "tenant",
  "status": "pending_verification",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowKey": "string",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Resend Ocp Communication Profile Confirmation

POST
/api/v1/ocp/tenants/{tenant_id}/communications/profiles/{profile_id}/resend-confirmation

Path Parameters

tenant_id*string
Formatuuid
profile_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/profiles/497f6eca-6276-4993-bfeb-53cbbbba6f08/resend-confirmation"
{
  "address": "string",
  "authorizedAt": "2019-08-24T14:15:22Z",
  "authorizedBy": "dde19a8c-029a-482f-ac49-c7a319b34b12",
  "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayName": "string",
  "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "kind": "platform",
  "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
  "policy": {},
  "replyToAddress": "string",
  "scope": "tenant",
  "status": "pending_verification",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowKey": "string",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Communication Routes

GET
/api/v1/ocp/tenants/{tenant_id}/communications/routes

Path Parameters

tenant_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/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/routes"
{
  "items": [
    {
      "address": "string",
      "allowedSenderPolicy": {},
      "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
      "config": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
      "handlerKind": "process",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "active",
      "targetId": "cbca1126-180e-4334-9df8-cf82289d378b",
      "targetKind": "string",
      "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
      "updatedAt": "2019-08-24T14:15:22Z",
      "workflowKey": "string",
      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Ocp Communication Route

POST
/api/v1/ocp/tenants/{tenant_id}/communications/routes

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

allowedSenderPolicy?
config?
handlerKind?string
Default"process"
Value in"process" | "document_ingest" | "chat_reply" | "workspace_intake" | "workflow_trigger"
targetId?|
targetKind?|
threadId?|
workflowKey?|
workspaceId?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/communications/routes" \  -H "Content-Type: application/json" \  -d '{}'
{
  "address": "string",
  "allowedSenderPolicy": {},
  "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
  "config": {},
  "createdAt": "2019-08-24T14:15:22Z",
  "endpointId": "c8d2c7e1-e4b1-4108-9e29-3429a36a1ef3",
  "handlerKind": "process",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "active",
  "targetId": "cbca1126-180e-4334-9df8-cf82289d378b",
  "targetKind": "string",
  "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workflowKey": "string",
  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Tenant Enforcement Mode

PATCH
/api/v1/ocp/tenants/{tenant_id}/enforcement-modes/{surface}

Path Parameters

tenant_id*string
Formatuuid
surface*string
Value in"api" | "inline_chat" | "outbox_chat" | "scheduled" | "approval_resume" | "ocp"

Header Parameters

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

Request Body

application/json

mode*string
Value in"legacy" | "strict"

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/enforcement-modes/api" \  -H "Content-Type: application/json" \  -d '{    "mode": "legacy"  }'
{
  "mode": "legacy",
  "surface": "api",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Authz Group

POST
/api/v1/ocp/tenants/{tenant_id}/groups

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

description?|
name*string
slug*string

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/groups" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string"  }'
{
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Add Authz Group Member

POST
/api/v1/ocp/tenants/{tenant_id}/groups/{group_id}/members/{membership_id}

Path Parameters

tenant_id*string
Formatuuid
group_id*string
Formatuuid
membership_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "membershipId": "8072cc74-4782-4f2c-827c-699c48ce2092",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Remove Authz Group Member

DELETE
/api/v1/ocp/tenants/{tenant_id}/groups/{group_id}/members/{membership_id}

Path Parameters

tenant_id*string
Formatuuid
group_id*string
Formatuuid
membership_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X DELETE "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/groups/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "property1": 0,
  "property2": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Tenant Memberships

GET
/api/v1/ocp/tenants/{tenant_id}/memberships

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/memberships"
{
  "members": [
    {
      "active": true,
      "email": "string",
      "firstName": "string",
      "joinedAt": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "membershipId": "string",
      "organizationId": "string",
      "organizationName": "string",
      "roleId": "string",
      "roleName": "string",
      "roleSlug": "string",
      "userId": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Membership Effective Access

GET
/api/v1/ocp/tenants/{tenant_id}/memberships/{membership_id}/effective-access

Path Parameters

tenant_id*string
Formatuuid
membership_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/memberships/497f6eca-6276-4993-bfeb-53cbbbba6f08/effective-access"
{
  "grants": [
    {
      "capability": "knowledge.read",
      "expiresAt": "2019-08-24T14:15:22Z",
      "source": "string",
      "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2"
    }
  ],
  "membershipId": "8072cc74-4782-4f2c-827c-699c48ce2092"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Tenant Membership Role

PATCH
/api/v1/ocp/tenants/{tenant_id}/memberships/{membership_id}/role

Path Parameters

tenant_id*string
Formatuuid
membership_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

roleSlug*string
Value in"owner" | "admin" | "member" | "viewer"

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/memberships/497f6eca-6276-4993-bfeb-53cbbbba6f08/role" \  -H "Content-Type: application/json" \  -d '{    "roleSlug": "owner"  }'
{
  "membershipId": "string",
  "roleId": "string",
  "roleName": "string",
  "roleSlug": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Grant Principal Capability

POST
/api/v1/ocp/tenants/{tenant_id}/principals/{principal_kind}/{principal_id}/capabilities

Path Parameters

tenant_id*string
Formatuuid
principal_kind*string
Value in"membership" | "role" | "group" | "tenant"
principal_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

capability*string
Value in"knowledge.read" | "knowledge.write" | "knowledge.delete" | "knowledge.admin" | "file.read" | "file.write" | "file.delete" | "file.admin" | "file.download" | "workspace.read" | "workspace.write" | "workspace.delete" | "workspace.admin" | "artifact.read" | "artifact.write" | "artifact.delete" | "artifact.admin" | "chat_thread.read" | "chat_thread.write" | "chat_thread.delete" | "chat_thread.admin" | "room.read" | "room.write" | "room.admin" | "agent.read" | "agent.write" | "agent.delete" | "agent.admin" | "task.read" | "task.write" | "task.delete" | "task.admin" | "task.execute" | "run.read" | "run.cancel" | "schedule.read" | "schedule.write" | "schedule.delete" | "connection.read" | "connection.write" | "connection.delete" | "connection.admin" | "communication.send" | "security_model.read" | "roles.manage"
expiresAt?|
sourceId?|
sourceKind?string
Default"direct"
Value in"direct" | "break_glass" | "seed"

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/principals/membership/497f6eca-6276-4993-bfeb-53cbbbba6f08/capabilities" \  -H "Content-Type: application/json" \  -d '{    "capability": "knowledge.read"  }'
{
  "capability": "knowledge.read",
  "expiresAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "principalId": "0a52818d-1e0c-4e64-848e-4d04f9e914e5",
  "principalKind": "membership",
  "provenanceEventId": "a42d1403-70d0-4f81-b72c-cc9c2a66427b",
  "revokedAt": "2019-08-24T14:15:22Z",
  "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
  "sourceKind": "direct",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Revoke Principal Capability

DELETE
/api/v1/ocp/tenants/{tenant_id}/principals/{principal_kind}/{principal_id}/capabilities/{capability}

Path Parameters

tenant_id*string
Formatuuid
principal_kind*string
Value in"membership" | "role" | "group" | "tenant"
principal_id*string
Formatuuid
capability*string
Value in"knowledge.read" | "knowledge.write" | "knowledge.delete" | "knowledge.admin" | "file.read" | "file.write" | "file.delete" | "file.admin" | "file.download" | "workspace.read" | "workspace.write" | "workspace.delete" | "workspace.admin" | "artifact.read" | "artifact.write" | "artifact.delete" | "artifact.admin" | "chat_thread.read" | "chat_thread.write" | "chat_thread.delete" | "chat_thread.admin" | "room.read" | "room.write" | "room.admin" | "agent.read" | "agent.write" | "agent.delete" | "agent.admin" | "task.read" | "task.write" | "task.delete" | "task.admin" | "task.execute" | "run.read" | "run.cancel" | "schedule.read" | "schedule.write" | "schedule.delete" | "connection.read" | "connection.write" | "connection.delete" | "connection.admin" | "communication.send" | "security_model.read" | "roles.manage"

Header Parameters

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

Response Body

application/json

application/json

curl -X DELETE "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/principals/membership/497f6eca-6276-4993-bfeb-53cbbbba6f08/capabilities/knowledge.read"
{
  "property1": 0,
  "property2": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Grant Role Capability

POST
/api/v1/ocp/tenants/{tenant_id}/roles/{role_id}/capabilities

Path Parameters

tenant_id*string
Formatuuid
role_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

capability*string
Value in"knowledge.read" | "knowledge.write" | "knowledge.delete" | "knowledge.admin" | "file.read" | "file.write" | "file.delete" | "file.admin" | "file.download" | "workspace.read" | "workspace.write" | "workspace.delete" | "workspace.admin" | "artifact.read" | "artifact.write" | "artifact.delete" | "artifact.admin" | "chat_thread.read" | "chat_thread.write" | "chat_thread.delete" | "chat_thread.admin" | "room.read" | "room.write" | "room.admin" | "agent.read" | "agent.write" | "agent.delete" | "agent.admin" | "task.read" | "task.write" | "task.delete" | "task.admin" | "task.execute" | "run.read" | "run.cancel" | "schedule.read" | "schedule.write" | "schedule.delete" | "connection.read" | "connection.write" | "connection.delete" | "connection.admin" | "communication.send" | "security_model.read" | "roles.manage"

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/roles/497f6eca-6276-4993-bfeb-53cbbbba6f08/capabilities" \  -H "Content-Type: application/json" \  -d '{    "capability": "knowledge.read"  }'
{
  "capability": "knowledge.read",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Revoke Role Capability

DELETE
/api/v1/ocp/tenants/{tenant_id}/roles/{role_id}/capabilities/{capability}

Path Parameters

tenant_id*string
Formatuuid
role_id*string
Formatuuid
capability*string
Value in"knowledge.read" | "knowledge.write" | "knowledge.delete" | "knowledge.admin" | "file.read" | "file.write" | "file.delete" | "file.admin" | "file.download" | "workspace.read" | "workspace.write" | "workspace.delete" | "workspace.admin" | "artifact.read" | "artifact.write" | "artifact.delete" | "artifact.admin" | "chat_thread.read" | "chat_thread.write" | "chat_thread.delete" | "chat_thread.admin" | "room.read" | "room.write" | "room.admin" | "agent.read" | "agent.write" | "agent.delete" | "agent.admin" | "task.read" | "task.write" | "task.delete" | "task.admin" | "task.execute" | "run.read" | "run.cancel" | "schedule.read" | "schedule.write" | "schedule.delete" | "connection.read" | "connection.write" | "connection.delete" | "connection.admin" | "communication.send" | "security_model.read" | "roles.manage"

Header Parameters

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

Response Body

application/json

application/json

curl -X DELETE "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/roles/497f6eca-6276-4993-bfeb-53cbbbba6f08/capabilities/knowledge.read"
{
  "property1": 0,
  "property2": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Tenant Security Model

GET
/api/v1/ocp/tenants/{tenant_id}/security-model

Path Parameters

tenant_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/security-model"
{
  "enforcementModes": {},
  "governance": {},
  "groups": [
    {}
  ],
  "recentAuthzChanges": [
    {}
  ],
  "roles": [
    {}
  ],
  "tenant": {}
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Tools

GET
/api/v1/ocp/tools

Query Parameters

q?|
tenant_id?|
status?|
tool_type?|
tag?array<>|
tag_id?array<>|
tag_match?string
Default"any"
Value in"any" | "all"
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/ocp/tools"
{
  "hasNext": true,
  "items": [
    {
      "approvalRequired": true,
      "asyncEligible": true,
      "builtInRef": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "executionMode": "string",
      "httpConfig": {},
      "id": "string",
      "maxRetries": 0,
      "mcpConfig": {},
      "mcpTransport": "string",
      "mode": "string",
      "name": "string",
      "risk": "string",
      "status": "string",
      "tenantId": "string",
      "tenantName": "string",
      "timeoutSeconds": 0,
      "toolType": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Create Tool

POST
/api/v1/ocp/tools

Header Parameters

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

Request Body

application/json

approvalRequired?boolean
Defaultfalse
asyncEligible?boolean
Defaultfalse
builtInRef?|
description*string
executionMode?string
Default"sync"
httpConfig?|
maxRetries?integer
Default2
mcpConfig?|
mcpTransport?|
mode?string
Default"read"
name*string
risk?string
Default"low"
tenantId*string
timeoutSeconds?integer
Default3600
toolType*string

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tools" \  -H "Content-Type: application/json" \  -d '{    "description": "string",    "name": "string",    "tenantId": "string",    "toolType": "string"  }'
{
  "approvalRequired": true,
  "asyncEligible": true,
  "builtInRef": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "executionMode": "string",
  "httpConfig": {},
  "id": "string",
  "maxRetries": 0,
  "mcpConfig": {},
  "mcpTransport": "string",
  "mode": "string",
  "name": "string",
  "risk": "string",
  "status": "string",
  "tenantId": "string",
  "tenantName": "string",
  "timeoutSeconds": 0,
  "toolType": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Tool

GET
/api/v1/ocp/tools/{tool_id}

Path Parameters

tool_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tools/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "approvalRequired": true,
  "asyncEligible": true,
  "builtInRef": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "executionMode": "string",
  "httpConfig": {},
  "id": "string",
  "maxRetries": 0,
  "mcpConfig": {},
  "mcpTransport": "string",
  "mode": "string",
  "name": "string",
  "risk": "string",
  "status": "string",
  "tenantId": "string",
  "tenantName": "string",
  "timeoutSeconds": 0,
  "toolType": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Update Tool

PATCH
/api/v1/ocp/tools/{tool_id}

Path Parameters

tool_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

approvalRequired?|
asyncEligible?|
builtInRef?|
description?|
executionMode?|
httpConfig?|
maxRetries?|
mcpConfig?|
mcpTransport?|
mode?|
name?|
risk?|
status?|
timeoutSeconds?|

Response Body

application/json

application/json

curl -X PATCH "https://loading/api/v1/ocp/tools/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "approvalRequired": true,
  "asyncEligible": true,
  "builtInRef": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "executionMode": "string",
  "httpConfig": {},
  "id": "string",
  "maxRetries": 0,
  "mcpConfig": {},
  "mcpTransport": "string",
  "mode": "string",
  "name": "string",
  "risk": "string",
  "status": "string",
  "tenantId": "string",
  "tenantName": "string",
  "timeoutSeconds": 0,
  "toolType": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Tool

DELETE
/api/v1/ocp/tools/{tool_id}

Path Parameters

tool_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

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

Ai Import Endpoints

POST
/api/v1/ocp/tools/{tool_id}/ai-import

Path Parameters

tool_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

content*string
contentType?string
Default"auto"

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tools/497f6eca-6276-4993-bfeb-53cbbbba6f08/ai-import" \  -H "Content-Type: application/json" \  -d '{    "content": "string"  }'
{
  "endpoints": [
    {
      "authMode": "none",
      "authOptional": false,
      "authRequired": false,
      "authSchemes": [
        "string"
      ],
      "bodyTemplate": {},
      "description": "string",
      "headers": {},
      "inputSchema": {},
      "method": "string",
      "name": "string",
      "path": "string",
      "queryTemplate": {
        "property1": "string",
        "property2": "string"
      },
      "responseExtract": "string",
      "source": "ai_generated"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Discover Tools

POST
/api/v1/ocp/tools/{tool_id}/discover

Path Parameters

tool_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tools/497f6eca-6276-4993-bfeb-53cbbbba6f08/discover"
{
  "tools": [
    {
      "authMode": "none",
      "authOptional": false,
      "authRequired": false,
      "authSchemes": [
        "string"
      ],
      "bodyTemplate": {},
      "description": "string",
      "inputSchema": {},
      "method": "string",
      "name": "string",
      "path": "string",
      "queryTemplate": {
        "property1": "string",
        "property2": "string"
      },
      "source": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ocp Tool Tags

GET
/api/v1/ocp/tools/{tool_id}/tags

Path Parameters

tool_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/tools/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 Ocp Tool Tags

PUT
/api/v1/ocp/tools/{tool_id}/tags

Path Parameters

tool_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/ocp/tools/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"
    }
  ]
}

Test Endpoint

POST
/api/v1/ocp/tools/{tool_id}/test-endpoint

Path Parameters

tool_id*string
Formatuuid

Header Parameters

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

Request Body

application/json

endpointName*string
params?
Default{}

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/tools/497f6eca-6276-4993-bfeb-53cbbbba6f08/test-endpoint" \  -H "Content-Type: application/json" \  -d '{    "endpointName": "string"  }'
{
  "request": {
    "body": {},
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "method": "string",
    "query": {
      "property1": "string",
      "property2": "string"
    },
    "url": "string"
  },
  "response": {
    "body": null,
    "durationMs": 0,
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "statusCode": 0
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Users

GET
/api/v1/ocp/users

Query Parameters

q?|
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/ocp/users"
{
  "hasNext": true,
  "items": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "email": "string",
      "emailVerified": true,
      "firstName": "string",
      "id": "string",
      "lastLoginAt": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "profilePictureUrl": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get User

GET
/api/v1/ocp/users/{user_id}

Path Parameters

user_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "createdAt": "2019-08-24T14:15:22Z",
  "email": "string",
  "emailVerified": true,
  "firstName": "string",
  "id": "string",
  "lastLoginAt": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "locale": "string",
  "memberships": [
    {
      "joinedAt": "2019-08-24T14:15:22Z",
      "membershipId": "string",
      "organizationId": "string",
      "organizationName": "string",
      "roleId": "string",
      "roleName": "string",
      "tenantId": "string",
      "tenantName": "string"
    }
  ],
  "profilePictureUrl": "string",
  "timezone": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List User Agents

GET
/api/v1/ocp/users/{user_id}/agents

Path Parameters

user_id*string
Formatuuid

Query Parameters

q?|
tenant_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/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents"
{
  "hasNext": true,
  "items": [
    {
      "agentSpecId": "string",
      "conversationCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "createdByEmail": "string",
      "description": "string",
      "lastUsedAt": "2019-08-24T14:15:22Z",
      "lifecycleStatus": "active",
      "name": "string",
      "tenantId": "string",
      "tenantName": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userCount": 0
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List User Conversations

GET
/api/v1/ocp/users/{user_id}/conversations

Path Parameters

user_id*string
Formatuuid

Query Parameters

q?|
tenant_id?|
agent_spec_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/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/conversations"
{
  "hasNext": true,
  "items": [
    {
      "agentLifecycleStatus": "active",
      "agentName": "string",
      "agentSpecId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "deletedAt": "2019-08-24T14:15:22Z",
      "hasReasoning": true,
      "hasToolError": true,
      "id": "string",
      "isShared": true,
      "lastTurnStatus": "pending",
      "memoryCount": 0,
      "messageCount": 0,
      "shareRecipients": [
        {
          "email": "string",
          "firstName": "string",
          "id": "string",
          "lastName": "string",
          "profilePictureUrl": "string"
        }
      ],
      "tenantId": "string",
      "tenantName": "string",
      "title": "string",
      "toolCallCount": 0,
      "updatedAt": "2019-08-24T14:15:22Z",
      "userEmail": "string",
      "userId": "string",
      "userName": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List User Documents

GET
/api/v1/ocp/users/{user_id}/documents

Path Parameters

user_id*string
Formatuuid

Query Parameters

q?|
document_kind?|
status?|
visibility_scope?|
attachment_state?string
Default"all"
Value in"all" | "attached" | "unattached"
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/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents"
{
  "hasNext": true,
  "items": [
    {
      "contentType": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "documentKind": "string",
      "fileSizeBytes": 0,
      "firstAttachedAt": "2019-08-24T14:15:22Z",
      "hasBeenAttached": true,
      "id": "string",
      "name": "string",
      "ownerUserEmail": "string",
      "ownerUserId": "string",
      "ownerUserName": "string",
      "pageCount": 0,
      "sheetCount": 0,
      "sheetNamesPreview": [
        "string"
      ],
      "status": "uploaded",
      "tenantId": "string",
      "tenantName": "string",
      "textCharCount": 0,
      "textTruncated": true,
      "updatedAt": "2019-08-24T14:15:22Z",
      "visibilityScope": "private"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get User Knowledge Graph

GET
/api/v1/ocp/users/{user_id}/knowledge-graph

Path Parameters

user_id*string
Formatuuid

Query Parameters

entity_type?|
q?|
limit?integer
Default200
Range1 <= value <= 500

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge-graph"
{
  "entities": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "entityType": "string",
      "id": "string",
      "mentionCount": 0,
      "name": "string",
      "organizationId": "string",
      "tenantId": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "entityCount": 0,
  "relationshipCount": 0,
  "relationships": [
    {
      "description": "string",
      "id": "string",
      "relationType": "string",
      "sourceEntityId": "string",
      "targetEntityId": "string",
      "weight": 0
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Backfill User Knowledge Graph

POST
/api/v1/ocp/users/{user_id}/knowledge-graph/backfill

Path Parameters

user_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge-graph/backfill"
{
  "entityCount": 0,
  "processed": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get User Entity Detail

GET
/api/v1/ocp/users/{user_id}/knowledge-graph/entities/{entity_id}

Path Parameters

user_id*string
Formatuuid
entity_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge-graph/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "connections": [
    {
      "direction": "outgoing",
      "entityType": "string",
      "id": "string",
      "name": "string",
      "relationDescription": "string",
      "relationType": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "entityType": "string",
  "id": "string",
  "mentionCount": 0,
  "name": "string",
  "organizationId": "string",
  "sourceMemories": [
    {
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "source": "string"
    }
  ],
  "tenantId": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List User Results

GET
/api/v1/ocp/users/{user_id}/results

Path Parameters

user_id*string
Formatuuid

Query Parameters

q?|
source_kind?|
data_kind?|
source_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/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/results"
{
  "hasNext": true,
  "items": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "latestVersion": {
        "actorType": "human",
        "changeReason": "string",
        "changedBy": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "dataKind": "tabular",
        "id": "string",
        "rendererKind": "ag_grid",
        "sourceSurface": "chat",
        "version": 0
      },
      "name": "string",
      "ownerUserId": "string",
      "sourceKind": "chat_promotion",
      "sourceMetadata": {},
      "tenantId": "string",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get User Result

GET
/api/v1/ocp/users/{user_id}/results/{artifact_id}

Path Parameters

user_id*string
Formatuuid
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/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/results/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "commentThreads": [
    {
      "anchorExcerpt": "string",
      "anchorKey": "string",
      "anchorKind": "table_cell",
      "anchorLabel": "string",
      "artifactVersionId": "c85f6cab-7ce1-42bc-a96e-3c6bbda8cfbe",
      "comments": [
        {
          "author": {
            "email": "string",
            "firstName": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "lastName": "string",
            "profilePictureUrl": "string"
          },
          "authorUserId": "ea75109d-c5c5-4407-b0ab-0da27cd41c18",
          "body": "string",
          "commentThreadId": "ead52d94-9a2c-40fa-af12-22dfad3c6296",
          "createdAt": "2019-08-24T14:15:22Z",
          "editedAt": "2019-08-24T14:15:22Z",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "updatedAt": "2019-08-24T14:15:22Z"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdByUser": {
        "email": "string",
        "firstName": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "lastName": "string",
        "profilePictureUrl": "string"
      },
      "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "isResolved": true,
      "resolvedAt": "2019-08-24T14:15:22Z",
      "resolvedByUser": {
        "email": "string",
        "firstName": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "lastName": "string",
        "profilePictureUrl": "string"
      },
      "resolvedByUserId": "65724e5a-550c-4e97-8411-a05f7a2e24df",
      "selectorPayload": {},
      "updatedAt": "2019-08-24T14:15:22Z",
      "viewportPayload": {}
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "isShared": false,
  "name": "string",
  "ownerUserId": "string",
  "resolvedVersion": {
    "actorType": "human",
    "changeReason": "string",
    "changedBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "data": {},
    "dataKind": "tabular",
    "id": "string",
    "refreshQuery": "string",
    "rendererConfig": {},
    "rendererKind": "ag_grid",
    "sourceSurface": "chat",
    "version": 0
  },
  "shareRecipients": [
    {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "profilePictureUrl": "string"
    }
  ],
  "shareStatus": "active",
  "sharedBy": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "profilePictureUrl": "string"
  },
  "sourceKind": "chat_promotion",
  "sourceMetadata": {},
  "tenantId": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "viewerAccess": "owner"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List User Result Versions

GET
/api/v1/ocp/users/{user_id}/results/{artifact_id}/versions

Path Parameters

user_id*string
Formatuuid
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/ocp/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/results/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions"
{
  "hasNext": true,
  "items": [
    {
      "actorType": "human",
      "changeReason": "string",
      "changedBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "dataKind": "tabular",
      "id": "string",
      "rendererKind": "ag_grid",
      "sourceSurface": "chat",
      "version": 0
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Observability

Previous Page

Organizations

Next Page