VirtuousAI
Reference

Inbound

GET
/api/v1/inbound/identity-links

Query Parameters

limit?integer
Default100
Range1 <= value <= 200
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/inbound/identity-links"
{
  "items": [
    {
      "agentSpecId": "string",
      "channel": "slack",
      "createdAt": "2019-08-24T14:15:22Z",
      "externalIdentity": "string",
      "id": "string",
      "metadata": {},
      "tenantId": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userId": "string",
      "verified": true
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
POST
/api/v1/inbound/identity-links

Header Parameters

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

Request Body

application/json

agentSpecId?|
channel*string
Value in"slack" | "email" | "sms" | "webhook"
externalIdentity*string
userId*string
verified?boolean
Defaultfalse

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/inbound/identity-links" \  -H "Content-Type: application/json" \  -d '{    "channel": "slack",    "externalIdentity": "string",    "userId": "string"  }'
{
  "agentSpecId": "string",
  "channel": "slack",
  "createdAt": "2019-08-24T14:15:22Z",
  "externalIdentity": "string",
  "id": "string",
  "metadata": {},
  "tenantId": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": "string",
  "verified": true
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
DELETE
/api/v1/inbound/identity-links/{link_id}

Path Parameters

link_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X DELETE "https://loading/api/v1/inbound/identity-links/497f6eca-6276-4993-bfeb-53cbbbba6f08"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
POST
/api/v1/inbound/identity-links/{link_id}/verify

Path Parameters

link_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/inbound/identity-links/497f6eca-6276-4993-bfeb-53cbbbba6f08/verify"
{
  "agentSpecId": "string",
  "channel": "slack",
  "createdAt": "2019-08-24T14:15:22Z",
  "externalIdentity": "string",
  "id": "string",
  "metadata": {},
  "tenantId": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": "string",
  "verified": true
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Messages

GET
/api/v1/inbound/messages

Query Parameters

status?|
limit?integer
Default100
Range1 <= value <= 200
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/inbound/messages"
{
  "items": [
    {
      "attachments": [
        {}
      ],
      "channel": "slack",
      "channelMessageId": "string",
      "channelMetadata": {},
      "channelThreadId": "string",
      "chatThreadId": "string",
      "chatTurnId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "error": {},
      "externalIdentity": "string",
      "id": "string",
      "idempotencyKey": "string",
      "routeTarget": "agent",
      "routeTargetId": "string",
      "status": "received",
      "tenantId": "string",
      "text": "string",
      "trustLevel": "verified",
      "updatedAt": "2019-08-24T14:15:22Z",
      "userId": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Message

GET
/api/v1/inbound/messages/{message_id}

Path Parameters

message_id*string
Formatuuid

Header Parameters

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

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/inbound/messages/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "attachments": [
    {}
  ],
  "channel": "slack",
  "channelMessageId": "string",
  "channelMetadata": {},
  "channelThreadId": "string",
  "chatThreadId": "string",
  "chatTurnId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "error": {},
  "externalIdentity": "string",
  "id": "string",
  "idempotencyKey": "string",
  "routeTarget": "agent",
  "routeTargetId": "string",
  "status": "received",
  "tenantId": "string",
  "text": "string",
  "trustLevel": "verified",
  "updatedAt": "2019-08-24T14:15:22Z",
  "userId": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Inbound webhooks

Previous Page

Platinum

Next Page