diff --git a/.changeset/assume-session-creator-create-turn.md b/.changeset/assume-session-creator-create-turn.md new file mode 100644 index 000000000..2ee7c6439 --- /dev/null +++ b/.changeset/assume-session-creator-create-turn.md @@ -0,0 +1,5 @@ +--- +'@truefoundry/trueforge': patch +--- + +Service API key may create or list turns on `/api/v1/sessions/{session_id}/turns` with `assume-user: session-creator` (identity is the session creator). diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json index 0ebe5588a..6399bf97d 100644 --- a/.github/fern/openapi/openapi.json +++ b/.github/fern/openapi/openapi.json @@ -10724,6 +10724,18 @@ "get": { "description": "List turns for a session (newest first by default), token-paginated. Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.", "parameters": [ + { + "description": "Service API key only: which user identity to assume. Currently only session-creator.", + "in": "header", + "name": "assume-user", + "required": false, + "schema": { + "enum": [ + "session-creator" + ], + "type": "string" + } + }, { "description": "Session identifier.", "in": "path", @@ -10819,6 +10831,18 @@ "post": { "description": "Create a turn within a session and execute it.\nOnly the session creator may create turns.\nWhen `stream` is true (default), respond with a Server-Sent Events stream of turn events.\nWhen `stream` is false, return the turn immediately with `state.status: \"running\"` while execution continues in the background; use get turn or subscribe to observe completion.\nUse `previous_turn_id` to chain to the session's last turn (defaults to `auto`); use `none` for a new root.", "parameters": [ + { + "description": "Service API key only: which user identity to assume. Currently only session-creator.", + "in": "header", + "name": "assume-user", + "required": false, + "schema": { + "enum": [ + "session-creator" + ], + "type": "string" + } + }, { "description": "Session identifier.", "in": "path", diff --git a/docs/openapi.json b/docs/openapi.json index 0ebe5588a..6399bf97d 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -10724,6 +10724,18 @@ "get": { "description": "List turns for a session (newest first by default), token-paginated. Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.", "parameters": [ + { + "description": "Service API key only: which user identity to assume. Currently only session-creator.", + "in": "header", + "name": "assume-user", + "required": false, + "schema": { + "enum": [ + "session-creator" + ], + "type": "string" + } + }, { "description": "Session identifier.", "in": "path", @@ -10819,6 +10831,18 @@ "post": { "description": "Create a turn within a session and execute it.\nOnly the session creator may create turns.\nWhen `stream` is true (default), respond with a Server-Sent Events stream of turn events.\nWhen `stream` is false, return the turn immediately with `state.status: \"running\"` while execution continues in the background; use get turn or subscribe to observe completion.\nUse `previous_turn_id` to chain to the session's last turn (defaults to `auto`); use `none` for a new root.", "parameters": [ + { + "description": "Service API key only: which user identity to assume. Currently only session-creator.", + "in": "header", + "name": "assume-user", + "required": false, + "schema": { + "enum": [ + "session-creator" + ], + "type": "string" + } + }, { "description": "Session identifier.", "in": "path", diff --git a/packages/trueforge-sdk/src/api/resources/sessions/client/Client.ts b/packages/trueforge-sdk/src/api/resources/sessions/client/Client.ts index 5e77bff0c..8e41849c7 100644 --- a/packages/trueforge-sdk/src/api/resources/sessions/client/Client.ts +++ b/packages/trueforge-sdk/src/api/resources/sessions/client/Client.ts @@ -2,7 +2,7 @@ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; -import { mergeHeaders } from "../../../../core/headers.js"; +import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js"; import * as core from "../../../../core/index.js"; import { mergeAdditionalBodyParameters } from "../../../../core/requestBody.js"; import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; @@ -1112,7 +1112,7 @@ export class SessionsClient { async ( request: TrueForge.ListTurnsSessionsRequest, ): Promise> => { - const { limit = 25, pageToken } = request; + const { limit = 25, pageToken, assumeUser } = request; const _queryParams: Record = { limit, page_token: pageToken, @@ -1121,6 +1121,7 @@ export class SessionsClient { const _headers: core.Fetcher.Args["headers"] = mergeHeaders( _authRequest.headers, this._options?.headers, + mergeOnlyDefinedHeaders({ "assume-user": assumeUser }), requestOptions?.headers, ); const _response = await (this._options.fetcher ?? core.fetcher)({ @@ -1239,10 +1240,12 @@ export class SessionsClient { request: TrueForge.CreateTurnSessionsStreamRequest, requestOptions?: SessionsClient.RequestOptions, ): Promise>> { + const { assumeUser, ..._body } = request; const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); const _headers: core.Fetcher.Args["headers"] = mergeHeaders( _authRequest.headers, this._options?.headers, + mergeOnlyDefinedHeaders({ "assume-user": assumeUser }), requestOptions?.headers, ); const _response = await (this._options.fetcher ?? core.fetcher)({ @@ -1258,7 +1261,7 @@ export class SessionsClient { requestType: "json", body: mergeAdditionalBodyParameters( { - ...serializers.CreateTurnSessionsStreamRequest.jsonOrThrow(request, { + ...serializers.CreateTurnSessionsStreamRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "passthrough", allowUnrecognizedUnionMembers: true, allowUnrecognizedEnumValues: true, @@ -1435,10 +1438,12 @@ export class SessionsClient { request: TrueForge.CreateTurnSessionsRequest, requestOptions?: SessionsClient.RequestOptions, ): Promise> { + const { assumeUser, ..._body } = request; const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); const _headers: core.Fetcher.Args["headers"] = mergeHeaders( _authRequest.headers, this._options?.headers, + mergeOnlyDefinedHeaders({ "assume-user": assumeUser }), requestOptions?.headers, ); const _response = await (this._options.fetcher ?? core.fetcher)({ @@ -1454,7 +1459,7 @@ export class SessionsClient { requestType: "json", body: mergeAdditionalBodyParameters( { - ...serializers.CreateTurnSessionsRequest.jsonOrThrow(request, { + ...serializers.CreateTurnSessionsRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "passthrough", allowUnrecognizedUnionMembers: true, allowUnrecognizedEnumValues: true, diff --git a/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsRequest.ts b/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsRequest.ts index 63af663f4..d7450c73d 100644 --- a/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsRequest.ts +++ b/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsRequest.ts @@ -12,6 +12,8 @@ import type * as TrueForge from "../../../../index.js"; * } */ export interface CreateTurnSessionsRequest { + /** Service API key only: which user identity to assume. Currently only session-creator. */ + assumeUser?: "session-creator"; /** User messages for this turn. At least one is required. */ input: TrueForge.CreateTurnSessionsRequestInputItem[]; previousTurnId?: TrueForge.PreviousTurnIdInput; diff --git a/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts b/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts index 803fd631a..41283d900 100644 --- a/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts +++ b/packages/trueforge-sdk/src/api/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts @@ -12,6 +12,8 @@ import type * as TrueForge from "../../../../index.js"; * } */ export interface CreateTurnSessionsStreamRequest { + /** Service API key only: which user identity to assume. Currently only session-creator. */ + assumeUser?: "session-creator"; /** User messages for this turn. At least one is required. */ input: TrueForge.CreateTurnSessionsStreamRequestInputItem[]; previousTurnId?: TrueForge.PreviousTurnIdInput; diff --git a/packages/trueforge-sdk/src/api/resources/sessions/client/requests/ListTurnsSessionsRequest.ts b/packages/trueforge-sdk/src/api/resources/sessions/client/requests/ListTurnsSessionsRequest.ts index 81882d9b4..e54b30027 100644 --- a/packages/trueforge-sdk/src/api/resources/sessions/client/requests/ListTurnsSessionsRequest.ts +++ b/packages/trueforge-sdk/src/api/resources/sessions/client/requests/ListTurnsSessionsRequest.ts @@ -9,4 +9,6 @@ export interface ListTurnsSessionsRequest { limit?: number; /** Opaque token from a previous response `next_page_token`. */ pageToken?: string; + /** Service API key only: which user identity to assume. Currently only session-creator. */ + assumeUser?: "session-creator"; } diff --git a/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsRequest.ts b/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsRequest.ts index 0c61affcb..0ce0a8aad 100644 --- a/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsRequest.ts +++ b/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsRequest.ts @@ -8,7 +8,7 @@ import { CreateTurnSessionsRequestInputItem } from "../../types/CreateTurnSessio export const CreateTurnSessionsRequest: core.serialization.Schema< serializers.CreateTurnSessionsRequest.Raw, - TrueForge.CreateTurnSessionsRequest + Omit > = core.serialization.object({ input: core.serialization.list(CreateTurnSessionsRequestInputItem), previousTurnId: core.serialization.property("previous_turn_id", PreviousTurnIdInput.optional()), diff --git a/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts b/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts index a6dc2d3f5..abc4b4842 100644 --- a/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts +++ b/packages/trueforge-sdk/src/serialization/resources/sessions/client/requests/CreateTurnSessionsStreamRequest.ts @@ -8,7 +8,7 @@ import { CreateTurnSessionsStreamRequestInputItem } from "../../types/CreateTurn export const CreateTurnSessionsStreamRequest: core.serialization.Schema< serializers.CreateTurnSessionsStreamRequest.Raw, - TrueForge.CreateTurnSessionsStreamRequest + Omit > = core.serialization.object({ input: core.serialization.list(CreateTurnSessionsStreamRequestInputItem), previousTurnId: core.serialization.property("previous_turn_id", PreviousTurnIdInput.optional()), diff --git a/packages/trueforge/src/apis/turns.ts b/packages/trueforge/src/apis/turns.ts index 38bb9e83b..26c71d79d 100644 --- a/packages/trueforge/src/apis/turns.ts +++ b/packages/trueforge/src/apis/turns.ts @@ -67,6 +67,7 @@ import { HTTPException } from 'hono/http-exception'; import { streamSSE } from 'hono/streaming'; import type { Logger } from 'winston'; import { z } from 'zod'; +import { applyAssumeUserToContext, ASSUME_USER_HEADER } from '../auth/assumeUser'; import type { Authorizer } from '../auth/authorizer'; import { requestContextFromCreatedBySubject, @@ -1146,6 +1147,49 @@ function isSessionOwner({ return created_by_subject.subject_id === subject_id; } +/** + * JWT context from auth middleware, or service-key + `assume-user` as the session creator. + * Callers load the session themselves after this returns. + */ +async function resolveTurnRequestContext(params: { + c: Context; + sessions: Sessions; + session_id: string; + resolveRequestContext: ResolveRequestContext; +}): Promise { + const { c, sessions, session_id: sessionId, resolveRequestContext } = params; + const existing = c.get('request_context'); + if (existing) { + return existing; + } + // Service key clears context; require assume-user so a JWT+header cannot take this path. + if (c.req.header(ASSUME_USER_HEADER)?.trim()) { + return applyAssumeUserToContext({ + c, + resolveCreatedBy: async () => { + const session = await sessions.getById({ session_id: sessionId }); + if (!session) { + throw new HTTPException(404, { message: `Session not found: ${sessionId}` }); + } + return { + tenant_id: session.record.tenant_id, + created_by_subject: session.record.created_by_subject, + session_id: sessionId, + }; + }, + }); + } + try { + return resolveRequestContext(c); + } catch (error) { + // Service key left context unset with no assume-user → 400, not a 500 from missing context. + if (error instanceof Error && error.message === 'RequestContext missing; auth middleware did not run') { + throw new HTTPException(400, { message: `Missing ${ASSUME_USER_HEADER} header`, cause: error }); + } + throw error; + } +} + /** Request-reply path the owner serves for inbound turn events. */ const TURNS_SEND_EVENTS_PATH = 'turns/send-events'; @@ -1792,7 +1836,12 @@ export function createTurnsRouter(deps: TurnsRouterDeps = async c => { const { session_id: sessionId } = c.req.valid('param'); const query = c.req.valid('query'); - const requestContext = deps.resolveRequestContext(c); + const requestContext = await resolveTurnRequestContext({ + c, + sessions: deps.sessions, + session_id: sessionId, + resolveRequestContext: deps.resolveRequestContext, + }); const session = await deps.sessions.get({ tenant_id: requestContext.tenant_id, session_id: sessionId, @@ -1971,8 +2020,13 @@ export function createTurnsRouter(deps: TurnsRouterDeps = async c => { const { session_id: sessionId } = c.req.valid('param'); const body = c.req.valid('json'); - const requestContext = deps.resolveRequestContext(c); - + const serviceAuth = !c.get('request_context') && Boolean(c.req.header(ASSUME_USER_HEADER)?.trim()); + const requestContext = await resolveTurnRequestContext({ + c, + sessions: deps.sessions, + session_id: sessionId, + resolveRequestContext: deps.resolveRequestContext, + }); const session = await deps.sessions.get({ tenant_id: requestContext.tenant_id, session_id: sessionId, @@ -1980,25 +2034,42 @@ export function createTurnsRouter(deps: TurnsRouterDeps = { @@ -2012,7 +2083,7 @@ export function createTurnsRouter(deps: TurnsRouterDeps(deps: ServerDeps) { authMiddleware, ), ); + // Turns before sessions: a JWT-only sessions shell mounted first would 401 the service key + // on list/create turns before dual-auth runs. + const turnsRouter = new OpenAPIHono(); + turnsRouter.use( + '/:session_id/turns', + createAuthOrServiceKeyMiddleware({ + authenticator: deps.authenticator, + apiKey: configuration.TRUEFORGE_API_KEY, + }), + ); + turnsRouter.use('/:session_id/turns/:turn_id/*', authMiddleware); + turnsRouter.route( + '/', + createTurnsRouter({ + accessControlStore: deps.accessControlStore, + activeTurns: deps.activeTurns, + authorizer: deps.authorizer, + eventSubscriptions: deps.eventSubscriptions, + logger: deps.logger, + redis: deps.redis, + requestReplyRouter: deps.requestReplyRouter, + resolveAgentStore: deps.resolveAgentStore, + resolveRequestContext, + resolveTurnExecutionStores: deps.resolveTurnExecutionStores, + sandboxEnvironmentStore: deps.sandboxEnvironmentStore, + sandboxProviderStore: deps.sandboxProviderStore, + sessions: deps.sessions, + sessionStore: deps.sessionStore, + }), + ); + app.route('/api/v1/sessions', turnsRouter); app.route( '/api/v1/sessions', withAuth( @@ -674,28 +706,6 @@ export function createServerApp(deps: ServerDeps) { authMiddleware, ), ); - app.route( - '/api/v1/sessions', - withAuth( - createTurnsRouter({ - accessControlStore: deps.accessControlStore, - activeTurns: deps.activeTurns, - authorizer: deps.authorizer, - eventSubscriptions: deps.eventSubscriptions, - logger: deps.logger, - redis: deps.redis, - requestReplyRouter: deps.requestReplyRouter, - resolveAgentStore: deps.resolveAgentStore, - resolveRequestContext, - resolveTurnExecutionStores: deps.resolveTurnExecutionStores, - sandboxEnvironmentStore: deps.sandboxEnvironmentStore, - sandboxProviderStore: deps.sandboxProviderStore, - sessions: deps.sessions, - sessionStore: deps.sessionStore, - }), - authMiddleware, - ), - ); // First-party TrueForge MCP (Streamable HTTP). Protocol endpoint. app.use('/mcp', authMiddleware); diff --git a/packages/trueforge/src/auth/assumeUser.ts b/packages/trueforge/src/auth/assumeUser.ts new file mode 100644 index 000000000..f0aa0f0e6 --- /dev/null +++ b/packages/trueforge/src/auth/assumeUser.ts @@ -0,0 +1,69 @@ +import type { Subject } from '@truefoundry/trueforge-core/agent-session'; +import type { Context } from 'hono'; +import { HTTPException } from 'hono/http-exception'; + +import { updateLogContext } from '../logger'; +import { requestContextFromCreatedBySubject, type RequestContext } from './identity'; + +export const ASSUME_USER_HEADER = 'assume-user'; + +/** Supported `assume-user` header values (not raw user ids). */ +export type AssumeUser = 'session-creator'; + +/** + * OpenAPI `parameters` entry (docs only). Prefer this over Zod `request.headers`: + * a headers schema validates the header bag and must allow Authorization and other + * client headers; Nest-style `@ApiHeader` / OpenAPI parameters document without that. + */ +export const ASSUME_USER_HEADER_PARAM = { + name: ASSUME_USER_HEADER, + in: 'header' as const, + required: false, + description: 'Service API key only: which user identity to assume. Currently only session-creator.', + schema: { type: 'string' as const, enum: ['session-creator'] satisfies AssumeUser[] }, +}; + +export function parseAssumeUserHeader(header: string | undefined): AssumeUser { + const raw = header?.trim(); + if (!raw) { + throw new HTTPException(400, { message: `Missing ${ASSUME_USER_HEADER} header` }); + } + if (raw !== 'session-creator') { + throw new HTTPException(400, { + message: `Invalid ${ASSUME_USER_HEADER}: only "session-creator" is supported`, + }); + } + return raw; +} + +/** Load tenant + created_by for the assumed identity. */ +export type ResolveAssumedCreatedBy = () => Promise<{ + tenant_id: string; + created_by_subject: Subject; + session_id?: string; +}>; + +/** + * Parse assume-user, resolve the assumed subject, and set `request_context` + `assume_user` + * for handlers / token vending. + */ +export async function applyAssumeUserToContext(params: { + c: Context; + resolveCreatedBy: ResolveAssumedCreatedBy; +}): Promise { + const { c, resolveCreatedBy } = params; + const assumed = parseAssumeUserHeader(c.req.header(ASSUME_USER_HEADER)); + const createdBy = await resolveCreatedBy(); + const requestContext = requestContextFromCreatedBySubject({ + tenant_id: createdBy.tenant_id, + created_by_subject: createdBy.created_by_subject, + user_credential: null, + }); + c.set('request_context', requestContext); + c.set('assume_user', assumed); + updateLogContext({ + tenant_id: createdBy.tenant_id, + ...(createdBy.session_id ? { session_id: createdBy.session_id } : {}), + }); + return requestContext; +} diff --git a/packages/trueforge/src/auth/identity.ts b/packages/trueforge/src/auth/identity.ts index d474761f8..45caddd0f 100644 --- a/packages/trueforge/src/auth/identity.ts +++ b/packages/trueforge/src/auth/identity.ts @@ -9,6 +9,7 @@ import configuration, { } from '../config'; import { RESERVED_SANDBOX_ENVIRONMENT_NAME } from '../schemas/sandboxEnvironment'; import { createTrueFoundryRequestContext } from '../truefoundry/accessToken'; +import type { AssumeUser } from './assumeUser'; /** Standalone / default TrueForge admin role string. */ export const STANDALONE_ADMIN_ROLE = 'admin'; @@ -46,6 +47,8 @@ declare module 'hono' { interface ContextVariableMap { subject?: RequestSubject; request_context?: RequestContext; + /** Set when service auth applied `assume-user`. */ + assume_user?: AssumeUser; } } diff --git a/packages/trueforge/src/auth/middleware.ts b/packages/trueforge/src/auth/middleware.ts index 867b66229..955c383a9 100644 --- a/packages/trueforge/src/auth/middleware.ts +++ b/packages/trueforge/src/auth/middleware.ts @@ -83,6 +83,34 @@ export function createApiKeyAuthMiddleware(apiKey: string): MiddlewareHandler { }; } +/** + * JWT or service API key. Service key leaves `request_context` unset so the handler can + * apply `assume-user`. Prefer {@link createAuthMiddleware} when service keys are not allowed. + */ +export function createAuthOrServiceKeyMiddleware(params: { + authenticator: Authenticator; + apiKey: string; +}): MiddlewareHandler { + const { authenticator, apiKey } = params; + return async (c, next) => { + const token = readBearerToken(c); + if (token && matchesServiceKey({ provided: token, expected: apiKey })) { + c.set('request_context', undefined); + c.set('subject', undefined); + return next(); + } + + const requestContext = await tryAuthenticate({ authenticator, context: c }); + if (!requestContext) { + throw new HTTPException(401, { message: 'Authentication required' }); + } + c.set('subject', requestContext.subject); + c.set('request_context', requestContext); + updateLogContext({ tenant_id: requestContext.tenant_id }); + return next(); + }; +} + /** * Soft OIDC probe for login/callback — not request-gate middleware. * diff --git a/packages/trueforge/src/routes/turnRoutes.ts b/packages/trueforge/src/routes/turnRoutes.ts index 1daf8c82a..4368dbb24 100644 --- a/packages/trueforge/src/routes/turnRoutes.ts +++ b/packages/trueforge/src/routes/turnRoutes.ts @@ -5,6 +5,7 @@ * Handlers are registered in apis/turns.ts. */ import { createRoute, z } from '@hono/zod-openapi'; +import { ASSUME_USER_HEADER_PARAM } from '../auth/assumeUser'; import { RequestErrorResponseSchema } from '../schemas/errors'; import { CreateTurnEventRequestSchema, @@ -37,6 +38,7 @@ export const listTurnsRoute = createRoute({ summary: 'List turns in a session', description: 'List turns for a session (newest first by default), token-paginated. Allowed for the creator, a manager of the bound named agent, or any tenant member when the session is shared.', + parameters: [ASSUME_USER_HEADER_PARAM], 'x-fern-sdk-group-name': ['sessions'], 'x-fern-sdk-method-name': 'list_turns', 'x-fern-pagination': TOKEN_PAGINATION, @@ -232,6 +234,7 @@ Only the session creator may create turns. When \`stream\` is true (default), respond with a Server-Sent Events stream of turn events. When \`stream\` is false, return the turn immediately with \`state.status: "running"\` while execution continues in the background; use get turn or subscribe to observe completion. Use \`previous_turn_id\` to chain to the session's last turn (defaults to \`auto\`); use \`none\` for a new root.`, + parameters: [ASSUME_USER_HEADER_PARAM], 'x-fern-sdk-group-name': ['sessions'], 'x-fern-sdk-method-name': 'create_turn', 'x-fern-streaming': { diff --git a/python/trueforge_sdk/reference.md b/python/trueforge_sdk/reference.md index e77cbe50e..20a21a712 100644 --- a/python/trueforge_sdk/reference.md +++ b/python/trueforge_sdk/reference.md @@ -2948,6 +2948,14 @@ client.sessions.list_turns(
+**assume_user:** `typing.Optional[typing.Literal]` — Service API key only: which user identity to assume. Currently only session-creator. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -3047,6 +3055,14 @@ client.sessions.create_turn_stream(
+**assume_user:** `typing.Optional[typing.Literal]` — Service API key only: which user identity to assume. Currently only session-creator. + +
+
+ +
+
+ **previous_turn_id:** `typing.Optional[PreviousTurnIdInput]`
@@ -3154,6 +3170,14 @@ client.sessions.create_turn_stream(
+**assume_user:** `typing.Optional[typing.Literal]` — Service API key only: which user identity to assume. Currently only session-creator. + +
+
+ +
+
+ **previous_turn_id:** `typing.Optional[PreviousTurnIdInput]`
diff --git a/python/trueforge_sdk/src/trueforge_sdk/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/__init__.py index f995179ef..9366c3bfe 100644 --- a/python/trueforge_sdk/src/trueforge_sdk/__init__.py +++ b/python/trueforge_sdk/src/trueforge_sdk/__init__.py @@ -64,7 +64,6 @@ CreateScheduleRunResponse, CreateSessionAgent, CreateTurnEventResponse, - Subject, CronExpression, CustomModelProvider, DaytonaSandboxProviderAuth, @@ -246,6 +245,7 @@ SkillCapability, SkillManifest, SkillVersion, + Subject, TextContent, ThreadContextCompactionFinishedEvent, ThreadContextCompactionStartedEvent, @@ -404,7 +404,6 @@ "CreateTurnEventResponse": ".types", "CreateTurnSessionsRequestInputItem": ".sessions", "CreateTurnSessionsStreamRequestInputItem": ".sessions", - "Subject": ".types", "CronExpression": ".types", "CustomModelProvider": ".types", "DaytonaSandboxProviderAuth": ".types", @@ -594,6 +593,7 @@ "SkillCapability": ".types", "SkillManifest": ".types", "SkillVersion": ".types", + "Subject": ".types", "TextContent": ".types", "ThreadContextCompactionFinishedEvent": ".types", "ThreadContextCompactionStartedEvent": ".types", @@ -759,7 +759,6 @@ def __dir__(): "CreateTurnEventResponse", "CreateTurnSessionsRequestInputItem", "CreateTurnSessionsStreamRequestInputItem", - "Subject", "CronExpression", "CustomModelProvider", "DaytonaSandboxProviderAuth", @@ -949,6 +948,7 @@ def __dir__(): "SkillCapability", "SkillManifest", "SkillVersion", + "Subject", "TextContent", "ThreadContextCompactionFinishedEvent", "ThreadContextCompactionStartedEvent", diff --git a/python/trueforge_sdk/src/trueforge_sdk/sessions/client.py b/python/trueforge_sdk/src/trueforge_sdk/sessions/client.py index 68621406d..3c826d5b4 100644 --- a/python/trueforge_sdk/src/trueforge_sdk/sessions/client.py +++ b/python/trueforge_sdk/src/trueforge_sdk/sessions/client.py @@ -473,6 +473,7 @@ def list_turns( session_id: str, limit: typing.Optional[int] = 25, page_token: typing.Optional[str] = None, + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Turn, ListTurnsResponse]: """ @@ -489,6 +490,9 @@ def list_turns( page_token : typing.Optional[str] Opaque token from a previous response `next_page_token`. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -515,7 +519,11 @@ def list_turns( yield page """ return self._raw_client.list_turns( - session_id=session_id, limit=limit, page_token=page_token, request_options=request_options + session_id=session_id, + limit=limit, + page_token=page_token, + assume_user=assume_user, + request_options=request_options, ) def create_turn_stream( @@ -523,6 +531,7 @@ def create_turn_stream( *, session_id: str, input: typing.Sequence[CreateTurnSessionsStreamRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> Stream[TurnStreamingEvent]: @@ -541,6 +550,9 @@ def create_turn_stream( input : typing.Sequence[CreateTurnSessionsStreamRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -574,7 +586,11 @@ def create_turn_stream( def _events() -> typing.Generator[StreamEvent[TurnStreamingEvent], None, None]: with self._raw_client.create_turn_stream( - session_id=session_id, input=input, previous_turn_id=previous_turn_id, request_options=request_options + session_id=session_id, + input=input, + assume_user=assume_user, + previous_turn_id=previous_turn_id, + request_options=request_options, ) as r: yield from r.data.with_metadata() @@ -585,6 +601,7 @@ def create_turn( *, session_id: str, input: typing.Sequence[CreateTurnSessionsRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> GetTurnResponse: @@ -603,6 +620,9 @@ def create_turn( input : typing.Sequence[CreateTurnSessionsRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -632,7 +652,11 @@ def create_turn( ) """ _response = self._raw_client.create_turn( - session_id=session_id, input=input, previous_turn_id=previous_turn_id, request_options=request_options + session_id=session_id, + input=input, + assume_user=assume_user, + previous_turn_id=previous_turn_id, + request_options=request_options, ) return _response.data @@ -1411,6 +1435,7 @@ async def list_turns( session_id: str, limit: typing.Optional[int] = 25, page_token: typing.Optional[str] = None, + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Turn, ListTurnsResponse]: """ @@ -1427,6 +1452,9 @@ async def list_turns( page_token : typing.Optional[str] Opaque token from a previous response `next_page_token`. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1462,7 +1490,11 @@ async def main() -> None: asyncio.run(main()) """ return await self._raw_client.list_turns( - session_id=session_id, limit=limit, page_token=page_token, request_options=request_options + session_id=session_id, + limit=limit, + page_token=page_token, + assume_user=assume_user, + request_options=request_options, ) def create_turn_stream( @@ -1470,6 +1502,7 @@ def create_turn_stream( *, session_id: str, input: typing.Sequence[CreateTurnSessionsStreamRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncStream[TurnStreamingEvent]: @@ -1488,6 +1521,9 @@ def create_turn_stream( input : typing.Sequence[CreateTurnSessionsStreamRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -1529,7 +1565,11 @@ async def main() -> None: async def _events() -> typing.AsyncGenerator[StreamEvent[TurnStreamingEvent], None]: async with self._raw_client.create_turn_stream( - session_id=session_id, input=input, previous_turn_id=previous_turn_id, request_options=request_options + session_id=session_id, + input=input, + assume_user=assume_user, + previous_turn_id=previous_turn_id, + request_options=request_options, ) as r: async for _event in r.data.with_metadata(): yield _event @@ -1541,6 +1581,7 @@ async def create_turn( *, session_id: str, input: typing.Sequence[CreateTurnSessionsRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> GetTurnResponse: @@ -1559,6 +1600,9 @@ async def create_turn( input : typing.Sequence[CreateTurnSessionsRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -1596,7 +1640,11 @@ async def main() -> None: asyncio.run(main()) """ _response = await self._raw_client.create_turn( - session_id=session_id, input=input, previous_turn_id=previous_turn_id, request_options=request_options + session_id=session_id, + input=input, + assume_user=assume_user, + previous_turn_id=previous_turn_id, + request_options=request_options, ) return _response.data diff --git a/python/trueforge_sdk/src/trueforge_sdk/sessions/raw_client.py b/python/trueforge_sdk/src/trueforge_sdk/sessions/raw_client.py index 9d47dfebf..104a65b06 100644 --- a/python/trueforge_sdk/src/trueforge_sdk/sessions/raw_client.py +++ b/python/trueforge_sdk/src/trueforge_sdk/sessions/raw_client.py @@ -872,6 +872,7 @@ def list_turns( session_id: str, limit: typing.Optional[int] = 25, page_token: typing.Optional[str] = None, + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, request_options: typing.Optional[RequestOptions] = None, ) -> SyncPager[Turn, ListTurnsResponse]: """ @@ -888,6 +889,9 @@ def list_turns( page_token : typing.Optional[str] Opaque token from a previous response `next_page_token`. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -903,6 +907,9 @@ def list_turns( "limit": limit, "page_token": page_token, }, + headers={ + "assume-user": str(assume_user) if assume_user is not None else None, + }, request_options=request_options, ) try: @@ -924,6 +931,7 @@ def list_turns( session_id=session_id, limit=limit, page_token=_parsed_next, + assume_user=assume_user, request_options=request_options, ) return SyncPager(has_next=_has_next, items=_items, get_next=_get_next, response=_parsed_response) @@ -975,6 +983,7 @@ def create_turn_stream( *, session_id: str, input: typing.Sequence[CreateTurnSessionsStreamRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> typing.Iterator[HttpResponse[Stream[TurnStreamingEvent]]]: @@ -993,6 +1002,9 @@ def create_turn_stream( input : typing.Sequence[CreateTurnSessionsStreamRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -1019,6 +1031,7 @@ def create_turn_stream( }, headers={ "content-type": "application/json", + "assume-user": str(assume_user) if assume_user is not None else None, }, request_options=request_options, omit=OMIT, @@ -1160,6 +1173,7 @@ def create_turn( *, session_id: str, input: typing.Sequence[CreateTurnSessionsRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[GetTurnResponse]: @@ -1178,6 +1192,9 @@ def create_turn( input : typing.Sequence[CreateTurnSessionsRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -1202,6 +1219,7 @@ def create_turn( }, headers={ "content-type": "application/json", + "assume-user": str(assume_user) if assume_user is not None else None, }, request_options=request_options, omit=OMIT, @@ -2716,6 +2734,7 @@ async def list_turns( session_id: str, limit: typing.Optional[int] = 25, page_token: typing.Optional[str] = None, + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncPager[Turn, ListTurnsResponse]: """ @@ -2732,6 +2751,9 @@ async def list_turns( page_token : typing.Optional[str] Opaque token from a previous response `next_page_token`. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -2747,6 +2769,9 @@ async def list_turns( "limit": limit, "page_token": page_token, }, + headers={ + "assume-user": str(assume_user) if assume_user is not None else None, + }, request_options=request_options, ) try: @@ -2770,6 +2795,7 @@ async def _get_next(): session_id=session_id, limit=limit, page_token=_parsed_next, + assume_user=assume_user, request_options=request_options, ) @@ -2822,6 +2848,7 @@ async def create_turn_stream( *, session_id: str, input: typing.Sequence[CreateTurnSessionsStreamRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> typing.AsyncIterator[AsyncHttpResponse[AsyncStream[TurnStreamingEvent]]]: @@ -2840,6 +2867,9 @@ async def create_turn_stream( input : typing.Sequence[CreateTurnSessionsStreamRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -2866,6 +2896,7 @@ async def create_turn_stream( }, headers={ "content-type": "application/json", + "assume-user": str(assume_user) if assume_user is not None else None, }, request_options=request_options, omit=OMIT, @@ -3007,6 +3038,7 @@ async def create_turn( *, session_id: str, input: typing.Sequence[CreateTurnSessionsRequestInputItem], + assume_user: typing.Optional[typing.Literal["session-creator"]] = None, previous_turn_id: typing.Optional[PreviousTurnIdInput] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[GetTurnResponse]: @@ -3025,6 +3057,9 @@ async def create_turn( input : typing.Sequence[CreateTurnSessionsRequestInputItem] User messages for this turn. At least one is required. + assume_user : typing.Optional[typing.Literal["session-creator"]] + Service API key only: which user identity to assume. Currently only session-creator. + previous_turn_id : typing.Optional[PreviousTurnIdInput] request_options : typing.Optional[RequestOptions] @@ -3049,6 +3084,7 @@ async def create_turn( }, headers={ "content-type": "application/json", + "assume-user": str(assume_user) if assume_user is not None else None, }, request_options=request_options, omit=OMIT, diff --git a/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py b/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py index ea0478976..2ce7a5922 100644 --- a/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py +++ b/python/trueforge_sdk/src/trueforge_sdk/types/__init__.py @@ -63,7 +63,6 @@ from .create_schedule_run_response import CreateScheduleRunResponse from .create_session_agent import CreateSessionAgent from .create_turn_event_response import CreateTurnEventResponse - from .subject import Subject from .cron_expression import CronExpression from .custom_model_provider import CustomModelProvider from .daytona_sandbox_provider_auth import DaytonaSandboxProviderAuth @@ -245,6 +244,7 @@ from .skill_capability import SkillCapability from .skill_manifest import SkillManifest from .skill_version import SkillVersion + from .subject import Subject from .text_content import TextContent from .thread_context_compaction_finished_event import ThreadContextCompactionFinishedEvent from .thread_context_compaction_started_event import ThreadContextCompactionStartedEvent @@ -362,7 +362,6 @@ "CreateScheduleRunResponse": ".create_schedule_run_response", "CreateSessionAgent": ".create_session_agent", "CreateTurnEventResponse": ".create_turn_event_response", - "Subject": ".subject", "CronExpression": ".cron_expression", "CustomModelProvider": ".custom_model_provider", "DaytonaSandboxProviderAuth": ".daytona_sandbox_provider_auth", @@ -544,6 +543,7 @@ "SkillCapability": ".skill_capability", "SkillManifest": ".skill_manifest", "SkillVersion": ".skill_version", + "Subject": ".subject", "TextContent": ".text_content", "ThreadContextCompactionFinishedEvent": ".thread_context_compaction_finished_event", "ThreadContextCompactionStartedEvent": ".thread_context_compaction_started_event", @@ -685,7 +685,6 @@ def __dir__(): "CreateScheduleRunResponse", "CreateSessionAgent", "CreateTurnEventResponse", - "Subject", "CronExpression", "CustomModelProvider", "DaytonaSandboxProviderAuth", @@ -867,6 +866,7 @@ def __dir__(): "SkillCapability", "SkillManifest", "SkillVersion", + "Subject", "TextContent", "ThreadContextCompactionFinishedEvent", "ThreadContextCompactionStartedEvent",