Filen Chat API
The chat API from Filen — 20 operation(s) for chat.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/filen:filen-chat-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Filen Chat API
description: 'The Filen API is used by Filen clients for uploading and downloading files, managing files and directories, sharing items, accessing notes and contacts, having chat conversations, managing user-specific settings, and more.
### API hosts
The Filen API is located at `gateway.filen.io`.
For file transfers, there''s `ingest.filen.io` and `egest.filen.io`. `ingest.filen.io` is used for uploads while `egest.filen.io` is used for downloads.
### API responses
All API responses follow the scheme (TypeScript type definition):
```ts
{
status: boolean, // indicates whether the request was successful
message: string, // additional information
code: string, // a status code
data: any? // optionally, response data
}
```
### Internal endpoints
There are a number of internal endpoints whose specifics are not documented here.
If you need them, you can infer their definitions and usage from the TypeScript SDK''s API wrapper.'
version: v3
servers:
- url: https://gateway.filen.io/v3
tags:
- name: Chat
paths:
/chat/send:
post:
tags:
- Chat
description: Send a chat message
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
conversation:
type: string
example: uuidv4
uuid:
type: string
example: uuidv4
message:
type: string
example: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat send
x-summary-source: derived
operationId: postChatSend
x-operation-id-source: derived
/chat/mute:
post:
tags:
- Chat
description: Mute/unmute a chat
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
mute:
type: string
example: boolean
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat mute
x-summary-source: derived
operationId: postChatMute
x-operation-id-source: derived
/chat/edit:
post:
tags:
- Chat
description: Edit a chat message
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
conversation:
type: string
example: uuidv4
uuid:
type: string
example: uuidv4
message:
type: string
example: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat edit
x-summary-source: derived
operationId: postChatEdit
x-operation-id-source: derived
/chat/message/embed/disable:
post:
tags:
- Chat
description: Disable message embed
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat message embed disable
x-summary-source: derived
operationId: postChatMessageEmbedDisable
x-operation-id-source: derived
/chat/conversations/delete:
post:
tags:
- Chat
description: Delete a conversation
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations delete
x-summary-source: derived
operationId: postChatConversationsDelete
x-operation-id-source: derived
/chat/conversations/leave:
post:
tags:
- Chat
description: Leave a conversation
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations leave
x-summary-source: derived
operationId: postChatConversationsLeave
x-operation-id-source: derived
/chat/messages:
post:
tags:
- Chat
description: Fetch chat messages
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
to:
type: string
example: string
timestamp:
type: string
example: number
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
data:
type: string
example: array
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat messages
x-summary-source: derived
operationId: postChatMessages
x-operation-id-source: derived
/chat/delete:
post:
tags:
- Chat
description: Delete a chat message
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat delete
x-summary-source: derived
operationId: postChatDelete
x-operation-id-source: derived
/chat/typing:
post:
tags:
- Chat
description: Send typing events
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
to:
type: string
example: string
type:
type: string
example: up | down
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat typing
x-summary-source: derived
operationId: postChatTyping
x-operation-id-source: derived
/chat/conversations:
get:
tags:
- Chat
description: Fetch conversations
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
data:
type: string
example: array
xml:
name: main
summary: Get chat conversations
x-summary-source: derived
operationId: getChatConversations
x-operation-id-source: derived
/chat/unread:
get:
tags:
- Chat
description: Fetch count of unread chat messages
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
data:
type: object
properties:
unread:
type: string
example: number
xml:
name: main
summary: Get chat unread
x-summary-source: derived
operationId: getChatUnread
x-operation-id-source: derived
/chat/conversations/unread:
post:
tags:
- Chat
description: Fetch count of unread chat messages
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
data:
type: object
properties:
unread:
type: string
example: number
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations unread
x-summary-source: derived
operationId: postChatConversationsUnread
x-operation-id-source: derived
/chat/read:
post:
tags:
- Chat
description: Delete unread chat notifications
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
summary: Create chat read
x-summary-source: derived
operationId: postChatRead
x-operation-id-source: derived
/chat/conversations/read:
post:
tags:
- Chat
description: Delete unread chat notifications
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations read
x-summary-source: derived
operationId: postChatConversationsRead
x-operation-id-source: derived
/chat/conversations/online:
post:
tags:
- Chat
description: Fetch online users in conversation
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
conversation:
type: string
example: uuidv4
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
data:
type: string
example: '{ userId: number; lastActive: number; appearOffline: boolean }[]'
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations online
x-summary-source: derived
operationId: postChatConversationsOnline
x-operation-id-source: derived
/chat/conversations/create:
post:
tags:
- Chat
description: Create a conversation
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
metadata:
type: string
example: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations create
x-summary-source: derived
operationId: postChatConversationsCreate
x-operation-id-source: derived
/chat/conversations/name/edit:
post:
tags:
- Chat
description: Edit conversation name
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
name:
type: string
example: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations name edit
x-summary-source: derived
operationId: postChatConversationsNameEdit
x-operation-id-source: derived
/chat/conversations/participants/add:
post:
tags:
- Chat
description: Add a participant to a chat conversation
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
contactUUID:
type: string
example: uuidv4
metadata:
type: string
example: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations participants add
x-summary-source: derived
operationId: postChatConversationsParticipantsAdd
x-operation-id-source: derived
/chat/conversations/participants/remove:
post:
tags:
- Chat
description: Remove a participant from a chat conversation
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
userId:
type: string
example: number
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat conversations participants remove
x-summary-source: derived
operationId: postChatConversationsParticipantsRemove
x-operation-id-source: derived
/chat/lastFocus:
get:
tags:
- Chat
description: Retrieve lastFocus timestamp of conversations
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
data:
type: string
example: '{ uuid: uuidv4, lastFocus: number }[]'
xml:
name: main
summary: Get chat last focus
x-summary-source: derived
operationId: getChatLastFocus
x-operation-id-source: derived
post:
tags:
- Chat
description: Update lastFocus timestamp of conversations
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
conversations:
type: string
example: '{ uuid: uuidv4, lastFocus: number }[]'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: boolean
message:
type: string
example: string
code:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create chat last focus
x-summary-source: derived
operationId: postChatLastFocus
x-operation-id-source: derived
components:
securitySchemes:
api_key:
type: apiKey
name: API Key
in: header
externalDocs:
description: Get general information about usage of the Filen API at docs.filen.io
url: https://docs.filen.io/docs/api