Skip to content

AI Chat

POST
/api/v1/ai/chat

Send a message to the AI financial coach. Returns a streamed response. Subject to monthly AI rate limits based on subscription tier.

object
message
required

User message to the AI coach

string
>= 1 characters <= 2000 characters
Example
How can I optimize my savings rate for FIRE?
conversationId

Existing conversation ID for follow-up messages

string format: uuid
category

AI coach category for context

string
Example
fi-planning

AI chat response (streamed SSE)

object
success
required
boolean
data
required
object
conversationId
required

Conversation ID for follow-up messages

string format: uuid
message
required

AI response text

string

Validation error

object
success
required

Always false for error responses

boolean
error
required

Error type

string
Example
Validation error
code

Machine-readable error code

string
Example
VALIDATION_ERROR
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
Example
currentAge
message
required

Error message

string
Example
Must be between 18 and 100

Unauthorized

object
success
required

Always false for error responses

boolean
error
required

Error type

string
Example
Validation error
code

Machine-readable error code

string
Example
VALIDATION_ERROR
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
Example
currentAge
message
required

Error message

string
Example
Must be between 18 and 100

AI rate limit exceeded

object
success
required

Always false for error responses

boolean
error
required

Error type

string
Example
Validation error
code

Machine-readable error code

string
Example
VALIDATION_ERROR
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
Example
currentAge
message
required

Error message

string
Example
Must be between 18 and 100