Create group conversation

POST

/v2/document/group/{groupId}/conversation

• Staging
• Development

Create a new group conversation

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Path Parameters

groupId

required

string

A group Id

Example

77a0049c-7683-45ff-956f-656f257048f7

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

Request Body ^required

object

templateId

The template id

string format: uuid

77a0049c-7683-45ff-956f-656f257048f7

Responses

201

The resource has been successfully created.

object

id

required

The Group Conversation Id

string format: uuid

groupId

required

The Group Id

string format: uuid

uploadBatchId

required

The Upload Batch Id

string format: uuid

documentIds

required

The Document Ids of the group conversation

Array<string>

status

The Status

string

Allowed values: CREATED RUNNING COMPLETED FAILED ARCHIVED

CREATED

result

The conversation results from AI processing

object

{
  "Issuing Company Name": {
    "value": "xxx Pty Ltd",
    "promptId": "xxx",
    "promptName": "Issuing Company Name"
  }
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error