API Reference

Build on the Avirt API

A REST API over the same primitives the product uses — records, the Smart Inbox, payments, and verified-event webhooks. Authenticate with a workspace key.

Authentication

All requests use a bearer token scoped to your workspace. Send it in the Authorization header over HTTPS.

# Every request is authenticated with your workspace key
curl https://api.avirt.io/v1/records \
  -H "Authorization: Bearer sk_live_…"

Records

Create and query the records behind every customer journey — orders, bookings, invoices, applications.

GET/v1/recordsList records

POST/v1/recordsCreate a record

GET/v1/records/{id}Retrieve a record

PUT/v1/records/{id}Update a record

Smart Inbox

Read conversations and the intent the operating loop detected from them.

GET/v1/conversationsList conversations

GET/v1/conversations/{id}/intentDetected intent

POST/v1/messagesSend an approved reply

Payments

Create payment links and read verification state. Status is always explicit — never assumed.

POST/v1/payment_linksCreate a payment link

GET/v1/payments/{id}Get verification state

{
  "id": "pay_2847xK",
  "amount": "18500.00",
  "currency": "NGN",
  "state": "verified",
  "rail": "paystack"
}

Webhooks

Subscribe to verified events — a payment confirmed, a delivery logged, an approval recorded — and react in your own systems.

POSToutcome.verifiedA verified outcome occurred

POSTapproval.recordedA named human approved an action