> For the complete documentation index, see [llms.txt](https://docs.streambased.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.streambased.io/deploy-and-operate/streambased-platform/hyperstream/architecture.md).
# Architecture
Hyperstream (I.S.K. acceleration service) exposes a REST API that can be used by any client. To accelerate queries clients will submit their queries to an enrichment endpoint that will add additional clauses that are informed by index information.
A typical flow may look like this:
1. The client submits a put request to create an index over a given table for a given table field:
```properties
PUT /api/index
{
"topic": "customers"
"field": "Name"
}
```
2.
```
Next the created index is used to enrich an analytical query
```
````
```properties
POST /api/enrich
{
"sql" : "SELECT * FROM customers WHERE Name = 'Judith Gottlieb'"
}
```
returns:
```properties
{
"originalSql" : "SELECT * FROM customers WHERE Name = 'Judith Gottlieb'"
"enrichedSql" : "SELECT * FROM (SELECT * FROM customers WHERE (( kafka_partition = 0 AND kafka_offset >= 334000 AND kafka_offset < 335000)) OR (( kafka_partition = 0 AND kafka_offset >= 999999 ))) WHERE Name = 'Judith Gottlieb'"
}
```
````
3\. Analytical clients can then execute this enriched query and benefit from dramtically increased performance (30x - 100x is common).
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.streambased.io/deploy-and-operate/streambased-platform/hyperstream/architecture.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.