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

Discovery API

Inspect the server and registered capabilities. Manage and search discovery publications under /api/v2/ard.

Operations

OperationMethodPath
listAgentsGET/api/v2/agents
agentCapabilitiesGET/api/v2/agents/{label}/capabilities
listPublicationsGET/api/v2/ard/publications
publishDiscoveryPOST/api/v2/ard/publications
deletePublicationDELETE/api/v2/ard/publications/{id}
searchDiscoveryPOST/api/v2/ard/search
discoverySettingsGET/api/v2/ard/settings
serverInfoGET/api/v2/server

listAgents

GET /api/v2/agents

Requires: invoke role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.list_agents()

Parameters

ParameterInRequiredType
tagquerynostring

Responses

StatusBodyMeaning
200AgentListSuccessful 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": [
    {
      "capabilities": {
        "key": {
          "input_schema": {},
          "kind": {},
          "output_schema": {},
          "realtime": {},
          "retry": {},
          "tags": [
            {}
          ],
          "timeout_seconds": 0
        }
      },
      "id": "string",
      "label": "string",
      "tags": [
        "string"
      ],
      "version": "string"
    }
  ]
}

agentCapabilities

GET /api/v2/agents/{label}/capabilities

Requires: invoke role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.agent_capabilities()

Parameters

ParameterInRequiredType
labelpathyesstring
tagquerynostring
versionquerynostring

Responses

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

{
  "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"
}

listPublications

GET /api/v2/ard/publications

Requires: invoke role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.list_publications()

Responses

StatusBodyMeaning
200DiscoveryPublicationsSuccessful 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": [
    {
      "artifact": {},
      "artifact_type": "string",
      "description": "string",
      "display_name": "string",
      "id": "string",
      "label": "string",
      "published": false,
      "tags": [
        "string"
      ],
      "updated_at": 0,
      "validation": {
        "scope": "string",
        "status": "string"
      },
      "version": "string"
    }
  ]
}

publishDiscovery

POST /api/v2/ard/publications

Requires: admin role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.publish_discovery()

Request body

PublishDiscovery (required)

{
  "label": "string"
}

Responses

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

{
  "artifact": {},
  "artifact_type": "string",
  "description": "string",
  "display_name": "string",
  "id": "string",
  "label": "string",
  "published": false,
  "tags": [
    "string"
  ],
  "updated_at": 0,
  "validation": {
    "scope": "string",
    "status": "string"
  },
  "version": "string"
}

deletePublication

DELETE /api/v2/ard/publications/{id}

Requires: admin role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.delete_publication()

Parameters

ParameterInRequiredType
idpathyesstring

Responses

StatusBodyMeaning
200DeletedSuccessful 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
}

searchDiscovery

POST /api/v2/ard/search

Requires: invoke role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.search_discovery()

Request body

DiscoverySearch (required)

{
  "query": "string"
}

Responses

StatusBodyMeaning
200DiscoveryPublicationsSuccessful 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": [
    {
      "artifact": {},
      "artifact_type": "string",
      "description": "string",
      "display_name": "string",
      "id": "string",
      "label": "string",
      "published": false,
      "tags": [
        "string"
      ],
      "updated_at": 0,
      "validation": {
        "scope": "string",
        "status": "string"
      },
      "version": "string"
    }
  ]
}

discoverySettings

GET /api/v2/ard/settings

Requires: invoke role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.discovery_settings()

Responses

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

{
  "configuration_path": "string",
  "configuration_source": "string",
  "enabled": false,
  "locked_reason": "string",
  "protocols": {
    "a2a_enabled": false,
    "mcp_enabled": false,
    "public_base_url": "string"
  },
  "public_base_url": "string",
  "public_registry": false,
  "publish_catalog": false
}

serverInfo

GET /api/v2/server

Requires: invoke role

Generated Python client internals: atfgraph._generated.api.discovery_api.DiscoveryApi.server_info()

Responses

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

{
  "api_version": "string",
  "features": {
    "key": false
  },
  "namespace": "string",
  "product": "string",
  "version": "string",
  "worker_protocol": "string"
}
ATFGraph documentationHosted workflow · Framework reference