--- title: "UpdateAgentSession" method: PATCH path: "/v1/namespaces/{object.tenant_meta.namespace}/agent-sessions" tags: ["AgentSessionService"] --- # UpdateAgentSession `PATCH /v1/namespaces/{object.tenant_meta.namespace}/agent-sessions` ## Request - Base URL: `https://api.endorlabs.com` - URL: `https://api.endorlabs.com/v1/namespaces/{object.tenant_meta.namespace}/agent-sessions` - Auth: none declared Updates a specified AgentSession. ## Path parameters - `object.tenant_meta.namespace` string, required ## Request body - AgentSessionServiceUpdateAgentSessionBody: Request to update an AgentSession. - `object` object: Implements an agent session by interacting with the implemented agents. - `meta` V1Meta: Common fields for all Endor Labs resources. - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string: Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float: search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time: Time that the resource will be deleted. - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required: Resource name. Must be 63 characters or less. - `parent_kind` string: Parent object resource kind, for example, Project. - `parent_uuid` string: Parent object UUID. - `references` object: Map of objects referenced in a query API. - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string: Message version. - `spec` V1AgentSessionSpec - `agent_contexts` SpecAgentContext[]: agent_contexts can include multiple instances of AgentContext. The context can only be provided at the beginning of a session and cannot be updated later on. - `resource` SpecContextResource: ContextResource is a target resource of a context. It can be a finding, project, package, namespace, etc. - `kind` string: Kind of the object. - `namespace` string: Namespace of the object. - `uuid` string: Uuid of the object. - `message_history` SpecMessage[]: The previous messages in the session. - `role` 'ROLE_UNSPECIFIED' | 'ROLE_SYSTEM' | 'ROLE_USER' | 'ROLE_ASSISTANT' | 'ROLE_TOOLS', required - `text` string - `tool_calls` SpecToolCall[]: The tool calls of the message. This is only present if the role is ROLE_TOOLS. This is the list of tools that the LLM needs to call. - `function` ToolCallToolCallFunction - `arguments` object: The arguments of the tool. - `description` string: The description of the tool. - `name` string: The name of the tool. - `results` object: The results of the tool. - `id` string, required: The id of the tool call. - `owner_claims` string[] - `request` string, required: The current message request in the session. - `shared_session` boolean: shared_session indicates if this session is shared with other users. If true, the session will be visible to all users in the same namespace. - `text` string - `tenant_meta` object: The tenant metadata restricts access to a specific tenant. - `uuid` string: The uuid of the resource. This is also the session ID for a user that wants to continue a conversation with the agent. It will accumulate messages over the conversation. - `request` V1UpdateRequest: Message used for all update requests. - `force` boolean: Force will force the update of the resource if any checks fail. - `update_mask` string: Fields to update. Defaults to all fields. ## Response `200` A successful response. - V1AgentSession: Implements an agent session by interacting with the implemented agents. - `meta` V1Meta, required: Common fields for all Endor Labs resources. - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string: Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float: search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time: Time that the resource will be deleted. - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required: Resource name. Must be 63 characters or less. - `parent_kind` string: Parent object resource kind, for example, Project. - `parent_uuid` string: Parent object UUID. - `references` object: Map of objects referenced in a query API. - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string: Message version. - `spec` V1AgentSessionSpec - `agent_contexts` SpecAgentContext[]: agent_contexts can include multiple instances of AgentContext. The context can only be provided at the beginning of a session and cannot be updated later on. - `resource` SpecContextResource: ContextResource is a target resource of a context. It can be a finding, project, package, namespace, etc. - `kind` string: Kind of the object. - `namespace` string: Namespace of the object. - `uuid` string: Uuid of the object. - `message_history` SpecMessage[]: The previous messages in the session. - `role` 'ROLE_UNSPECIFIED' | 'ROLE_SYSTEM' | 'ROLE_USER' | 'ROLE_ASSISTANT' | 'ROLE_TOOLS', required - `text` string - `tool_calls` SpecToolCall[]: The tool calls of the message. This is only present if the role is ROLE_TOOLS. This is the list of tools that the LLM needs to call. - `function` ToolCallToolCallFunction - `arguments` object: The arguments of the tool. - `description` string: The description of the tool. - `name` string: The name of the tool. - `results` object: The results of the tool. - `id` string, required: The id of the tool call. - `owner_claims` string[] - `request` string, required: The current message request in the session. - `shared_session` boolean: shared_session indicates if this session is shared with other users. If true, the session will be visible to all users in the same namespace. - `text` string - `tenant_meta` V1TenantMeta, required: Tenant related data for the tenant containing the resource. - `namespace` string, required: Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". - `uuid` string: The uuid of the resource. This is also the session ID for a user that wants to continue a conversation with the agent. It will accumulate messages over the conversation. ## Other responses - `default`: An unexpected error response. ## Changes - **2026-11-03** `4acd9fe15140`: 1 info - endpoint added [Operation history](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/changes/v1/namespaces/:object.tenant_meta.namespace/agent-sessions/patch.md) --- [API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) - [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/revisions/4acd9fe15140?raw)