Skip to main content

API Reference — Python

Welcome to the complete API reference for the Nexla Python SDK. This documentation provides detailed information about all classes, methods, parameters, return types, and error handling.

Documentation Structure​

This API reference is automatically generated from the source code using Python introspection, ensuring it's always up-to-date with the latest SDK version.

Organization​

  • Client - Main NexlaClient class and initialization
  • Resources - All API resource classes (flows, sources, destinations, etc.)
  • Models - Pydantic data models for requests and responses
  • Exceptions - Error handling and exception classes
  • Authentication - Authentication mechanisms
  • HTTP Client - Low-level HTTP communication

Core Components​

NexlaClient​

The main entry point for all SDK operations. Provides access to all resource managers.

from nexla_sdk import NexlaClient

client = NexlaClient(service_key="your_key")

Resource Managers​

Each resource type has its own manager with standard CRUD operations:

  • client.flows - Data flow management
  • client.sources - Data source operations
  • client.destinations - Destination management
  • client.nexsets - Dataset operations
  • client.projects - Project management
  • client.users - User management
  • client.organizations - Organization operations
  • client.teams - Team management
  • client.notifications - Notification handling
  • client.metrics - Performance metrics
  • client.lookups - Lookup table operations

Standard Operations​

Most resource managers support these operations:

  • list() - Get all resources with optional filtering
  • get(id) - Get a specific resource by ID
  • create(data) - Create a new resource
  • update(id, data) - Update an existing resource
  • delete(id) - Delete a resource

How to Read the Documentation​

Method Signatures​

def create_flow(
    name: str,
    description: Optional[str] = None,
    project_id: Optional[str] = None
) -> FlowResponse

Parameter Documentation​

  • name (str, required) - The flow name
  • description (str, optional) - Flow description
  • project_id (str, optional) - Target project ID

Return Types​

All methods return typed Pydantic models with full validation.

Error Handling​

Methods may raise:

  • AuthenticationError - Invalid credentials
  • NexlaAPIError - API-specific errors
  • ValidationError - Invalid input data

Quick Navigation​

By Use Case​

By Category​

Model Reference​

Request Models​

Located in models/{resource}/requests.py:

  • Input validation and serialization
  • Required and optional field definitions
  • Type hints for IDE support

Response Models​

Located in models/{resource}/responses.py:

  • API response parsing and validation
  • Nested object handling
  • Computed properties and methods

Enumeration Types​

Located in models/{resource}/enums.py:

  • Valid values for choice fields
  • Status codes and types
  • Configuration options

Usage Tips​

  1. Start with the Client: Begin at NexlaClient for initialization patterns
  2. Follow the Models: Check request/response models for exact field requirements
  3. Handle Errors: Review Exceptions for proper error handling
  4. Check Examples: Many methods include usage examples in their documentation

Need Help?​

Auto-Generated Content

This documentation is automatically generated from the source code. For the most current information, always refer to the latest SDK version.