Documentation

API Reference

Knowledge Base

Libraries

Dashboard

Chat with founders

Get Workshops

Location

Message

Error Type

ValidationError

The date and time this object was created

Created At

The id of the job the workshop is associated with

Job Id

The id of the pipeline the workshop is associated with

Pipeline Id

The id of the source schema the workshop is associated with

Source Schema Id

The status of the Workshop. This status will be set to 'deployed' if the workshop was most recently deployed. If the workshop has either not yet been deployed or has been run since last deployment, it will reflect the status of the most recent result

Status

The id of the target schema the workshop is associated with

Target Schema Id

The date and time this object was last updated

Updated At

User Id

WorkShop

OAuth2PasswordBearer

APIKeyHeader

Page[WorkShop]

HTTPValidationError

Introduction

Set up your Lume account

Core Concepts

Generate Mapper

Get Mapped Data

Review Mapper

Edit Mapper

Use Pipeline

How to organize, manage, and leverage existing pipelines

Managing Pipelines

How to parse and edit target schemas for your pipelines

Editing Target Schema

How to structure mapper logic when submitting manual logic edits in a workshop

Building Mapper Logic

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

Pipeline

Mapper

Workshop

Mappings

Target Schema

Source Data

Result

Learn about the four main user roles in Lume

User Permissions

Create a new mapping in an existing Pipeline

Run Pipeline

Create Mapping

Get Mapping

Create Joined Data

Get Pipeline

Get Pipelines

Create Pipeline

Learn Pipeline

Update Pipeline

Delete Pipeline

Get Job

Get Jobs

Retrieve a paginated list of Jobs for a specific Pipeline

Get Pipeline Jobs

Retrieve the source data for a specific Job

Get Job Data

Get Result

Get Results

Retrieve the results associated with a Job

Get Job Results

Get Workshop Results

Clean Result

Retrieve a paginated list of mappings for a specific result

Get Result Mappings

Get Result Manifest

Retrieve the confidence scores for a specific result

Get Confidence scores

Calculate the confidence scores for a specific result

Run Calculate Confidence Scores

Create Workshop For Job

Create a new Workshop for a specific Pipeline

Create Workshop For Pipeline

Run Workshop With Mapper

Run Workshop With Prompt

Run Workshop With Target Schema

Deploy Workshop

Get Workshop

Retrieve a paginated list of Workshops for a specific Pipeline

Get Pipeline Workshops

Retrieve the workshops associated with a Job

Get Job Workshops

Delete Workshop

Retrieve the target schema for a Pipeline

Get Pipeline Target Schema

Get Job Target Schema

Retrieve the target schema for a Workshop

Get Workshop Target Schema

Generate Target Schema

Gets the import task for a PDF, with a processing status and data if finished

Get PDF Import

Gets all PDF import tasks, with a processing status and data if finished

Get PDF Imports

Get the URL of the provided PDF task (1 hour expiration).

Get PDF Url

Process PDF Import

Convert CSV to JSON

Get CSV

Get CSVs

Perform a search based on the provided parameters

Search

Convert an Excel file to structured JSON data

Convert Sheets

Learn how to integrate using the Typescript Client Library

Typescript Client Library

Overview of the functionalities in the Typescript Client Library

Methods and Classes

Overview of the models in Typescript Client Library

Models

Learn how to integrate using the Python SDK

Python SDK

Overview of the functionalities in the Python SDK

Overview of the classes in the Python SDK

Workflows

Pipeline

Job

Results

Mappings

Confidence Score

Workshop

Target Schema

PDF

CSV to JSON

Convenience

Get Workshops

Authorizations

Query Parameters

Response