Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a new Session.

post/v1/{+parent}/sessions

Path parameters

parentstring required

Required. The resource name of the location to create the session in. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

Query parameters

sessionIdstring

Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are [a-z0-9-]. The first and last characters must be a letter or number.

Request body

updateTimestring google-datetime

Output only. Timestamp when the session was updated.

labelsobject

The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

expireTimestring google-datetime

Optional. Timestamp of when this session is considered expired. This is always provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.

createTimestring google-datetime

Output only. Timestamp when the session was created.

displayNamestring

Optional. The display name of the session.

namestring

Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

ttlstring google-duration

Optional. Input only. The TTL for this session. The minimum value is 24 hours.

userIdstring

Required. Immutable. String id provided by the user

sessionStateobject

Optional. Session specific memory which stores key conversation points.

Response

Successful response