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-items-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Filen Items 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: Items
paths:
  /user/baseFolder:
    get:
      tags:
      - Items
      summary: Get user base folder
      description: Returns the UUID of the user's root directory.
      security:
      - api_key: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response'
                - type: object
                  properties:
                    data:
                      type: object
                      properties:
                        uuid:
                          type: string
                          description: the user's root directory's UUID
      operationId: getUserBaseFolder
      x-operation-id-source: derived
  /trash/empty:
    post:
      tags:
      - Items
      summary: Empty trash
      description: Permanently deletes all trash items.
      security:
      - api_key: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
      operationId: postTrashEmpty
      x-operation-id-source: derived
  /item/favorite:
    post:
      summary: Change item favorited
      tags:
      - Items
      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
      operationId: postItemFavorite
      x-operation-id-source: derived
components:
  schemas:
    response:
      type: object
      properties:
        status:
          type: boolean
        message:
          type: string
        code:
          type: string
  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