@beeable/sdk 0.6.3 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/app-runtime/data.d.ts +137 -0
- package/dist/app-runtime/data.d.ts.map +1 -0
- package/dist/app-runtime/data.js +360 -0
- package/dist/app-runtime/data.js.map +1 -0
- package/dist/app-runtime/index.d.ts +37 -27
- package/dist/app-runtime/index.d.ts.map +1 -1
- package/dist/app-runtime/index.js +64 -67
- package/dist/app-runtime/index.js.map +1 -1
- package/dist/app-runtime/typed-api.d.ts +196 -0
- package/dist/app-runtime/typed-api.d.ts.map +1 -0
- package/dist/app-runtime/typed-api.js +233 -0
- package/dist/app-runtime/typed-api.js.map +1 -0
- package/dist/generated/schemas/appTemplateResponseDto.d.ts +5 -3
- package/dist/generated/schemas/appTemplateResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/appTemplateResponseDto.js +84 -0
- package/dist/generated/schemas/appTemplateResponseDto.js.map +1 -1
- package/dist/generated/schemas/chatCompletionDto.d.ts +7 -6
- package/dist/generated/schemas/chatCompletionDto.d.ts.map +1 -1
- package/dist/generated/schemas/chatCompletionDtoToolChoice.d.ts +5 -3
- package/dist/generated/schemas/chatCompletionDtoToolChoice.d.ts.map +1 -1
- package/dist/generated/schemas/chatCompletionDtoToolChoice.js +0 -84
- package/dist/generated/schemas/chatCompletionDtoToolChoice.js.map +1 -1
- package/dist/generated/schemas/chatContentPartDto.d.ts +103 -0
- package/dist/generated/schemas/chatContentPartDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatContentPartDto.js +2 -0
- package/dist/generated/schemas/chatContentPartDto.js.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoContent.d.ts +91 -0
- package/dist/generated/schemas/chatContentPartDtoContent.d.ts.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoContent.js +86 -0
- package/dist/generated/schemas/chatContentPartDtoContent.js.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoImageUrl.d.ts +91 -0
- package/dist/generated/schemas/chatContentPartDtoImageUrl.d.ts.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoImageUrl.js +86 -0
- package/dist/generated/schemas/chatContentPartDtoImageUrl.js.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoInput.d.ts +91 -0
- package/dist/generated/schemas/chatContentPartDtoInput.d.ts.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoInput.js +86 -0
- package/dist/generated/schemas/chatContentPartDtoInput.js.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoType.d.ts +95 -0
- package/dist/generated/schemas/chatContentPartDtoType.d.ts.map +1 -0
- package/dist/generated/schemas/chatContentPartDtoType.js +92 -0
- package/dist/generated/schemas/chatContentPartDtoType.js.map +1 -0
- package/dist/generated/schemas/chatMessageDto.d.ts +3 -2
- package/dist/generated/schemas/chatMessageDto.d.ts.map +1 -1
- package/dist/generated/schemas/chatMessageDtoContent.d.ts +3 -4
- package/dist/generated/schemas/chatMessageDtoContent.d.ts.map +1 -1
- package/dist/generated/schemas/chatMessageDtoContent.js +0 -84
- package/dist/generated/schemas/chatMessageDtoContent.js.map +1 -1
- package/dist/generated/schemas/chatResponseFormatDto.d.ts +89 -0
- package/dist/generated/schemas/chatResponseFormatDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatResponseFormatDto.js +2 -0
- package/dist/generated/schemas/chatResponseFormatDto.js.map +1 -0
- package/dist/generated/schemas/chatResponseFormatDtoType.d.ts +90 -0
- package/dist/generated/schemas/chatResponseFormatDtoType.d.ts.map +1 -0
- package/dist/generated/schemas/chatResponseFormatDtoType.js +90 -0
- package/dist/generated/schemas/chatResponseFormatDtoType.js.map +1 -0
- package/dist/generated/schemas/chatStreamOptionsDto.d.ts +89 -0
- package/dist/generated/schemas/chatStreamOptionsDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatStreamOptionsDto.js +86 -0
- package/dist/generated/schemas/chatStreamOptionsDto.js.map +1 -0
- package/dist/generated/schemas/chatToolCallDto.d.ts +92 -0
- package/dist/generated/schemas/chatToolCallDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolCallDto.js +2 -0
- package/dist/generated/schemas/chatToolCallDto.js.map +1 -0
- package/dist/generated/schemas/chatToolCallDtoType.d.ts +89 -0
- package/dist/generated/schemas/chatToolCallDtoType.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolCallDtoType.js +89 -0
- package/dist/generated/schemas/chatToolCallDtoType.js.map +1 -0
- package/dist/generated/schemas/chatToolCallFunctionDto.d.ts +90 -0
- package/dist/generated/schemas/chatToolCallFunctionDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolCallFunctionDto.js +86 -0
- package/dist/generated/schemas/chatToolCallFunctionDto.js.map +1 -0
- package/dist/generated/schemas/chatToolChoiceDto.d.ts +91 -0
- package/dist/generated/schemas/chatToolChoiceDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolChoiceDto.js +2 -0
- package/dist/generated/schemas/chatToolChoiceDto.js.map +1 -0
- package/dist/generated/schemas/chatToolChoiceDtoType.d.ts +89 -0
- package/dist/generated/schemas/chatToolChoiceDtoType.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolChoiceDtoType.js +89 -0
- package/dist/generated/schemas/chatToolChoiceDtoType.js.map +1 -0
- package/dist/generated/schemas/chatToolChoiceFunctionDto.d.ts +88 -0
- package/dist/generated/schemas/chatToolChoiceFunctionDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolChoiceFunctionDto.js +86 -0
- package/dist/generated/schemas/chatToolChoiceFunctionDto.js.map +1 -0
- package/dist/generated/schemas/chatToolDto.d.ts +91 -0
- package/dist/generated/schemas/chatToolDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolDto.js +2 -0
- package/dist/generated/schemas/chatToolDto.js.map +1 -0
- package/dist/generated/schemas/chatToolDtoType.d.ts +89 -0
- package/dist/generated/schemas/chatToolDtoType.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolDtoType.js +89 -0
- package/dist/generated/schemas/chatToolDtoType.js.map +1 -0
- package/dist/generated/schemas/chatToolFunctionDto.d.ts +92 -0
- package/dist/generated/schemas/chatToolFunctionDto.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolFunctionDto.js +2 -0
- package/dist/generated/schemas/chatToolFunctionDto.js.map +1 -0
- package/dist/generated/schemas/chatToolFunctionDtoParameters.d.ts +91 -0
- package/dist/generated/schemas/chatToolFunctionDtoParameters.d.ts.map +1 -0
- package/dist/generated/schemas/chatToolFunctionDtoParameters.js +86 -0
- package/dist/generated/schemas/chatToolFunctionDtoParameters.js.map +1 -0
- package/dist/generated/schemas/connectIntegrationDto.d.ts +1 -1
- package/dist/generated/schemas/connectIntegrationDto.d.ts.map +1 -1
- package/dist/generated/schemas/connectIntegrationDtoConfig.d.ts +1 -1
- package/dist/generated/schemas/createTaskDto.d.ts +1 -1
- package/dist/generated/schemas/createTaskDto.d.ts.map +1 -1
- package/dist/generated/schemas/createTaskDtoInput.d.ts +1 -1
- package/dist/generated/schemas/eventExecutionResponseDto.d.ts +1 -0
- package/dist/generated/schemas/eventExecutionResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/eventExecutionResponseDtoTriggerPayload.d.ts +3 -0
- package/dist/generated/schemas/eventExecutionResponseDtoTriggerPayload.d.ts.map +1 -1
- package/dist/generated/schemas/eventExecutionStepResponseDto.d.ts +8 -2
- package/dist/generated/schemas/eventExecutionStepResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/eventExecutionStepResponseDtoInputPayload.d.ts +1 -0
- package/dist/generated/schemas/eventExecutionStepResponseDtoInputPayload.d.ts.map +1 -1
- package/dist/generated/schemas/eventExecutionStepResponseDtoTranslatedPayload.d.ts +1 -0
- package/dist/generated/schemas/eventExecutionStepResponseDtoTranslatedPayload.d.ts.map +1 -1
- package/dist/generated/schemas/flowStepDtoNext.d.ts +2 -1
- package/dist/generated/schemas/flowStepDtoNext.d.ts.map +1 -1
- package/dist/generated/schemas/flowStepDtoNext.js +0 -84
- package/dist/generated/schemas/flowStepDtoNext.js.map +1 -1
- package/dist/generated/schemas/index.d.ts +28 -0
- package/dist/generated/schemas/index.d.ts.map +1 -1
- package/dist/generated/schemas/index.js +28 -0
- package/dist/generated/schemas/index.js.map +1 -1
- package/dist/generated/schemas/inlineWidgetResponseDto.d.ts +6 -5
- package/dist/generated/schemas/inlineWidgetResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/inlineWidgetResponseDto.js +84 -0
- package/dist/generated/schemas/inlineWidgetResponseDto.js.map +1 -1
- package/dist/generated/schemas/integrationActionDto.d.ts +97 -0
- package/dist/generated/schemas/integrationActionDto.d.ts.map +1 -0
- package/dist/generated/schemas/integrationActionDto.js +2 -0
- package/dist/generated/schemas/integrationActionDto.js.map +1 -0
- package/dist/generated/schemas/integrationActionDtoInputSchema.d.ts +91 -0
- package/dist/generated/schemas/integrationActionDtoInputSchema.d.ts.map +1 -0
- package/dist/generated/schemas/integrationActionDtoInputSchema.js +86 -0
- package/dist/generated/schemas/integrationActionDtoInputSchema.js.map +1 -0
- package/dist/generated/schemas/integrationActionDtoOutputSchema.d.ts +91 -0
- package/dist/generated/schemas/integrationActionDtoOutputSchema.d.ts.map +1 -0
- package/dist/generated/schemas/integrationActionDtoOutputSchema.js +86 -0
- package/dist/generated/schemas/integrationActionDtoOutputSchema.js.map +1 -0
- package/dist/generated/schemas/integrationTypeInfoDto.d.ts +4 -4
- package/dist/generated/schemas/integrationTypeInfoDto.d.ts.map +1 -1
- package/dist/generated/schemas/integrationTypeInfoDtoConfigSchema.d.ts +1 -1
- package/dist/generated/schemas/memoryEdgeResponseDto.d.ts +4 -1
- package/dist/generated/schemas/memoryEdgeResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/memoryEdgeResponseDtoMetadata.d.ts +1 -0
- package/dist/generated/schemas/memoryEdgeResponseDtoMetadata.d.ts.map +1 -1
- package/dist/generated/schemas/messageAttachmentResponseDto.d.ts +2 -4
- package/dist/generated/schemas/messageAttachmentResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/messageAttachmentResponseDto.js +84 -0
- package/dist/generated/schemas/messageAttachmentResponseDto.js.map +1 -1
- package/dist/generated/schemas/messageResponseDto.d.ts +3 -3
- package/dist/generated/schemas/messageResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/orchestratorTaskResponseDto.d.ts +5 -1
- package/dist/generated/schemas/orchestratorTaskResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/orchestratorTaskResponseDtoInput.d.ts +3 -0
- package/dist/generated/schemas/orchestratorTaskResponseDtoInput.d.ts.map +1 -1
- package/dist/generated/schemas/orchestratorTaskResponseDtoResult.d.ts +1 -0
- package/dist/generated/schemas/orchestratorTaskResponseDtoResult.d.ts.map +1 -1
- package/dist/generated/schemas/organizationDetailResponseDto.d.ts +1 -0
- package/dist/generated/schemas/organizationDetailResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/organizationDetailResponseDtoSettings.d.ts +3 -0
- package/dist/generated/schemas/organizationDetailResponseDtoSettings.d.ts.map +1 -1
- package/dist/generated/schemas/organizationResponseDto.d.ts +1 -0
- package/dist/generated/schemas/organizationResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/organizationResponseDtoSettings.d.ts +3 -0
- package/dist/generated/schemas/organizationResponseDtoSettings.d.ts.map +1 -1
- package/dist/generated/schemas/pendingClarificationFieldDto.d.ts +103 -0
- package/dist/generated/schemas/pendingClarificationFieldDto.d.ts.map +1 -0
- package/dist/generated/schemas/pendingClarificationFieldDto.js +2 -0
- package/dist/generated/schemas/pendingClarificationFieldDto.js.map +1 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoDefaultValue.d.ts +89 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoDefaultValue.d.ts.map +1 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoDefaultValue.js +86 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoDefaultValue.js.map +1 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoType.d.ts +96 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoType.d.ts.map +1 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoType.js +93 -0
- package/dist/generated/schemas/pendingClarificationFieldDtoType.js.map +1 -0
- package/dist/generated/schemas/pendingClarificationResponseDto.d.ts +3 -4
- package/dist/generated/schemas/pendingClarificationResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/publishEventDto.d.ts +1 -1
- package/dist/generated/schemas/publishEventDto.d.ts.map +1 -1
- package/dist/generated/schemas/publishEventDtoPayload.d.ts +1 -1
- package/dist/generated/schemas/recordUsageDto.d.ts +1 -1
- package/dist/generated/schemas/recordUsageDto.d.ts.map +1 -1
- package/dist/generated/schemas/recordUsageDtoMetadata.d.ts +1 -1
- package/dist/generated/schemas/reportWidgetErrorDto.d.ts +4 -1
- package/dist/generated/schemas/reportWidgetErrorDto.d.ts.map +1 -1
- package/dist/generated/schemas/reportWidgetErrorDtoBody.d.ts +3 -2
- package/dist/generated/schemas/reportWidgetErrorDtoBody.d.ts.map +1 -1
- package/dist/generated/schemas/submitClarificationDto.d.ts +1 -1
- package/dist/generated/schemas/submitClarificationDto.d.ts.map +1 -1
- package/dist/generated/schemas/submitClarificationDtoValues.d.ts +2 -2
- package/dist/generated/schemas/submitClarificationDtoValues.d.ts.map +1 -1
- package/dist/generated/schemas/toolHistoryEntryDto.d.ts +102 -0
- package/dist/generated/schemas/toolHistoryEntryDto.d.ts.map +1 -0
- package/dist/generated/schemas/toolHistoryEntryDto.js +2 -0
- package/dist/generated/schemas/toolHistoryEntryDto.js.map +1 -0
- package/dist/generated/schemas/toolHistoryEntryDtoInput.d.ts +91 -0
- package/dist/generated/schemas/toolHistoryEntryDtoInput.d.ts.map +1 -0
- package/dist/generated/schemas/toolHistoryEntryDtoInput.js +86 -0
- package/dist/generated/schemas/toolHistoryEntryDtoInput.js.map +1 -0
- package/dist/generated/schemas/toolHistoryEntryDtoResult.d.ts +91 -0
- package/dist/generated/schemas/toolHistoryEntryDtoResult.d.ts.map +1 -0
- package/dist/generated/schemas/toolHistoryEntryDtoResult.js +86 -0
- package/dist/generated/schemas/toolHistoryEntryDtoResult.js.map +1 -0
- package/dist/generated/schemas/toolHistoryEntryDtoType.d.ts +93 -0
- package/dist/generated/schemas/toolHistoryEntryDtoType.d.ts.map +1 -0
- package/dist/generated/schemas/toolHistoryEntryDtoType.js +90 -0
- package/dist/generated/schemas/toolHistoryEntryDtoType.js.map +1 -0
- package/dist/generated/schemas/updateAdminOrganizationDto.d.ts +1 -1
- package/dist/generated/schemas/updateAdminOrganizationDto.d.ts.map +1 -1
- package/dist/generated/schemas/updateAdminOrganizationDtoSettings.d.ts +1 -1
- package/dist/generated/schemas/updateColleagueDto.d.ts +30 -18
- package/dist/generated/schemas/updateColleagueDto.d.ts.map +1 -1
- package/dist/generated/schemas/updateFlowDto.d.ts +5 -3
- package/dist/generated/schemas/updateFlowDto.d.ts.map +1 -1
- package/dist/generated/schemas/updateIntegrationDto.d.ts +1 -1
- package/dist/generated/schemas/updateIntegrationDto.d.ts.map +1 -1
- package/dist/generated/schemas/updateIntegrationDtoConfig.d.ts +1 -1
- package/dist/generated/schemas/updateOrganizationDto.d.ts +1 -0
- package/dist/generated/schemas/updateOrganizationDto.d.ts.map +1 -1
- package/dist/generated/schemas/updateOrganizationDtoSettings.d.ts +3 -0
- package/dist/generated/schemas/updateOrganizationDtoSettings.d.ts.map +1 -1
- package/dist/generated/schemas/updatedOrganizationResponseDto.d.ts +1 -0
- package/dist/generated/schemas/updatedOrganizationResponseDto.d.ts.map +1 -1
- package/dist/generated/schemas/updatedOrganizationResponseDtoSettings.d.ts +3 -0
- package/dist/generated/schemas/updatedOrganizationResponseDtoSettings.d.ts.map +1 -1
- package/dist/generated/schemas/widgetSqlDto.d.ts +1 -1
- package/dist/generated/schemas/widgetSqlDto.d.ts.map +1 -1
- package/dist/generated/schemas/widgetSqlDtoParamsItem.d.ts +4 -3
- package/dist/generated/schemas/widgetSqlDtoParamsItem.d.ts.map +1 -1
- package/package.json +6 -1
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Beeable API
|
|
5
|
+
* Orchestrator-first business agent platform — a multi-tenant platform where users talk to digital colleagues powered by AI.
|
|
6
|
+
|
|
7
|
+
## Authentication flow
|
|
8
|
+
|
|
9
|
+
1. **Register or login** — returns JWT with { sub } only (no org context).
|
|
10
|
+
2. **List organizations** — GET /auth/organizations to see which orgs the user belongs to.
|
|
11
|
+
3. **Select organization** — POST /auth/select-organization with an organizationId — returns new JWT with { sub, org }. Use GET /auth/me to resolve org-admin status.
|
|
12
|
+
4. **Use org-scoped endpoints** — all resource endpoints require the org-scoped token.
|
|
13
|
+
5. **Switch orgs** — call POST /auth/select-organization again with a different org.
|
|
14
|
+
6. **Token refresh** — POST /auth/refresh preserves org context.
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
Users create conversations with digital colleagues. Each colleague resolves its available tools and context from namespace bindings — tool availability is determined by which skills exist in the colleague's namespaces. Complex work is delegated to subagents via background tasks. Context profiles optionally pre-load condensed file/web page content into the system prompt.
|
|
19
|
+
|
|
20
|
+
## Namespaces & access control
|
|
21
|
+
|
|
22
|
+
All resources (databases, skills, apps, files, context profiles, widgets, memories) live in namespaces. Namespaces serve triple duty: group resources, define member visibility, and control permissions via role bindings. See the `namespaces` tag for the full RBAC model.
|
|
23
|
+
|
|
24
|
+
## Digital colleagues
|
|
25
|
+
|
|
26
|
+
Persistent AI team members with defined personas, optional model overrides, and namespace-scoped access. All conversations go through a colleague (the system colleague "Buzz" is the default). Colleagues can be invited into meetings for multi-party conversations.
|
|
27
|
+
|
|
28
|
+
## Skills
|
|
29
|
+
|
|
30
|
+
Org-scoped capability packages that bundle markdown instructions with tool access. Skills live in namespaces — a colleague gets a skill's tools if it has `skill:use` permission in that namespace. Tool execution is guarded: the streaming loop rejects any tool call not in the resolved set.
|
|
31
|
+
|
|
32
|
+
## Memories
|
|
33
|
+
|
|
34
|
+
Two-tier memory system: **org memories** (business facts about the org) and **user memories** (facts about individual users). Created via contemplation (post-conversation synthesis), explicit `remember_this` during conversation, or `manage_user_memory` tool. Injected into system prompts as background knowledge.
|
|
35
|
+
|
|
36
|
+
## Billing
|
|
37
|
+
|
|
38
|
+
Credit-based billing. Usage (AI tokens) is tracked and converted to credits via exchange rates. When credits run out, expensive operations return 402.
|
|
39
|
+
|
|
40
|
+
## File upload flow
|
|
41
|
+
|
|
42
|
+
POST /files as multipart/form-data with the file in the `file` field. The API stores the file, creates the record, and triggers condensation in a single request.
|
|
43
|
+
|
|
44
|
+
## Dynamic databases
|
|
45
|
+
|
|
46
|
+
Each organization can have multiple databases, each backed by its own isolated PostgreSQL schema. Databases are fully SQL-driven — no abstraction layer. Use POST /databases/:id/sql for DDL and DML. Supports migrations, forking, and promoting.
|
|
47
|
+
|
|
48
|
+
## Conversation SSE protocol
|
|
49
|
+
|
|
50
|
+
POST /conversations/:id/messages returns an SSE stream (Content-Type: text/event-stream). Events:
|
|
51
|
+
|
|
52
|
+
| Event | Data | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `text` | Raw text delta | Append to displayed message |
|
|
55
|
+
| `tool_use` | `{ "tool": "<name>", "status": "executing" }` | Orchestrator is calling a tool (show spinner) |
|
|
56
|
+
| `done` | `{ "content": "...", "retrievedUnits": [...], "usage": {...} }` | Stream complete |
|
|
57
|
+
| `error` | `{ "error": "..." }` | Error during streaming |
|
|
58
|
+
|
|
59
|
+
Parse SSE with `event:` and `data:` fields per the SSE spec. On `done`, stop listening and close the connection.
|
|
60
|
+
|
|
61
|
+
## Inline widgets
|
|
62
|
+
|
|
63
|
+
Lightweight React components rendered inside conversation messages. Created by the orchestrator during streaming via the `create_widget` tool. Widgets can be saved to a library for reuse.
|
|
64
|
+
|
|
65
|
+
## Apps
|
|
66
|
+
|
|
67
|
+
Per-org managed containers running Express. Each org gets its own container with apps served as Express routes. All app traffic is proxied through the API. Install pre-built templates or build custom apps.
|
|
68
|
+
|
|
69
|
+
## Member management
|
|
70
|
+
|
|
71
|
+
Org admins manage their team through invitations and namespace bindings:
|
|
72
|
+
|
|
73
|
+
1. **Invite** — POST /organizations/me/invitations with email → sends an invitation email with a link.
|
|
74
|
+
2. **View invitation** — GET /invitations/:token (public, no auth) → shows org name and whether the invitee has an account.
|
|
75
|
+
3. **Accept** — POST /invitations/:token/accept (auth required, email must match) → creates namespace binding. Then call POST /auth/select-organization to enter the org.
|
|
76
|
+
4. **Decline** — DELETE /invitations/:token (auth required) → permanently deletes the invitation.
|
|
77
|
+
5. **List members** — GET /organizations/me/members → all members with userId, email, displayName, joinedAt.
|
|
78
|
+
6. **Manage access** — use namespace bindings and system roles to control permissions (see `namespaces` tag).
|
|
79
|
+
|
|
80
|
+
## Context profiles
|
|
81
|
+
|
|
82
|
+
Context profiles are optional — a conversation can be created without one. When a profile is assigned to a namespace, colleagues with access to that namespace will have its tag and website sources loaded as condensed context into the system prompt.
|
|
83
|
+
* OpenAPI spec version: 2.0
|
|
84
|
+
*/
|
|
85
|
+
export interface ChatStreamOptionsDto {
|
|
86
|
+
/** Emit a final usage block in the stream. */
|
|
87
|
+
include_usage?: boolean;
|
|
88
|
+
}
|
|
89
|
+
//# sourceMappingURL=chatStreamOptionsDto.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chatStreamOptionsDto.d.ts","sourceRoot":"","sources":["../../../src/generated/schemas/chatStreamOptionsDto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AAEH,MAAM,WAAW,oBAAoB;IACnC,8CAA8C;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB"}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Beeable API
|
|
5
|
+
* Orchestrator-first business agent platform — a multi-tenant platform where users talk to digital colleagues powered by AI.
|
|
6
|
+
|
|
7
|
+
## Authentication flow
|
|
8
|
+
|
|
9
|
+
1. **Register or login** — returns JWT with { sub } only (no org context).
|
|
10
|
+
2. **List organizations** — GET /auth/organizations to see which orgs the user belongs to.
|
|
11
|
+
3. **Select organization** — POST /auth/select-organization with an organizationId — returns new JWT with { sub, org }. Use GET /auth/me to resolve org-admin status.
|
|
12
|
+
4. **Use org-scoped endpoints** — all resource endpoints require the org-scoped token.
|
|
13
|
+
5. **Switch orgs** — call POST /auth/select-organization again with a different org.
|
|
14
|
+
6. **Token refresh** — POST /auth/refresh preserves org context.
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
Users create conversations with digital colleagues. Each colleague resolves its available tools and context from namespace bindings — tool availability is determined by which skills exist in the colleague's namespaces. Complex work is delegated to subagents via background tasks. Context profiles optionally pre-load condensed file/web page content into the system prompt.
|
|
19
|
+
|
|
20
|
+
## Namespaces & access control
|
|
21
|
+
|
|
22
|
+
All resources (databases, skills, apps, files, context profiles, widgets, memories) live in namespaces. Namespaces serve triple duty: group resources, define member visibility, and control permissions via role bindings. See the `namespaces` tag for the full RBAC model.
|
|
23
|
+
|
|
24
|
+
## Digital colleagues
|
|
25
|
+
|
|
26
|
+
Persistent AI team members with defined personas, optional model overrides, and namespace-scoped access. All conversations go through a colleague (the system colleague "Buzz" is the default). Colleagues can be invited into meetings for multi-party conversations.
|
|
27
|
+
|
|
28
|
+
## Skills
|
|
29
|
+
|
|
30
|
+
Org-scoped capability packages that bundle markdown instructions with tool access. Skills live in namespaces — a colleague gets a skill's tools if it has `skill:use` permission in that namespace. Tool execution is guarded: the streaming loop rejects any tool call not in the resolved set.
|
|
31
|
+
|
|
32
|
+
## Memories
|
|
33
|
+
|
|
34
|
+
Two-tier memory system: **org memories** (business facts about the org) and **user memories** (facts about individual users). Created via contemplation (post-conversation synthesis), explicit `remember_this` during conversation, or `manage_user_memory` tool. Injected into system prompts as background knowledge.
|
|
35
|
+
|
|
36
|
+
## Billing
|
|
37
|
+
|
|
38
|
+
Credit-based billing. Usage (AI tokens) is tracked and converted to credits via exchange rates. When credits run out, expensive operations return 402.
|
|
39
|
+
|
|
40
|
+
## File upload flow
|
|
41
|
+
|
|
42
|
+
POST /files as multipart/form-data with the file in the `file` field. The API stores the file, creates the record, and triggers condensation in a single request.
|
|
43
|
+
|
|
44
|
+
## Dynamic databases
|
|
45
|
+
|
|
46
|
+
Each organization can have multiple databases, each backed by its own isolated PostgreSQL schema. Databases are fully SQL-driven — no abstraction layer. Use POST /databases/:id/sql for DDL and DML. Supports migrations, forking, and promoting.
|
|
47
|
+
|
|
48
|
+
## Conversation SSE protocol
|
|
49
|
+
|
|
50
|
+
POST /conversations/:id/messages returns an SSE stream (Content-Type: text/event-stream). Events:
|
|
51
|
+
|
|
52
|
+
| Event | Data | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `text` | Raw text delta | Append to displayed message |
|
|
55
|
+
| `tool_use` | `{ "tool": "<name>", "status": "executing" }` | Orchestrator is calling a tool (show spinner) |
|
|
56
|
+
| `done` | `{ "content": "...", "retrievedUnits": [...], "usage": {...} }` | Stream complete |
|
|
57
|
+
| `error` | `{ "error": "..." }` | Error during streaming |
|
|
58
|
+
|
|
59
|
+
Parse SSE with `event:` and `data:` fields per the SSE spec. On `done`, stop listening and close the connection.
|
|
60
|
+
|
|
61
|
+
## Inline widgets
|
|
62
|
+
|
|
63
|
+
Lightweight React components rendered inside conversation messages. Created by the orchestrator during streaming via the `create_widget` tool. Widgets can be saved to a library for reuse.
|
|
64
|
+
|
|
65
|
+
## Apps
|
|
66
|
+
|
|
67
|
+
Per-org managed containers running Express. Each org gets its own container with apps served as Express routes. All app traffic is proxied through the API. Install pre-built templates or build custom apps.
|
|
68
|
+
|
|
69
|
+
## Member management
|
|
70
|
+
|
|
71
|
+
Org admins manage their team through invitations and namespace bindings:
|
|
72
|
+
|
|
73
|
+
1. **Invite** — POST /organizations/me/invitations with email → sends an invitation email with a link.
|
|
74
|
+
2. **View invitation** — GET /invitations/:token (public, no auth) → shows org name and whether the invitee has an account.
|
|
75
|
+
3. **Accept** — POST /invitations/:token/accept (auth required, email must match) → creates namespace binding. Then call POST /auth/select-organization to enter the org.
|
|
76
|
+
4. **Decline** — DELETE /invitations/:token (auth required) → permanently deletes the invitation.
|
|
77
|
+
5. **List members** — GET /organizations/me/members → all members with userId, email, displayName, joinedAt.
|
|
78
|
+
6. **Manage access** — use namespace bindings and system roles to control permissions (see `namespaces` tag).
|
|
79
|
+
|
|
80
|
+
## Context profiles
|
|
81
|
+
|
|
82
|
+
Context profiles are optional — a conversation can be created without one. When a profile is assigned to a namespace, colleagues with access to that namespace will have its tag and website sources loaded as condensed context into the system prompt.
|
|
83
|
+
* OpenAPI spec version: 2.0
|
|
84
|
+
*/
|
|
85
|
+
export {};
|
|
86
|
+
//# sourceMappingURL=chatStreamOptionsDto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chatStreamOptionsDto.js","sourceRoot":"","sources":["../../../src/generated/schemas/chatStreamOptionsDto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG"}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Beeable API
|
|
5
|
+
* Orchestrator-first business agent platform — a multi-tenant platform where users talk to digital colleagues powered by AI.
|
|
6
|
+
|
|
7
|
+
## Authentication flow
|
|
8
|
+
|
|
9
|
+
1. **Register or login** — returns JWT with { sub } only (no org context).
|
|
10
|
+
2. **List organizations** — GET /auth/organizations to see which orgs the user belongs to.
|
|
11
|
+
3. **Select organization** — POST /auth/select-organization with an organizationId — returns new JWT with { sub, org }. Use GET /auth/me to resolve org-admin status.
|
|
12
|
+
4. **Use org-scoped endpoints** — all resource endpoints require the org-scoped token.
|
|
13
|
+
5. **Switch orgs** — call POST /auth/select-organization again with a different org.
|
|
14
|
+
6. **Token refresh** — POST /auth/refresh preserves org context.
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
Users create conversations with digital colleagues. Each colleague resolves its available tools and context from namespace bindings — tool availability is determined by which skills exist in the colleague's namespaces. Complex work is delegated to subagents via background tasks. Context profiles optionally pre-load condensed file/web page content into the system prompt.
|
|
19
|
+
|
|
20
|
+
## Namespaces & access control
|
|
21
|
+
|
|
22
|
+
All resources (databases, skills, apps, files, context profiles, widgets, memories) live in namespaces. Namespaces serve triple duty: group resources, define member visibility, and control permissions via role bindings. See the `namespaces` tag for the full RBAC model.
|
|
23
|
+
|
|
24
|
+
## Digital colleagues
|
|
25
|
+
|
|
26
|
+
Persistent AI team members with defined personas, optional model overrides, and namespace-scoped access. All conversations go through a colleague (the system colleague "Buzz" is the default). Colleagues can be invited into meetings for multi-party conversations.
|
|
27
|
+
|
|
28
|
+
## Skills
|
|
29
|
+
|
|
30
|
+
Org-scoped capability packages that bundle markdown instructions with tool access. Skills live in namespaces — a colleague gets a skill's tools if it has `skill:use` permission in that namespace. Tool execution is guarded: the streaming loop rejects any tool call not in the resolved set.
|
|
31
|
+
|
|
32
|
+
## Memories
|
|
33
|
+
|
|
34
|
+
Two-tier memory system: **org memories** (business facts about the org) and **user memories** (facts about individual users). Created via contemplation (post-conversation synthesis), explicit `remember_this` during conversation, or `manage_user_memory` tool. Injected into system prompts as background knowledge.
|
|
35
|
+
|
|
36
|
+
## Billing
|
|
37
|
+
|
|
38
|
+
Credit-based billing. Usage (AI tokens) is tracked and converted to credits via exchange rates. When credits run out, expensive operations return 402.
|
|
39
|
+
|
|
40
|
+
## File upload flow
|
|
41
|
+
|
|
42
|
+
POST /files as multipart/form-data with the file in the `file` field. The API stores the file, creates the record, and triggers condensation in a single request.
|
|
43
|
+
|
|
44
|
+
## Dynamic databases
|
|
45
|
+
|
|
46
|
+
Each organization can have multiple databases, each backed by its own isolated PostgreSQL schema. Databases are fully SQL-driven — no abstraction layer. Use POST /databases/:id/sql for DDL and DML. Supports migrations, forking, and promoting.
|
|
47
|
+
|
|
48
|
+
## Conversation SSE protocol
|
|
49
|
+
|
|
50
|
+
POST /conversations/:id/messages returns an SSE stream (Content-Type: text/event-stream). Events:
|
|
51
|
+
|
|
52
|
+
| Event | Data | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `text` | Raw text delta | Append to displayed message |
|
|
55
|
+
| `tool_use` | `{ "tool": "<name>", "status": "executing" }` | Orchestrator is calling a tool (show spinner) |
|
|
56
|
+
| `done` | `{ "content": "...", "retrievedUnits": [...], "usage": {...} }` | Stream complete |
|
|
57
|
+
| `error` | `{ "error": "..." }` | Error during streaming |
|
|
58
|
+
|
|
59
|
+
Parse SSE with `event:` and `data:` fields per the SSE spec. On `done`, stop listening and close the connection.
|
|
60
|
+
|
|
61
|
+
## Inline widgets
|
|
62
|
+
|
|
63
|
+
Lightweight React components rendered inside conversation messages. Created by the orchestrator during streaming via the `create_widget` tool. Widgets can be saved to a library for reuse.
|
|
64
|
+
|
|
65
|
+
## Apps
|
|
66
|
+
|
|
67
|
+
Per-org managed containers running Express. Each org gets its own container with apps served as Express routes. All app traffic is proxied through the API. Install pre-built templates or build custom apps.
|
|
68
|
+
|
|
69
|
+
## Member management
|
|
70
|
+
|
|
71
|
+
Org admins manage their team through invitations and namespace bindings:
|
|
72
|
+
|
|
73
|
+
1. **Invite** — POST /organizations/me/invitations with email → sends an invitation email with a link.
|
|
74
|
+
2. **View invitation** — GET /invitations/:token (public, no auth) → shows org name and whether the invitee has an account.
|
|
75
|
+
3. **Accept** — POST /invitations/:token/accept (auth required, email must match) → creates namespace binding. Then call POST /auth/select-organization to enter the org.
|
|
76
|
+
4. **Decline** — DELETE /invitations/:token (auth required) → permanently deletes the invitation.
|
|
77
|
+
5. **List members** — GET /organizations/me/members → all members with userId, email, displayName, joinedAt.
|
|
78
|
+
6. **Manage access** — use namespace bindings and system roles to control permissions (see `namespaces` tag).
|
|
79
|
+
|
|
80
|
+
## Context profiles
|
|
81
|
+
|
|
82
|
+
Context profiles are optional — a conversation can be created without one. When a profile is assigned to a namespace, colleagues with access to that namespace will have its tag and website sources loaded as condensed context into the system prompt.
|
|
83
|
+
* OpenAPI spec version: 2.0
|
|
84
|
+
*/
|
|
85
|
+
import type { ChatToolCallDtoType } from './chatToolCallDtoType';
|
|
86
|
+
import type { ChatToolCallFunctionDto } from './chatToolCallFunctionDto';
|
|
87
|
+
export interface ChatToolCallDto {
|
|
88
|
+
id: string;
|
|
89
|
+
type: ChatToolCallDtoType;
|
|
90
|
+
function: ChatToolCallFunctionDto;
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=chatToolCallDto.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chatToolCallDto.d.ts","sourceRoot":"","sources":["../../../src/generated/schemas/chatToolCallDto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AACH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,QAAQ,EAAE,uBAAuB,CAAC;CACnC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chatToolCallDto.js","sourceRoot":"","sources":["../../../src/generated/schemas/chatToolCallDto.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Beeable API
|
|
5
|
+
* Orchestrator-first business agent platform — a multi-tenant platform where users talk to digital colleagues powered by AI.
|
|
6
|
+
|
|
7
|
+
## Authentication flow
|
|
8
|
+
|
|
9
|
+
1. **Register or login** — returns JWT with { sub } only (no org context).
|
|
10
|
+
2. **List organizations** — GET /auth/organizations to see which orgs the user belongs to.
|
|
11
|
+
3. **Select organization** — POST /auth/select-organization with an organizationId — returns new JWT with { sub, org }. Use GET /auth/me to resolve org-admin status.
|
|
12
|
+
4. **Use org-scoped endpoints** — all resource endpoints require the org-scoped token.
|
|
13
|
+
5. **Switch orgs** — call POST /auth/select-organization again with a different org.
|
|
14
|
+
6. **Token refresh** — POST /auth/refresh preserves org context.
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
Users create conversations with digital colleagues. Each colleague resolves its available tools and context from namespace bindings — tool availability is determined by which skills exist in the colleague's namespaces. Complex work is delegated to subagents via background tasks. Context profiles optionally pre-load condensed file/web page content into the system prompt.
|
|
19
|
+
|
|
20
|
+
## Namespaces & access control
|
|
21
|
+
|
|
22
|
+
All resources (databases, skills, apps, files, context profiles, widgets, memories) live in namespaces. Namespaces serve triple duty: group resources, define member visibility, and control permissions via role bindings. See the `namespaces` tag for the full RBAC model.
|
|
23
|
+
|
|
24
|
+
## Digital colleagues
|
|
25
|
+
|
|
26
|
+
Persistent AI team members with defined personas, optional model overrides, and namespace-scoped access. All conversations go through a colleague (the system colleague "Buzz" is the default). Colleagues can be invited into meetings for multi-party conversations.
|
|
27
|
+
|
|
28
|
+
## Skills
|
|
29
|
+
|
|
30
|
+
Org-scoped capability packages that bundle markdown instructions with tool access. Skills live in namespaces — a colleague gets a skill's tools if it has `skill:use` permission in that namespace. Tool execution is guarded: the streaming loop rejects any tool call not in the resolved set.
|
|
31
|
+
|
|
32
|
+
## Memories
|
|
33
|
+
|
|
34
|
+
Two-tier memory system: **org memories** (business facts about the org) and **user memories** (facts about individual users). Created via contemplation (post-conversation synthesis), explicit `remember_this` during conversation, or `manage_user_memory` tool. Injected into system prompts as background knowledge.
|
|
35
|
+
|
|
36
|
+
## Billing
|
|
37
|
+
|
|
38
|
+
Credit-based billing. Usage (AI tokens) is tracked and converted to credits via exchange rates. When credits run out, expensive operations return 402.
|
|
39
|
+
|
|
40
|
+
## File upload flow
|
|
41
|
+
|
|
42
|
+
POST /files as multipart/form-data with the file in the `file` field. The API stores the file, creates the record, and triggers condensation in a single request.
|
|
43
|
+
|
|
44
|
+
## Dynamic databases
|
|
45
|
+
|
|
46
|
+
Each organization can have multiple databases, each backed by its own isolated PostgreSQL schema. Databases are fully SQL-driven — no abstraction layer. Use POST /databases/:id/sql for DDL and DML. Supports migrations, forking, and promoting.
|
|
47
|
+
|
|
48
|
+
## Conversation SSE protocol
|
|
49
|
+
|
|
50
|
+
POST /conversations/:id/messages returns an SSE stream (Content-Type: text/event-stream). Events:
|
|
51
|
+
|
|
52
|
+
| Event | Data | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `text` | Raw text delta | Append to displayed message |
|
|
55
|
+
| `tool_use` | `{ "tool": "<name>", "status": "executing" }` | Orchestrator is calling a tool (show spinner) |
|
|
56
|
+
| `done` | `{ "content": "...", "retrievedUnits": [...], "usage": {...} }` | Stream complete |
|
|
57
|
+
| `error` | `{ "error": "..." }` | Error during streaming |
|
|
58
|
+
|
|
59
|
+
Parse SSE with `event:` and `data:` fields per the SSE spec. On `done`, stop listening and close the connection.
|
|
60
|
+
|
|
61
|
+
## Inline widgets
|
|
62
|
+
|
|
63
|
+
Lightweight React components rendered inside conversation messages. Created by the orchestrator during streaming via the `create_widget` tool. Widgets can be saved to a library for reuse.
|
|
64
|
+
|
|
65
|
+
## Apps
|
|
66
|
+
|
|
67
|
+
Per-org managed containers running Express. Each org gets its own container with apps served as Express routes. All app traffic is proxied through the API. Install pre-built templates or build custom apps.
|
|
68
|
+
|
|
69
|
+
## Member management
|
|
70
|
+
|
|
71
|
+
Org admins manage their team through invitations and namespace bindings:
|
|
72
|
+
|
|
73
|
+
1. **Invite** — POST /organizations/me/invitations with email → sends an invitation email with a link.
|
|
74
|
+
2. **View invitation** — GET /invitations/:token (public, no auth) → shows org name and whether the invitee has an account.
|
|
75
|
+
3. **Accept** — POST /invitations/:token/accept (auth required, email must match) → creates namespace binding. Then call POST /auth/select-organization to enter the org.
|
|
76
|
+
4. **Decline** — DELETE /invitations/:token (auth required) → permanently deletes the invitation.
|
|
77
|
+
5. **List members** — GET /organizations/me/members → all members with userId, email, displayName, joinedAt.
|
|
78
|
+
6. **Manage access** — use namespace bindings and system roles to control permissions (see `namespaces` tag).
|
|
79
|
+
|
|
80
|
+
## Context profiles
|
|
81
|
+
|
|
82
|
+
Context profiles are optional — a conversation can be created without one. When a profile is assigned to a namespace, colleagues with access to that namespace will have its tag and website sources loaded as condensed context into the system prompt.
|
|
83
|
+
* OpenAPI spec version: 2.0
|
|
84
|
+
*/
|
|
85
|
+
export type ChatToolCallDtoType = typeof ChatToolCallDtoType[keyof typeof ChatToolCallDtoType];
|
|
86
|
+
export declare const ChatToolCallDtoType: {
|
|
87
|
+
readonly function: "function";
|
|
88
|
+
};
|
|
89
|
+
//# sourceMappingURL=chatToolCallDtoType.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chatToolCallDtoType.d.ts","sourceRoot":"","sources":["../../../src/generated/schemas/chatToolCallDtoType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AAEH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAI/F,eAAO,MAAM,mBAAmB;;CAEtB,CAAC"}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Beeable API
|
|
5
|
+
* Orchestrator-first business agent platform — a multi-tenant platform where users talk to digital colleagues powered by AI.
|
|
6
|
+
|
|
7
|
+
## Authentication flow
|
|
8
|
+
|
|
9
|
+
1. **Register or login** — returns JWT with { sub } only (no org context).
|
|
10
|
+
2. **List organizations** — GET /auth/organizations to see which orgs the user belongs to.
|
|
11
|
+
3. **Select organization** — POST /auth/select-organization with an organizationId — returns new JWT with { sub, org }. Use GET /auth/me to resolve org-admin status.
|
|
12
|
+
4. **Use org-scoped endpoints** — all resource endpoints require the org-scoped token.
|
|
13
|
+
5. **Switch orgs** — call POST /auth/select-organization again with a different org.
|
|
14
|
+
6. **Token refresh** — POST /auth/refresh preserves org context.
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
Users create conversations with digital colleagues. Each colleague resolves its available tools and context from namespace bindings — tool availability is determined by which skills exist in the colleague's namespaces. Complex work is delegated to subagents via background tasks. Context profiles optionally pre-load condensed file/web page content into the system prompt.
|
|
19
|
+
|
|
20
|
+
## Namespaces & access control
|
|
21
|
+
|
|
22
|
+
All resources (databases, skills, apps, files, context profiles, widgets, memories) live in namespaces. Namespaces serve triple duty: group resources, define member visibility, and control permissions via role bindings. See the `namespaces` tag for the full RBAC model.
|
|
23
|
+
|
|
24
|
+
## Digital colleagues
|
|
25
|
+
|
|
26
|
+
Persistent AI team members with defined personas, optional model overrides, and namespace-scoped access. All conversations go through a colleague (the system colleague "Buzz" is the default). Colleagues can be invited into meetings for multi-party conversations.
|
|
27
|
+
|
|
28
|
+
## Skills
|
|
29
|
+
|
|
30
|
+
Org-scoped capability packages that bundle markdown instructions with tool access. Skills live in namespaces — a colleague gets a skill's tools if it has `skill:use` permission in that namespace. Tool execution is guarded: the streaming loop rejects any tool call not in the resolved set.
|
|
31
|
+
|
|
32
|
+
## Memories
|
|
33
|
+
|
|
34
|
+
Two-tier memory system: **org memories** (business facts about the org) and **user memories** (facts about individual users). Created via contemplation (post-conversation synthesis), explicit `remember_this` during conversation, or `manage_user_memory` tool. Injected into system prompts as background knowledge.
|
|
35
|
+
|
|
36
|
+
## Billing
|
|
37
|
+
|
|
38
|
+
Credit-based billing. Usage (AI tokens) is tracked and converted to credits via exchange rates. When credits run out, expensive operations return 402.
|
|
39
|
+
|
|
40
|
+
## File upload flow
|
|
41
|
+
|
|
42
|
+
POST /files as multipart/form-data with the file in the `file` field. The API stores the file, creates the record, and triggers condensation in a single request.
|
|
43
|
+
|
|
44
|
+
## Dynamic databases
|
|
45
|
+
|
|
46
|
+
Each organization can have multiple databases, each backed by its own isolated PostgreSQL schema. Databases are fully SQL-driven — no abstraction layer. Use POST /databases/:id/sql for DDL and DML. Supports migrations, forking, and promoting.
|
|
47
|
+
|
|
48
|
+
## Conversation SSE protocol
|
|
49
|
+
|
|
50
|
+
POST /conversations/:id/messages returns an SSE stream (Content-Type: text/event-stream). Events:
|
|
51
|
+
|
|
52
|
+
| Event | Data | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `text` | Raw text delta | Append to displayed message |
|
|
55
|
+
| `tool_use` | `{ "tool": "<name>", "status": "executing" }` | Orchestrator is calling a tool (show spinner) |
|
|
56
|
+
| `done` | `{ "content": "...", "retrievedUnits": [...], "usage": {...} }` | Stream complete |
|
|
57
|
+
| `error` | `{ "error": "..." }` | Error during streaming |
|
|
58
|
+
|
|
59
|
+
Parse SSE with `event:` and `data:` fields per the SSE spec. On `done`, stop listening and close the connection.
|
|
60
|
+
|
|
61
|
+
## Inline widgets
|
|
62
|
+
|
|
63
|
+
Lightweight React components rendered inside conversation messages. Created by the orchestrator during streaming via the `create_widget` tool. Widgets can be saved to a library for reuse.
|
|
64
|
+
|
|
65
|
+
## Apps
|
|
66
|
+
|
|
67
|
+
Per-org managed containers running Express. Each org gets its own container with apps served as Express routes. All app traffic is proxied through the API. Install pre-built templates or build custom apps.
|
|
68
|
+
|
|
69
|
+
## Member management
|
|
70
|
+
|
|
71
|
+
Org admins manage their team through invitations and namespace bindings:
|
|
72
|
+
|
|
73
|
+
1. **Invite** — POST /organizations/me/invitations with email → sends an invitation email with a link.
|
|
74
|
+
2. **View invitation** — GET /invitations/:token (public, no auth) → shows org name and whether the invitee has an account.
|
|
75
|
+
3. **Accept** — POST /invitations/:token/accept (auth required, email must match) → creates namespace binding. Then call POST /auth/select-organization to enter the org.
|
|
76
|
+
4. **Decline** — DELETE /invitations/:token (auth required) → permanently deletes the invitation.
|
|
77
|
+
5. **List members** — GET /organizations/me/members → all members with userId, email, displayName, joinedAt.
|
|
78
|
+
6. **Manage access** — use namespace bindings and system roles to control permissions (see `namespaces` tag).
|
|
79
|
+
|
|
80
|
+
## Context profiles
|
|
81
|
+
|
|
82
|
+
Context profiles are optional — a conversation can be created without one. When a profile is assigned to a namespace, colleagues with access to that namespace will have its tag and website sources loaded as condensed context into the system prompt.
|
|
83
|
+
* OpenAPI spec version: 2.0
|
|
84
|
+
*/
|
|
85
|
+
// eslint-disable-next-line @typescript-eslint/no-redeclare
|
|
86
|
+
export const ChatToolCallDtoType = {
|
|
87
|
+
function: 'function',
|
|
88
|
+
};
|
|
89
|
+
//# sourceMappingURL=chatToolCallDtoType.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chatToolCallDtoType.js","sourceRoot":"","sources":["../../../src/generated/schemas/chatToolCallDtoType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AAKH,2DAA2D;AAC3D,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,QAAQ,EAAE,UAAU;CACZ,CAAC"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by orval v7.21.0 🍺
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
* Beeable API
|
|
5
|
+
* Orchestrator-first business agent platform — a multi-tenant platform where users talk to digital colleagues powered by AI.
|
|
6
|
+
|
|
7
|
+
## Authentication flow
|
|
8
|
+
|
|
9
|
+
1. **Register or login** — returns JWT with { sub } only (no org context).
|
|
10
|
+
2. **List organizations** — GET /auth/organizations to see which orgs the user belongs to.
|
|
11
|
+
3. **Select organization** — POST /auth/select-organization with an organizationId — returns new JWT with { sub, org }. Use GET /auth/me to resolve org-admin status.
|
|
12
|
+
4. **Use org-scoped endpoints** — all resource endpoints require the org-scoped token.
|
|
13
|
+
5. **Switch orgs** — call POST /auth/select-organization again with a different org.
|
|
14
|
+
6. **Token refresh** — POST /auth/refresh preserves org context.
|
|
15
|
+
|
|
16
|
+
## Architecture
|
|
17
|
+
|
|
18
|
+
Users create conversations with digital colleagues. Each colleague resolves its available tools and context from namespace bindings — tool availability is determined by which skills exist in the colleague's namespaces. Complex work is delegated to subagents via background tasks. Context profiles optionally pre-load condensed file/web page content into the system prompt.
|
|
19
|
+
|
|
20
|
+
## Namespaces & access control
|
|
21
|
+
|
|
22
|
+
All resources (databases, skills, apps, files, context profiles, widgets, memories) live in namespaces. Namespaces serve triple duty: group resources, define member visibility, and control permissions via role bindings. See the `namespaces` tag for the full RBAC model.
|
|
23
|
+
|
|
24
|
+
## Digital colleagues
|
|
25
|
+
|
|
26
|
+
Persistent AI team members with defined personas, optional model overrides, and namespace-scoped access. All conversations go through a colleague (the system colleague "Buzz" is the default). Colleagues can be invited into meetings for multi-party conversations.
|
|
27
|
+
|
|
28
|
+
## Skills
|
|
29
|
+
|
|
30
|
+
Org-scoped capability packages that bundle markdown instructions with tool access. Skills live in namespaces — a colleague gets a skill's tools if it has `skill:use` permission in that namespace. Tool execution is guarded: the streaming loop rejects any tool call not in the resolved set.
|
|
31
|
+
|
|
32
|
+
## Memories
|
|
33
|
+
|
|
34
|
+
Two-tier memory system: **org memories** (business facts about the org) and **user memories** (facts about individual users). Created via contemplation (post-conversation synthesis), explicit `remember_this` during conversation, or `manage_user_memory` tool. Injected into system prompts as background knowledge.
|
|
35
|
+
|
|
36
|
+
## Billing
|
|
37
|
+
|
|
38
|
+
Credit-based billing. Usage (AI tokens) is tracked and converted to credits via exchange rates. When credits run out, expensive operations return 402.
|
|
39
|
+
|
|
40
|
+
## File upload flow
|
|
41
|
+
|
|
42
|
+
POST /files as multipart/form-data with the file in the `file` field. The API stores the file, creates the record, and triggers condensation in a single request.
|
|
43
|
+
|
|
44
|
+
## Dynamic databases
|
|
45
|
+
|
|
46
|
+
Each organization can have multiple databases, each backed by its own isolated PostgreSQL schema. Databases are fully SQL-driven — no abstraction layer. Use POST /databases/:id/sql for DDL and DML. Supports migrations, forking, and promoting.
|
|
47
|
+
|
|
48
|
+
## Conversation SSE protocol
|
|
49
|
+
|
|
50
|
+
POST /conversations/:id/messages returns an SSE stream (Content-Type: text/event-stream). Events:
|
|
51
|
+
|
|
52
|
+
| Event | Data | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `text` | Raw text delta | Append to displayed message |
|
|
55
|
+
| `tool_use` | `{ "tool": "<name>", "status": "executing" }` | Orchestrator is calling a tool (show spinner) |
|
|
56
|
+
| `done` | `{ "content": "...", "retrievedUnits": [...], "usage": {...} }` | Stream complete |
|
|
57
|
+
| `error` | `{ "error": "..." }` | Error during streaming |
|
|
58
|
+
|
|
59
|
+
Parse SSE with `event:` and `data:` fields per the SSE spec. On `done`, stop listening and close the connection.
|
|
60
|
+
|
|
61
|
+
## Inline widgets
|
|
62
|
+
|
|
63
|
+
Lightweight React components rendered inside conversation messages. Created by the orchestrator during streaming via the `create_widget` tool. Widgets can be saved to a library for reuse.
|
|
64
|
+
|
|
65
|
+
## Apps
|
|
66
|
+
|
|
67
|
+
Per-org managed containers running Express. Each org gets its own container with apps served as Express routes. All app traffic is proxied through the API. Install pre-built templates or build custom apps.
|
|
68
|
+
|
|
69
|
+
## Member management
|
|
70
|
+
|
|
71
|
+
Org admins manage their team through invitations and namespace bindings:
|
|
72
|
+
|
|
73
|
+
1. **Invite** — POST /organizations/me/invitations with email → sends an invitation email with a link.
|
|
74
|
+
2. **View invitation** — GET /invitations/:token (public, no auth) → shows org name and whether the invitee has an account.
|
|
75
|
+
3. **Accept** — POST /invitations/:token/accept (auth required, email must match) → creates namespace binding. Then call POST /auth/select-organization to enter the org.
|
|
76
|
+
4. **Decline** — DELETE /invitations/:token (auth required) → permanently deletes the invitation.
|
|
77
|
+
5. **List members** — GET /organizations/me/members → all members with userId, email, displayName, joinedAt.
|
|
78
|
+
6. **Manage access** — use namespace bindings and system roles to control permissions (see `namespaces` tag).
|
|
79
|
+
|
|
80
|
+
## Context profiles
|
|
81
|
+
|
|
82
|
+
Context profiles are optional — a conversation can be created without one. When a profile is assigned to a namespace, colleagues with access to that namespace will have its tag and website sources loaded as condensed context into the system prompt.
|
|
83
|
+
* OpenAPI spec version: 2.0
|
|
84
|
+
*/
|
|
85
|
+
export interface ChatToolCallFunctionDto {
|
|
86
|
+
name: string;
|
|
87
|
+
/** JSON-encoded arguments */
|
|
88
|
+
arguments: string;
|
|
89
|
+
}
|
|
90
|
+
//# sourceMappingURL=chatToolCallFunctionDto.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chatToolCallFunctionDto.d.ts","sourceRoot":"","sources":["../../../src/generated/schemas/chatToolCallFunctionDto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AAEH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB"}
|