---
title: "Search catalog text with JSON or SSE responses."
method: POST
path: "/ask"
---

# Search catalog text with JSON or SSE responses.

`POST /ask`

## Request

- Base URL: `https://ecoaloha.com`
- URL: `https://ecoaloha.com/ask`
- Auth: none required

## Request body

- object
  - `query` union, required
    - string
    - object
      - `text` string, required
  - `mode` 'list'
  - `query_id` string
  - `streaming` boolean
  - `prefer` object
    - `streaming` boolean
    - `mode` 'list'

## Response `200`

Keyword matches from published catalog text. Accept: application/json selects JSON unless streaming is explicit. SSE emits start, result, complete and closes. No generated text.

- object
  - `query_id` string, required
  - `_meta` object, required
    - `response_type` 'list'
    - `version` '1.0'
  - `results` object[], required
    - `url` string, uri, required
    - `name` string, required
    - `description` string, required
    - `site` string, required
    - `score` number, required
    - `schema_object` object, required

## Other responses

- `400`: Invalid query or unsupported mode. Only list mode is available.
- `413`: Request exceeds 16 KiB.
- `500`: Catalog unavailable.

---

[API](https://skmtc.dev/ecoaloha/apis/ecoaloha-api.md) · [All operations](https://skmtc.dev/ecoaloha/apis/ecoaloha-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ecoaloha/apis/ecoaloha-api/revisions/1d423001d484?raw)