Aana API (0.1.0)

Download OpenAPI description

Servers

https://v1.api.aana.ai/

Analyze

Operations

Indexing

Operations

Search

Operations

Collections

Operations

Create Collection

Request

Create a new collection.

Bodyapplication/jsonrequired

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

The human-readable ID of the collection.

Example: "my_collection"

namestring[ 1 .. 100 ] charactersrequired

The name of the collection.

descriptionstring or null

Description of the collection

is_publicboolean

Whether the collection should be public. Only admins can create public collections.

Default false

curl -i -X POST \
  https://v1.api.aana.ai/collections \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "collection_id": "my_collection",
    "name": "string",
    "description": "string",
    "is_public": false
  }'

Responses

Successful Response

Bodyapplication/json

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

The human-readable ID of the collection.

Example: "my_collection"

namestring[ 1 .. 100 ] charactersrequired

The name of the collection.

descriptionstring or nullrequired

Description of the collection

is_publicbooleanrequired

Whether the collection is public.

thumbnailsArray of strings or null

Thumbnails for the collection

Response

application/json

{
  "collection_id": "my_collection",
  "name": "string",
  "description": "string",
  "is_public": true,
  "thumbnails": [
    "string"
  ]
}

List Collections

Request

List all collections for a user.

Query

publicboolean

Whether to list public collections. List private collections by default.

Default false

return_thumbnailsboolean

Whether to return thumbnails for the collections

Default false

curl -i -X GET \
  'https://v1.api.aana.ai/collections?public=false&return_thumbnails=false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

collectionsArray of objectsrequired

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

The human-readable ID of the collection.

Example: "my_collection"

namestring[ 1 .. 100 ] charactersrequired

The name of the collection.

descriptionstring or nullrequired

Description of the collection

is_publicbooleanrequired

Whether the collection is public.

thumbnailsArray of strings or null

Thumbnails for the collection

Response

application/json

{
  "collections": [
    { … }
  ]
}

Get Collection

Request

Get a collection by ID.

Path

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

The human-readable ID of the collection.

Example: my_collection

Query

publicboolean

Whether to get a public collection. Get a private collection by default.

Default false

return_thumbnailsboolean

Whether to return thumbnails for the collection

Default false

curl -i -X GET \
  'https://v1.api.aana.ai/collections/my_collection?public=false&return_thumbnails=false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

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

The human-readable ID of the collection.

Example: "my_collection"

namestring[ 1 .. 100 ] charactersrequired

The name of the collection.

descriptionstring or nullrequired

Description of the collection

is_publicbooleanrequired

Whether the collection is public.

thumbnailsArray of strings or null

Thumbnails for the collection

Response

application/json

{
  "collection_id": "my_collection",
  "name": "string",
  "description": "string",
  "is_public": true,
  "thumbnails": [
    "string"
  ]
}

Delete Collection

Request

Delete a collection.

Path

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

The human-readable ID of the collection.

Example: my_collection

curl -i -X DELETE \
  https://v1.api.aana.ai/collections/my_collection \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

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

The human-readable ID of the collection.

Example: "my_collection"

namestring[ 1 .. 100 ] charactersrequired

The name of the collection.

descriptionstring or nullrequired

Description of the collection

is_publicbooleanrequired

Whether the collection is public.

thumbnailsArray of strings or null

Thumbnails for the collection

Response

application/json

{
  "collection_id": "my_collection",
  "name": "string",
  "description": "string",
  "is_public": true,
  "thumbnails": [
    "string"
  ]
}

Update Collection

Request

Update a collection.

Path

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

The human-readable ID of the collection.

Example: my_collection

Bodyapplication/jsonrequired

namestring or null[ 1 .. 100 ] characters

The name of the collection.

descriptionstring or null

Description of the collection

is_publicboolean or null

Whether the collection should be public. Only admins can create public collections.

curl -i -X PUT \
  https://v1.api.aana.ai/collections/my_collection \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "description": "string",
    "is_public": true
  }'

Responses

Successful Response

Bodyapplication/json

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

The human-readable ID of the collection.

Example: "my_collection"

namestring[ 1 .. 100 ] charactersrequired

The name of the collection.

descriptionstring or nullrequired

Description of the collection

is_publicbooleanrequired

Whether the collection is public.

thumbnailsArray of strings or null

Thumbnails for the collection

Response

application/json

{
  "collection_id": "my_collection",
  "name": "string",
  "description": "string",
  "is_public": true,
  "thumbnails": [
    "string"
  ]
}

Get Collection Items

Request

Get items in a collection.

Path

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

The human-readable ID of the collection.

Example: my_collection

Query

is_publicboolean

Whether the collection is public

Default false

limitinteger

The number of items to return

Default 10

offsetstring or null(uuid)

The offset to start from returned by a previous query

curl -i -X GET \
  'https://v1.api.aana.ai/collections/my_collection/items?is_public=false&limit=10&offset=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

itemsArray of objectsrequired

The items in the collection

typestringrequired

The media type.

Enum"video""audio""image"

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

The media id.

Example: "123e4567-e89b-12d3-a456-426614174000"

thumbnail_urlstring or null(uri)[ 1 .. 2083 ] characters

The thumbnail URL.

titlestring or null

The title.

offsetstring or null

The offset for the next query to get more items

Response

application/json

{
  "items": [
    { … }
  ],
  "offset": "string"
}

Remove Item From Collection

Request

Remove an item from a collection.

Path

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

The human-readable ID of the collection.

Example: my_collection

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

The media ID.

Example: 123e4567-e89b-12d3-a456-426614174000

curl -i -X DELETE \
  https://v1.api.aana.ai/collections/my_collection/items/123e4567-e89b-12d3-a456-426614174000 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

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

The human-readable ID of the collection.

Example: "my_collection"

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

Media ID

Example: "123e4567-e89b-12d3-a456-426614174000"

Response

application/json

{
  "collection_id": "my_collection",
  "media_id": "123e4567-e89b-12d3-a456-426614174000"
}

Get content exploration prompts

Request

Provides intelligent question suggestions based on your collection content, surfacing information you might not know to look for.

Query

deferboolean

Defer execution of the endpoint to the task queue.

Default false

Bodyapplication/x-www-form-urlencodedrequired

bodyobjectrequired

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 of the user's search query.

Default "en"

Enum"en""de"

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

Responses

Successful Response

Bodyapplication/x-ndjson

completionobject

generation output.

Response

application/x-ndjson

{
  "completion": {}
}

Webhooks

Operations

Tasks

Operations