Skip to main content
POST
Ask Question

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ai_id
string
required

Body

application/json
question
string
required
session_id
string
required

Session ID It is recommended to use uuid

Maximum string length: 100
message_id
string<uuid>
anonymous_username
string
default:""
use_faq
boolean
default:true
max_tokens
integer
default:3000
stream
boolean
default:true
stream_obj
boolean
default:false
format
enum<string>
default:PLAIN_TEXT

An enumeration.

Available options:
PLAIN_TEXT,
JSON_AST,
OPENAI_AST
with_source
boolean
default:false
with_images
boolean
debug_with_messages
boolean
default:false

Debug only, use debug_with_messages: true, stream: false to get prompt messages

recommend_faq_id
string<uuid>
created_by
string
default:""
page_info
Page Info · object
is_test
boolean
default:false
metadata
QuestionMetadata · object[]
prompt_custom_goal
string
default:""

custom goal for prompt

Maximum string length: 200
dynamic_background
default:""

JSON string or dict for dynamic background information, used to add to agent meta prompt

language
string
agent_mode
string
model
string
user_identifier
string
tool_response
boolean
default:false
image_contents
Image Contents · object[]

多模态图片内容列表,格式: [{'url': 'data:image/png;base64,...', 'detail': 'auto'}]

Response

Successful Response

answer
messages
any[]
tool_calls
any[]