Create an annotation queue

Create a new annotation queue with a name, optional description, filters, and an initial set of event IDs to add.

POST /v1/queues

Create an annotation queue

cURL

curl --request POST \
  --url https://api.dp1.us.honeyhive.ai/v1/queues \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "",
  "filters": {
    "filterArray": []
  },
  "enabled": true,
  "event_ids": []
}
'

201

{
  "queue": {
    "name": "<string>",
    "description": "<string>",
    "filters": {
      "filterArray": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ]
    },
    "enabled": true,
    "id": "<string>",
    "scope_id": "<string>",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

Maximum string length: 200

description · string · default: ""

Maximum string length: 1000

filters · object

Show child attributes

enabled · boolean · default: true

event_ids · string[]

Response

201

application/json

Queue created successfully

queue · object · required

Show child attributes

message · string · required