@orq-ai/node 4.10.0-rc.0 → 4.10.0-rc.10

package/src/models/components/totals.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Totals = {
+  /**
+   * Same shape and rules as `DataPoint.metrics`, aggregated across the
+   *
+   * @remarks
+   *  whole window.
+   */
+  metrics?: { [k: string]: number } | undefined;
+};
+
+/** @internal */
+export const Totals$inboundSchema: z.ZodType<Totals, z.ZodTypeDef, unknown> = z
+  .object({
+    metrics: z.record(z.number()).optional(),
+  });
+
+export function totalsFromJSON(
+  jsonString: string,
+): SafeParseResult<Totals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Totals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Totals' from JSON`,
+  );
+}

package/src/models/components/updateidentityrequest.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UpdateIdentityRequestMetadata = {};
+
+export type UpdateIdentityRequest = {
+  id?: string | undefined;
+  displayName?: string | undefined;
+  email?: string | undefined;
+  avatarUrl?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: UpdateIdentityRequestMetadata | undefined;
+};
+
+/** @internal */
+export type UpdateIdentityRequestMetadata$Outbound = {};
+
+/** @internal */
+export const UpdateIdentityRequestMetadata$outboundSchema: z.ZodType<
+  UpdateIdentityRequestMetadata$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequestMetadata
+> = z.object({});
+
+export function updateIdentityRequestMetadataToJSON(
+  updateIdentityRequestMetadata: UpdateIdentityRequestMetadata,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequestMetadata$outboundSchema.parse(
+      updateIdentityRequestMetadata,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateIdentityRequest$Outbound = {
+  id?: string | undefined;
+  display_name?: string | undefined;
+  email?: string | undefined;
+  avatar_url?: string | undefined;
+  tags?: Array<string> | undefined;
+  metadata?: UpdateIdentityRequestMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityRequest$outboundSchema: z.ZodType<
+  UpdateIdentityRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateIdentityRequest
+> = z.object({
+  id: z.string().optional(),
+  displayName: z.string().optional(),
+  email: z.string().optional(),
+  avatarUrl: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  metadata: z.lazy(() => UpdateIdentityRequestMetadata$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayName: "display_name",
+    avatarUrl: "avatar_url",
+  });
+});
+
+export function updateIdentityRequestToJSON(
+  updateIdentityRequest: UpdateIdentityRequest,
+): string {
+  return JSON.stringify(
+    UpdateIdentityRequest$outboundSchema.parse(updateIdentityRequest),
+  );
+}

package/src/models/components/updateidentityresponse.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Identity, Identity$inboundSchema } from "./identity.js";
+
+export type UpdateIdentityResponse = {
+  identity?: Identity | undefined;
+};
+
+/** @internal */
+export const UpdateIdentityResponse$inboundSchema: z.ZodType<
+  UpdateIdentityResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identity: Identity$inboundSchema.optional(),
+});
+
+export function updateIdentityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateIdentityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateIdentityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateIdentityResponse' from JSON`,
+  );
+}

package/src/models/components/updateprojectrequest.ts

@@ -6,8 +6,20 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type UpdateProjectRequest = {
+  /**
+   * Project ID to update.
+   */
   projectId?: string | undefined;
+  /**
+   * New project name. Omit to keep the current name.
+   */
   name?: string | undefined;
+  /**
+   * Replacement list of team identifiers associated with the project.
+   *
+   * @remarks
+   *  Leave empty to remove all team associations.
+   */
   teams?: Array<string> | undefined;
 };
 

package/src/models/components/updateprojectresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Project, Project$inboundSchema } from "./project.js";
 
 export type UpdateProjectResponse = {
+  /**
+   * Updated project.
+   */
   project?: Project | undefined;
 };
 

package/src/models/components/updateskillrequest.ts

@@ -6,12 +6,33 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type UpdateSkillRequest = {
+  /**
+   * Skill ID to update.
+   */
   skillId?: string | undefined;
+  /**
+   * New workspace-unique display name. Omit to keep the current name.
+   */
   displayName?: string | undefined;
+  /**
+   * New description. Omit to keep the current description.
+   */
   description?: string | undefined;
+  /**
+   * Replacement tag list. Leave empty to clear tags.
+   */
   tags?: Array<string> | undefined;
+  /**
+   * New project path. Omit to keep the current path.
+   */
   path?: string | undefined;
+  /**
+   * New instruction body. Omit to keep the current instructions.
+   */
   instructions?: string | undefined;
+  /**
+   * New containing project. Omit to keep the current project.
+   */
   projectId?: string | undefined;
 };
 

package/src/models/components/updateskillresponse.ts

@@ -9,6 +9,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Skill, Skill$inboundSchema } from "./skill.js";
 
 export type UpdateSkillResponse = {
+  /**
+   * Updated skill.
+   */
   skill?: Skill | undefined;
 };
 

package/src/models/errors/index.ts

@@ -11,7 +11,6 @@ export * from "./createtranslation.js";
 export * from "./deleteagent.js";
 export * from "./deleteagentschedule.js";
 export * from "./deleteeval.js";
-export * from "./deleteidentity.js";
 export * from "./deleteprompt.js";
 export * from "./getevals.js";
 export * from "./getpromptversion.js";
@@ -29,7 +28,6 @@ export * from "./postv2feedbackremove.js";
 export * from "./responsevalidationerror.js";
 export * from "./retrieveagentrequest.js";
 export * from "./retrieveagentschedule.js";
-export * from "./retrieveidentity.js";
 export * from "./sdkvalidationerror.js";
 export * from "./streamagent.js";
 export * from "./streamrunagent.js";
@@ -37,6 +35,5 @@ export * from "./triggeragentschedule.js";
 export * from "./updateagent.js";
 export * from "./updateagentschedule.js";
 export * from "./updateeval.js";
-export * from "./updateidentity.js";
 export * from "./updateprompt.js";
 export * from "./updatetool.js";

package/src/models/operations/createagentrequest.ts

@@ -2577,13 +2577,13 @@ export type CreateAgentRequestResponseBody = {
    */
   version?: string | undefined;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
   /**

package/src/models/operations/createannotation.ts

@@ -8,7 +8,7 @@ import { remap as remap$ } from "../../lib/primitives.js";
 /**
  * The feedback value. For single-select, provide a string or single-element array. For multi-select, provide an array of strings. For range evaluations, provide a number. For text/correction, provide a string.
  */
-export type CreateAnnotationValue = string | number | Array<string>;
+export type Value = string | number | Array<string>;
 
 export type Annotations = {
   /**
@@ -43,21 +43,17 @@ export type CreateAnnotationRequest = {
 };
 
 /** @internal */
-export type CreateAnnotationValue$Outbound = string | number | Array<string>;
+export type Value$Outbound = string | number | Array<string>;
 
 /** @internal */
-export const CreateAnnotationValue$outboundSchema: z.ZodType<
-  CreateAnnotationValue$Outbound,
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
   z.ZodTypeDef,
-  CreateAnnotationValue
+  Value
 > = z.union([z.string(), z.number(), z.array(z.string())]);
 
-export function createAnnotationValueToJSON(
-  createAnnotationValue: CreateAnnotationValue,
-): string {
-  return JSON.stringify(
-    CreateAnnotationValue$outboundSchema.parse(createAnnotationValue),
-  );
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
 }
 
 /** @internal */

package/src/models/operations/createdataset.ts

@@ -14,13 +14,13 @@ export type CreateDatasetRequestBody = {
    */
   displayName: string;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
 };
@@ -138,7 +138,7 @@ export const CreateDatasetResponseBody$inboundSchema: z.ZodType<
   created: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   updated: z.string().datetime({ offset: true }).default(
-    "2026-05-13T07:58:53.577Z",
+    "2026-05-17T12:53:05.298Z",
   ).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {

package/src/models/operations/createdatasetitem.ts

@@ -2355,7 +2355,7 @@ export const Evaluations3$inboundSchema: z.ZodType<
   ),
   reviewed_by_id: z.string(),
   reviewed_at: z.string().datetime({ offset: true }).default(
-    "2026-05-13T07:59:08.654Z",
+    "2026-05-17T12:53:21.030Z",
   ).transform(v => new Date(v)),
   type: z.literal("string_array"),
   values: z.array(z.string()),
@@ -2400,7 +2400,7 @@ export const Evaluations2$inboundSchema: z.ZodType<
   source: CreateDatasetItemEvaluationsSource$inboundSchema.default("orq"),
   reviewed_by_id: z.string(),
   reviewed_at: z.string().datetime({ offset: true }).default(
-    "2026-05-13T07:59:08.654Z",
+    "2026-05-17T12:53:21.029Z",
   ).transform(v => new Date(v)),
   type: z.literal("number"),
   value: z.number(),
@@ -2446,7 +2446,7 @@ export const Evaluations1$inboundSchema: z.ZodType<
   source: EvaluationsSource$inboundSchema.default("orq"),
   reviewed_by_id: z.string(),
   reviewed_at: z.string().datetime({ offset: true }).default(
-    "2026-05-13T07:59:08.654Z",
+    "2026-05-17T12:53:21.026Z",
   ).transform(v => new Date(v)),
   type: z.literal("string"),
   value: z.string(),
@@ -2529,7 +2529,7 @@ export const CreateDatasetItemResponseBody$inboundSchema: z.ZodType<
   created: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   updated: z.string().datetime({ offset: true }).default(
-    "2026-05-13T07:58:53.577Z",
+    "2026-05-17T12:53:05.298Z",
   ).transform(v => new Date(v)),
 }).transform((v) => {
   return remap$(v, {

package/src/models/operations/createdatasource.ts

@@ -403,7 +403,7 @@ export const CreateDatasourceResponseBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _id: z.string().default("01KRG5HGST3QN1HV93A6SFJV0J"),
+  _id: z.string().default("01KRTZZ3D0YN8C0TP7NFF3XKK2"),
   display_name: z.string(),
   description: z.string().optional(),
   status: CreateDatasourceStatus$inboundSchema,

package/src/models/operations/createeval.ts

@@ -74,13 +74,13 @@ export type Python = {
   code: string;
   type: CreateEvalRequestBodyType;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
   description?: string | undefined;
@@ -170,13 +170,13 @@ export type RequestBodyHTTP = {
   headers: { [k: string]: string };
   payload: { [k: string]: any };
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
   description?: string | undefined;
@@ -245,13 +245,13 @@ export type Json = {
   type: CreateEvalRequestBodyEvalsType;
   schema: string;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
   description?: string | undefined;
@@ -379,13 +379,13 @@ export type Llm2 = {
   categories?: Array<string> | undefined;
   categoricalLabels?: Array<LLMCategoricalLabels> | undefined;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
   description?: string | undefined;
@@ -476,13 +476,13 @@ export type Llm1 = {
   categories?: Array<string> | undefined;
   categoricalLabels?: Array<CreateEvalLLMCategoricalLabels> | undefined;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
   description?: string | undefined;
@@ -2776,8 +2776,8 @@ export const Typescript$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-13T07:58:55.725Z"),
-  updated: z.string().default("2026-05-13T07:58:55.725Z"),
+  created: z.string().default("2026-05-17T12:53:06.560Z"),
+  updated: z.string().default("2026-05-17T12:53:06.560Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -2965,8 +2965,8 @@ export const Ragas$inboundSchema: z.ZodType<Ragas, z.ZodTypeDef, unknown> = z
   .object({
     _id: z.string(),
     description: z.string(),
-    created: z.string().default("2026-05-13T07:58:55.725Z"),
-    updated: z.string().default("2026-05-13T07:58:55.725Z"),
+    created: z.string().default("2026-05-17T12:53:06.560Z"),
+    updated: z.string().default("2026-05-17T12:53:06.560Z"),
     guardrail_config: z.nullable(
       z.union([
         z.lazy(() =>
@@ -3789,8 +3789,8 @@ export const CreateEvalResponseBodyFunction$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-13T07:58:55.725Z"),
-  updated: z.string().default("2026-05-13T07:58:55.725Z"),
+  created: z.string().default("2026-05-17T12:53:06.560Z"),
+  updated: z.string().default("2026-05-17T12:53:06.560Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4008,8 +4008,8 @@ export const ResponseBodyPython$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-13T07:58:55.725Z"),
-  updated: z.string().default("2026-05-13T07:58:55.725Z"),
+  created: z.string().default("2026-05-17T12:53:06.560Z"),
+  updated: z.string().default("2026-05-17T12:53:06.560Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4190,8 +4190,8 @@ export const ResponseBodyHTTP$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-13T07:58:55.725Z"),
-  updated: z.string().default("2026-05-13T07:58:55.725Z"),
+  created: z.string().default("2026-05-17T12:53:06.560Z"),
+  updated: z.string().default("2026-05-17T12:53:06.560Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4367,8 +4367,8 @@ export const ResponseBodyJSON$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-13T07:58:55.725Z"),
-  updated: z.string().default("2026-05-13T07:58:55.725Z"),
+  created: z.string().default("2026-05-17T12:53:06.560Z"),
+  updated: z.string().default("2026-05-17T12:53:06.560Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() => CreateEvalGuardrailConfigEvalsResponseBoolean$inboundSchema),
@@ -4738,8 +4738,8 @@ export const CreateEvalLlm2$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-13T07:58:55.725Z"),
-  updated: z.string().default("2026-05-13T07:58:55.725Z"),
+  created: z.string().default("2026-05-17T12:53:06.560Z"),
+  updated: z.string().default("2026-05-17T12:53:06.560Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4954,8 +4954,8 @@ export const CreateEvalLlm1$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-13T07:58:55.725Z"),
-  updated: z.string().default("2026-05-13T07:58:55.725Z"),
+  created: z.string().default("2026-05-17T12:53:06.560Z"),
+  updated: z.string().default("2026-05-17T12:53:06.560Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>

package/src/models/operations/createknowledge.ts

@@ -128,13 +128,13 @@ export type CreateKnowledgeRequestBody1 = {
    */
   retrievalSettings?: RetrievalSettings | undefined;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
 };
@@ -236,13 +236,13 @@ export type ResponseBody2 = {
    */
   domainId: string;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path?: string | undefined;
   createdById?: string | null | undefined;
@@ -357,13 +357,13 @@ export type ResponseBody1 = {
    */
   domainId: string;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path?: string | undefined;
   createdById?: string | null | undefined;

package/src/models/operations/creatememorystore.ts

@@ -30,13 +30,13 @@ export type CreateMemoryStoreRequestBody = {
    */
   ttl?: number | undefined;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
 };

package/src/models/operations/createprompt.ts

@@ -871,13 +871,13 @@ export type CreatePromptRequestBody = {
    */
   prompt: PromptInput;
   /**
-   * Entity storage path in the format: `project/folder/subfolder/...`
+   * Entity storage path.
    *
    * @remarks
    *
-   * The first element identifies the project, followed by nested folders (auto-created as needed).
+   * With workspace-level API keys, use the format `project/folder/subfolder/...`. The first element identifies the project, followed by nested folders (auto-created as needed). Example: `Default/agents`.
    *
-   * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
+   * With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: `agents`. For backward compatibility, a leading project name is ignored when it matches the scoped project.
    */
   path: string;
 };