get
https://{yourinstance}.makaira.io/stream/documents//
Retrieves documents associated to a given stream.
Returns the documents currently assigned to a stream for a specific language index. Useful for previewing or auditing which products are in a stream.
Requires authentication.
Request
GET /stream/documents/{streamId}/{languageId}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
streamId | integer | Yes | The ID of the stream. |
languageId | string | Yes | The language identifier for the index (e.g. de, en). |
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Request Body (optional)
| Field | Type | Default | Description |
|---|---|---|---|
sorting | string | id | Field to sort results by. |
order | string | desc | Sort order: asc or desc. |
count | integer | 50 | Number of documents to return per page. |
offset | integer | 0 | Pagination offset. |
Example Request
GET /stream/documents/3/de
Authorization: Bearer <token>
Response
Returns a JSON array of document objects assigned to the stream.
Example Response
[
{
"id": "product-123",
"title": "Running Shoes XR",
"price": 89.99
},
{
"id": "product-456",
"title": "Trail Running Boots",
"price": 119.99
}
] 200List of documents
404Stream Not Found

