Get conversation details

curl --request GET \
  --url https://api.duix.ai/duix-openapi-v2/sdk/v2/getConversationById \
  --header 'token: <api-key>'

{
  "success": true,
  "code": "0",
  "message": "SUCCESS",
  "msg": "SUCCESS",
  "data": {
    "id": "108",
    "conversationName": "Unnamed-18:04",
    "language": "zh",
    "corpId": "1003645",
    "userId": "3959",
    "conversationConfigDto": null,
    "maxConversation": 2,
    "dataModelIsUsed": 1,
    "knowledgeIsUsed": 1,
    "fileIsUsed": 0,
    "thirdIsUsed": 0,
    "isFreedom": 0,
    "asrProvider": null,
    "conversationInfoDto": {
      "id": 109,
      "name": "1",
      "nickName": "",
      "gender": 1,
      "age": 0,
      "height": 0,
      "weight": 0,
      "characters": "",
      "backStory": ""
    },
    "detailDto": {
      "id": 95,
      "conversationId": "108",
      "proportion": "16:9",
      "terminalType": 0,
      "modelId": "321486924406853",
      "modelIdType": 0,
      "imageId": null,
      "sceneId": null,
      "modelName": "Model name",
      "sceneType": 0,
      "background": 1,
      "backgroundDto": {
        "id": 1,
        "backgroundCode": "1591003727513522176",
        "backgroundName": "zuoyi.jpg",
        "backgroundUrl": "/video-server/jpg/1592809647136509954.jpg",
        "fileType": 0,
        "proportion": "16:9",
        "userId": null
      },
      "modelConfig": null,
      "ttsId": "15",
      "ttsName": "guina",
      "ttsConfig": null,
      "ttsUrl": "",
      "ttsVolume": 0,
      "ttsSpeaker": "zhifeng_emo",
      "ttsSpeedRate": 0,
      "ttsPitch": 0,
      "ttsSource": 20,
      "samplePictureUrl": "/model/2023/02/06/c5348a17fac75feb0152a0c599b7af87.png",
      "videoWidth": 1920,
      "videoHeight": 1920,
      "humanProportion": "9:16",
      "humanWidth": 540,
      "humanHeight": 960,
      "humanX": 690,
      "humanY": 120,
      "localModelInfo": null
    },
    "knowledgeDtoList": [],
    "kbConversationDto": null,
    "modelDtoList": [
      {
        "id": 487,
        "conversationId": "108",
        "largeModelType": 0,
        "modelCode": 0,
        "largeName": "chatbot_law",
        "modelId": "1",
        "prompt": "Task: Your name is Zhang San...",
        "botUrl": ""
      }
    ],
    "thirdDto": null,
    "scriptDtoList": [
      {
        "id": 2728,
        "conversationId": "108",
        "scriptType": 0,
        "scriptContent": "Els silvrants",
        "ttsContent": null,
        "emotion": "0"
      }
    ]
  }
}

GET

getConversationById

curl --request GET \
  --url https://api.duix.ai/duix-openapi-v2/sdk/v2/getConversationById \
  --header 'token: <api-key>'

{
  "success": true,
  "code": "0",
  "message": "SUCCESS",
  "msg": "SUCCESS",
  "data": {
    "id": "108",
    "conversationName": "Unnamed-18:04",
    "language": "zh",
    "corpId": "1003645",
    "userId": "3959",
    "conversationConfigDto": null,
    "maxConversation": 2,
    "dataModelIsUsed": 1,
    "knowledgeIsUsed": 1,
    "fileIsUsed": 0,
    "thirdIsUsed": 0,
    "isFreedom": 0,
    "asrProvider": null,
    "conversationInfoDto": {
      "id": 109,
      "name": "1",
      "nickName": "",
      "gender": 1,
      "age": 0,
      "height": 0,
      "weight": 0,
      "characters": "",
      "backStory": ""
    },
    "detailDto": {
      "id": 95,
      "conversationId": "108",
      "proportion": "16:9",
      "terminalType": 0,
      "modelId": "321486924406853",
      "modelIdType": 0,
      "imageId": null,
      "sceneId": null,
      "modelName": "Model name",
      "sceneType": 0,
      "background": 1,
      "backgroundDto": {
        "id": 1,
        "backgroundCode": "1591003727513522176",
        "backgroundName": "zuoyi.jpg",
        "backgroundUrl": "/video-server/jpg/1592809647136509954.jpg",
        "fileType": 0,
        "proportion": "16:9",
        "userId": null
      },
      "modelConfig": null,
      "ttsId": "15",
      "ttsName": "guina",
      "ttsConfig": null,
      "ttsUrl": "",
      "ttsVolume": 0,
      "ttsSpeaker": "zhifeng_emo",
      "ttsSpeedRate": 0,
      "ttsPitch": 0,
      "ttsSource": 20,
      "samplePictureUrl": "/model/2023/02/06/c5348a17fac75feb0152a0c599b7af87.png",
      "videoWidth": 1920,
      "videoHeight": 1920,
      "humanProportion": "9:16",
      "humanWidth": 540,
      "humanHeight": 960,
      "humanX": 690,
      "humanY": 120,
      "localModelInfo": null
    },
    "knowledgeDtoList": [],
    "kbConversationDto": null,
    "modelDtoList": [
      {
        "id": 487,
        "conversationId": "108",
        "largeModelType": 0,
        "modelCode": 0,
        "largeName": "chatbot_law",
        "modelId": "1",
        "prompt": "Task: Your name is Zhang San...",
        "botUrl": ""
      }
    ],
    "thirdDto": null,
    "scriptDtoList": [
      {
        "id": 2728,
        "conversationId": "108",
        "scriptType": 0,
        "scriptContent": "Els silvrants",
        "ttsContent": null,
        "emotion": "0"
      }
    ]
  }
}

Authorizations

token

string

header

required

Token generated from your API keys.

Query Parameters

conversationId

string

required

Unique conversation ID.

Response

200 - application/json

Successfully retrieved conversation details

code

string

Response code

message

string

Text message returned by the API

msg

string

Additional message field

success

boolean

Request success flag

data

object

Main conversation data

Show child attributes

data.id

string

Conversation ID

data.conversationName

string

Conversation name

data.language

string

Conversation language

data.corpId

string

Corporate ID

data.userId

string

User ID

data.conversationConfigDto

object

Conversation configuration

data.maxConversation

integer

Maximum concurrent conversations

data.dataModelIsUsed

integer

Whether data model is used

data.knowledgeIsUsed

integer

Whether knowledge base is used

data.fileIsUsed

integer

Whether file is used

data.thirdIsUsed

integer

Whether third-party integration is used

data.isFreedom

integer

Whether in freedom mode

data.asrProvider

string

ASR provider

data.conversationInfoDto

object

Conversation information details

Show child attributes

data.conversationInfoDto.id

integer

Info ID

data.conversationInfoDto.name

string

Name

data.conversationInfoDto.nickName

string

Nickname

data.conversationInfoDto.gender

integer

Gender (1=Male, 2=Female)

data.conversationInfoDto.age

integer

Age

data.conversationInfoDto.height

integer

Height

data.conversationInfoDto.weight

integer

Weight

data.conversationInfoDto.characters

string

Character traits

data.conversationInfoDto.backStory

string

Background story

data.detailDto

object

Conversation resource details (includes model, background, and TTS configuration)

Show child attributes

data.detailDto.id

integer

Detail ID

data.detailDto.conversationId

string

Conversation ID

data.detailDto.proportion

string

Video proportion

data.detailDto.terminalType

integer

Terminal type

data.detailDto.modelId

string

Model ID

data.detailDto.modelIdType

integer

Model type (0 = Cloud Digital Human, 1 = Local Digital Human)

data.detailDto.imageId

string

Image ID

data.detailDto.sceneId

string

Scene ID

data.detailDto.modelName

string

Model name

data.detailDto.sceneType

integer

Scene type

data.detailDto.background

integer

Background type

data.detailDto.backgroundDto

object

Background resource details

Show child attributes

data.detailDto.backgroundDto.id

integer

Background ID

data.detailDto.backgroundDto.backgroundCode

string

Background code

data.detailDto.backgroundDto.backgroundName

string

Background name

data.detailDto.backgroundDto.backgroundUrl

string

Background image or video URL

data.detailDto.backgroundDto.fileType

integer

File type

data.detailDto.backgroundDto.proportion

string

Background proportion

data.detailDto.backgroundDto.userId

string

User ID

data.detailDto.modelConfig

object

Model configuration

data.detailDto.ttsId

string

TTS ID

data.detailDto.ttsName

string

TTS name

data.detailDto.ttsConfig

object

TTS configuration

data.detailDto.ttsUrl

string

TTS URL

data.detailDto.ttsVolume

integer

TTS volume

data.detailDto.ttsSpeaker

string

TTS speaker ID

data.detailDto.ttsSpeedRate

integer

TTS speed rate

data.detailDto.ttsPitch

integer

TTS pitch

data.detailDto.ttsSource

integer

TTS source

data.detailDto.samplePictureUrl

string

Sample picture URL

data.detailDto.videoWidth

integer

Video width

data.detailDto.videoHeight

integer

Video height

data.detailDto.humanProportion

string

Human proportion

data.detailDto.humanWidth

integer

Human width

data.detailDto.humanHeight

integer

Human height

data.detailDto.humanX

integer

Human X coordinate

data.detailDto.humanY

integer

Human Y coordinate

data.detailDto.localModelInfo

object

Local digital human information

data.knowledgeDtoList

array

Knowledge base list

data.kbConversationDto

object

Knowledge base conversation

data.modelDtoList

object[]

Model data transfer object list

Show child attributes

data.modelDtoList.id

integer

Model DTO ID

data.modelDtoList.conversationId

string

Conversation ID

data.modelDtoList.largeModelType

integer

Large model type

data.modelDtoList.modelCode

integer

Model code

data.modelDtoList.largeName

string

Large model name

data.modelDtoList.modelId

string

Model ID

data.modelDtoList.prompt

string

Prompt template for the model

data.modelDtoList.botUrl

string

Bot URL

data.thirdDto

object

Third-party integration data

data.scriptDtoList

object[]

Predefined dialog scripts

Show child attributes

data.scriptDtoList.id

integer

Script ID

data.scriptDtoList.conversationId

string

Conversation ID

data.scriptDtoList.scriptType

integer

Script type (0: Wake-up Word, 1: Opening Line, 2: Waiting Phrase, 3: Unknown Question, 4: Farewell, 5: Interruption, 6: Interruption Sentence, 7: Guiding Phrase)

data.scriptDtoList.scriptContent

string

Script text

data.scriptDtoList.ttsContent

string

Script audio file URL

data.scriptDtoList.emotion

string

Emotion level

Close session Create avatar

⌘I

API reference

Authorizations

Query Parameters

Response