Developer Resources

BigMind Desktop API Documentation

Integrate BigMind Desktop into your applications with our comprehensive REST API

Get Started View SDKs

Getting Started

1. Get API Credentials

Generate your API key and secret from the BigMind Desktop settings

2. Authenticate

Exchange your credentials for a JWT token to access the API

3. Make Requests

Use the token to make authenticated API requests

Base URL

https://api.bigmind.com/v1

All API requests should be made to this base URL

Authentication

BigMind uses JWT tokens for API authentication. First, exchange your API credentials for a token:

POST /auth/token
Content-Type: application/json

{
  "api_key": "YOUR_API_KEY",
  "secret": "YOUR_SECRET"
}

API Endpoints

POST

/api/v1/backup

Auth Required

Create a new backup job

GET

/api/v1/backup/:id

Auth Required

Get backup job status

POST

/api/v1/restore

Auth Required

Initiate a restore operation

GET

/api/v1/files

Auth Required

List backed up files

GET

/api/v1/status

Get system status

Code Examples

curl

# Authentication
curl -X POST https://api.bigmind.com/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"api_key": "YOUR_API_KEY", "secret": "YOUR_SECRET"}'

# Create Backup
curl -X POST https://api.bigmind.com/v1/backup \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "/path/to/files",
    "destination": "cloud",
    "options": {
      "compression": "zstd",
      "encryption": true,
      "deduplication": true
    }
  }'

Response Format

Success Response

{
  "success": true,
  "data": {
    "id": "backup_12345",
    "status": "completed",
    "files_backed_up": 1234,
    "size_bytes": 5678901234,
    "duration_seconds": 120
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-12-15T10:30:00Z"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_SOURCE",
    "message": "The specified source path does not exist",
    "details": {
      "path": "/invalid/path"
    }
  },
  "meta": {
    "request_id": "req_xyz789",
    "timestamp": "2024-12-15T10:31:00Z"
  }
}