Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Checkpoints/POST /harness/sessions/{sessionId}/rollback

    POST /harness/sessions/{sessionId}/rollback

    Rollback to checkpoint

    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.

    Restore the session to the state captured in the specified checkpoint. The session version is incremented; subsequent messages are truncated.

    Request

    Path parameters

    sessionIdstring (uuid)

    Session UUID (UUIDv7 — time-ordered)

    Request body

    checkpointIdstring

    ID of the checkpoint to restore

    Responses

    200 OK

    Rollback applied

    Response shape:

    successboolean
    sessionIdstring (uuid)
    checkpointIdstring
    restoredStepinteger

    Graph step number of the restored checkpoint

    versioninteger

    New session version after rollback

    updatedAtstring (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

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

    Was this page helpful?

    Loading...