Skip to navigation
API ReferenceExecution Sessions

Create Session

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequired
harness_idstringRequired

Request

This endpoint expects an object.
acknowledge_wideningbooleanOptionalDefaults to false
auto_improvebooleanOptionalDefaults to false

Automatically request evaluated harness improvements after completed turns. Requires harness:write and configured improvement policy.

conversation_idstring or nullOptional<=128 characters
draft_revisioninteger or nullOptional>=1
Saved document revision to test. Required for document Draft sessions.
environmentenumOptionalDefaults to production

Draft sessions test the pinned agent definition without activation. Creating or appending draft sessions also requires harness:write.

Allowed values:
expected_access_digeststring or nullOptional=64 characters
final_output_schemamap from strings to any or nullOptional
idempotency_keystring or nullOptional1-128 characters
modelstring or nullOptional1-200 characters

Default model for this session. Use a Sikaru model catalog ID, such as kimi-k3. Omit to inherit the project default.

pinned_generation_idstring or nullOptional1-128 characters
Optional previously serving release generation. Omit to follow promotions.
reasoning_effortenum or nullOptional
tenant_idstring or nullOptional1-128 characters
user_idstring or nullOptional1-128 characters

Response

Successful Response
sessionobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
503
Service Unavailable Error