Docs/API Reference/Agent Card

Agent Card API

Generate AI Bill of Materials (AIBOM) agent cards with aggregated governance data, compliance status, and blockchain verification. Aligned with NIST G-6.1 and Map 3.3.

Endpoints

GET/v1/agent-cardGet agent card as JSON
GET/v1/agent-card/pdfDownload agent card as text document

Authentication

Both endpoints require API key authentication. Subject to admin-level rate limiting.

Get Agent Card (JSON)

GET/v1/agent-card

Returns a comprehensive agent card with governance posture, PII configuration, compliance status, and blockchain verification data.

Query Parameters

ParameterTypeRequiredDescription
use_casestringNoFilter agent card data by use case identifier

Response Structure

FieldTypeDescription
agent_card.identityobjectOrganization ID, name, use case, masked API key, plan
agent_card.governance_postureobjectAutonomy level (0-5), TORKING-X score, total calls, policy version
agent_card.pii_configurationobjectPII types detected, regional profiles, industry profile
agent_card.compliance_statusobjectOverall status, governance coverage %, NIST alignment array
agent_card.blockchain_verificationobjectChain, network, last anchor date, total anchors
agent_card.operational_statusobjectEmergency shutdown state, API status
generated_atstringISO timestamp of generation
versionstringAgent card schema version (currently "1.0")

Example

bash
curl "https://api.tork.network/v1/agent-card?use_case=customer-support" \
  -H "x-tork-api-key: tork_sk_your_api_key"
json
{
  "agent_card": {
    "version": "1.0",
    "nist_reference": "G-6.1, Map 3.3",
    "identity": {
      "org_id": "org_abc123",
      "org_name": "Acme Corp",
      "use_case": "customer-support",
      "api_key_id": "key_***abc",
      "plan": "pro"
    },
    "governance_posture": {
      "autonomy_level": 3,
      "autonomy_label": "Moderate",
      "torking_x_score": 82.5,
      "total_governance_calls": 14250,
      "policy_version": "2.1.0",
      "last_activity": "2026-02-12T14:30:00Z"
    },
    "pii_configuration": {
      "types_detected": ["email", "phone", "ssn", "credit_card", "name"],
      "regional_profiles": ["US", "GB"],
      "industry_profile": "finance"
    },
    "compliance_status": {
      "overall": "compliant",
      "governance_coverage": 94,
      "nist_alignment": [
        { "control": "G-1.1", "status": "met", "description": "PII detection active" },
        { "control": "G-1.5", "status": "met", "description": "Canary monitoring enabled" },
        { "control": "G-6.1", "status": "met", "description": "Agent card generated" }
      ]
    },
    "blockchain_verification": {
      "status": "verified",
      "chain": "solana",
      "network": "mainnet-beta",
      "last_anchor_date": "2026-02-12",
      "total_anchors": 45
    },
    "operational_status": {
      "emergency_shutdown": false,
      "api_status": "operational"
    }
  },
  "generated_at": "2026-02-12T14:35:00Z",
  "version": "1.0"
}

Download Agent Card

GET/v1/agent-card/pdf

Returns the agent card as a formatted plain-text AIBOM document, suitable for compliance audits and regulatory submissions. Includes full TORKING-X score breakdown (T/O/R/K/I/N/G/M/X components).

Query Parameters

ParameterTypeRequiredDescription
use_casestringNoFilter data by use case identifier

Response Headers

HeaderValue
Content-Typetext/plain
Content-Dispositionattachment; filename="tork-agent-card-{orgId}-{date}.txt"

Document Sections

1.IDENTITY — Organization and agent identification
2.GOVERNANCE POSTURE — Autonomy level, TORKING-X breakdown (T/O/R/K/I/N/G/M/X scores)
3.PII CONFIGURATION — Detection types, regional and industry profiles
4.COMPLIANCE STATUS — NIST alignment checklist with pass/fail
5.BLOCKCHAIN VERIFICATION — Anchor chain and verification status
6.OPERATIONAL STATUS — Emergency shutdown and API status

Example

bash
curl "https://api.tork.network/v1/agent-card/pdf" \
  -H "x-tork-api-key: tork_sk_your_api_key" \
  -o agent-card.txt

Error Responses

StatusDescription
401Missing or invalid API key
429Rate limit exceeded
500Internal server error