SpecifyDocs

Canvas checkpoint name

/v1/canvases/{id}/checkpoints

Signed-in sessionLaunch key product.canvasOperation canvas_checkpoint_name

A canvas is a drawing in the workspace or a page in a project's Docs tree.

Path parameters

idstringRequired

Body

expectedAuthorizationVersionstring
checkpointIdstring
namestringRequired

Returns

kind"agent_change" | "checkpoint"Required
idstringRequired
atnumberRequired
agentobject
forPersonnull | object
summarystring
addednumberRequired
changednumberRequired
removednumberRequired
fromSeqnumberRequired
toSeqnumber
beforeCheckpointIdstring
revertedAtnull | number
revertedBynull | object
checkpointKind"automatic" | "before_agent" | "before_restore" | "left" | "named" | "restore"
namenull | string
namedBynull | object
atSeqnumber
actorsobject[]
moreActorsnumber
restoredFromnull | string
expiresAtnull | number

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}. A call without a valid credential gets 401 before its input is checked, and so does an address that is not an operation: 404 and 400 come only once the credential is accepted. Public operations answer without one.