Documentation

Installation & Setup

Everything you need to start using the ZeroDrive API.

Requirements

  • A ZeroDrive account
  • Any HTTP client (cURL, Postman, or language-specific libraries)
  • Your API key

Creating Your Account

  1. Visit drive.futurixai.com
  2. Click Sign Up or sign in with Google/Microsoft
  3. Complete the registration process
  4. You'll receive 5GB of free storage

Generating API Keys

From the Web Dashboard

  1. Log into your ZeroDrive account
  2. Click on your profile picture > Settings
  3. Navigate to Developer > API Keys
  4. Click Create New API Key

API Key Configuration

When creating an API key, you'll configure:

SettingDescription
NameA descriptive name for the key (e.g., "Production App")
PermissionsSelect which endpoints the key can access
ExpirationOptional expiration date
Rate LimitOptional custom rate limit

Permission Categories

Choose permissions based on your use case:

File Management

  • GET /api/v1/files - List files
  • POST /api/v1/files/upload - Upload files
  • GET /api/v1/files/{fileId} - Get file details
  • PATCH /api/v1/files/{fileId} - Update file
  • DELETE /api/v1/files/{fileId} - Delete file
  • GET /api/v1/files/{fileId}/download - Download file
  • PUT /api/v1/files/{fileId}/move - Move file
  • POST /api/v1/files/{fileId}/share - Share file

Folder Management

  • GET /api/v1/folders - List folders
  • POST /api/v1/folders/create - Create folder
  • GET /api/v1/folders/{folderId} - Get folder details
  • PATCH /api/v1/folders/{folderId} - Update folder
  • DELETE /api/v1/folders/{folderId} - Delete folder
  • PUT /api/v1/folders/{folderId}/move - Move folder
  • POST /api/v1/folders/{folderId}/share - Share folder

Workspace Management

  • GET /api/v1/workspaces - List workspaces
  • POST /api/v1/workspaces - Create workspace
  • GET /api/v1/workspaces/{workspaceId} - Get workspace
  • PATCH /api/v1/workspaces/{workspaceId} - Update workspace
  • DELETE /api/v1/workspaces/{workspaceId} - Delete workspace
  • GET /api/v1/workspaces/{workspaceId}/members - List members
  • POST /api/v1/workspaces/{workspaceId}/members - Invite member
  • DELETE /api/v1/workspaces/{workspaceId}/members/{memberId} - Remove member

Trash Management

  • GET /api/v1/trash - List trashed items
  • POST /api/v1/trash/restore - Restore items
  • DELETE /api/v1/trash/empty - Empty trash

API Key Format

API keys follow this format:

  • zd_ - ZeroDrive prefix
  • live_ or test_ - Environment indicator
  • xxx... - 32 character random string

Setting Up Your Development Environment

Environment Variables

Store your API key securely as an environment variable:

JavaScript/TypeScript Setup

Python Setup

Go Setup

Testing Your Setup

Run this quick test to verify everything is configured correctly:

Expected response:

Security Best Practices

  1. Never expose API keys in client-side code

    • Use server-side proxies for browser applications
  2. Use environment variables

    • Never hardcode API keys in source code
  3. Rotate keys regularly

    • Create new keys periodically and revoke old ones
  4. Use minimal permissions

    • Only grant the permissions your application needs
  5. Set expiration dates

    • For temporary integrations, set keys to expire
  6. Monitor usage

    • Check the usage logs in Developer Settings

Managing API Keys

List All Keys

Revoke a Key

Check Usage Statistics

Troubleshooting

"Unauthorized" (401) Error

  • Verify your API key is correct
  • Check that the key hasn't expired
  • Ensure the Authorization header format is Bearer YOUR_KEY

"Forbidden" (403) Error

  • The API key doesn't have permission for this endpoint
  • Update the key's permissions in Developer Settings

"Rate Limited" (429) Error

  • You've exceeded the rate limit
  • Wait before making more requests
  • Consider implementing exponential backoff