Api Reference

Full API/function reference block — name, description, parameters table,

Surfaces
webmeet-stagepdfapps-script-web
Degraded on
SurfaceNote
googlechatcomplex table layout not supported — use key_value + code block instead
emailnested table styling unreliable — use key_value + code block
Fields
FieldType
namestringrequired
kindfunction | endpoint | class | methodrequired
methodstringoptional
descriptionstringrequired
deprecatedbooloptional
parameters[{'name': 'string', 'type': 'string', 'required': 'bool', 'description': 'string', 'default': 'string'}]optional
returnsstringoptional
example{'label': 'string', 'language': 'string', 'code': 'string'}optional
Example payload
{
  "type": "api_reference",
  "name": "Api Reference",
  "kind": 1,
  "description": "A concise description of the content."
}
ARD catalog entry
{
  "identifier": "urn:air:a2uicatalog.ai:atom:api_reference",
  "displayName": "Api Reference",
  "type": "application/vnd.a2ui.atom+json",
  "url": "https://a2uicatalog.ai/atoms/api_reference",
  "capabilities": [
    "web",
    "meet-stage",
    "pdf",
    "apps-script-web"
  ],
  "description": "Full API/function reference block \u2014 name, description, parameters table,",
  "representativeQueries": [
    "show a API endpoint method parameters and response docs returns, example",
    "full api/function reference block \u2014 name, description, parameters table,",
    "render a api reference"
  ]
}
← Full ARD catalog Try it live →
Deploy your own renderer

The renderer is open source. Deploy your own instance in 4 commands — you own the URL, no dependency on the demo endpoint.

git clone https://github.com/a2uicatalog/a2ui
cd apps-script-surface/gas-schema-renderer
clasp push && clasp deploy
Full deploy guide →