Filen Shared API
The Shared API from Filen — 8 operation(s) for shared.
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-shared-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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 Shared 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.
If you need a more in depth documentation, please refer to our generated OpenAPI specs.
### 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 schema (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
}
```
### Format of timestamps
Some endpoints (where noted) provide timestamps that are *either in milliseconds or in seconds*. To handle them correctly, a calculation like this might be helpful: A timestamp is in milliseconds if `Math.abs(millisecondsNow - timestamp) for a full description of the realtime events API, see the SDK''s implementations
- `/versions` (get current client versions)
- `/mobile/offline/files` (get offline files info)'
version: v3
servers:
- url: https://gateway.filen.io/v3
tags:
- name: Shared
paths:
/shared/in:
post:
summary: Get shared in items
tags:
- Shared
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:
uploads:
type: string
example: array
folders:
type: string
example: array
xml:
name: main
x-codegen-request-body-name: body
operationId: postSharedIn
x-operation-id-source: derived
/shared/out:
post:
summary: Get shared out items
tags:
- Shared
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
receiverId:
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: object
properties:
uploads:
type: string
example: array
folders:
type: string
example: array
xml:
name: main
x-codegen-request-body-name: body
operationId: postSharedOut
x-operation-id-source: derived
/dir/download/shared:
post:
summary: Get directory tree of shared folder
tags:
- Shared
description: Retrieve complete folder tree of a shared folder (flattened)
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:
files:
type: string
example: array
folders:
type: string
example: array
xml:
name: main
x-codegen-request-body-name: body
operationId: postDirDownloadShared
x-operation-id-source: derived
/item/share:
post:
summary: Create share out
tags:
- Shared
description: Share an item to a user
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
parent:
type: string
example: string
email:
type: string
example: string
type:
type: string
example: file | folder
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
operationId: postItemShare
x-operation-id-source: derived
/item/shared:
post:
summary: Check if item is shared
tags:
- Shared
description: Check if an item is shared
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:
sharing:
type: string
example: boolean
users:
type: string
example: '{ email: string, publicKey: string, id: number }[]'
xml:
name: main
x-codegen-request-body-name: body
operationId: postItemShared
x-operation-id-source: derived
/item/shared/rename:
post:
summary: Rename shared item
tags:
- Shared
description: Rename a shared item
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
receiverId:
type: string
example: number
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
operationId: postItemSharedRename
x-operation-id-source: derived
/item/shared/in/remove:
post:
summary: Remove shared in item
tags:
- Shared
description: Remove an item that is shared with your account
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
operationId: postItemSharedInRemove
x-operation-id-source: derived
/item/shared/out/remove:
post:
summary: Remove shared out item
tags:
- Shared
description: Remove an item that is shared with another user
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
receiverId:
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
operationId: postItemSharedOutRemove
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