/\ 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.

Admin API

Register a node's versioned capability definition. Use a new version when its definition changes.

Operations

OperationMethodPath
registerAgentPOST/api/v2/agents
unregisterAgentDELETE/api/v2/agents/{label}

registerAgent

POST /api/v2/agents

Requires: worker role

Generated Python client internals: atfgraph._generated.api.admin_api.AdminApi.register_agent()

Request body

RegisterAgent (required)

{
  "capabilities": {
    "key": {
      "input_schema": {},
      "kind": "traversal",
      "output_schema": {}
    }
  },
  "label": "string",
  "version": "string"
}

Responses

StatusBodyMeaning
201AgentDefinitionSuccessful 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 201

{
  "capabilities": {
    "key": {
      "input_schema": {},
      "kind": "traversal",
      "output_schema": {},
      "realtime": {
        "model": "string",
        "provider": "string",
        "transport": "string"
      },
      "retry": {
        "max_attempts": 0
      },
      "tags": [
        "string"
      ],
      "timeout_seconds": 0
    }
  },
  "id": "string",
  "label": "string",
  "tags": [
    "string"
  ],
  "version": "string"
}

unregisterAgent

DELETE /api/v2/agents/{label}

Requires: worker role

Generated Python client internals: atfgraph._generated.api.admin_api.AdminApi.unregister_agent()

Parameters

ParameterInRequiredType
labelpathyesstring
versionquerynostring

Responses

StatusBodyMeaning
200AgentRemovedSuccessful 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

{
  "deleted": false,
  "label": "string",
  "versions": 0
}
ATFGraph documentationHosted workflow · Framework reference