betteroff-finance Chat API
The chat API from betteroff-finance — 9 operation(s) for chat.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/betteroff-finance:betteroff-finance-chat-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: BetterOff Chat API
version: 0.5.0+cd65185c
servers:
- url: https://api.betteroff.finance
tags:
- name: Chat
paths:
/chat/browser-overview:
post:
operationId: postChatBrowserOverview
tags:
- Chat
security:
- session: []
requestBody:
required: true
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties: {}
additionalProperties: false
responses:
'200':
description: Success
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post chat browser overview
x-summary-source: derived
/chat:
post:
operationId: postChat
tags:
- Chat
security:
- session: []
requestBody:
required: true
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
messages:
minItems: 1
maxItems: 1
type: array
items: {}
requestId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
regenerateRunId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
conversationId:
type: string
model:
type: string
pageContext:
type: object
properties:
page:
type: string
minLength: 1
maxLength: 120
route:
type: string
maxLength: 800
format: starts_with
pattern: ^\/.*
filters:
type: object
propertyNames:
type: string
minLength: 1
maxLength: 80
additionalProperties:
type: string
minLength: 1
maxLength: 240
selection:
type: object
properties:
kind:
type: string
enum:
- transaction
- recurring
- debt
- transfer
- todo
id:
type: string
minLength: 1
maxLength: 200
required:
- kind
- id
required:
- page
- route
required:
- messages
responses:
'200':
description: Success
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post chat
x-summary-source: derived
/chat/usage:
get:
operationId: getChatUsage
tags:
- Chat
security:
- session: []
responses:
'200':
description: Success
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Get chat usage
x-summary-source: derived
/chat/consent-summary:
get:
operationId: getChatConsentSummary
tags:
- Chat
security:
- session: []
responses:
'200':
description: Success
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Get chat consent summary
x-summary-source: derived
/chat/conversations:
get:
operationId: getChatConversations
tags:
- Chat
security:
- session: []
parameters:
- name: query
in: query
required: false
schema:
type: string
- name: offset
in: query
required: false
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
conversations:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title:
type: string
latestMessageAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
source:
type: string
enum:
- web
- page
- imessage
- mcp
page:
type:
- string
- 'null'
required:
- id
- title
- latestMessageAt
- source
- page
additionalProperties: false
required:
- conversations
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Get chat conversations
x-summary-source: derived
/chat/conversations/{id}:
get:
operationId: getChatConversationsId
tags:
- Chat
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Get chat conversations id
x-summary-source: derived
patch:
operationId: patchChatConversationsId
tags:
- Chat
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
title:
type: string
minLength: 1
maxLength: 120
required:
- title
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title:
type:
- string
- 'null'
required:
- id
- title
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Patch chat conversations id
x-summary-source: derived
delete:
operationId: deleteChatConversationsId
tags:
- Chat
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No content
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Delete chat conversations id
x-summary-source: derived
/chat/runs/{id}:
get:
operationId: getChatRunsId
tags:
- Chat
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
run:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status:
type: string
enum:
- running
- completed
- failed
- aborted
reason:
type:
- string
- 'null'
conversationId:
anyOf:
- type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
assistantMessageId:
type:
- string
- 'null'
required:
- id
- status
- reason
- conversationId
- assistantMessageId
additionalProperties: false
message:
anyOf:
- type: object
properties:
id:
type: string
role:
type: string
parts:
type: array
items: {}
metadata: {}
required:
- id
- role
- parts
- metadata
additionalProperties: false
- type: 'null'
required:
- run
- message
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Get chat runs id
x-summary-source: derived
/chat/runs/{id}/cancel:
post:
operationId: postChatRunsIdCancel
tags:
- Chat
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
run:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status:
type: string
enum:
- running
- completed
- failed
- aborted
reason:
type:
- string
- 'null'
conversationId:
anyOf:
- type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
- type: 'null'
assistantMessageId:
type:
- string
- 'null'
required:
- id
- status
- reason
- conversationId
- assistantMessageId
additionalProperties: false
message:
anyOf:
- type: object
properties:
id:
type: string
role:
type: string
parts:
type: array
items: {}
metadata: {}
required:
- id
- role
- parts
- metadata
additionalProperties: false
- type: 'null'
required:
- run
- message
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post chat runs id cancel
x-summary-source: derived
/chat/feedback:
post:
operationId: postChatFeedback
tags:
- Chat
security:
- session: []
requestBody:
required: true
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
oneOf:
- type: object
properties:
eventType:
type: string
const: feedback
runId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
messageId:
type: string
minLength: 1
maxLength: 200
value:
type: string
enum:
- good_answer
- wrong
required:
- eventType
- runId
- messageId
- value
- type: object
properties:
eventType:
type: string
const: outcome_action
runId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
messageId:
type: string
minLength: 1
maxLength: 200
value:
type: string
enum:
- copy
required:
- eventType
- runId
- messageId
- value
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
ok:
type: boolean
const: true
recorded:
type: boolean
required:
- ok
- recorded
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post chat feedback
x-summary-source: derived
components:
schemas:
ProblemDetails:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
type:
type: string
description: Always "about:blank"; branch on `code`.
title:
type: string
status:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
detail:
type: string
code:
type: string
description: Stable UPPER_SNAKE code.
error:
type: string
description: Older clients' copy of `detail`.
message:
type: string
description: Older clients' copy of `detail`.
requestId:
description: Diagnostic only; quote it to support.
type: string
instance:
type: string
details:
type: object
propertyNames:
type: string
additionalProperties: {}
required:
- type
- title
- status
- detail
- code
- error
- message
additionalProperties: {}
description: RFC 9457 problem details. Some refusals add fields; ignore ones you don't know.
securitySchemes:
session:
type: http
scheme: bearer
description: 'The BetterOff app acting for its signed-in user. Not available to integrations: Better Auth session tokens and browser session cookies are rejected. Use an API token or agent OAuth.'
apiToken:
type: http
scheme: bearer
description: Personal API token (bo_pat_), created in BetterOff settings with the scopes it may use.
agentOAuth:
type: openIdConnect
openIdConnectUrl: https://app.betteroff.finance/api/auth/.well-known/openid-configuration
description: Agent OAuth grant; the same token and scopes as /mcp.