Skip to content

sessions module route (requires sessions:run:write)

POST
/v1/m/sessions/runs
curl --request POST \
--url https://example.com/v1/m/sessions/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "effort": "", "env_allow": [ "example" ], "isolation": "", "model": "example", "name": "example", "permission_mode": "", "template_id": "example", "transport": "", "workspace_ref": "example" }'

Creates one session run from the posted parameters, and answers 503 when the runtime is not available.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
Any of:
object
effort
Any of:
string
Allowed values: "" low medium high xhigh max
env_allow
Any of:
Array<string>
<= 64 items unique items
isolation
Any of:

Empty/null defaults to native; unavailable runners refuse rather than downgrade.

string
Allowed values: "" native container sandbox
model
Any of:

Trimmed before launch.

string
name
Any of:

Trimmed before persistence.

string
permission_mode
Any of:

Empty/null defaults to default.

string
Allowed values: "" default acceptEdits plan auto dontAsk bypassPermissions
template_id
Any of:

When non-empty, identifies the stored template whose terms govern the launch.

string
transport
Any of:

Empty/null defaults to stream-json.

string
Allowed values: "" stream-json remote-control
workspace_ref
Any of:

Trimmed and, when non-empty, resolved to a registered workspace.

string

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}