Skip to content

Get group

GET
/v2/document/group/{groupId}

Get all the details of a group by ID

groupId
required
string

A group Id

Example
77a0049c-7683-45ff-956f-656f257048f7
X-API-Key
string

API Key

X-API-Secret
string

API Secret

Retrieves the details of a single group

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

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error