List Collection Threads

GET

collection

{collectionID}

threads

curl --request GET \
  --url https://api.storytell.ai/v1/collection/{collectionID}/threads

{
  "code": "<string>",
  "data": {
    "pagination": {
      "count": 1,
      "currentPage": 1,
      "firstRecordOnPage": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "lastRecordOnPage": "<string>",
      "limit": 1,
      "offset": 1,
      "totalPages": 1
    },
    "result": {
      "collections": {},
      "entities": [
        {
          "actions": [
            "<string>"
          ],
          "collectionIds": [
            [
              127
            ]
          ],
          "data": {
            "createdAt": "2023-11-07T05:31:56Z",
            "createdBy": [
              127
            ],
            "etag": "<string>",
            "label": "<string>",
            "lifecycleState": "<string>",
            "messageCount": 123,
            "modifiedAt": "2023-11-07T05:31:56Z",
            "organizationId": [
              127
            ],
            "tenantId": [
              127
            ],
            "threadId": [
              127
            ],
            "version": 123
          },
          "flags": [
            [
              "<string>"
            ]
          ]
        }
      ]
    }
  },
  "details": {
    "consumption": {
      "units": 123
    },
    "operation": {
      "duration": 123,
      "operationId": "<string>"
    }
  },
  "done": true,
  "eventKey": "<string>",
  "message": "<string>"
}

Path Parameters

collectionID

string

required

Query Parameters

limit

integer

required

Limit is the number of items to return.

Required range: x > 0

offset

integer

required

Offset is the number of items to skip.

Required range: x > 0

sort

string[]

required

Sort is a CSV of fields to sort by. Prefix with "-" for descending order.

Response

200

application/json

Success response

code

string

required

data

object

required

details

object

required

done

boolean

required

eventKey

string

required

message

string

required

Was this page helpful?

Add New Collection Creates a new collection under the specified ancestor. Requires user authentication and proper authorization permissions.

curl --request GET \
  --url https://api.storytell.ai/v1/collection/{collectionID}/threads

{
  "code": "<string>",
  "data": {
    "pagination": {
      "count": 1,
      "currentPage": 1,
      "firstRecordOnPage": "<string>",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "lastRecordOnPage": "<string>",
      "limit": 1,
      "offset": 1,
      "totalPages": 1
    },
    "result": {
      "collections": {},
      "entities": [
        {
          "actions": [
            "<string>"
          ],
          "collectionIds": [
            [
              127
            ]
          ],
          "data": {
            "createdAt": "2023-11-07T05:31:56Z",
            "createdBy": [
              127
            ],
            "etag": "<string>",
            "label": "<string>",
            "lifecycleState": "<string>",
            "messageCount": 123,
            "modifiedAt": "2023-11-07T05:31:56Z",
            "organizationId": [
              127
            ],
            "tenantId": [
              127
            ],
            "threadId": [
              127
            ],
            "version": 123
          },
          "flags": [
            [
              "<string>"
            ]
          ]
        }
      ]
    }
  },
  "details": {
    "consumption": {
      "units": 123
    },
    "operation": {
      "duration": 123,
      "operationId": "<string>"
    }
  },
  "done": true,
  "eventKey": "<string>",
  "message": "<string>"
}

API documentation

API Reference

List Collection Threads

Path Parameters

Query Parameters

Response