---
title: "ask: semantic search"
description: "a text or a subject's vector, the model, a floor and a population to the units above the floor."
section: reference
address: /reference/ask/semantic_search
contract: 0476e35e6e275db5
---
# ask: semantic search
a text or a subject's vector, the model, a floor and a population to the units above the floor.
[figure: The caller sends SemanticSearchInput to /v1/ask/semantic_search. The platform returns a card whose body is SemanticSearchAnswer.]
POST/v1/ask/semantic_search
Semantic search. The call needs the strategy rung under a token with the ask grant, and it is served by the platform.
The route takes [SemanticSearchInput](/concepts/semanticsearchinput) and returns a card whose body is [SemanticSearchAnswer](/concepts/semanticsearchanswer).
## Request body
The request body is [SemanticSearchInput](/concepts/semanticsearchinput).
| field | type | required | note |
|---|---|---|---|
| `text` | `text` | no | |
| `subject` | [UnitRef](/concepts/unitref) | no | |
| `model` | [Model](/concepts/model) | yes | |
| `floor` | `share` | yes | |
| `population` | [Predicate](/concepts/predicate) | yes | |
## Response
The route returns a card whose body is [SemanticSearchAnswer](/concepts/semanticsearchanswer). Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.
## Headers
| header | required | meaning |
|---|---|---|
| `Scale-Scope` | yes | the scope the call runs in: tenant/, then /brand/, then /strategy/ |
| `Scale-As-True-On` | no | the date the facts must have been true on; defaults to now |
| `Scale-As-Known-On` | no | the date the facts must have been known on; defaults to now |
| `Scale-Key` | no | for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing |
A caller needs the strategy rung and a token with the ask grant. The platform serves this route.
## Example
The example sends the smallest body that SemanticSearchInput allows. The build validates it against the schema of SemanticSearchInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/ask/semantic_search \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "model": "…", "floor": 0, "population": { "tree": { "form": "group" }, "population": "…", "tree_hash": "…", "register_hash": "…", "compiler_version": "…", "comparator_versions": {} } }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.ask.semantic_search({
"model": "…",
"floor": 0,
"population": {
"tree": {
"form": "group"
},
"population": "…",
"tree_hash": "…",
"register_hash": "…",
"compiler_version": "…",
"comparator_versions": {}
}
});
// answer.body is a SemanticSearchAnswer. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/ask/semantic_search",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"model": "…",
"floor": 0,
"population": {
"tree": {
"form": "group"
},
"population": "…",
"tree_hash": "…",
"register_hash": "…",
"compiler_version": "…",
"comparator_versions": {}
}
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/ask/semantic_search")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&SemanticSearchInput { /* the fields of the page */ }).send().await?.json().await?;
```