Skip to content

Get groups

GET
/v2/document/group

List of groups.

page[number]
number

Page number (starts at 1)

Example
1
page[size]
number

Items per page

Example
10
X-API-Key
string

API Key

X-API-Secret
string

API Secret

List of groups

object
items
required

List of groups

Array<object>
object
id
required

A group Id

string format: uuid
name
required

A group name

string
description

A group description

string
status
required

The status of the group

string
Allowed values: ACTIVE ARCHIVED
ACTIVE
providerModelId

The provider model id

string format: uuid
documentIds
required

The document ids

Array<string>
templateId
required

The prompts template id

string format: uuid
page
required

List of groups

object
number
required

Page number (starts at 1)

number
1
size
required

Items per page

number
10
totalPages
required

Total number of items

number
100
totalCount
required

Total number of pages

number
10
hasNext
required

Whether there is a next page

boolean
true
hasPrev
required

Whether there is a previous page

boolean

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error