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
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
Parameter In Required Type idpath yes string lease_tokenquery no string step_idquery no string task_idquery no string
Responses
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
Parameter In Required Type idpath yes string namepath yes string lease_tokenquery no string step_idquery no string task_idquery no string
Responses
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
Parameter In Required Type idpath yes string namepath yes string
Request body CheckpointWrite (required)
{
"lease_token": "string",
"value": {},
"worker_id": "string"
}
Responses
Example response 200
{
"name": "string",
"revision": 0
}
ATFGraph documentation Hosted workflow · Framework reference
ON THIS PAGE
Operations Build locally. Run in dev. Inspect in Console.