Aana API (0.1.0)

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

Analyze

Operations

Indexing

Operations

Index video

Request

Index video to be searchable in your collection, enabling discovery of specific moments and information.

Bodyapplication/x-www-form-urlencodedrequired
bodyobjectrequired
videoobjectrequired

A video. Exactly one of 'path', 'url', or 'content' must be provided. If 'path' is provided, the video will be loaded from the path. If 'url' is provided, the video will be downloaded from the url. The 'content' will be loaded automatically if files are uploaded to the endpoint and 'content' is set to the filename.

pathstring or null

The file path of the video.

Default null
urlstring or null(uri)non-empty

The URL of the video (supports YouTube videos).

Default null
contentstring or null

The name of the file uploaded to the endpoint. The content of the video will be loaded automatically.

Default null
media_idstring[ 1 .. 36 ] characters^[A-Za-z0-9_-]+$

The ID of the video. If not provided, it will be generated automatically.

Example: "123e4567-e89b-12d3-a456-426614174000"
additional_metadataobject or null

Additional metadata for the video

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

The human-readable ID of the collection.

Example: "my_collection"
reindex_if_existsboolean

Whether to reindex if the video already exists in the collection.

Default false
curl https://v1.api.aana.ai/index \
--request POST \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-api-key: YOUR_API_KEY_HERE' \
--data 'body={"video":{"media_id":"12345","url":"https://example.com/video_12345.mp4"},"collection":"my_collection","reindex_if_exists":false}'

Responses

Successful Response

Bodyapplication/json
task_idstringrequired

The task ID.

Example: "11111111-1111-1111-1111-111111111111"
Response
application/json
{ "task_id": "11111111-1111-1111-1111-111111111111" }

Collections

Operations

Webhooks

Operations

Tasks

Operations