Aana API (0.1.0)

Download OpenAPI description
Languages
Servers
https://v1.api.aana.ai/

Analyze

Operations

Indexing

Operations

Search for a query in the given collection and cluster the results (streaming)

Request

Query
deferboolean

Defer execution of the endpoint to the task queue.

Default false
Bodyapplication/x-www-form-urlencodedrequired
bodyobjectrequired
querystringrequired

Search query.

Example: "Cat"
collectionstring[ 1 .. 100 ] characters^[A-Za-z0-9_-]+$required

The human-readable ID of the collection.

Example: "my_collection"
search_public_collectionsboolean

Whether to search public collections.

Default false
search_languagestring

Language to use for indexing or search.

Default "en"
Enum"en""de"
curl https://v1.api.aana.ai/search_clusters \
--request POST \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--data 'body={"query":"Cat","collection":"my_collection","search_public_collections":false,"search_language":"en"}'

Responses

Successful Response

Bodyapplication/json-seq
answerstring
teaser_idinteger
cluster_resultsArray of objects
additional_infostring
related_queriesArray of strings
Response
application/json-seq
{ "answer": "string", "teaser_id": 0, "cluster_results": [ {} ], "additional_info": "string", "related_queries": [ "string" ] }

Collections

Operations

Webhooks

Operations

Tasks

Operations