/\ ATFGraph /docs
README Downloads
HTTP API & schemas / ATFGraph
Framework reference

This article is retained from the existing framework docs. Self-hosting commands and server-admin access differ from the managed CLI workflow. Start with Get started for the installed product.

Checkpoints API

Save named, revisioned values so a handler can reuse work when it starts again.

Operations

OperationMethodPath
listCheckpointsGET/api/v2/traversers/{id}/checkpoints
getCheckpointGET/api/v2/traversers/{id}/checkpoints/{name}
writeCheckpointPOST/api/v2/traversers/{id}/checkpoints/{name}

listCheckpoints

GET /api/v2/traversers/{id}/checkpoints

Requires: invoke role, worker role

Generated Python client internals: atfgraph._generated.api.checkpoints_api.CheckpointsApi.list_checkpoints()

Parameters

ParameterInRequiredType
idpathyesstring
lease_tokenquerynostring
step_idquerynostring
task_idquerynostring

Responses

StatusBodyMeaning
200CheckpointListSuccessful operation
400ErrorResponseStructured API error
401ErrorResponseMissing or invalid credentials
403ErrorResponseRole or ownership denied
404ErrorResponseResource unavailable to this identity
409ErrorResponseRevision, idempotency, immutable version or lease conflict
413ErrorResponseStructured API error
422ErrorResponseCapability input/output schema violation
429ErrorResponseCapacity exceeded
500ErrorResponseStructured API error
503ErrorResponseStructured API error

Example response 200

{
  "items": [
    {
      "name": "string",
      "revision": 0,
      "updated_at": 0,
      "value": {}
    }
  ]
}

getCheckpoint

GET /api/v2/traversers/{id}/checkpoints/{name}

Requires: invoke role, worker role

Generated Python client internals: atfgraph._generated.api.checkpoints_api.CheckpointsApi.get_checkpoint()

Parameters

ParameterInRequiredType
idpathyesstring
namepathyesstring
lease_tokenquerynostring
step_idquerynostring
task_idquerynostring

Responses

StatusBodyMeaning
200CheckpointSuccessful operation
400ErrorResponseStructured API error
401ErrorResponseMissing or invalid credentials
403ErrorResponseRole or ownership denied
404ErrorResponseResource unavailable to this identity
409ErrorResponseRevision, idempotency, immutable version or lease conflict
413ErrorResponseStructured API error
422ErrorResponseCapability input/output schema violation
429ErrorResponseCapacity exceeded
500ErrorResponseStructured API error
503ErrorResponseStructured API error

Example response 200

{
  "name": "string",
  "revision": 0,
  "updated_at": 0,
  "value": {}
}

writeCheckpoint

POST /api/v2/traversers/{id}/checkpoints/{name}

Requires: worker role

Generated Python client internals: atfgraph._generated.api.checkpoints_api.CheckpointsApi.write_checkpoint()

Parameters

ParameterInRequiredType
idpathyesstring
namepathyesstring

Request body

CheckpointWrite (required)

{
  "lease_token": "string",
  "value": {},
  "worker_id": "string"
}

Responses

StatusBodyMeaning
200CheckpointRevisionSuccessful operation
400ErrorResponseStructured API error
401ErrorResponseMissing or invalid credentials
403ErrorResponseRole or ownership denied
404ErrorResponseResource unavailable to this identity
409ErrorResponseRevision, idempotency, immutable version or lease conflict
413ErrorResponseStructured API error
422ErrorResponseCapability input/output schema violation
429ErrorResponseCapacity exceeded
500ErrorResponseStructured API error
503ErrorResponseStructured API error

Example response 200

{
  "name": "string",
  "revision": 0
}
ATFGraph documentationHosted workflow · Framework reference