Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

Add internal ns to sdk - add agents.get_code_snippets (#522)

Chirag Jain52987a7a1a46
diff --git a/.changeset/sdk-internal-agents-get-code-snippets.md b/.changeset/sdk-internal-agents-get-code-snippets.md
new file mode 100644
index 000000000..099be6d46
--- /dev/null
+++ b/.changeset/sdk-internal-agents-get-code-snippets.md
@@ -0,0 +1,5 @@
+---
+"@truefoundry/trueforge-sdk": patch
+---
+
+Add `internal.agents.getCodeSnippets` API under the new SDK `internal` namespace.
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json
index 273b52efb..3c7d7aacb 100644
--- a/.github/fern/openapi/openapi.json
+++ b/.github/fern/openapi/openapi.json
@@ -45,6 +45,72 @@
],
"type": "object"
},
+ "AgentCodeSnippet": {
+ "additionalProperties": false,
+ "properties": {
+ "icon": {
+ "format": "uri",
+ "type": "string"
+ },
+ "label_name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "language": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "sample_code": {
+ "$ref": "#/components/schemas/AgentCodeSnippetSampleCode"
+ }
+ },
+ "required": [
+ "label_name",
+ "language",
+ "icon",
+ "sample_code"
+ ],
+ "type": "object"
+ },
+ "AgentCodeSnippetSampleCode": {
+ "additionalProperties": false,
+ "properties": {
+ "non_stream": {
+ "description": "SDK sample that creates a turn without streaming.",
+ "type": "string"
+ },
+ "stream": {
+ "description": "SDK sample that streams turn events.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "stream",
+ "non_stream"
+ ],
+ "type": "object"
+ },
+ "AgentCodeSnippets": {
+ "additionalProperties": false,
+ "properties": {
+ "base_url": {
+ "description": "Origin to pass as the TrueForge SDK `baseUrl`.",
+ "format": "uri",
+ "type": "string"
+ },
+ "snippets": {
+ "items": {
+ "$ref": "#/components/schemas/AgentCodeSnippet"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "base_url",
+ "snippets"
+ ],
+ "type": "object"
+ },
"AgentInfo": {
"properties": {
"input": {
@@ -1180,6 +1246,17 @@
},
"type": "object"
},
+ "GetAgentCodeSnippetsResponse": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/AgentCodeSnippets"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "type": "object"
+ },
"GetAgentResponse": {
"properties": {
"data": {
@@ -4667,72 +4744,7 @@
"content": {
"application/json": {
"schema": {
- "properties": {
- "data": {
- "additionalProperties": false,
- "properties": {
- "base_url": {
- "description": "Origin to pass as the TrueForge SDK `baseUrl`.",
- "format": "uri",
- "type": "string"
- },
- "snippets": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "icon": {
- "format": "uri",
- "type": "string"
- },
- "label_name": {
- "minLength": 1,
- "type": "string"
- },
- "language": {
- "minLength": 1,
- "type": "string"
- },
- "sample_code": {
- "additionalProperties": false,
- "properties": {
- "non_stream": {
- "description": "SDK sample that creates a turn without streaming.",
- "type": "string"
- },
- "stream": {
- "description": "SDK sample that streams turn events.",
- "type": "string"
- }
- },
- "required": [
- "stream",
- "non_stream"
- ],
- "type": "object"
- }
- },
- "required": [
- "label_name",
- "language",
- "icon",
- "sample_code"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "base_url",
- "snippets"
- ],
- "type": "object"
- }
- },
- "required": [
- "data"
- ],
- "type": "object"
+ "$ref": "#/components/schemas/GetAgentCodeSnippetsResponse"
}
}
},
@@ -4754,7 +4766,11 @@
"Agents"
],
"x-excluded": true,
- "x-fern-ignore": true
+ "x-fern-sdk-group-name": [
+ "internal",
+ "agents"
+ ],
+ "x-fern-sdk-method-name": "get_code_snippets"
}
},
"/api/v1/auth/callback": {
diff --git a/docs/openapi.json b/docs/openapi.json
index 273b52efb..3c7d7aacb 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -45,6 +45,72 @@
],
"type": "object"
},
+ "AgentCodeSnippet": {
+ "additionalProperties": false,
+ "properties": {
+ "icon": {
+ "format": "uri",
+ "type": "string"
+ },
+ "label_name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "language": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "sample_code": {
+ "$ref": "#/components/schemas/AgentCodeSnippetSampleCode"
+ }
+ },
+ "required": [
+ "label_name",
+ "language",
+ "icon",
+ "sample_code"
+ ],
+ "type": "object"
+ },
+ "AgentCodeSnippetSampleCode": {
+ "additionalProperties": false,
+ "properties": {
+ "non_stream": {
+ "description": "SDK sample that creates a turn without streaming.",
+ "type": "string"
+ },
+ "stream": {
+ "description": "SDK sample that streams turn events.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "stream",
+ "non_stream"
+ ],
+ "type": "object"
+ },
+ "AgentCodeSnippets": {
+ "additionalProperties": false,
+ "properties": {
+ "base_url": {
+ "description": "Origin to pass as the TrueForge SDK `baseUrl`.",
+ "format": "uri",
+ "type": "string"
+ },
+ "snippets": {
+ "items": {
+ "$ref": "#/components/schemas/AgentCodeSnippet"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "base_url",
+ "snippets"
+ ],
+ "type": "object"
+ },
"AgentInfo": {
"properties": {
"input": {
@@ -1180,6 +1246,17 @@
},
"type": "object"
},
+ "GetAgentCodeSnippetsResponse": {
+ "properties": {
+ "data": {
+ "$ref": "#/components/schemas/AgentCodeSnippets"
+ }
+ },
+ "required": [
+ "data"
+ ],
+ "type": "object"
+ },
"GetAgentResponse": {
"properties": {
"data": {
@@ -4667,72 +4744,7 @@
"content": {
"application/json": {
"schema": {
- "properties": {
- "data": {
- "additionalProperties": false,
- "properties": {
- "base_url": {
- "description": "Origin to pass as the TrueForge SDK `baseUrl`.",
- "format": "uri",
- "type": "string"
- },
- "snippets": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "icon": {
- "format": "uri",
- "type": "string"
- },
- "label_name": {
- "minLength": 1,
- "type": "string"
- },
- "language": {
- "minLength": 1,
- "type": "string"
- },
- "sample_code": {
- "additionalProperties": false,
- "properties": {
- "non_stream": {
- "description": "SDK sample that creates a turn without streaming.",
- "type": "string"
- },
- "stream": {
- "description": "SDK sample that streams turn events.",
- "type": "string"
- }
- },
- "required": [
- "stream",
- "non_stream"
- ],
- "type": "object"
- }
- },
- "required": [
- "label_name",
- "language",
- "icon",
- "sample_code"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "base_url",
- "snippets"
- ],
- "type": "object"
- }
- },
- "required": [
- "data"
- ],
- "type": "object"
+ "$ref": "#/components/schemas/GetAgentCodeSnippetsResponse"
}
}
},
@@ -4754,7 +4766,11 @@
"Agents"
],
"x-excluded": true,
- "x-fern-ignore": true
+ "x-fern-sdk-group-name": [
+ "internal",
+ "agents"
+ ],
+ "x-fern-sdk-method-name": "get_code_snippets"
}
},
"/api/v1/auth/callback": {
diff --git a/packages/trueforge-sdk/package.json b/packages/trueforge-sdk/package.json
index 05c2fdca6..4741b5fd8 100644
--- a/packages/trueforge-sdk/package.json
+++ b/packages/trueforge-sdk/package.json
@@ -172,6 +172,28 @@
},
"default": "./dist/cjs/api/resources/catalogs/resources/skills/exports.js"
},
+ "./internal": {
+ "import": {
+ "types": "./dist/esm/api/resources/internal/exports.d.mts",
+ "default": "./dist/esm/api/resources/internal/exports.mjs"
+ },
+ "require": {
+ "types": "./dist/cjs/api/resources/internal/exports.d.ts",
+ "default": "./dist/cjs/api/resources/internal/exports.js"
+ },
+ "default": "./dist/cjs/api/resources/internal/exports.js"
+ },
+ "./internal/agents": {
+ "import": {
+ "types": "./dist/esm/api/resources/internal/resources/agents/exports.d.mts",
+ "default": "./dist/esm/api/resources/internal/resources/agents/exports.mjs"
+ },
+ "require": {
+ "types": "./dist/cjs/api/resources/internal/resources/agents/exports.d.ts",
+ "default": "./dist/cjs/api/resources/internal/resources/agents/exports.js"
+ },
+ "default": "./dist/cjs/api/resources/internal/resources/agents/exports.js"
+ },
"./settings": {
"import": {
"types": "./dist/esm/api/resources/settings/exports.d.mts",
diff --git a/packages/trueforge-sdk/reference.md b/packages/trueforge-sdk/reference.md
index ef2c9ff78..fb50247e7 100644
--- a/packages/trueforge-sdk/reference.md
+++ b/packages/trueforge-sdk/reference.md
@@ -2432,6 +2432,70 @@ await client.catalogs.skills.list();
</dl>
+</dd>
+</dl>
+</details>
+
+## Internal Agents
+<details><summary><code>client.internal.agents.<a href="/src/api/resources/internal/resources/agents/client/Client.ts">getCodeSnippets</a>(agent_id) -> TrueForge.GetAgentCodeSnippetsResponse</code></summary>
+<dl>
+<dd>
+
+#### πŸ“ Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### πŸ”Œ Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.internal.agents.getCodeSnippets("agent_id");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### βš™οΈ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**agent_id:** `string` β€” Immutable agent identifier.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentsClient.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
</dd>
</dl>
</details>
diff --git a/packages/trueforge-sdk/src/Client.ts b/packages/trueforge-sdk/src/Client.ts
index ed658f25b..6c3ca5450 100644
--- a/packages/trueforge-sdk/src/Client.ts
+++ b/packages/trueforge-sdk/src/Client.ts
@@ -3,6 +3,7 @@
import { AgentsClient } from "./api/resources/agents/client/Client.js";
import { AuthClient } from "./api/resources/auth/client/Client.js";
import { CatalogsClient } from "./api/resources/catalogs/client/Client.js";
+import { InternalClient } from "./api/resources/internal/client/Client.js";
import { McpServersClient } from "./api/resources/mcpServers/client/Client.js";
import { ModelsClient } from "./api/resources/models/client/Client.js";
import { SchedulesClient } from "./api/resources/schedules/client/Client.js";
@@ -31,6 +32,7 @@ export class TrueForge {
protected _sessions: SessionsClient | undefined;
protected _skills: SkillsClient | undefined;
protected _catalogs: CatalogsClient | undefined;
+ protected _internal: InternalClient | undefined;
protected _settings: SettingsClient | undefined;
constructor(options: TrueForge.Options) {
@@ -73,6 +75,10 @@ export class TrueForge {
return (this._catalogs ??= new CatalogsClient(this._options));
}
+ public get internal(): InternalClient {
+ return (this._internal ??= new InternalClient(this._options));
+ }
+
public get settings(): SettingsClient {
return (this._settings ??= new SettingsClient(this._options));
}
diff --git a/packages/trueforge-sdk/src/api/resources/index.ts b/packages/trueforge-sdk/src/api/resources/index.ts
index e5ee899b1..3d97a276c 100644
--- a/packages/trueforge-sdk/src/api/resources/index.ts
+++ b/packages/trueforge-sdk/src/api/resources/index.ts
@@ -2,6 +2,7 @@ export * from "./agents/client/requests/index.js";
export * as agents from "./agents/index.js";
export * as auth from "./auth/index.js";
export * as catalogs from "./catalogs/index.js";
+export * as internal from "./internal/index.js";
export * from "./mcpServers/client/requests/index.js";
export * as mcpServers from "./mcpServers/index.js";
export * as models from "./models/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/internal/client/Client.ts b/packages/trueforge-sdk/src/api/resources/internal/client/Client.ts
new file mode 100644
index 000000000..b2c95313c
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/client/Client.ts
@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { AgentsClient } from "../resources/agents/client/Client.js";
+
+export declare namespace InternalClient {
+ export type Options = BaseClientOptions;
+}
+
+export class InternalClient {
+ protected readonly _options: NormalizedClientOptionsWithAuth<InternalClient.Options>;
+ protected _agents: AgentsClient | undefined;
+
+ constructor(options: InternalClient.Options) {
+ this._options = normalizeClientOptionsWithAuth(options);
+ }
+
+ public get agents(): AgentsClient {
+ return (this._agents ??= new AgentsClient(this._options));
+ }
+}
diff --git a/packages/trueforge-sdk/src/api/resources/internal/client/index.ts b/packages/trueforge-sdk/src/api/resources/internal/client/index.ts
new file mode 100644
index 000000000..cb0ff5c3b
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/client/index.ts
@@ -0,0 +1 @@
+export {};
diff --git a/packages/trueforge-sdk/src/api/resources/internal/exports.ts b/packages/trueforge-sdk/src/api/resources/internal/exports.ts
new file mode 100644
index 000000000..d8b87d8ce
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/exports.ts
@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export { InternalClient } from "./client/Client.js";
+export * from "./client/index.js";
+export * from "./resources/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/internal/index.ts b/packages/trueforge-sdk/src/api/resources/internal/index.ts
new file mode 100644
index 000000000..9eb1192dc
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/index.ts
@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+export * from "./resources/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/internal/resources/agents/client/Client.ts b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/client/Client.ts
new file mode 100644
index 000000000..08d8a7745
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/client/Client.ts
@@ -0,0 +1,112 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.js";
+import { mergeHeaders } from "../../../../../../core/headers.js";
+import * as core from "../../../../../../core/index.js";
+import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../../../errors/index.js";
+import * as serializers from "../../../../../../serialization/index.js";
+import * as TrueForge from "../../../../../index.js";
+
+export declare namespace AgentsClient {
+ export type Options = BaseClientOptions;
+
+ export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class AgentsClient {
+ protected readonly _options: NormalizedClientOptionsWithAuth<AgentsClient.Options>;
+
+ constructor(options: AgentsClient.Options) {
+ this._options = normalizeClientOptionsWithAuth(options);
+ }
+
+ /**
+ * TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.
+ *
+ * @param {string} agent_id - Immutable agent identifier.
+ * @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
+ *
+ * @throws {@link TrueForge.NotFoundError}
+ * @throws {@link errors.TrueForgeError}
+ * @throws {@link errors.TrueForgeTimeoutError}
+ *
+ * @example
+ * await client.internal.agents.getCodeSnippets("agent_id")
+ */
+ public getCodeSnippets(
+ agent_id: string,
+ requestOptions?: AgentsClient.RequestOptions,
+ ): core.HttpResponsePromise<TrueForge.GetAgentCodeSnippetsResponse> {
+ return core.HttpResponsePromise.fromPromise(this.__getCodeSnippets(agent_id, requestOptions));
+ }
+
+ private async __getCodeSnippets(
+ agent_id: string,
+ requestOptions?: AgentsClient.RequestOptions,
+ ): Promise<core.WithRawResponse<TrueForge.GetAgentCodeSnippetsResponse>> {
+ const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+ const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+ _authRequest.headers,
+ this._options?.headers,
+ requestOptions?.headers,
+ );
+ const _response = await (this._options.fetcher ?? core.fetcher)({
+ url: core.url.join(
+ (await core.Supplier.get(this._options.baseUrl)) ??
+ (await core.Supplier.get(this._options.environment)),
+ `api/v1/agents/${core.url.encodePathParam(agent_id)}/code-snippets`,
+ ),
+ method: "GET",
+ headers: _headers,
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+ abortSignal: requestOptions?.abortSignal,
+ fetchFn: this._options?.fetch,
+ logging: this._options.logging,
+ });
+ if (_response.ok) {
+ return {
+ data: serializers.GetAgentCodeSnippetsResponse.parseOrThrow(_response.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ rawResponse: _response.rawResponse,
+ };
+ }
+
+ if (_response.error.reason === "status-code") {
+ switch (_response.error.statusCode) {
+ case 404:
+ throw new TrueForge.NotFoundError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ default:
+ throw new errors.TrueForgeError({
+ statusCode: _response.error.statusCode,
+ body: _response.error.body,
+ rawResponse: _response.rawResponse,
+ });
+ }
+ }
+
+ return handleNonStatusCodeError(
+ _response.error,
+ _response.rawResponse,
+ "GET",
+ "/api/v1/agents/{agent_id}/code-snippets",
+ );
+ }
+}
diff --git a/packages/trueforge-sdk/src/api/resources/internal/resources/agents/client/index.ts b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/client/index.ts
new file mode 100644
index 000000000..cb0ff5c3b
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/client/index.ts
@@ -0,0 +1 @@
+export {};
diff --git a/packages/trueforge-sdk/src/api/resources/internal/resources/agents/exports.ts b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/exports.ts
new file mode 100644
index 000000000..b468a638b
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/exports.ts
@@ -0,0 +1,4 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export { AgentsClient } from "./client/Client.js";
+export * from "./client/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/internal/resources/agents/index.ts b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/index.ts
new file mode 100644
index 000000000..914b8c3c7
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/resources/agents/index.ts
@@ -0,0 +1 @@
+export * from "./client/index.js";
diff --git a/packages/trueforge-sdk/src/api/resources/internal/resources/index.ts b/packages/trueforge-sdk/src/api/resources/internal/resources/index.ts
new file mode 100644
index 000000000..a9be31949
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/resources/internal/resources/index.ts
@@ -0,0 +1 @@
+export * as agents from "./agents/index.js";
diff --git a/packages/trueforge-sdk/src/api/types/AgentCodeSnippet.ts b/packages/trueforge-sdk/src/api/types/AgentCodeSnippet.ts
new file mode 100644
index 000000000..f8b2ae472
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/AgentCodeSnippet.ts
@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface AgentCodeSnippet {
+ icon: string;
+ labelName: string;
+ language: string;
+ sampleCode: TrueForge.AgentCodeSnippetSampleCode;
+}
diff --git a/packages/trueforge-sdk/src/api/types/AgentCodeSnippetSampleCode.ts b/packages/trueforge-sdk/src/api/types/AgentCodeSnippetSampleCode.ts
new file mode 100644
index 000000000..da977053d
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/AgentCodeSnippetSampleCode.ts
@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export interface AgentCodeSnippetSampleCode {
+ /** SDK sample that creates a turn without streaming. */
+ nonStream: string;
+ /** SDK sample that streams turn events. */
+ stream: string;
+}
diff --git a/packages/trueforge-sdk/src/api/types/AgentCodeSnippets.ts b/packages/trueforge-sdk/src/api/types/AgentCodeSnippets.ts
new file mode 100644
index 000000000..b86134ef0
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/AgentCodeSnippets.ts
@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface AgentCodeSnippets {
+ /** Origin to pass as the TrueForge SDK `baseUrl`. */
+ baseUrl: string;
+ snippets: TrueForge.AgentCodeSnippet[];
+}
diff --git a/packages/trueforge-sdk/src/api/types/GetAgentCodeSnippetsResponse.ts b/packages/trueforge-sdk/src/api/types/GetAgentCodeSnippetsResponse.ts
new file mode 100644
index 000000000..35e1e289a
--- /dev/null
+++ b/packages/trueforge-sdk/src/api/types/GetAgentCodeSnippetsResponse.ts
@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface GetAgentCodeSnippetsResponse {
+ data: TrueForge.AgentCodeSnippets;
+}
diff --git a/packages/trueforge-sdk/src/api/types/index.ts b/packages/trueforge-sdk/src/api/types/index.ts
index ee41d22de..7baa28fe8 100644
--- a/packages/trueforge-sdk/src/api/types/index.ts
+++ b/packages/trueforge-sdk/src/api/types/index.ts
@@ -1,5 +1,8 @@
export * from "./ActionRequiredEvent.js";
export * from "./Agent.js";
+export * from "./AgentCodeSnippet.js";
+export * from "./AgentCodeSnippetSampleCode.js";
+export * from "./AgentCodeSnippets.js";
export * from "./AgentInfo.js";
export * from "./AgentParent.js";
export * from "./AgentSpec.js";
@@ -50,6 +53,7 @@ export * from "./FileContent.js";
export * from "./FinishReason.js";
export * from "./FireworksModelProvider.js";
export * from "./GenerativeUiConfig.js";
+export * from "./GetAgentCodeSnippetsResponse.js";
export * from "./GetAgentResponse.js";
export * from "./GetCapabilitiesResponse.js";
export * from "./GetMcpServerCatalogResponse.js";
diff --git a/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippet.ts b/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippet.ts
new file mode 100644
index 000000000..e07712f74
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippet.ts
@@ -0,0 +1,25 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { AgentCodeSnippetSampleCode } from "./AgentCodeSnippetSampleCode.js";
+
+export const AgentCodeSnippet: core.serialization.ObjectSchema<
+ serializers.AgentCodeSnippet.Raw,
+ TrueForge.AgentCodeSnippet
+> = core.serialization.object({
+ icon: core.serialization.string(),
+ labelName: core.serialization.property("label_name", core.serialization.string()),
+ language: core.serialization.string(),
+ sampleCode: core.serialization.property("sample_code", AgentCodeSnippetSampleCode),
+});
+
+export declare namespace AgentCodeSnippet {
+ export interface Raw {
+ icon: string;
+ label_name: string;
+ language: string;
+ sample_code: AgentCodeSnippetSampleCode.Raw;
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippetSampleCode.ts b/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippetSampleCode.ts
new file mode 100644
index 000000000..6abf4c99e
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippetSampleCode.ts
@@ -0,0 +1,20 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+
+export const AgentCodeSnippetSampleCode: core.serialization.ObjectSchema<
+ serializers.AgentCodeSnippetSampleCode.Raw,
+ TrueForge.AgentCodeSnippetSampleCode
+> = core.serialization.object({
+ nonStream: core.serialization.property("non_stream", core.serialization.string()),
+ stream: core.serialization.string(),
+});
+
+export declare namespace AgentCodeSnippetSampleCode {
+ export interface Raw {
+ non_stream: string;
+ stream: string;
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippets.ts b/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippets.ts
new file mode 100644
index 000000000..037df418c
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/AgentCodeSnippets.ts
@@ -0,0 +1,21 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { AgentCodeSnippet } from "./AgentCodeSnippet.js";
+
+export const AgentCodeSnippets: core.serialization.ObjectSchema<
+ serializers.AgentCodeSnippets.Raw,
+ TrueForge.AgentCodeSnippets
+> = core.serialization.object({
+ baseUrl: core.serialization.property("base_url", core.serialization.string()),
+ snippets: core.serialization.list(AgentCodeSnippet),
+});
+
+export declare namespace AgentCodeSnippets {
+ export interface Raw {
+ base_url: string;
+ snippets: AgentCodeSnippet.Raw[];
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/GetAgentCodeSnippetsResponse.ts b/packages/trueforge-sdk/src/serialization/types/GetAgentCodeSnippetsResponse.ts
new file mode 100644
index 000000000..86436a272
--- /dev/null
+++ b/packages/trueforge-sdk/src/serialization/types/GetAgentCodeSnippetsResponse.ts
@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { AgentCodeSnippets } from "./AgentCodeSnippets.js";
+
+export const GetAgentCodeSnippetsResponse: core.serialization.ObjectSchema<
+ serializers.GetAgentCodeSnippetsResponse.Raw,
+ TrueForge.GetAgentCodeSnippetsResponse
+> = core.serialization.object({
+ data: AgentCodeSnippets,
+});
+
+export declare namespace GetAgentCodeSnippetsResponse {
+ export interface Raw {
+ data: AgentCodeSnippets.Raw;
+ }
+}
diff --git a/packages/trueforge-sdk/src/serialization/types/index.ts b/packages/trueforge-sdk/src/serialization/types/index.ts
index ee41d22de..7baa28fe8 100644
--- a/packages/trueforge-sdk/src/serialization/types/index.ts
+++ b/packages/trueforge-sdk/src/serialization/types/index.ts
@@ -1,5 +1,8 @@
export * from "./ActionRequiredEvent.js";
export * from "./Agent.js";
+export * from "./AgentCodeSnippet.js";
+export * from "./AgentCodeSnippetSampleCode.js";
+export * from "./AgentCodeSnippets.js";
export * from "./AgentInfo.js";
export * from "./AgentParent.js";
export * from "./AgentSpec.js";
@@ -50,6 +53,7 @@ export * from "./FileContent.js";
export * from "./FinishReason.js";
export * from "./FireworksModelProvider.js";
export * from "./GenerativeUiConfig.js";
+export * from "./GetAgentCodeSnippetsResponse.js";
export * from "./GetAgentResponse.js";
export * from "./GetCapabilitiesResponse.js";
export * from "./GetMcpServerCatalogResponse.js";
diff --git a/packages/trueforge-sdk/tests/wire/internal/agents.test.ts b/packages/trueforge-sdk/tests/wire/internal/agents.test.ts
new file mode 100644
index 000000000..87df366cc
--- /dev/null
+++ b/packages/trueforge-sdk/tests/wire/internal/agents.test.ts
@@ -0,0 +1,71 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import * as TrueForgeTypes from "../../../src/api/index";
+import { TrueForge } from "../../../src/Client";
+import { mockServerPool } from "../../mock-server/MockServerPool";
+
+describe("AgentsClient", () => {
+ test("get_code_snippets (1)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = {
+ data: {
+ base_url: "base_url",
+ snippets: [
+ {
+ icon: "icon",
+ label_name: "label_name",
+ language: "language",
+ sample_code: { non_stream: "non_stream", stream: "stream" },
+ },
+ ],
+ },
+ };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/agents/agent_id/code-snippets")
+ .respondWith()
+ .statusCode(200)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ const response = await client.internal.agents.getCodeSnippets("agent_id");
+ expect(response).toEqual({
+ data: {
+ baseUrl: "base_url",
+ snippets: [
+ {
+ icon: "icon",
+ labelName: "label_name",
+ language: "language",
+ sampleCode: {
+ nonStream: "non_stream",
+ stream: "stream",
+ },
+ },
+ ],
+ },
+ });
+ });
+
+ test("get_code_snippets (2)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .get("/api/v1/agents/agent_id/code-snippets")
+ .respondWith()
+ .statusCode(404)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.internal.agents.getCodeSnippets("agent_id");
+ }).rejects.toThrow(TrueForgeTypes.NotFoundError);
+ });
+});
diff --git a/packages/trueforge/src/routes/agentRoutes.ts b/packages/trueforge/src/routes/agentRoutes.ts
index 6655e433b..23c0a4f5f 100644
--- a/packages/trueforge/src/routes/agentRoutes.ts
+++ b/packages/trueforge/src/routes/agentRoutes.ts
@@ -81,7 +81,8 @@ export const getAgentCodeSnippetsRoute = createRoute({
summary: 'Get agent SDK code snippets',
description:
'TypeScript TrueForge SDK samples (stream and non-stream) for creating a session and turn against this agent.',
- 'x-fern-ignore': true,
+ 'x-fern-sdk-group-name': ['internal', 'agents'],
+ 'x-fern-sdk-method-name': 'get_code_snippets',
'x-excluded': true,
request: {
params: AgentIdParamsSchema,
diff --git a/packages/trueforge/src/schemas/agent.ts b/packages/trueforge/src/schemas/agent.ts
index e5ad277c4..b6db2b7d6 100644
--- a/packages/trueforge/src/schemas/agent.ts
+++ b/packages/trueforge/src/schemas/agent.ts
@@ -42,7 +42,8 @@ export const AgentCodeSnippetSampleCodeSchema = z
stream: z.string().describe('SDK sample that streams turn events.'),
non_stream: z.string().describe('SDK sample that creates a turn without streaming.'),
})
- .strict();
+ .strict()
+ .openapi('AgentCodeSnippetSampleCode');
export const AgentCodeSnippetSchema = z
.object({
@@ -51,16 +52,20 @@ export const AgentCodeSnippetSchema = z
icon: z.url(),
sample_code: AgentCodeSnippetSampleCodeSchema,
})
- .strict();
+ .strict()
+ .openapi('AgentCodeSnippet');
export const AgentCodeSnippetsSchema = z
.object({
base_url: z.url().describe('Origin to pass as the TrueForge SDK `baseUrl`.'),
snippets: z.array(AgentCodeSnippetSchema),
})
- .strict();
+ .strict()
+ .openapi('AgentCodeSnippets');
-export const GetAgentCodeSnippetsResponseSchema = z.object({ data: AgentCodeSnippetsSchema });
+export const GetAgentCodeSnippetsResponseSchema = z
+ .object({ data: AgentCodeSnippetsSchema })
+ .openapi('GetAgentCodeSnippetsResponse');
export type CreateAgentRequest = z.infer<typeof CreateAgentRequestSchema>;
export type UpdateAgentRequest = z.infer<typeof UpdateAgentRequestSchema>;