Skip to main content

API reference

All operations: Chat

Every Chat operation: channels, conversations, messages and chat contacts.

Generated from the API's OpenAPI spec, so it always matches what the API serves.

Chat channels, conversations and their messages, and chat contacts.

Generated from the API's OpenAPI spec: 12 operations. Request and response bodies for each are in the API reference. The MCP tool column names the tool in Finn's MCP server that makes the same call.

Chat

EndpointWhat it doesScopeMCP toolNotes
GET /chat/channelsList chat channelschat:readsend_message_to_contact
GET /chat/conversationsList conversationschat:readlist_conversationscursor pages
POST /chat/conversationsStart a conversationchat:writesend_message_to_contactIdempotency-Key; can be held: 202 pending_approval
GET /chat/conversations/{id}Get a conversationchat:readread_conversation
GET /chat/conversations/{id}/messagesList messageschat:readread_conversationcursor pages
POST /chat/conversations/{id}/messagesSend a messagechat:writesend_message_to_contactIdempotency-Key; can be held: 202 pending_approval
GET /chat/contactsList chat contactschat:readlist_chat_contactscursor pages
GET /chat/contacts/{id}Get a chat contactchat:readget_chat_contact
PATCH /chat/contacts/{id}Update a chat contactchat:writeupdate_chat_contactcan be held: 202 pending_approval
GET /chat/agents/{agent_id}Get a chat agent's settingschat:readchat_get_agent
PATCH /chat/agents/{agent_id}Change a chat agent's settingschat:writechat_update_agentIdempotency-Key; can be held: 202 pending_approval
POST /chat/agents/{agent_id}/test_turnTest a chat agentchat:writechat_test_agentIdempotency-Key