Skip to content

Agent Identity API

The Agent Identity API defines how an agent advertises its capabilities, versioning, and security requirements to the fleet.

Discovery Mechanism

Every OpenSIN-compatible agent MUST expose its identity via the standard .well-known path:

text
GET https://<agent-domain>/.well-known/agent-card.json

Agent Card Schema

The agent-card.json is the source of truth for the agent's contract.

json
{
  "name": "Research-Agent",
  "version": "2.4.1",
  "description": "Deep-web research and data extraction specialist.",
  "url": "https://research.opensin.ai",
  "capabilities": {
    "streaming": true,
    "stateful": false,
    "a2a_native": true
  },
  "skills": [
    {
      "id": "search",
      "name": "Web Search",
      "description": "Access real-time information via Google Search"
    }
  ],
  "authentication": {
    "schemes": ["bearer", "mtls"],
    "registry_url": "https://auth.opensin.ai"
  }
}

Fields Definition

FieldTypeRequiredDescription
namestringYesCanonical ID of the agent
versionstringYesSemVer versioning
descriptionstringYesHuman-readable purpose
capabilitiesobjectYesTechnical flags (streaming, stateful)
skillsarrayYesList of skill-objects the agent can perform
authenticationobjectYesSupported auth methods and endpoints

Versioning Policy

OpenSIN agents follow strict SemVer:

  • Major: Breaking changes in JSON-RPC methods or parameters.
  • Minor: New tools added or non-breaking capability changes.
  • Patch: Internal fixes and prompt optimizations.

Best Practices

  1. Keep it Static: The agent-card should be a static file or a fast-cached endpoint.
  2. Detailed Skill Descriptions: Use clear descriptions for skills; other agents use these to decide when to delegate.
  3. Valid JSON-Schema: Ensure all tool parameters are documented with valid JSON-Schema for automated validation.

Quick Entry

Next Steps

Guides and concepts for the OpenSIN API.