Sign in
sessions

Spawn a new agent session

post/api/v1/sessions

Request body

approvalMode'default' | 'accept-edits' | 'auto' | 'bypass-permissions'
branchstring
displayNamestring
effortstring
harness'claude-code' | 'codex' | 'aider' | 'opencode' | 'grok' | 'droid' | 'amp' | 'agy' | 'crush' | 'cursor' | 'qwen' | 'copilot' | 'goose' | 'auggie' | 'continue' | 'devin' | 'cline' | 'kimi' | 'muse' | 'kiro' | 'kilocode' | 'vibe' | 'pi' | 'kimchi' | 'omp' | 'prime-agent' | 'autohand' | 'unreal-agent'
issueIdstring
kind'worker' | 'orchestrator'
mode'chat' | 'tui'
modelstring
parentSessionIdstring
projectIdstring
promptstring
trackerProvider'github' | 'gitlab'

Response

Created

promptBytesinteger required
systemPromptBytesinteger required

Changes

Changed in 43 of the 169 revisions of this API.35464

  • 710a6d7a75012See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0af2a59f74cf2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new unreal-agent enum value to the request property

      request-property-enum-value-added

  • bfeab20f1fc81See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 401b2f38894f1See the full diff
    • ●

      added the new Review failed enum value to the / response property for the response status

      response-property-enum-value-added

  • baacc5153a7d1See the full diff
    • ○

      the request property's maxLength was increased from 20 to 100

      request-property-max-length-increased

  • 6a868cfec2ac1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 44477babb3341See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 43c53c828d801See the full diff
    • ○

      added the required property / to the response with the status

      response-required-property-added

  • ee265060ea2811See the full diff
    • ▲

      the response property / became optional for the status

      response-property-became-optional

    • ○

      the request property became optional

      request-property-became-optional

  • 0a8ba70394bb4See the full diff
    • ○

      removed the continue enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the goose enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the qwen enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the vibe enum value from the / response property for the response status

      response-property-enum-value-removed