Get recommended questions

POST 
/v1/aibot/bots/:botId/recommend-questions

Get recommended questions

Request

Path Parameters

botId stringrequired
Agent ID
Example: bot-xxx

application/json

Body

required

name string

Agent name

introduction string

Agent introduction

agentSetting string

Agent setting

msg string

User message content

history object[]
Conversation history
Array [
role stringrequired
Message role
content stringrequired
Message content
]

Responses

200

Returned upon successful retrieval of recommended questions in SSE format.

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

created number

Conversation timestamp

record_id string

Conversation record ID

model string

Large model type

version string

Large model version

type string

Response type: text: main answer content, thinking: thinking process, search: search results, knowledge: knowledge base

role string

Conversation role, fixed as assistant in the response

content string

Conversation content

finish_reason string

Conversation end flag, 'continue' means the conversation is not over, 'stop' means the conversation is over

reasoning_content string

Deep thinking content (only deepseek-r1 is not an empty string)

usage object

token usage

promptTokens number

Indicates the number of tokens in the prompt, remains unchanged across multiple responses

completionTokens number

Total tokens in the response. In streaming responses, represents the cumulative total of all completion tokens up to now, continues to accumulate across multiple responses

totalTokens number

Represents the sum of promptTokens and completionTokens

knowledge_base string[]

Knowledge base used in the conversation

search_info object
Search result information, requires enabling web search
search_results undefined[]
Search citation information
Array [
index string
Citation index
title string
Citation title
url string
Citation URL
]

Example (from schema)

{
  "created": "1726030224",
  "record_id": "record-427d3652",
  "model": "hunyuan",
  "version": "202407241700",
  "type": "assistant",
  "role": "assistant",
  "content": "Hello",
  "finish_reason": "continue",
  "reasoning_content": "",
  "usage": {
    "promptTokens": 10,
    "completionTokens": 20,
    "totalTokens": 30
  },
  "knowledge_base": [
    ""
  ],
  "search_info": {
    "search_results": [
      {
        "index": "[1]",
        "title": "Sample Title",
        "url": "https://example.com"
      }
    ]
  }
}

default

Returned when getting recommended questions fails

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Request ID

Example (from schema)

{
  "code": "INVALID_CREDENTIALS",
  "message": "Credentials are invalid",
  "requestId": "6360ba4b-f672-434b-9dee-35686a5589a4"
}

Loading...