Develop with the OpenLink AI (OPAL) Assistants API

An immersive, interactive guide to the OPAL Assistants API. Learn the Assistant -> Thread -> Run workflow and go from zero to a stateful conversation in minutes.

Interactive Quick Start

Step 1: Configuration

Set your API endpoint, your personal Bearer Token, and the backend LLM API Key (e.g., from OpenAI).

Step 2: Find an Assistant

Let's list the available assistants and find the ID for the "Virtuoso Support" agent.

Response will appear here...

Step 3: Create a Conversation Thread

Assistants require a `thread_id` to maintain conversation state. Let's create a new one.

Response will appear here...

Step 4: Ask a Question

Now we can run the assistant within our thread. The `assistant_id` and `thread_id` are automatically included.

Response will appear here...

Step 5: View Conversation History

Finally, let's retrieve all messages from the thread to see the full conversation, including your prompt and the assistant's reply.

Response will appear here...

Interactive API Explorer