---
title: "Ask a question about YouSpot in plain words"
method: GET
path: "/ask"
tags: ["Ask"]
---

# Ask a question about YouSpot in plain words

`GET /ask`

## Request

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

Answered from this site only, by keyword retrieval over its public pages. Every result carries the URL and the passage it came from, so the answer is checkable. There is no model in this path.

## Query parameters

- `query` string, required
- `q` string
- `limit` integer
- `streaming` boolean

## Response `200`

The matching pages, best first.

- AskResponse
  - `_meta` object, required
    - `query` string
    - `query_id` string
    - `site` string
    - `generated_at` string, date-time
    - `retrieval` 'keyword'
    - `results_returned` integer
  - `@context` 'https://schema.org'
  - `query_id` string
  - `results` AskResult[], required
    - `url` string, uri, required: A page on this site.
    - `name` string, required
    - `site` 'youspot.com', required
    - `score` number, required: Relative, within one response. Not comparable across queries.
    - `description` string, required: The passage that matched, or the page description when the match was in the title.
    - `schema_object` object: schema.org for the page, including the markdown twin under `encoding.contentUrl`.

## Other responses

- `400`: The request was refused. `error` is stable; read `error_description` for the reason.

---

[API](https://skmtc.dev/youspot/apis/youspot-http-api.md) · [All operations](https://skmtc.dev/youspot/apis/youspot-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/youspot/apis/youspot-http-api/revisions/6615ad5d017d?raw)