file.io API
 1.0.0 
OAS3

file.io API

Servers

default

Creates a file

Parameters

No parameters

Request body

file
string($binary)
expires
maxDownloads
integer
autoDelete
boolean

Responses

CodeDescription
200

A FileDetails object

Media type
Controls Accept header.
{
  "success": true,
  "status": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": "string",
  "name": "string",
  "link": "string",
  "expires": "2025-01-06T15:37:03.357Z",
  "expiry": "string",
  "downloads": 0,
  "maxDownloads": 0,
  "autoDelete": true,
  "size": 0,
  "mimeType": "string",
  "created": "2025-01-06T15:37:03.357Z",
  "modified": "2025-01-06T15:37:03.357Z"
}

Gets list of files

Parameters

NameDescription
search
string
(query)
sort
string
(query)
offset
integer
(query)
limit
integer
(query)

Responses

CodeDescription
200

An array of FileDetails objects

Media type
Controls Accept header.
{
  "count": 0,
  "files": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "key": "string",
      "name": "string",
      "link": "string",
      "expires": "2025-01-06T15:37:03.359Z",
      "expiry": "string",
      "downloads": 0,
      "maxDownloads": 0,
      "autoDelete": true,
      "size": 0,
      "mimeType": "string",
      "created": "2025-01-06T15:37:03.359Z",
      "modified": "2025-01-06T15:37:03.359Z"
    }
  ]
}

Downloads the file identified by {key}

Parameters

NameDescription
key *
string
(path)

Responses

CodeDescription
200

File data

Media type
Controls Accept header.
string
302

Redirect to https://www.file.io/download/{key}

Updates the file identified by {key}. Any parameters not provided are reset to defaults.

Parameters

NameDescription
key *
string
(path)

Request body

file
string($binary)
expires
maxDownloads
integer
autoDelete
boolean

Responses

CodeDescription
200

A FileDetails object

Media type
Controls Accept header.
{
  "success": true,
  "status": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": "string",
  "name": "string",
  "link": "string",
  "expires": "2025-01-06T15:37:03.361Z",
  "expiry": "string",
  "downloads": 0,
  "maxDownloads": 0,
  "autoDelete": true,
  "size": 0,
  "mimeType": "string",
  "created": "2025-01-06T15:37:03.361Z",
  "modified": "2025-01-06T15:37:03.361Z"
}

Updates the file identified by {key}. For any parameters not provided in request, existing values are retained.

Parameters

NameDescription
key *
string
(path)

Request body

file
string($binary)
expires
maxDownloads
integer
autoDelete
boolean

Responses

CodeDescription
200

A FileDetails object

Media type
Controls Accept header.
{
  "success": true,
  "status": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": "string",
  "name": "string",
  "link": "string",
  "expires": "2025-01-06T15:37:03.363Z",
  "expiry": "string",
  "downloads": 0,
  "maxDownloads": 0,
  "autoDelete": true,
  "size": 0,
  "mimeType": "string",
  "created": "2025-01-06T15:37:03.363Z",
  "modified": "2025-01-06T15:37:03.363Z"
}

Deletes the file identified by

Parameters

NameDescription
key *
string
(path)

Responses

CodeDescription
200

Response

Media type
Controls Accept header.
{
  "success": true,
  "status": 0
}

Gets plan/account details for authenticated user

Parameters

No parameters

Responses

CodeDescription
200

Plan/account details

Media type
Controls Accept header.
{
  "success": true,
  "status": 0,
  "planId": 0,
  "maxUploadBytes": 0,
  "maxStorageBytes": 0,
  "usedStorageBytes": 0,
  "rateLimit": 0
}

{
success
status
}
string
pattern: ^[1-9]\d*[y|Q|M|w|d|h|m|s]$
{
id
key
name
link
expires
expiry
downloads
maxDownloads
autoDelete
size
mimeType
created
modified
}
{
success
status
id
key
name
link
expires
expiry
downloads
maxDownloads
autoDelete
size
mimeType
created
modified
}