Skip to content

Create group

POST
/v2/document/group

Create a new group

X-API-Key
string

API Key

X-API-Secret
string

API Secret

object
name
required

The group name

string
description

The group description

string
providerModelId

The provider model id

string format: uuid
templateId

The prompts template id

string format: uuid

The resource has been successfully created.

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