👩‍💻API Documentation

Complete API reference for integrating Operator Uplift with your applications.

Authentication

All API requests require authentication using API keys.

const headers = {
  'Authorization': 'Bearer YOUR_API_KEY',
  'Content-Type': 'application/json'
};

Endpoints

Documents

  • GET /api/v1/documents - List all documents

  • POST /api/v1/documents - Create new document

  • GET /api/v1/documents/{id} - Get document by ID

  • PUT /api/v1/documents/{id} - Update document

  • DELETE /api/v1/documents/{id} - Delete document

Users

  • GET /api/v1/users - List users

  • POST /api/v1/users - Create user

  • GET /api/v1/users/{id} - Get user details

Workflows

  • GET /api/v1/workflows - List workflows

  • POST /api/v1/workflows - Create workflow

  • PUT /api/v1/workflows/{id} - Update workflow

Rate Limiting

API requests are limited to 1000 requests per hour per API key.

Webhooks

Configure webhooks to receive real-time notifications about events.

Last updated

Was this helpful?