Skip to main content
GET
/
generation
/
groups
List generation groups
curl --request GET \
  --url https://api.animusai.co/v2/generation/groups \
  --header 'Authorization: Bearer <token>'
{
  "groups": [
    {
      "group_id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "group_type": "<string>",
      "generation_count": 123,
      "preview_image_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "character_id": "<string>"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "returned": 1,
    "has_more": true
  },
  "organization_id": "<string>",
  "error": {
    "error": "<string>",
    "message": "<string>",
    "character_id": "<string>",
    "group_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:50

Maximum number of groups to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of groups to skip for pagination.

Required range: x >= 0
character_id
string

Filter by character identifier.

Response

200 - application/json

Available groups.

groups
object[]
pagination
object
organization_id
string
error
object
I