Documentation

API Reference

Libraries

Dashboard

Chat with founders

Retrieve the target schema for a Workshop

Get Workshop Target Schema

Location

Message

Error Type

ValidationError

OAuth2PasswordBearer

APIKeyHeader

Response Get Workshop Target Schema

HTTPValidationError

Introduction

Account Setup

Core Concepts

Quickstart

How to organize, manage, and leverage existing pipelines

Managing Pipelines

How to parse and edit target schemas for your pipelines

Editing Target Schema

Understanding the Result Manifest Structure

Parsing Manifests

Value Classifications

Understanding and parsing validation errors in mapping results

Flagged Mappings

How to optimize your description to maximize accuracy

Creating Descriptions

How to generate and access confidence scores

Confidence Scores

Creating Jobs

Creating Pipelines

Edit Mapping Logic

Review Flagged Jobs

Lume Cookbooks

Postman Collection

Security Overview

Frequently Asked Questions

Learn about the four main user roles in Lume

User Permissions

Creates a new pipeline and initial mapper version. The pipeline will be run with the provided sample data.

Create Pipeline

Updates a pipeline. Can be used to modify the active mapper version and other metadata.

Update Pipeline

Get Pipeline

Retrieves a page of pipelines in descending order by last activity.

List Pipelines

Delete Pipeline

Creates a new mapper. The mapper will be run with the provided sample data

Create Mapper

Get Mapper

Retrieves a page of pipeline mappers in descending order by version.

List Mappers

Runs a pipeline with the provided sample data. The active mapper version is used by default.

Run Pipeline

Retrieves a pipeline run by number for a given mapper version. The active mapper version is used by default.

Get Run

Retrieves a page of pipeline runs in descending order by number for a specific mapper version. The active mapper version is used by default.

List Runs

Create Target Schema

Update Target Schema

Get Target Schema

Retrieves a page of target schemas in descending order by creation time.

List Target Schemas

Delete Target Schema

Create Joined Data

Get Joined Data

List Joined Data

Get Organization

Create User

Update User

Get User

Get Current User

List Users

Delete User

Get Role

List Roles

Retrieve the current usage for the current user

Get Usage

Retrieve the usage limits for the current user

Get Limits

Learn how to integrate using the Typescript Client Library

Getting Started

Overview of the functionalities in the Typescript Client Library

Library Overview

Learn how to integrate using the Python SDK

Python SDK

Overview of the functionalities in the Python SDK

Methods and Classes

Overview of the classes in the Python SDK

Pipelines

Mappers

Runs

Target Schemas

Joined Data

Users

Usage

Get Workshop Target Schema

Authorizations

Path Parameters

Response