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

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 Directories 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: Directories
paths:
  /dir:
    post:
      tags:
      - Directories
      summary: Get directory info
      description: Returns information about a directory.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                  description: the desired directory's UUID
                  example: (directory UUID)
        required: true
      security:
      - api_key: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response'
                - type: object
                  properties:
                    uuid:
                      type: string
                      description: the directory's UUID
                      example: (directory UUID)
                    nameEncrypted:
                      type: string
                      description: the directory's name (metadata-encrypted)
                      example: (directory name, metadata-encrypted)
                    nameHashed:
                      type: string
                      description: the hex-encoded SHA-512 hash of the directory's name
                      example: (SHA-512 hash of directory name, hex-encoded)
                    parent:
                      type: string
                      description: the parente directory's UUID
                      example: (parent directory UUID)
                    trash:
                      type: boolean
                      description: whether this directory is in trash
                      example: (whether the directory is trashed)
                    favorited:
                      type: boolean
                      description: whether this directory is favorited
                      example: (whether the directory is favorited)
                    color:
                      type: string
                      description: the directory's assigned color (as hex code `#000000` or valid CSS value), or `null` if none is set
                      example: (directory color, or null)
      operationId: postDir
      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