Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Sessions/PUT /harness/sessions/{sessionId}

    PUT /harness/sessions/{sessionId}

    Update a session

    Auth: required. Send an ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.

    Update session title or merge partial state. Uses optimistic concurrency — returns 409 if the session was concurrently modified (version mismatch).

    Request

    Path parameters

    sessionIdstring (uuid)

    Session UUID (UUIDv7 — time-ordered)

    Request body

    titlestring
    stateobject

    Partial SessionState fields — shallow-merged into the current state

    Responses

    200 OK

    Session updated

    Response shape:

    idstring (uuid)
    titlestring
    versioninteger

    Monotonically increasing optimistic-concurrency counter

    schemaVersioninteger

    Session state schema version (currently 1)

    stateobject

    Full session state snapshot persisted in Supabase

    messageCountinteger
    createdAtstring (date-time)
    updatedAtstring (date-time)
    lastActiveAtstring (date-time)

    400 Bad Request

    Invalid request

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    404 Not Found

    Resource not found

    Response shape: object

    409 Conflict

    Version conflict — session was modified by another client, re-fetch and retry

    Response shape: object

    curl -X PUT 'https://ivybiosciences.com/api/harness/sessions/{sessionId}' \
      -H "Authorization: Bearer $IVY_API_KEY" \
      -H 'Content-Type: application/json' \
      -d '{}'

    Was this page helpful?

    Loading...