Skip to main content
POST
Send a message to the AI assistant (experimental — Soul Document V2 prompt)

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json

Request payload for AI Q&A conversation

inputs
string[]
required

User messages to send to the AI

Example:
id
number

Client-generated request identifier (epoch timestamp)

Example:

1750660464754

requestArgs
object

Context arguments for AI conversation requests

outputs
string[]

Previous AI responses (for context continuity)

Example:

Response

AI response generated successfully (Soul Document V2 system prompt)

Response from AI Q&A conversation

success
boolean

Whether the request completed successfully

streamingFailed
boolean

True if Socket.IO streaming failed (response still contains full output)

streamingError
string

Error message if streaming failed

outputs
string[]

AI-generated response messages

usage
number

Total tokens consumed (input + output)

credits
number

Credits consumed for this request

creditsUsed
number

User's total credits consumed

totalCredits
number

User's remaining credit balance

query_duration_ms
number

Total processing time in milliseconds

model
string

AI model identifier used for generation

Example:

"gpt-4o"

conducted
boolean

Pricing modality — true when the turn was billed on the subagent-modality lanes (conversation + orchestrator + workers at true model cost × margin), false/absent for flat single-shot pricing (10,000 tokens = 1 credit)

creditsBreakdown
object

Per-lane fractional credits (post-margin) summed into the billed integer — voice (conversation), conductor (orchestrator), subagents (workers). Present on billed turns only.

conductorCredits
number

Orchestrator-lane fractional credits (subagent-modality turns only)

costMargin
number

The cost margin applied to the subagent-modality lanes on this turn (e.g. 1.5)