Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18029,7 +18029,7 @@ paths:
- Memory
operationId: listMemories
summary: List a person's memories
description: 'Return one page of what a person''s Bots remember about them, most recently changed first: the ones they wrote, the ones their Bots formed and are waiting for their review, the ones read in from their sources, and the ones the backend holds for them that OpenBot formed no record of, after OpenBot''s own. Paused memories are included; forgotten ones are not. Only the person themselves may list them: an administrator can''t either. A missing cursor starts at the first page and nextCursor null ends the list.'
description: 'Return one page of what a person''s Bots remember about them in this organization, and in no other they belong to, most recently changed first: the ones they wrote, the ones their Bots formed and are waiting for their review, the ones read in from their sources, and the ones the backend holds for them that OpenBot formed no record of, after OpenBot''s own. Paused memories are included; forgotten ones are not. Only the person themselves may list them: an administrator can''t either. A missing cursor starts at the first page and nextCursor null ends the list.'
security:
- webSession: []
- appOAuth:
Expand Down Expand Up @@ -22815,6 +22815,9 @@ components:
threadId:
type: string
description: The new thread's id.
liveThreadId:
type: string
description: The id that live updates about this thread carry. Compare an incoming update with this one, and use threadId everywhere else. It is threadId itself in the organization default. Left out by a server that names threads one way only, where it is threadId.
ConversationThreadStatus:
type: object
required:
Expand All @@ -22826,6 +22829,9 @@ components:
known:
type: boolean
description: Whether the thread still holds the caller's conversation.
liveThreadId:
type: string
description: The id that live updates about this thread carry. Compare an incoming update with this one, and use threadId everywhere else. It is threadId itself in the organization default. Left out by a server that names threads one way only, where it is threadId.
TaskStatus:
type: string
enum:
Expand Down Expand Up @@ -32354,6 +32360,11 @@ components:
oneOf:
- $ref: '#/components/schemas/LearningAutomatic'
- type: 'null'
organizationSpaceId:
description: 'The space OpenBot keeps for this organization alone, which its Bots learn into unless an administrator chooses another. Another space of the organization''s is named after it: this id, a hyphen, then a name of the administrator''s choosing. The id says nothing a person can read, so a screen names the space by the organization and never shows it. Null, or absent, where OpenBot keeps no space for the organization alone and its default is whichever space is assigned or chosen.'
oneOf:
- $ref: '#/components/schemas/LearningSpaceId'
- type: 'null'
UpdateLearningSettingsRequest:
type: object
additionalProperties: false
Expand Down Expand Up @@ -32738,7 +32749,7 @@ components:
- closed
- open
- choose
description: 'Who else''s Bots use the skills learned in a person''s own space. closed: only their own Bots. open: every Bot. choose: every Bot, for the skills they open one by one.'
description: 'Who else''s Bots use the skills learned in a person''s own space. closed: only their own Bots. open: every Bot in the organization. choose: every Bot in the organization, for the skills they open one by one. Never a Bot in another organization.'
PersonalLearnedSkill:
type: object
required:
Expand Down Expand Up @@ -39081,11 +39092,13 @@ components:
summary: A new thread id.
value:
threadId: 6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a
liveThreadId: 2b503bf7-514a-8c4e-b132-3ca9b729ffeb
ConversationThreadStatusExample:
summary: A thread that is still there.
value:
threadId: 6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a
known: true
liveThreadId: 2b503bf7-514a-8c4e-b132-3ca9b729ffeb
TaskPageExample:
summary: One task, ready to read.
value:
Expand Down
16 changes: 14 additions & 2 deletions api/openapi/conversations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2313,6 +2313,12 @@ components:
threadId:
type: string
description: The new thread's id.
liveThreadId:
type: string
description: The id that live updates about this thread carry. Compare
an incoming update with this one, and use threadId everywhere else.
It is threadId itself in the organization default. Left out by a
server that names threads one way only, where it is threadId.
ConversationThreadStatus:
type: object
required:
Expand All @@ -2324,6 +2330,12 @@ components:
known:
type: boolean
description: Whether the thread still holds the caller's conversation.
liveThreadId:
type: string
description: The id that live updates about this thread carry. Compare
an incoming update with this one, and use threadId everywhere else.
It is threadId itself in the organization default. Left out by a
server that names threads one way only, where it is threadId.
TaskStatus:
type: string
enum:
Expand Down Expand Up @@ -3068,10 +3080,10 @@ components:
value: {"transport": "webrtc"}
ConversationThreadExample:
summary: "A new thread id."
value: {"threadId": "6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a"}
value: {"threadId": "6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a", "liveThreadId": "2b503bf7-514a-8c4e-b132-3ca9b729ffeb"}
ConversationThreadStatusExample:
summary: "A thread that is still there."
value: {"threadId": "6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a", "known": true}
value: {"threadId": "6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a", "known": true, "liveThreadId": "2b503bf7-514a-8c4e-b132-3ca9b729ffeb"}
TaskPageExample:
summary: "One task, ready to read."
value: {"tasks": [{"id": "7c2d6b1f-6f10-4a53-9d51-5f0d6c0e2f1a", "botId": "general-assistant", "conversationId": "5f0d6c0e-2f1a-4a53-9d51-6f3d6b1f6f10", "threadId": "6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a", "title": "Reply to Sam about the spec", "why": "Sam asked for the spec by Friday.", "origin": "check_in", "suggestionId": "0b1c6f0e-7f0e-4c1e-9d55-2f4a8c1b6e21", "sourceApp": "Gmail", "sourceLink": null, "originConversationId": null, "status": "ready_for_review", "failure": null, "failedAt": null, "stoppedAt": null, "next": "Read the draft and send it.", "workingSince": null, "lastActivityAt": "2026-11-14T09:05:00.000Z", "resolvedAt": null, "createdAt": "2026-11-14T09:00:00.000Z", "updatedAt": "2026-11-14T09:05:00.000Z"}], "nextCursor": null}
Expand Down
24 changes: 21 additions & 3 deletions api/openapi/learning.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@
# api/openapi.yaml, the file every client and check reads. See api/README.md.
#
# CopilotKit Intelligence learns skills from conversations and recordings, in Learning spaces
# (containers) inside the organization's Intelligence project. What it proposes, the evidence behind
# (containers) that belong to one organization. Every organization has its own spaces, and each
# person has their own space in each organization they belong to: what is learned in one
# organization never reaches a Bot in another, the same person's Bots included, and "every Bot"
# below always means every Bot in the organization. What it proposes, the evidence behind
# each proposal, approving and rejecting one, and its runs live in Intelligence: OpenBot reads and
# changes them for a person, after checking which spaces that person may reach, and answers in the
# shapes below. Beside them is what OpenBot keeps: which space each Bot learns into, who reviews
Expand All @@ -14,6 +17,7 @@
# The organization's spaces (the one every Bot learns into, and each Bot's own) are an
# administrator's, under settings/learning, picked with botId. A person's own spaces are under
# people/{personId}, picked with containerId; an administrator may read and review them too.
# An administrator here is an administrator of the organization in the address, and of no other.
paths:
/api/v2/organizations/{organizationId}/settings/learning:
parameters:
Expand Down Expand Up @@ -1800,6 +1804,19 @@ components:
oneOf:
- $ref: '#/components/schemas/LearningAutomatic'
- type: 'null'
organizationSpaceId:
description: >-
The space OpenBot keeps for this organization alone, which its
Bots learn into unless an administrator chooses another. Another
space of the organization's is named after it: this id, a hyphen,
then a name of the administrator's choosing. The id says nothing
a person can read, so a screen names the space by the
organization and never shows it. Null, or absent, where OpenBot
keeps no space for the organization alone and its default is
whichever space is assigned or chosen.
oneOf:
- $ref: '#/components/schemas/LearningSpaceId'
- type: 'null'
LearningAutomaticResult:
type: object
required: [automatic]
Expand Down Expand Up @@ -2040,8 +2057,9 @@ components:
enum: [closed, open, choose]
description: >-
Who else's Bots use the skills learned in a person's own space.
closed: only their own Bots. open: every Bot. choose: every Bot, for
the skills they open one by one.
closed: only their own Bots. open: every Bot in the organization.
choose: every Bot in the organization, for the skills they open one
by one. Never a Bot in another organization.
PersonalLearnedSkill:
type: object
required: [name, description, open, approvedBy, sharing]
Expand Down
9 changes: 7 additions & 2 deletions api/openapi/memory.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
# does the recall, and the memories Intelligence holds for the person that OpenBot formed no record
# of are listed here too. Without it, OpenBot's record is the whole store. A single-person OpenBot
# keeps no memory: every operation here answers not found there.
#
# A person's memory is kept per organization. What their Bots remember in one organization is never
# listed or recalled in another they belong to, and a memory named from another organization is
# answered as not found.
paths:
/api/v2/organizations/{organizationId}/people/{personId}/memories:
parameters:
Expand All @@ -19,8 +23,9 @@ paths:
operationId: listMemories
summary: List a person's memories
description: >-
Return one page of what a person's Bots remember about them, most
recently changed first: the ones they wrote, the ones their Bots
Return one page of what a person's Bots remember about them in this
organization, and in no other they belong to, most recently changed
first: the ones they wrote, the ones their Bots
formed and are waiting for their review, the ones read in from their
sources, and the ones the backend holds for them that OpenBot formed
no record of, after OpenBot's own. Paused memories are included;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,14 @@ export const getUploadConversationAttachmentResponseMock = (): Attachment => ({
export const getCreateConversationThreadResponseMock =
(): ConversationThread => ({
threadId: "6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a",
liveThreadId: "2b503bf7-514a-8c4e-b132-3ca9b729ffeb",
});

export const getGetConversationThreadResponseMock =
(): ConversationThreadStatus => ({
threadId: "6f3d6b1f-6f10-8a53-9d51-5f0d6c0e2f1a",
known: true,
liveThreadId: "2b503bf7-514a-8c4e-b132-3ca9b729ffeb",
});

export const getCreateTranscriptionResponseMock = (): Transcription => ({
Expand Down
12 changes: 12 additions & 0 deletions app/src/lib/api/generated/conversations/conversations.zod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1324,6 +1324,12 @@ export const CreateConversationThreadHeader = zod.object({

export const CreateConversationThreadResponse = zod.object({
threadId: zod.string().describe("The new thread's id."),
liveThreadId: zod
.string()
.optional()
.describe(
"The id that live updates about this thread carry. Compare an incoming update with this one, and use threadId everywhere else. It is threadId itself in the organization default. Left out by a server that names threads one way only, where it is threadId.",
),
});

/**
Expand All @@ -1346,6 +1352,12 @@ export const GetConversationThreadResponse = zod.object({
known: zod
.boolean()
.describe("Whether the thread still holds the caller's conversation."),
liveThreadId: zod
.string()
.optional()
.describe(
"The id that live updates about this thread carry. Compare an incoming update with this one, and use threadId everywhere else. It is threadId itself in the organization default. Left out by a server that names threads one way only, where it is threadId.",
),
});

/**
Expand Down
42 changes: 39 additions & 3 deletions app/src/lib/api/generated/learning/learning.zod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ export const getLearningSettingsResponseAutomaticOneContainerIdMax = 64;

export const getLearningSettingsResponseAutomaticOneContainerIdRegExp =
new RegExp("^[a-z0-9]+(?:-[a-z0-9]+)*$");
export const getLearningSettingsResponseOrganizationSpaceIdOneMax = 64;

export const getLearningSettingsResponseOrganizationSpaceIdOneRegExp =
new RegExp("^[a-z0-9]+(?:-[a-z0-9]+)*$");

export const GetLearningSettingsResponse = zod.object({
settings: zod.object({
Expand Down Expand Up @@ -156,6 +160,20 @@ export const GetLearningSettingsResponse = zod.object({
zod.null(),
])
.describe("Null where OpenBot never assigns a space by itself."),
organizationSpaceId: zod
.union([
zod
.string()
.min(1)
.max(getLearningSettingsResponseOrganizationSpaceIdOneMax)
.regex(getLearningSettingsResponseOrganizationSpaceIdOneRegExp)
.describe("A Learning space's id in the backend (its container)."),
zod.null(),
])
.optional()
.describe(
"The space OpenBot keeps for this organization alone, which its Bots learn into unless an administrator chooses another. Another space of the organization's is named after it: this id, a hyphen, then a name of the administrator's choosing. The id says nothing a person can read, so a screen names the space by the organization and never shows it. Null, or absent, where OpenBot keeps no space for the organization alone and its default is whichever space is assigned or chosen.",
),
});

/**
Expand Down Expand Up @@ -272,6 +290,10 @@ export const updateLearningSettingsResponseAutomaticOneContainerIdMax = 64;

export const updateLearningSettingsResponseAutomaticOneContainerIdRegExp =
new RegExp("^[a-z0-9]+(?:-[a-z0-9]+)*$");
export const updateLearningSettingsResponseOrganizationSpaceIdOneMax = 64;

export const updateLearningSettingsResponseOrganizationSpaceIdOneRegExp =
new RegExp("^[a-z0-9]+(?:-[a-z0-9]+)*$");

export const UpdateLearningSettingsResponse = zod.object({
settings: zod.object({
Expand Down Expand Up @@ -397,6 +419,20 @@ export const UpdateLearningSettingsResponse = zod.object({
zod.null(),
])
.describe("Null where OpenBot never assigns a space by itself."),
organizationSpaceId: zod
.union([
zod
.string()
.min(1)
.max(updateLearningSettingsResponseOrganizationSpaceIdOneMax)
.regex(updateLearningSettingsResponseOrganizationSpaceIdOneRegExp)
.describe("A Learning space's id in the backend (its container)."),
zod.null(),
])
.optional()
.describe(
"The space OpenBot keeps for this organization alone, which its Bots learn into unless an administrator chooses another. Another space of the organization's is named after it: this id, a hyphen, then a name of the administrator's choosing. The id says nothing a person can read, so a screen names the space by the organization and never shows it. Null, or absent, where OpenBot keeps no space for the organization alone and its default is whichever space is assigned or chosen.",
),
});

/**
Expand Down Expand Up @@ -1061,7 +1097,7 @@ export const GetPersonLearningSettingsResponse = zod.object({
mode: zod
.enum(["closed", "open", "choose"])
.describe(
"Who else's Bots use the skills learned in a person's own space. closed: only their own Bots. open: every Bot. choose: every Bot, for the skills they open one by one.",
"Who else's Bots use the skills learned in a person's own space. closed: only their own Bots. open: every Bot in the organization. choose: every Bot in the organization, for the skills they open one by one. Never a Bot in another organization.",
),
sharingAllowed: zod
.boolean()
Expand Down Expand Up @@ -1153,7 +1189,7 @@ export const UpdatePersonLearningSettingsBody = zod.object({
.enum(["closed", "open", "choose"])
.optional()
.describe(
"Who else's Bots use the skills learned in a person's own space. closed: only their own Bots. open: every Bot. choose: every Bot, for the skills they open one by one.",
"Who else's Bots use the skills learned in a person's own space. closed: only their own Bots. open: every Bot in the organization. choose: every Bot in the organization, for the skills they open one by one. Never a Bot in another organization.",
),
autoApprove: zod
.boolean()
Expand All @@ -1165,7 +1201,7 @@ export const UpdatePersonLearningSettingsResponse = zod.object({
mode: zod
.enum(["closed", "open", "choose"])
.describe(
"Who else's Bots use the skills learned in a person's own space. closed: only their own Bots. open: every Bot. choose: every Bot, for the skills they open one by one.",
"Who else's Bots use the skills learned in a person's own space. closed: only their own Bots. open: every Bot in the organization. choose: every Bot in the organization, for the skills they open one by one. Never a Bot in another organization.",
),
autoApprove: zod.boolean().nullable(),
});
Expand Down
2 changes: 1 addition & 1 deletion app/src/lib/api/generated/memory/memory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ export const getListMemoriesUrl = (
};

/**
* Return one page of what a person's Bots remember about them, most recently changed first: the ones they wrote, the ones their Bots formed and are waiting for their review, the ones read in from their sources, and the ones the backend holds for them that OpenBot formed no record of, after OpenBot's own. Paused memories are included; forgotten ones are not. Only the person themselves may list them: an administrator can't either. A missing cursor starts at the first page and nextCursor null ends the list.
* Return one page of what a person's Bots remember about them in this organization, and in no other they belong to, most recently changed first: the ones they wrote, the ones their Bots formed and are waiting for their review, the ones read in from their sources, and the ones the backend holds for them that OpenBot formed no record of, after OpenBot's own. Paused memories are included; forgotten ones are not. Only the person themselves may list them: an administrator can't either. A missing cursor starts at the first page and nextCursor null ends the list.
* @summary List a person's memories
*/
export const listMemories = async (
Expand Down
2 changes: 1 addition & 1 deletion app/src/lib/api/generated/memory/memory.zod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import * as zod from "zod";

/**
* Return one page of what a person's Bots remember about them, most recently changed first: the ones they wrote, the ones their Bots formed and are waiting for their review, the ones read in from their sources, and the ones the backend holds for them that OpenBot formed no record of, after OpenBot's own. Paused memories are included; forgotten ones are not. Only the person themselves may list them: an administrator can't either. A missing cursor starts at the first page and nextCursor null ends the list.
* Return one page of what a person's Bots remember about them in this organization, and in no other they belong to, most recently changed first: the ones they wrote, the ones their Bots formed and are waiting for their review, the ones read in from their sources, and the ones the backend holds for them that OpenBot formed no record of, after OpenBot's own. Paused memories are included; forgotten ones are not. Only the person themselves may list them: an administrator can't either. A missing cursor starts at the first page and nextCursor null ends the list.
* @summary List a person's memories
*/

Expand Down
Loading
Loading