Aana API (0.1.0)

Download OpenAPI description

Servers

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

Analyze

Operations

Indexing

Operations

Search

Operations

Collections

Operations

Webhooks

Operations

List Webhooks

Request

This endpoint is used to list all registered webhooks.

curl -i -X GET \
  https://v1.api.aana.ai/webhooks \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

webhooksArray of objectsrequired

The list of webhooks.

idstringrequired

The webhook ID.

Example: "00000000-0000-0000-0000-000000000000"

urlstring(uri)[ 1 .. 2083 ] charactersrequired

The URL to which the webhook will send requests.

eventsArray of stringsrequired

The events that the webhook is subscribed to.

Items Enum"task.completed""task.failed""task.started"

Response

application/json

{
  "webhooks": [
    { … }
  ]
}

Create Webhook

Request

This endpoint is used to register a webhook.

Bodyapplication/jsonrequired

urlstring(uri)[ 1 .. 2083 ] charactersrequired

The URL to which the webhook will send requests.

eventsArray of strings

The events to subscribe to. If None, the webhook is subscribed to all events.

Items Enum"task.completed""task.failed""task.started"

curl -i -X POST \
  https://v1.api.aana.ai/webhooks \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "url": "http://example.com",
    "events": [
      "task.completed"
    ]
  }'

Responses

Successful Response

Bodyapplication/json

idstringrequired

The webhook ID.

Example: "00000000-0000-0000-0000-000000000000"

urlstring(uri)[ 1 .. 2083 ] charactersrequired

The URL to which the webhook will send requests.

eventsArray of stringsrequired

The events that the webhook is subscribed to.

Items Enum"task.completed""task.failed""task.started"

Response

application/json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "url": "http://example.com",
  "events": [
    "task.completed"
  ]
}

Get Webhook

Request

This endpoint is used to fetch a webhook by ID.

Path

webhook_idstringrequired

curl -i -X GET \
  'https://v1.api.aana.ai/webhooks/{webhook_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

idstringrequired

The webhook ID.

Example: "00000000-0000-0000-0000-000000000000"

urlstring(uri)[ 1 .. 2083 ] charactersrequired

The URL to which the webhook will send requests.

eventsArray of stringsrequired

The events that the webhook is subscribed to.

Items Enum"task.completed""task.failed""task.started"

Response

application/json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "url": "http://example.com",
  "events": [
    "task.completed"
  ]
}

Update Webhook

Request

This endpoint is used to update a webhook.

Path

webhook_idstringrequired

Bodyapplication/jsonrequired

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

New URL for the webhook.

eventsArray of strings or null

New list of events to subscribe to.

Enum"task.completed""task.failed""task.started"

curl -i -X PUT \
  'https://v1.api.aana.ai/webhooks/{webhook_id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "url": "http://example.com",
    "events": [
      "task.completed"
    ]
  }'

Responses

Successful Response

Bodyapplication/json

idstringrequired

The webhook ID.

Example: "00000000-0000-0000-0000-000000000000"

urlstring(uri)[ 1 .. 2083 ] charactersrequired

The URL to which the webhook will send requests.

eventsArray of stringsrequired

The events that the webhook is subscribed to.

Items Enum"task.completed""task.failed""task.started"

Response

application/json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "url": "http://example.com",
  "events": [
    "task.completed"
  ]
}

Delete Webhook

Request

This endpoint is used to delete a webhook.

Path

webhook_idstringrequired

curl -i -X DELETE \
  'https://v1.api.aana.ai/webhooks/{webhook_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json

idstringrequired

The webhook ID.

Example: "00000000-0000-0000-0000-000000000000"

urlstring(uri)[ 1 .. 2083 ] charactersrequired

The URL to which the webhook will send requests.

eventsArray of stringsrequired

The events that the webhook is subscribed to.

Items Enum"task.completed""task.failed""task.started"

Response

application/json

{
  "id": "00000000-0000-0000-0000-000000000000",
  "url": "http://example.com",
  "events": [
    "task.completed"
  ]
}

Tasks

Operations