Filen Item API

The item API from Filen — 8 operation(s) for item.

Operations 8

POST /item/favorite Create item favorite #
POST /item/share Create item share #
POST /item/shared/rename Create item shared rename #
POST /item/linked/rename Create item linked rename #
POST /item/linked Create item linked #
POST /item/shared Create item shared #
POST /item/shared/in/remove Create item shared in remove #
POST /item/shared/out/remove Create item shared out remove #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/filen:filen-item-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

filen-item-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Filen Item 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: Item
paths:
  /item/favorite:
    post:
      tags:
      - Item
      description: Change item favorite status
      requestBody:
        description: Body JSON
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                  example: uuidv4
                type:
                  type: string
                  example: file | folder
                value:
                  type: string
                  example: 0 | 1
        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:
                      uuid:
                        type: string
                        example: uuidv4
                      type:
                        type: string
                        example: file | folder
                      value:
                        type: string
                        example: 0 | 1
                xml:
                  name: main
      x-codegen-request-body-name: body
      summary: Create item favorite
      x-summary-source: derived
      operationId: postItemFavorite
      x-operation-id-source: derived
  /item/share:
    post:
      tags:
      - Item
      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
      summary: Create item share
      x-summary-source: derived
      operationId: postItemShare
      x-operation-id-source: derived
  /item/shared/rename:
    post:
      tags:
      - Item
      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
      summary: Create item shared rename
      x-summary-source: derived
      operationId: postItemSharedRename
      x-operation-id-source: derived
  /item/linked/rename:
    post:
      tags:
      - Item
      description: Rename a public linked folder item
      requestBody:
        description: Body JSON
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                  example: uuidv4
                linkUUID:
                  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 item linked rename
      x-summary-source: derived
      operationId: postItemLinkedRename
      x-operation-id-source: derived
  /item/linked:
    post:
      tags:
      - Item
      description: Check if an item is in a public link
      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:
                      link:
                        type: string
                        example: boolean
                      links:
                        type: string
                        example: '{ linkUUID: uuidv4, linkKey: string }[]'
                xml:
                  name: main
      x-codegen-request-body-name: body
      summary: Create item linked
      x-summary-source: derived
      operationId: postItemLinked
      x-operation-id-source: derived
  /item/shared:
    post:
      tags:
      - Item
      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
      summary: Create item shared
      x-summary-source: derived
      operationId: postItemShared
      x-operation-id-source: derived
  /item/shared/in/remove:
    post:
      tags:
      - Item
      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
      summary: Create item shared in remove
      x-summary-source: derived
      operationId: postItemSharedInRemove
      x-operation-id-source: derived
  /item/shared/out/remove:
    post:
      tags:
      - Item
      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
      summary: Create item shared out remove
      x-summary-source: derived
      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