.mint-block {
    display: block
}
.mint-hidden {
    display: none
}
.dark\:mint-block:is(.dark *) {
    display: block
}
.dark\:mint-hidden:is(.dark *) {
    display: none
}

Introduction

Roe AI Documentation

Start analyzing your unstructured data in under 5 minutes

Quickstart

Start building powerful data processing Agents in under 5 minutes

Build your first VolansDB Agent in under 5 minutes

Define the inputs that your VolansDB Agent will accept

Input Definitions

How to create prompts effectively for your VolansDB Agents

Prompt Engineering Guide

JSON Output Schema

Fine-tuning

Index, search, and analyze unstructured data with SQL, no matter the scale.

Work with your unstructured data at scale in under 5 minutes

Connect to any data source or manage your data directly on Roe AI

Manage your unstructured data with Roe API

Examples

Retrieve a list of agents or create a new agent.

List Agents

Create Agent

Retrieve details of a specific base agent. For version-specific fields, you will receive the current version's data.

Retrieve an Agent

Update an Agent's Settings

Delete an Agent

Create a new agent with the same attributes as the current version of the specified agent.

Duplicate an Agent

Retrieve a list of versions for a specific agent or create a new version of an existing agent.

List Agent Versions

Create a new version of an existing agent. The new version will inherit the organization and engine_class_id from the base agent.

Create Agent Version

Retrieve details of a specific agent version.

Retrieve an Agent Version

Run agent synchronously. Returns agent outputs.

Run Agent

Run agent asynchronously. Returns agent job id which can be used to check status and get results.

Run Agent Async

Agent Job Status

Agent Job Result

Retrieve a list of jobs for a specific agent or create a new job

List Agent's Jobs

Run Query

Run a query as in Roe AI workspace asynchronously. Returns the query task ID which can be used to check status and get results.

Run Query Async

Query Status

Query Result

Retrieve a list of datasets or create a new dataset.

List Datasets

Create a Dataset

Upload File

Download a file by its file string identifier.

Download File

Manage your unstructured data in ROE AI with SQL

We've been overhauling Roe AI’s Agent and Worksheet experience to be as frictionless and intuitive as possible for you. We hope you love it!

v0.2.34

We've been making iterative improvements to our last major change. Albeit small, we hope they make your experience better!

v0.2.35

We've implemented more quality of life changes for the agents and the workspace. Enjoy!

v0.2.36

Some more changes with better user feedback and improved engine reliability. Enjoy!

v0.2.37

We’ve released v1.0.0, packed with powerful enhancements to streamline your workflow and boost productivity.

v1.0.0

We’ve made big changes to our subscriptions model in v1.0.1 to allow for more flexibility and better align with our customers.

v1.0.1

Along with introducing SSO for v1.0.3, we’ve made improvements to subscriptions, job scalability, and web engine reliability. Enjoy!

v1.0.3

Agent versioning is supported! We also pushed a improvements and hot fixes to our latest features. Enjoy!

v1.0.4

A new Page Selection Engine for your agent workflows! We also built a UI selector for agent input variables triggered by ‘@’ in engine configurations for an assisted experience. Enjoy!

v1.0.5

We've improved worksheet performance, enhanced the UI, strengthened crawler worker security, added partial failure support, optimized backend scaling, and fixed various bugs. Enjoy!

v1.0.18

A five minutes glance of ROE AI's power in action

Functional References

This is a general, non-configurable Agent for unstructured data extraction.

Default Extraction Agent

This is a general, non-configurable Agent for unstructured data classification.

Default Classification Agent

This Engine extracts data from any text source into your desired structure.

Text Extraction

This Engine extracts data from any image into your desired structure.

Image Extraction

This Engine extracts data from any video into your desired structure.

Video Extraction

This Engine extracts data from PDF documents into your desired structure.

PDF Extraction

This Engine parses information from PDF documents--**including tables, charts, and images**--into our predefined structure.

PDF Parser

This Engine takes a full-page snapshot of any website.

Website Snapshot

This Engine extracts structured information from a webpage with the given URL.

URL Website Extraction

A set of functions dedicated to working with unstructured data

Classify your unstructured data using the [Default Classification Agent](/agents/default/classification).

classify

Extract from unstructured data using the [Default Extraction Agent](/agents/default/extraction).

extract_from

extract_from_sync

Run an Agent to process unstructured data.

run_agent

Run an Agent to process unstructured data synchronously.

run_agent_sync

job_status

job_result | resolve

Get the multi-modality similarity score between the data and a natural language query.

similarity_score

AWS S3 Connector

Snowflake Connector

Guide to configuring OIDC SSO for your organization.

OIDC Single Sign-On (SSO) Integration

Microsoft Entra ID (Azure AD) OIDC SSO Integration

Okta OIDC SSO Integration Guide

ADFS OIDC SSO Integration Guide

Run system defined agent synchronously. Returns agent outputs.

Run Default Agent

Run system defined agent asynchronously. Returns agent job id which can be used to check status and get results.

Run Default Agent Async

Download a file or specific page range from a file.

Get Started

Agents

VolansDB

Data Resources

Enterprise

Use Cases

Introduction

Quickstart

API Reference

SQL Reference