Skip to main content
POST
Apply session configuration

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Needed only when the server has a key configured.

Body

application/json

Request object for session configuration, supporting both initialization and runtime updates

sessionId
string
required

The unique session identifier used to track this context

Maximum string length: 256
Pattern: ^(?!.*\.\.)[^/\\]*$
Example:

"session-123"

name
string
required

A human-readable name for the session

Maximum string length: 256
Example:

"Production ETL v4"

description
string
required

A human-readable description of the session

Maximum string length: 256
Example:

"Daily build and quality check"

initiator
string
required

The name of the initiator (user or system)

Minimum string length: 1
Example:

"AI Agent"

projectPath
string
required

The absolute root path of the project on the server's filesystem

Maximum string length: 1024
Example:

"/home/user/workspace/project-alpha"

workflows
object
required

A map of workflow definition requests keyed by workflow ID

tags
object

Metadata tags for categorization and filtering

Example:

Response

200 - */*

OK

Unified API response wrapper for both success and error responses. Success responses include data field; error responses include error, path, and errors fields.

timestamp
string<date-time>

The time the response was generated

status
integer<int32>

The HTTP status code

Example:

200

message
string

A human-readable message

Example:

"Operation successful"

data
any

The response data

error
string

The HTTP status error name

Example:

"Bad Request"

path
string

The request path

Example:

"/api/files"

errors
object[]

The list of field validation errors