aiendpoint.dev
Docs

Spec Reference

Required fields, optional fields, capability rules, and category values for AIEndpoint v1.0.

Required fields

FieldTypeNotes
aiendpointstringMust be "1.0"
service.namestringHuman-readable service name
service.descriptionstringConcise summary for agents
capabilitiesarrayMust contain at least one capability

Capability object

Each item in capabilities describes one action an AI agent can take.

{
  "id": "search_products",
  "description": "Search for products by keyword or category",
  "endpoint": "/api/products/search",
  "method": "GET",
  "params": {
    "q": "search keyword (string, required)",
    "category": "filter by category (string, optional)",
    "limit": "maximum results (integer, optional, default: 20)"
  },
  "returns": "products[] with id, name, price, stock"
}

Optional fields

Use optional fields to reduce ambiguity for agents and improve discoverability.

FieldWhy it matters
service.languageHelps with locale-aware routing
service.categoryImproves registry search quality
authTells agents what auth they need
token_hintsHelps agents make cheaper calls
rate_limitsLets agents plan retries and pacing
meta.last_updatedGives the spec freshness metadata

Category values

productivity, ecommerce, finance, news, weather, maps, search, data, communication, calendar, storage, media, health, education, travel, food, government, developer