Skip to main content

API reference overview

Use the API to send user messages, manage sessions, and control conversations.

Base URL

https://channels.moveo.ai

Required headers

All endpoints require the following headers:

HeaderValueRequired
Authorizationapikey YOUR_API_KEYYes
Content-Typeapplication/jsonYes

See setup guide for details on API key authentication and IP allowlisting.

Endpoints

MethodEndpointDescription
POST/v1/custom/:integration_id/sessionsCreate a new session.
PATCH/v1/custom/:integration_id/sessions/:session_id/contextUpdate session context.
POST/v1/custom/:integration_id/sessions/:session_id/closeClose a session.
POST/v1/custom/:integration_id/sessions/:session_id/messagesSend a user message.
POST/v1/custom/:integration_id/sessions/:session_id/messages/agentSend an agent message.
POST/v1/custom/:integration_id/sessions/:session_id/messages/readMark messages as read.
POST/v1/custom/:integration_id/sessions/:session_id/messages/deliveredMark messages as delivered.
POST/v1/custom/:integration_id/sessions/:session_id/conversation/closeClose (resolve) a conversation.
POST/v1/custom/:integration_id/sessions/:session_id/conversation/reopenReopen a resolved conversation.
POST/v1/custom/:integration_id/sessions/:session_id/handoverHand over to a human agent.
POST/v1/custom/:integration_id/sessions/:session_id/files/upload-urlGet a presigned file upload URL.
POST/v1/custom/:integration_id/sessions/:session_id/files/download-urlGet a presigned file download URL.