Contact Support

    Changelog

    Back
    📦 NEW: API v1

    📦 NEW: API v1

    Nov 20 20243 min read

    We're excited to announce the release of Langbase API v1! This version includes new and simplified endpoints, enabling users to programmatically interact with Langbase pipes, memory, and documents.

    The beta version of the API has been deprecated and will remain supported until February 28, 2025. We strongly encourage all users to migrate to the new v1 API.

    Key Changes

    • Deprecated /beta/generate and /beta/chat endpoints in favour of run pipe endpoint
    • Unified pipe, memory, and document endpoints
    • Improved create pipe configuration
    • Added document delete endpoint

    Migrate to API v1

    Please follow the Migration Guide to update your existing applications to API v1.

    Pipe Endpoints

    Run pipe

    • Old: /beta/pipes/run
    • New: /v1/pipes/run

    Changes:

    • Added support for image URL in user messages

    Create pipe

    • Old: /beta/org/{org}/pipes and /beta/user/pipes
    • New: /v1/pipes

    Changes:

    • Unified org and user endpoints into a single endpoint
    • Flattened config structure (removed nested configuration)
    • Added upsert parameter to update existing pipe
    • Simplified model configuration with model parameter (format: provider:model_id)
    • Improved message structure with clearer type definitions

    List pipes

    • Old: /beta/org/{org}/pipes and /beta/user/pipes
    • New: /v1/pipes

    Changes:

    • Unified endpoints into single GET endpoint
    • Enhanced response format with more detailed pipe information
    • Added model and configuration details in response
    • Improved response format

    Update pipe

    • Old: /beta/pipes/{owner}/{pipe}
    • New: /v1/pipes/{pipeName}

    Changes:

    • Simplified path parameters
    • Removed owner from path

    Memory Endpoints

    Create memory

    • Old: /beta/org/{org}/memorysets and /beta/user/memorysets
    • New: /v1/memory

    Changes:

    • Unified creation endpoint
    • Simplified request parameters

    List memory

    • Old: /beta/org/{org}/memorysets and /beta/user/memorysets
    • New: /v1/memory

    Changes:

    • Unified list endpoint
    • Added more memory details in response
    • Improved response format

    Delete memory

    • Old: /beta/memorysets/{ownerLogin}/{memoryName}
    • New: /v1/memory/{memoryName}

    Changes:

    • Simplified path structure
    • Removed owner parameter

    Retrieve from memory

    • Old: /beta/memory/retrieve and /beta/memorysets/{ownerLogin}/{memoryName}/retrieve
    • New: /v1/memory/retrieve

    Changes:

    • Consolidated into single endpoint
    • Improved response format with metadata

    Document Endpoints

    Upload document

    • Old: /beta/org/{org}/memorysets/documents and /beta/user/memorysets/documents
    • New: /v1/memory/documents

    Changes:

    • Unified upload endpoint
    • Added support for custom metadata (up to 10 key-value pairs)

    List documents

    • Old: /beta/memorysets/{owner}/{memoryName}/documents
    • New: /v1/memory/{memoryName}/documents

    Changes:

    • Simplified path structure
    • Added document metadata
    • Improved status reporting
    • Improved response format

    Retry document Embeddings

    • Old: /beta/memorysets/{owner}/documents/embeddings/retry
    • New: /v1/memory/{memoryName}/documents/{documentName}/embeddings/retry

    Changes:

    • Simplified endpoint structure

    Documentation

    For more information, please refer to Langbase Pipe API and Langbase Memory API documentation.