API References

Contact us

Petal Cite Documentation

Support

Sign up

Get detailed information of an AI Table by ID

Get an AI Table

bearerAuth

AITable

ValidationError

Read dict of AI table

Introduction

Retrieve your authorization credentials to access the API

Credentials

Document Creation

AI Chats

AI Tables

Petal API Reference

Provides the access tokens for user log in, as well as other identifying information

Obtain authorization information

List all Organizations a given user is part of

List Workspaces

Create a Document by uploading your file to Petal

Create a Document

Fetch detailed information on a single Document by its unique ID

Get a Document

List all Documents within an Organization

List all Documents in an Organization

Permanently delete Documents and all their associated Annotations, comments, AI Sessions, etc.

Delete Documents

Create an AI chat Session

List Sessions based on Document (single-doc) or Organization (multi-doc). Provide both Organization and Document IDs to fetch all single-doc Sessions for that particular Document, and provide only the Organization ID for all multi-doc Sessions in the Organization

List AI Chat Sessions

Fetch detailed information on a single AI Session by its unique ID

Get an AI chat Session

Change visibility or Document list of AI Session

Update an AI Chat Session

Reset an AI Session by deleting all existing chat messages in it, restoring it to a blank slate

Reset an AI chat Session

Permanently delete an AI Session and all its chat messages

Delete an AI chat Session

Create a new message in a given AI Session

Create a chat message

List chat messages in a Session

Delete a chat message

Create an AI Table

List detailed information of all AI Tables in a given Organization

List AI Tables

Change visibility or Document list of AI Table

Update an AI Table

Permanently delete an AI Table, including all its columns and cells

Delete an AI Table

Create a column within the given AI Table

Create an AI Table column

List all columns in an AI Table

Provides detailed information on the AI Table column with the given ID

Get an AI Table column

Update the name or query associated with a column. Does not automatically update the cells if a new query is provided

Update an AI Table column

Invokes the AI on all cells (Documents) within a column. If a cell does not already exist, a new one will be created. Existing cells' responses will be overwritten

Run AI on all cells in a column

Delete an AI Table column, and all its associated cells

Delete an AI Table column

Since each row of an AI Table corresponds to a specific Document, this endpoint simply lists all cells match the provided Document ID

List all cells in a row

Run AI on all cells in a row

Create cells for the given column-Document pairs if cells do not already exist, and invoke the AI to generate responses for them

Create cells and run AI

Create a cell within an AI table, without invoking the AI to generate any response. Cell contents will still be embedded to be used as context for AI chat, if needed

Create cell without AI

Change the contents of an AI cell manually, without invoking the AI on it. The user-submitted content is still embedded for AI chat context purposes

Overview

Authorization

Document

AI Chat

AI Table

Get an AI Table

Authorizations

Path Parameters

Response