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"
{
  "agentSpecId": "string",
  "conversationCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByEmail": "string",
  "description": "string",
  "frontmatter": {},
  "lifecycleStatus": "active",
  "markdown": "string",
  "name": "string",
  "tenantId": "string",
  "tenantName": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userCount": 0
}
{
  "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": [
    {
      "columnNames": [],
      "columnTypes": [],
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "lastReadAt": "2019-08-24T14:15:22Z",
      "lastWriteAt": "2019-08-24T14:15:22Z",
      "rowCount": 0,
      "schemaContract": "evolve",
      "schemaStable": false,
      "schemaStableSince": "2019-08-24T14:15:22Z",
      "schemaVersion": 1,
      "sourceType": "string",
      "tableName": "string",
      "tenantSchema": "string"
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}
{
  "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?|
availability?string
Default"all"
Value in"all" | "available" | "uploaded_only"
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": [
    {
      "availableAt": "2019-08-24T14:15:22Z",
      "contentType": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "documentKind": "string",
      "fileSizeBytes": 0,
      "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"
    }
  ],
  "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"
{
  "availableAt": "2019-08-24T14:15:22Z",
  "contentType": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "documentKind": "string",
  "fileSizeBytes": 0,
  "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"
}
{
  "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",
      "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 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 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 Ocp Tasks

GET
/api/v1/ocp/tasks

Query Parameters

q?|
tenant_id?|
lifecycle?|
category?|
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 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"
    }
  ]
}

List Tools

GET
/api/v1/ocp/tools

Query Parameters

q?|
tenant_id?|
status?|
tool_type?|
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": [
    {
      "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": [
    {
      "description": "string",
      "inputSchema": {},
      "method": "string",
      "name": "string",
      "path": "string"
    }
  ]
}
{
  "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",
      "organizationId": "string",
      "organizationName": "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?|
availability?string
Default"all"
Value in"all" | "available" | "uploaded_only"
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": [
    {
      "availableAt": "2019-08-24T14:15:22Z",
      "contentType": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "documentKind": "string",
      "fileSizeBytes": 0,
      "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"
    }
  ],
  "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