Skip to main content
POST
Start project session

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string
required

Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey.

Required string length: 1 - 255

Body

application/json
sourceHarness
string
required

Host starting the session, for example codex, claude, opencode, or codebuddy.

Required string length: 1 - 80
Pattern: ^[A-Za-z0-9._-]+$
clientVersion
string
required

Version of the Agent Kit or native host wrapper making this request.

Required string length: 1 - 80
externalSessionId
string
required

Opaque, persisted host thread/session id used to resume this binding.

Required string length: 1 - 200
privacyMode
enum<string>
required

How much host conversation state Sigmora may retain; artifacts_only is the safe default.

Available options:
artifacts_only,
session_summary,
full_transcript
projectId
string
required

Existing workspace project to bind.

Required string length: 1 - 200

Response

Success.

success
boolean
required
sessionId
string
required

Durable Sigmora harness-session id.

projectId
string
required

Bound workspace project id.

dashboardUrl
string<uri>
required

Dashboard handoff for the same project.

{key}
any