Agents v2: update CustomAgents and remove v1 agent integration tests

.fern/metadata.json

@@ -1,5 +1,5 @@
 {
-    "cliVersion": "5.75.1",
+    "cliVersion": "5.77.0",
     "generatorName": "fernapi/fern-typescript-node-sdk",
     "generatorVersion": "3.54.0",
     "generatorConfig": {
@@ -34,6 +34,6 @@
             }
         }
     },
-    "originGitCommit": "94a714862b705ee097af1b7ef3c5d9affa7fc382",
+    "originGitCommit": "e051149eeb3680e201b74bc59dac5132de3df262",
     "sdkVersion": "0.0.0-dev"
 }

src/api/errors/ConflictError.ts

@@ -2,10 +2,9 @@
 
 import type * as core from "../../core/index.js";
 import * as errors from "../../errors/index.js";
-import type * as Corti from "../index.js";
 
 export class ConflictError extends errors.CortiError {
-    constructor(body: Corti.ErrorResponse, rawResponse?: core.RawResponse) {
+    constructor(body?: unknown, rawResponse?: core.RawResponse) {
         super({
             message: "ConflictError",
             statusCode: 409,

src/api/resources/agents/client/Client.ts

@@ -15,6 +15,9 @@
     export interface RequestOptions extends BaseRequestOptions {}
 }
 
+/**
+ * Create, read, update, and delete agents.
+ */
 export class AgentsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<AgentsClient.Options>;
 
@@ -23,6 +26,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint retrieves a list of all agents that can be called by the Corti Agent Framework.
      *
      * @param {Corti.AgentsListRequest} request
@@ -105,6 +110,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint allows the creation of a new agent that can be utilized in the `POST /agents/{id}/v1/message:send` endpoint.
      *
      * @param {Corti.AgentsCreateAgent} request
@@ -197,6 +204,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint retrieves an agent by its identifier. The agent contains information about its capabilities and the experts it can call.
      *
      * @param {string} id - The identifier of the agent associated with the context.
@@ -276,6 +285,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint deletes an agent by its identifier. Once deleted, the agent can no longer be used in threads.
      *
      * @param {string} id - The identifier of the agent associated with the context.
@@ -343,6 +354,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint updates an existing agent. Only the fields provided in the request body will be updated; other fields will remain unchanged.
      *
      * @param {string} id - The identifier of the agent associated with the context.
@@ -434,6 +447,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint retrieves the agent card in JSON format, which provides metadata about the agent, including its name, description, and the experts it can call.
      *
      * @param {string} id - The identifier of the agent associated with the context.
@@ -513,10 +528,12 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint sends a message to the specified agent to start or continue a task. The agent processes the message and returns a response. If the message contains a task ID that matches an ongoing task, the agent will continue that task; otherwise, it will start a new task.
      *
      * @param {string} id - The identifier of the agent associated with the context.
-     * @param {Corti.AgentsMessageSendParams} request
+     * @param {Corti.AgentsMessageSendBody} request
      * @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -540,15 +557,15 @@
      */
     public messageSend(
         id: string,
-        request: Corti.AgentsMessageSendParams,
+        request: Corti.AgentsMessageSendBody,
         requestOptions?: AgentsClient.RequestOptions,
     ): core.HttpResponsePromise<Corti.AgentsMessageSendResponse> {
         return core.HttpResponsePromise.fromPromise(this.__messageSend(id, request, requestOptions));
     }
 
     private async __messageSend(
         id: string,
-        request: Corti.AgentsMessageSendParams,
+        request: Corti.AgentsMessageSendBody,
         requestOptions?: AgentsClient.RequestOptions,
     ): Promise<core.WithRawResponse<Corti.AgentsMessageSendResponse>> {
         const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
@@ -569,7 +586,7 @@
             contentType: "application/json",
             queryParameters: requestOptions?.queryParams,
             requestType: "json",
-            body: serializers.AgentsMessageSendParams.jsonOrThrow(request, {
+            body: serializers.AgentsMessageSendBody.jsonOrThrow(request, {
                 unrecognizedObjectKeys: "strip",
                 omitUndefined: true,
             }),
@@ -617,6 +634,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint retrieves the status and details of a specific task associated with the given agent. It provides information about the task's current state, history, and any artifacts produced during its execution.
      *
      * @param {string} id - The identifier of the agent associated with the context.
@@ -714,6 +733,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint retrieves all tasks and top-level messages associated with a specific context for the given agent.
      *
      * @param {string} id - The identifier of the agent associated with the context.
@@ -792,7 +813,7 @@
                 case 404:
                     throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortiError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.body,
                         rawResponse: _response.rawResponse,
@@ -809,6 +830,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint deletes a context (thread) and scrubs all associated data including messages, memories, and memory chunks for the given agent. Thread and task metadata is soft-deleted for audit purposes, while content columns are irreversibly overwritten.
      *
      * @param {string} id - The identifier of the agent associated with the context.
@@ -870,7 +893,7 @@
                 case 404:
                     throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortiError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.body,
                         rawResponse: _response.rawResponse,
@@ -887,6 +910,8 @@
     }
 
     /**
+     * @deprecated
+     *
      * This endpoint retrieves the experts registry, which contains information about all available experts that can be referenced when creating agents through the AgentsCreateExpertReference schema.
      *
      * @param {Corti.AgentsGetRegistryExpertsRequest} request
@@ -962,7 +987,7 @@
                 case 422:
                     throw new Corti.UnprocessableEntityError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortiError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.body,
                         rawResponse: _response.rawResponse,

src/api/resources/agents/client/requests/AgentsMessageSendParams.ts → src/api/resources/agents/client/requests/AgentsMessageSendBody.ts

@@ -16,7 +16,7 @@ import type * as Corti from "../../../../index.js";
  *         }
  *     }
  */
-export interface AgentsMessageSendParams {
+export interface AgentsMessageSendBody {
     message: Corti.AgentsMessage;
     configuration?: Corti.AgentsMessageSendConfiguration;
     /** Optional metadata that will be associated with the message. */

src/api/resources/agents/client/requests/index.ts

@@ -3,5 +3,5 @@ export type { AgentsGetContextRequest } from "./AgentsGetContextRequest.js";
 export type { AgentsGetRegistryExpertsRequest } from "./AgentsGetRegistryExpertsRequest.js";
 export type { AgentsGetTaskRequest } from "./AgentsGetTaskRequest.js";
 export type { AgentsListRequest } from "./AgentsListRequest.js";
-export type { AgentsMessageSendParams } from "./AgentsMessageSendParams.js";
+export type { AgentsMessageSendBody } from "./AgentsMessageSendBody.js";
 export type { AgentsUpdateAgent } from "./AgentsUpdateAgent.js";

src/api/resources/auth/client/Client.ts

@@ -98,7 +98,7 @@ export class AuthClient {
      * authorization_code (with client_secret), authorization_code with PKCE (code_verifier), password (ROPC), or refresh_token. Use the returned access_token in the Authorization header when calling the Corti API.
      *
      * @param {string} tenantName
-     * @param {Corti.AuthTokenRequestBody} request
+     * @param {Corti.AuthTokenRequest} request
      * @param {AuthClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -113,15 +113,15 @@ export class AuthClient {
      */
     public token(
         tenantName: string,
-        request: Corti.AuthTokenRequestBody,
+        request: Corti.AuthTokenRequest,
         requestOptions?: AuthClient.RequestOptions,
     ): core.HttpResponsePromise<Corti.AuthTokenResponse> {
         return core.HttpResponsePromise.fromPromise(this.__token(tenantName, request, requestOptions));
     }
 
     private async __token(
         tenantName: string,
-        request: Corti.AuthTokenRequestBody,
+        request: Corti.AuthTokenRequest,
         requestOptions?: AuthClient.RequestOptions,
     ): Promise<core.WithRawResponse<Corti.AuthTokenResponse>> {
         const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
@@ -142,7 +142,7 @@ export class AuthClient {
             contentType: "application/x-www-form-urlencoded",
             queryParameters: requestOptions?.queryParams,
             requestType: "form",
-            body: serializers.AuthTokenRequestBody.jsonOrThrow(request, {
+            body: serializers.AuthTokenRequest.jsonOrThrow(request, {
                 unrecognizedObjectKeys: "strip",
                 omitUndefined: true,
             }),

src/api/resources/auth/types/AuthTokenRequestBody.ts → src/api/resources/auth/types/AuthTokenRequest.ts

@@ -2,7 +2,7 @@
 
 import type * as Corti from "../../../index.js";
 
-export type AuthTokenRequestBody =
+export type AuthTokenRequest =
     | Corti.AuthTokenRequestClientCredentials
     | Corti.AuthTokenRequestAuthorizationCode
     | Corti.AuthTokenRequestAuthorizationPkce

src/api/resources/auth/types/index.ts

@@ -1 +1 @@
-export * from "./AuthTokenRequestBody.js";
+export * from "./AuthTokenRequest.js";

src/api/resources/documents/client/Client.ts

@@ -142,7 +142,7 @@ export class DocumentsClient {
      * This endpoint offers different ways to generate a document. Find guides to document generation [here](/textgen/documents-standard).
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
-     * @param {Corti.DocumentsCreateRequest} request
+     * @param {Corti.CreateDocumentsRequest} request
      * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -152,34 +152,40 @@ export class DocumentsClient {
      *
      * @example
      *     await client.documents.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
-     *         context: [{
-     *                 type: "facts",
-     *                 data: [{
-     *                         text: "text"
-     *                     }]
-     *             }],
-     *         templateKey: "templateKey",
-     *         outputLanguage: "outputLanguage"
+     *         body: {
+     *             context: [{
+     *                     type: "facts",
+     *                     data: [{
+     *                             text: "text"
+     *                         }]
+     *                 }],
+     *             templateKey: "templateKey",
+     *             outputLanguage: "outputLanguage"
+     *         }
      *     })
      */
     public create(
         id: Corti.Uuid,
-        request: Corti.DocumentsCreateRequest,
+        request: Corti.CreateDocumentsRequest,
         requestOptions?: DocumentsClient.RequestOptions,
     ): core.HttpResponsePromise<Corti.DocumentsGetResponse> {
         return core.HttpResponsePromise.fromPromise(this.__create(id, request, requestOptions));
     }
 
     private async __create(
         id: Corti.Uuid,
-        request: Corti.DocumentsCreateRequest,
+        request: Corti.CreateDocumentsRequest,
         requestOptions?: DocumentsClient.RequestOptions,
     ): Promise<core.WithRawResponse<Corti.DocumentsGetResponse>> {
+        const { cortiRetentionPolicy, body: _body } = request;
         const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
         const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
             _authRequest.headers,
             this._options?.headers,
-            mergeOnlyDefinedHeaders({ "Tenant-Name": requestOptions?.tenantName ?? this._options?.tenantName }),
+            mergeOnlyDefinedHeaders({
+                "X-Corti-Retention-Policy": cortiRetentionPolicy,
+                "Tenant-Name": requestOptions?.tenantName ?? this._options?.tenantName,
+            }),
             requestOptions?.headers,
         );
         const _response = await core.fetcher({
@@ -193,7 +199,7 @@ export class DocumentsClient {
             contentType: "application/json",
             queryParameters: requestOptions?.queryParams,
             requestType: "json",
-            body: serializers.DocumentsCreateRequest.jsonOrThrow(request, {
+            body: serializers.DocumentsCreateRequest.jsonOrThrow(_body, {
                 unrecognizedObjectKeys: "strip",
                 omitUndefined: true,
             }),
@@ -592,7 +598,7 @@ export class DocumentsClient {
      * Context can combine different types or reference an interactionId to automatically fetch existing context to pass to the LLM. Note that discarded facts are not passed to the LLM.
      * With the exception of the plain `templateRef` path (no overrides), every call creates a new auto-generated template aggregate that snapshots the resolved prompts as a drift-proof receipt, persisted for 30 days.
      *
-     * @param {Corti.GuidedDocumentsGenerateRequest} request
+     * @param {Corti.GenerateDocumentsRequest} request
      * @param {DocumentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -602,28 +608,34 @@ export class DocumentsClient {
      *
      * @example
      *     await client.documents.generate({
-     *         outputLanguage: "outputLanguage",
-     *         templateRef: {
-     *             templateId: "templateId"
+     *         body: {
+     *             outputLanguage: "outputLanguage",
+     *             templateRef: {
+     *                 templateId: "templateId"
+     *             }
      *         }
      *     })
      */
     public generate(
-        request: Corti.GuidedDocumentsGenerateRequest,
+        request: Corti.GenerateDocumentsRequest,
         requestOptions?: DocumentsClient.RequestOptions,
     ): core.HttpResponsePromise<Corti.GuidedDocumentsCreateEphemeralResponse> {
         return core.HttpResponsePromise.fromPromise(this.__generate(request, requestOptions));
     }
 
     private async __generate(
-        request: Corti.GuidedDocumentsGenerateRequest,
+        request: Corti.GenerateDocumentsRequest,
         requestOptions?: DocumentsClient.RequestOptions,
     ): Promise<core.WithRawResponse<Corti.GuidedDocumentsCreateEphemeralResponse>> {
+        const { cortiRetentionPolicy, body: _body } = request;
         const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
         const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
             _authRequest.headers,
             this._options?.headers,
-            mergeOnlyDefinedHeaders({ "Tenant-Name": requestOptions?.tenantName ?? this._options?.tenantName }),
+            mergeOnlyDefinedHeaders({
+                "X-Corti-Retention-Policy": cortiRetentionPolicy,
+                "Tenant-Name": requestOptions?.tenantName ?? this._options?.tenantName,
+            }),
             requestOptions?.headers,
         );
         const _response = await core.fetcher({
@@ -637,7 +649,7 @@ export class DocumentsClient {
             contentType: "application/json",
             queryParameters: requestOptions?.queryParams,
             requestType: "json",
-            body: serializers.GuidedDocumentsGenerateRequest.jsonOrThrow(request, {
+            body: serializers.GuidedDocumentsGenerateRequest.jsonOrThrow(_body, {
                 unrecognizedObjectKeys: "strip",
                 omitUndefined: true,
             }),

src/api/resources/documents/client/requests/CreateDocumentsRequest.ts

@@ -0,0 +1,24 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Corti from "../../../../index.js";
+
+/**
+ * @example
+ *     {
+ *         body: {
+ *             context: [{
+ *                     type: "facts",
+ *                     data: [{
+ *                             text: "text"
+ *                         }]
+ *                 }],
+ *             templateKey: "templateKey",
+ *             outputLanguage: "outputLanguage"
+ *         }
+ *     }
+ */
+export interface CreateDocumentsRequest {
+    /** With the optional header `X-Corti-Retention-Policy:none` the API will generate and return the document as expected, but the generated document will not be saved to the database. The response will include the header `X-Corti-Retention-Policy:acknowledged` to confirm that your retention preference was respected. If the header is omitted or set to any other value, the default retention policy will apply, and the document will be stored in the database. */
+    cortiRetentionPolicy?: Corti.CreateDocumentsRequestXCortiRetentionPolicy;
+    body: Corti.DocumentsCreateRequest;
+}