Getting Started

This page will help you set up your first integration, including how to authenticate, make requests, and understand the basics of working with Mediaflow’s RESTful endpoints.

Full documentation is available in our Postman collection: View Postman Docs

Authentication

All API requests require an access token.

See the Authentication Guide for details on how to authenticate using client_id and client_secret via OAuth2.

Common API Endpoints

List Folders

Retrieve the folder structure your integration has access to:

GET https://api.mediaflow.com/1/foldertree?fields=all

This returns all folders, including parent-child relationships and depth, useful for building a folder tree UI.

List Files in a Folder

Fetch files in a specific folder:

GET https://api.mediaflow.com/1/folder/{id}/files?fields=id,name,filename,...

Use the type=any&processed=true parameters to filter by processed files of any type.

Search Files

Search for files by a text query:

GET https://api.mediaflow.com/1/search/file?query={text}&fields=id,name,filename,...

Returns matching files of any media type (images, videos, etc.).

Download Files

Download the original or a formatted version of a file:

GET https://api.mediaflow.com/1/file/{id}/download/0

Use 0 to download the original.

To request a custom format, use -1 and pass crop/scaling parameters like x1, y1, w, h, etc.

Upload Files

File upload is a two-step process:

1. Request upload URL

POST https://api.mediaflow.com/1/file

Send metadata (filename, size, target folder).

2. Upload file to URL

Use the uploadURL returned in step 1 to POST the file body.

You can then optionally update metadata via:

PUT https://api.mediaflow.com/1/file/{id}

Ready to get started?

Check the complete endpoint list, response formats, and field options in our Postman collection.