Filen Notes API
The notes API from Filen — 24 operation(s) for notes.
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-notes-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 Notes 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: Notes
paths:
/notes:
get:
tags:
- Notes
description: Fetch all notes
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 notes
x-summary-source: derived
operationId: getNotes
x-operation-id-source: derived
/notes/content:
post:
tags:
- Notes
description: Fetch note content
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:
preview:
type: string
example: string
content:
type: string
example: string
editedTimestamp:
type: string
example: number
editorId:
type: string
example: number
type:
type: string
example: text | md | rich | code | checklist
xml:
name: main
x-codegen-request-body-name: body
summary: Create notes content
x-summary-source: derived
operationId: postNotesContent
x-operation-id-source: derived
/notes/history:
post:
tags:
- Notes
description: Fetch note history
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: string
example: '{ id: number, preview: string, content: string, editedTimestamp: number, editorId: number, type: text | md | rich | code | checklist }[]'
xml:
name: main
x-codegen-request-body-name: body
summary: Create notes history
x-summary-source: derived
operationId: postNotesHistory
x-operation-id-source: derived
/notes/history/restore:
post:
tags:
- Notes
description: Restore a note from history
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
id:
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 notes history restore
x-summary-source: derived
operationId: postNotesHistoryRestore
x-operation-id-source: derived
/notes/create:
post:
tags:
- Notes
description: Create a note
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
title:
type: string
example: string
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 notes create
x-summary-source: derived
operationId: postNotesCreate
x-operation-id-source: derived
/notes/delete:
post:
tags:
- Notes
description: Delete a note
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 notes delete
x-summary-source: derived
operationId: postNotesDelete
x-operation-id-source: derived
/notes/trash:
post:
tags:
- Notes
description: Trash a note
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 notes trash
x-summary-source: derived
operationId: postNotesTrash
x-operation-id-source: derived
/notes/archive:
post:
tags:
- Notes
description: Archive a note
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 notes archive
x-summary-source: derived
operationId: postNotesArchive
x-operation-id-source: derived
/notes/restore:
post:
tags:
- Notes
description: Restore a note
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 notes restore
x-summary-source: derived
operationId: postNotesRestore
x-operation-id-source: derived
/notes/pinned:
post:
tags:
- Notes
description: Pin or unpin a note
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
pinned:
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 notes pinned
x-summary-source: derived
operationId: postNotesPinned
x-operation-id-source: derived
/notes/favorite:
post:
tags:
- Notes
description: Favorite or unfavorite a note
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
favorite:
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 notes favorite
x-summary-source: derived
operationId: postNotesFavorite
x-operation-id-source: derived
/notes/participants/add:
post:
tags:
- Notes
description: Add a participant to a note
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
permissionsWrite:
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 notes participants add
x-summary-source: derived
operationId: postNotesParticipantsAdd
x-operation-id-source: derived
/notes/participants/remove:
post:
tags:
- Notes
description: Remove a participant to a note
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 notes participants remove
x-summary-source: derived
operationId: postNotesParticipantsRemove
x-operation-id-source: derived
/notes/participants/permissions:
post:
tags:
- Notes
description: Change participant permissions
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
userId:
type: string
example: number
permissionsWrite:
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 notes participants permissions
x-summary-source: derived
operationId: postNotesParticipantsPermissions
x-operation-id-source: derived
/notes/type/change:
post:
tags:
- Notes
description: Change note type
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
type:
type: string
example: text | md | code | rich | checklist
preview:
type: string
example: string
content:
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 notes type change
x-summary-source: derived
operationId: postNotesTypeChange
x-operation-id-source: derived
/notes/title/edit:
post:
tags:
- Notes
description: Edit note title
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
title:
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 notes title edit
x-summary-source: derived
operationId: postNotesTitleEdit
x-operation-id-source: derived
/notes/content/edit:
post:
tags:
- Notes
description: Edit content of a note
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
preview:
type: string
example: string
content:
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 notes content edit
x-summary-source: derived
operationId: postNotesContentEdit
x-operation-id-source: derived
/notes/tags:
get:
tags:
- Notes
description: Fetch all tags
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: string, name: string, favorite: boolean, editedTimestamp: number, createdTimestamp: number }[]'
xml:
name: main
summary: Get notes tags
x-summary-source: derived
operationId: getNotesTags
x-operation-id-source: derived
/notes/tags/create:
post:
tags:
- Notes
description: Create a tag
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
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
data:
type: object
properties:
uuid:
type: string
example: string
xml:
name: main
x-codegen-request-body-name: body
summary: Create notes tags create
x-summary-source: derived
operationId: postNotesTagsCreate
x-operation-id-source: derived
/notes/tags/rename:
post:
tags:
- Notes
description: Rename a tag
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 notes tags rename
x-summary-source: derived
operationId: postNotesTagsRename
x-operation-id-source: derived
/notes/tags/delete:
post:
tags:
- Notes
description: Delete a tag
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 notes tags delete
x-summary-source: derived
operationId: postNotesTagsDelete
x-operation-id-source: derived
/notes/tags/favorite:
post:
tags:
- Notes
description: Favorite a tag
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
favorite:
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 notes tags favorite
x-summary-source: derived
operationId: postNotesTagsFavorite
x-operation-id-source: derived
/notes/tag:
post:
tags:
- Notes
description: Tag a note
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
tag:
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 notes tag
x-summary-source: derived
operationId: postNotesTag
x-operation-id-source: derived
/notes/untag:
post:
tags:
- Notes
description: Untag a note
requestBody:
description: Body JSON
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
example: uuidv4
tag:
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 notes untag
x-summary-source: derived
operationId: postNotesUntag
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