AnyFile API documentation

API keys and OAuth 2.0

Send either an AnyFile API key or an OAuth 2.0 access token in the Authorization header. OAuth tokens for REST integrations target the AnyFile API resource.

Authorization: Bearer YOUR_API_KEY

OAuth authorization-server metadata is available at /.well-known/oauth-authorization-server.

Use least-privilege scopes

API keys and OAuth use the same granular permissions. Grant only the scopes your integration needs. Uploading, organizing, renaming, and deleting owned files or folders requires files:write. Reading folders and downloads use files:read. Moving a file request requires requests:write.

Upload directly without proxying file bytes

AnyFile uses short-lived upload grants so large files transfer directly to private Blob storage. First prepare one or many uploads with file metadata. Add an owned folder ID to create the resulting files directly inside that folder.

POST https://www.useanyfile.com/api/v1/files
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "folderId": "FOLDER_ID",
  "files": [
    {
      "name": "proposal.pdf",
      "type": "application/pdf",
      "size": 482193
    }
  ]
}

Install @vercel/blob, then transfer each file using the returned pathname, handleUploadUrl, and clientPayload. Pass the client payload exactly as returned. It expires with the upload intent and should be treated like a presigned upload URL.

import { upload } from "@vercel/blob/client";

await upload(grant.pathname, file, {
  access: "private",
  contentType: grant.contentType,
  multipart: file.size > 5 * 1024 * 1024,
  handleUploadUrl: grant.handleUploadUrl,
  clientPayload: JSON.stringify(grant.clientPayload),
});

Finally, poll the returned statusUrl with the same bearer credential used to prepare the upload until the status iscomplete. The result contains the AnyFile file ID you can use with download, metadata, deletion, folder moves, or the existing share-link endpoint.

GET https://www.useanyfile.com/api/v1/files/uploads/UPLOAD_INTENT_ID
Authorization: Bearer YOUR_API_KEY

{
  "data": {
    "status": "complete",
    "result": { "id": "FILE_ID" }
  }
}

Organize files and request destinations

Folders are flat, user-owned containers. Files and file requests expose both folderId and compact folder metadata. Filter collection endpoints with folderId, or setfolderId: null on an update to move a resource back to root. Deleting a folder keeps its contents and moves them to root automatically.

POST https://www.useanyfile.com/api/v1/folders
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{ "name": "Client A" }

PATCH https://www.useanyfile.com/api/v1/files/FILE_ID
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{ "folderId": "FOLDER_ID" }

POST https://www.useanyfile.com/api/v1/requests
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "title": "Upload your documents",
  "folderId": "FOLDER_ID"
}

Cursor-based pagination

Collection endpoints use cursor pagination. Pass the returnednextCursorvalue as the next request'scursorparameter. A null next cursor means there are no more results.

{
  "data": [...],
  "pagination": {
    "nextCursor": "cursor_value"
  }
}

Structured error responses

API errors use a consistent object with a machine-readable code, human-readable message, and actionable hint. Handle 400, 401, 403, 404, 409, and 429 responses where applicable.

{
  "error": {
    "code": "...",
    "message": "...",
    "hint": "..."
  }
}