Back to explore

storage

Files

Credits: 0.000001

Delete

POST /v1/file/Delete

Delete a file by project name/path

Request

pathstring

Path to the file

projectstring

The project name

Response

{}

Request

Response

{}

Credits: 0.000001

List

POST /v1/file/List

List files by their project and optionally a path.

Request

pathstring

Defaults to '/', ie. lists all files in a project. Supply path to a folder if you want to list files inside that folder eg. '/docs'

projectstring

Project, required for listing.

Response

filesarray

Request

Response

{
    "files": [
        {
            "project": "examples",
            "name": "file.txt",
            "path": "/document/text-files/file.txt"
        }
    ]
}

Credits: 0.000001

Read

POST /v1/file/Read

Read a file by path

Request

pathstring

Path to the file

projectstring

Project name

Response

fileobject

Returns the file

Request

Response

{
    "files": [
        {
            "project": "examples",
            "content": "file content example",
            "path": "/document/text-files/file.txt"
        }
    ]
}

Credits: 0.000001

Save

POST /v1/file/Save

Save a file

Request

fileobject

The file to save

publicboolean

Make the file public: true or false

Response

urlstring

The permalink for the file if made public

Request

Response

{}