Skip to main content
POST
/
v1
/
question
/
{ai_id}
Ask Question
curl --request POST \
  --url https://api.gbase.ai/v1/question/{ai_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "question": "<string>",
  "session_id": "<string>",
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "anonymous_username": "",
  "use_faq": true,
  "max_tokens": 3000,
  "stream": false,
  "stream_obj": false,
  "format": "PLAIN_TEXT",
  "with_source": false,
  "with_images": true,
  "debug_with_messages": false,
  "recommend_faq_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "",
  "page_info": {},
  "is_test": false,
  "metadata": [],
  "prompt_custom_goal": "",
  "dynamic_background": "<string>",
  "language": "<string>",
  "agent_mode": "<string>",
  "model": "<string>",
  "user_identifier": "<string>"
}'
{
  "answer": "<string>",
  "messages": [
    "<any>"
  ],
  "tool_calls": [
    "<any>"
  ]
}

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
Maximum length: 65535
session_id
string
required

Session ID It is recommended to use uuid

Maximum length: 100
message_id
string<uuid>
anonymous_username
string
default:""
use_faq
boolean
default:true
max_tokens
integer
default:3000
stream
boolean
default:false
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
object
is_test
boolean
default:false
metadata
QuestionMetadata · object[]
prompt_custom_goal
string
default:""

custom goal for prompt

Maximum length: 200
dynamic_background
default:""

json格式字符串或者字典, 动态背景背景信息, 用于添加到agent的meta prompt中

language
string
agent_mode
string
model
string
user_identifier
string

Response

Successful Response

answer
messages
any[]
tool_calls
any[]
I