@orq-ai/node 4.9.6 → 4.9.7

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-18T08:05:02.495Z",
+    "2026-05-18T14:04:15.855Z",
   ).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-18T08:05:18.549Z",
+    "2026-05-18T14:04:32.059Z",
   ).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-18T08:05:18.548Z",
+    "2026-05-18T14:04:32.059Z",
   ).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-18T08:05:18.548Z",
+    "2026-05-18T14:04:32.059Z",
   ).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-18T08:05:02.495Z",
+    "2026-05-18T14:04:15.855Z",
   ).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("01KRX1WD04BSH6X5T8JK453HD3"),
+  _id: z.string().default("01KRXPE5C691TNTDMYPKTDXG8C"),
   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;
@@ -378,14 +378,15 @@ export type Llm2 = {
   prompt: string;
   categories?: Array<string> | undefined;
   categoricalLabels?: Array<LLMCategoricalLabels> | undefined;
+  datasetId?: 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;
   description?: string | undefined;
@@ -475,14 +476,15 @@ export type Llm1 = {
   prompt: string;
   categories?: Array<string> | undefined;
   categoricalLabels?: Array<CreateEvalLLMCategoricalLabels> | undefined;
+  datasetId?: 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;
   description?: string | undefined;
@@ -1237,6 +1239,7 @@ export type CreateEvalLlm2 = {
   prompt: string;
   categories?: Array<string> | undefined;
   categoricalLabels?: Array<CreateEvalLLMEvalsCategoricalLabels> | undefined;
+  datasetId?: string | undefined;
   key: string;
   mode: "jury";
   jury: CreateEvalLLMJury;
@@ -1315,6 +1318,7 @@ export type CreateEvalLlm1 = {
   categoricalLabels?:
     | Array<CreateEvalLLMEvalsResponseCategoricalLabels>
     | undefined;
+  datasetId?: string | undefined;
   key: string;
   mode: "single";
   model: string;
@@ -2288,6 +2292,7 @@ export type Llm2$Outbound = {
   prompt: string;
   categories?: Array<string> | undefined;
   categorical_labels?: Array<LLMCategoricalLabels$Outbound> | undefined;
+  dataset_id?: string | undefined;
   path: string;
   description: string;
   key: string;
@@ -2319,6 +2324,7 @@ export const Llm2$outboundSchema: z.ZodType<Llm2$Outbound, z.ZodTypeDef, Llm2> =
     categoricalLabels: z.array(
       z.lazy(() => LLMCategoricalLabels$outboundSchema),
     ).optional(),
+    datasetId: z.string().optional(),
     path: z.string(),
     description: z.string().default(""),
     key: z.string(),
@@ -2329,6 +2335,7 @@ export const Llm2$outboundSchema: z.ZodType<Llm2$Outbound, z.ZodTypeDef, Llm2> =
       guardrailConfig: "guardrail_config",
       outputType: "output_type",
       categoricalLabels: "categorical_labels",
+      datasetId: "dataset_id",
     });
   });
 
@@ -2530,6 +2537,7 @@ export type Llm1$Outbound = {
   categorical_labels?:
     | Array<CreateEvalLLMCategoricalLabels$Outbound>
     | undefined;
+  dataset_id?: string | undefined;
   path: string;
   description: string;
   key: string;
@@ -2561,6 +2569,7 @@ export const Llm1$outboundSchema: z.ZodType<Llm1$Outbound, z.ZodTypeDef, Llm1> =
     categoricalLabels: z.array(
       z.lazy(() => CreateEvalLLMCategoricalLabels$outboundSchema),
     ).optional(),
+    datasetId: z.string().optional(),
     path: z.string(),
     description: z.string().default(""),
     key: z.string(),
@@ -2571,6 +2580,7 @@ export const Llm1$outboundSchema: z.ZodType<Llm1$Outbound, z.ZodTypeDef, Llm1> =
       guardrailConfig: "guardrail_config",
       outputType: "output_type",
       categoricalLabels: "categorical_labels",
+      datasetId: "dataset_id",
     });
   });
 
@@ -2776,8 +2786,8 @@ export const Typescript$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-18T08:05:04.737Z"),
-  updated: z.string().default("2026-05-18T08:05:04.737Z"),
+  created: z.string().default("2026-05-18T14:04:16.993Z"),
+  updated: z.string().default("2026-05-18T14:04:16.993Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -2965,8 +2975,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-18T08:05:04.737Z"),
-    updated: z.string().default("2026-05-18T08:05:04.737Z"),
+    created: z.string().default("2026-05-18T14:04:16.993Z"),
+    updated: z.string().default("2026-05-18T14:04:16.993Z"),
     guardrail_config: z.nullable(
       z.union([
         z.lazy(() =>
@@ -3789,8 +3799,8 @@ export const CreateEvalResponseBodyFunction$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-18T08:05:04.737Z"),
-  updated: z.string().default("2026-05-18T08:05:04.737Z"),
+  created: z.string().default("2026-05-18T14:04:16.993Z"),
+  updated: z.string().default("2026-05-18T14:04:16.993Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4008,8 +4018,8 @@ export const ResponseBodyPython$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-18T08:05:04.737Z"),
-  updated: z.string().default("2026-05-18T08:05:04.737Z"),
+  created: z.string().default("2026-05-18T14:04:16.993Z"),
+  updated: z.string().default("2026-05-18T14:04:16.993Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4190,8 +4200,8 @@ export const ResponseBodyHTTP$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-18T08:05:04.737Z"),
-  updated: z.string().default("2026-05-18T08:05:04.737Z"),
+  created: z.string().default("2026-05-18T14:04:16.993Z"),
+  updated: z.string().default("2026-05-18T14:04:16.993Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4367,8 +4377,8 @@ export const ResponseBodyJSON$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-18T08:05:04.737Z"),
-  updated: z.string().default("2026-05-18T08:05:04.737Z"),
+  created: z.string().default("2026-05-18T14:04:16.993Z"),
+  updated: z.string().default("2026-05-18T14:04:16.993Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() => CreateEvalGuardrailConfigEvalsResponseBoolean$inboundSchema),
@@ -4738,8 +4748,8 @@ export const CreateEvalLlm2$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-18T08:05:04.737Z"),
-  updated: z.string().default("2026-05-18T08:05:04.737Z"),
+  created: z.string().default("2026-05-18T14:04:16.993Z"),
+  updated: z.string().default("2026-05-18T14:04:16.993Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4760,6 +4770,7 @@ export const CreateEvalLlm2$inboundSchema: z.ZodType<
   categorical_labels: z.array(
     z.lazy(() => CreateEvalLLMEvalsCategoricalLabels$inboundSchema),
   ).optional(),
+  dataset_id: z.string().optional(),
   key: z.string(),
   mode: z.literal("jury"),
   jury: z.lazy(() => CreateEvalLLMJury$inboundSchema),
@@ -4768,6 +4779,7 @@ export const CreateEvalLlm2$inboundSchema: z.ZodType<
     "_id": "id",
     "guardrail_config": "guardrailConfig",
     "categorical_labels": "categoricalLabels",
+    "dataset_id": "datasetId",
   });
 });
 
@@ -4954,8 +4966,8 @@ export const CreateEvalLlm1$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   description: z.string(),
-  created: z.string().default("2026-05-18T08:05:04.737Z"),
-  updated: z.string().default("2026-05-18T08:05:04.737Z"),
+  created: z.string().default("2026-05-18T14:04:16.993Z"),
+  updated: z.string().default("2026-05-18T14:04:16.993Z"),
   guardrail_config: z.nullable(
     z.union([
       z.lazy(() =>
@@ -4976,6 +4988,7 @@ export const CreateEvalLlm1$inboundSchema: z.ZodType<
   categorical_labels: z.array(
     z.lazy(() => CreateEvalLLMEvalsResponseCategoricalLabels$inboundSchema),
   ).optional(),
+  dataset_id: z.string().optional(),
   key: z.string(),
   mode: z.literal("single"),
   model: z.string(),
@@ -4984,6 +4997,7 @@ export const CreateEvalLlm1$inboundSchema: z.ZodType<
     "_id": "id",
     "guardrail_config": "guardrailConfig",
     "categorical_labels": "categoricalLabels",
+    "dataset_id": "datasetId",
   });
 });
 

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;
 };