Skip to main content

orchata init

Configure the CLI to connect to the Orchata cloud API. Run this once after installing.
You can also pass values directly:

orchata login

Authenticate with your API key. Opens the signup page in your browser if you don’t have an account yet.
Provide an API key non-interactively:
Use a named profile:

orchata configure

Update saved settings like profile, API base, and app base.

orchata spaces

Manage knowledge base spaces.

List spaces

Filter by metadata:

Create a space

With metadata:

Get a space

Update a space

Update metadata:

Delete a space

Deleting a space archives it (soft delete). The space and its documents remain accessible but hidden.

orchata documents

Manage documents within a space.

List documents

Filter by metadata:

Upload a document

Upload a file:
Upload inline content:

Get a document

Get document content

Retrieve the processed text content:

Append to a document

Batch upload

Upload all files in a directory:

orchata query

Query one or more spaces using semantic search.

Basic query

Smart query

Discover relevant spaces automatically:

Options