Core API

REST API for AI Support

Integrate directly with the Relvios AI customer support inbox. Authenticate with Workspace API keys, manage tickets, power website widget handoff, and connect agent workflows.

Authentication

All API requests require a Workspace API key. You can generate these from the API settings page in your dashboard. Pass the key via the Authorization header:

Header: Authorization: Bearer YOUR_API_KEY

Base URL

Inbox API endpoints are prefixed with the following base URL:

https://api.relvios.com/api/workspaces/YOUR_WORKSPACE_ID/inbox

Endpoints

GET/threads

List all support tickets for your workspace. You can filter by source, status, priority, or search query.

Query Parameters

status (new, open, resolved, archived)
source (gmail, outlook, email, slack, discord, whatsapp, instagram, messenger, telegram, webhook)
priority (low, medium, high)

GET/threads/:threadId

Retrieve a single thread with its entire message history and internal notes.

POST/threads/:threadId/reply

Send a direct outbound reply to a thread.

Body (JSON)

{ "bodyText": "Your reply message goes here." }

GET/messages/new?since=ISO_DATE

Fetch new messages across all threads since a specific date/time. Useful for polling and listening for incoming messages.

POST/widget/:workspaceToken/ask

Ask the website widget AI agent for a knowledge-base answer before creating a ticket.

{ "query": "How do I update billing?", "history": [] }

POST/widget/:workspaceToken/message

Create a Relvios ticket from an unresolved website widget conversation. The transcript is preserved for human reply from the inbox.

POST/workspaces/:workspaceId/rules

Create plain-English agent actions and guardrails the AI can choose from in autonomous or HITL inboxes.

{ "name": "Book support call", "naturalLanguage": "When a customer needs a walkthrough, offer https://cal.com/acme/support. Require approval before account-changing commitments." }

GEThttps://api.relvios.com/api/workspaces/admin

List all workspaces (ID and name) where the authenticated user is an admin or owner. Note: This endpoint does not use the inbox base URL.