Skip to main content

​
Welcome

The Alchemyst API reference covers every endpoint available for adding, searching, and managing context, memory, asynchronous ingestion jobs, traces, and organization-level context. Use the cards below to jump to an endpoint.

​
Models

Chat completions

OpenAI-compatible chat completions grounded in your Alchemyst context.

Models

Big Bull Alpha, is the default Alchemyst-served model. See the model section for details.

​
Authentication

To obtain your API key, follow these steps:
  1. Go to the Alchemyst Platform and sign up using your Google account.
  2. After logging in, open the API Keys page to generate your API key.
  3. You can view and manage your API keys anytime from the same API Keys page.
Include your API key in the Authorization header on every request:

​
Context

Add context

Store documents and resources in your private context.

Add context asynchronously

Queue a large add operation and track it as a job.

Delete context

Remove documents or resources from your context.

Search context

Retrieve the most relevant chunks for a query.

Steer context search

Search and summarize context using a steering prompt.

View context

List the context stored for the current account.

View context documents

Inspect stored documents and their metadata.

​
Memory

Add memory

Save facts and conversation state for later retrieval.

Update memory

Change an existing memory entry.

Delete memory

Remove a memory entry.

​
Asynchronous jobs

Get async job status

Check the status of the most recent add job.

Get async job status by id

Check the status of a specific add job.

Cancel async job

Cancel a running add job.

​
Traces

List traces

Retrieve request traces for debugging and observability.

Delete trace

Delete a specific trace by id.

​
Organization

View organization context

Read context shared across your organization.