Agent Catalog
Overview
This API turns structured agent metadata into a finished, publication-ready catalog entry - as a governance record and as a portal-style web view.
This API turns structured agent metadata into a finished, publication-ready catalog entry - as a governance record and as a portal-style web view.
What it's for
- Registering a new AI agent or copilot into the internal Agent Catalog as soon as it clears review
- Producing a consistent, human-readable catalog entry (capability summary, data scope, compliance disclosures) from structured intake data
- Checking, before publication, whether all required compliance disclosures are present
- Retiring or updating an existing catalog entry when an agent's rollout status changes
What it's not for
The API doesn't maintain agent deployment records. Owning team, model/provider, hosting region and deployment tier belong in Agent Deployments; the catalog entry reads them from there.
States of a catalog entry
| Status | Meaning |
|---|---|
in_progress | Generation is running, typically 2-10 seconds |
completed | Entry is ready, not yet published |
published | Live in the internal catalog |
withdrawn | Removed from the catalog, record remains available for audit |
failed | Generation aborted, reason is in disclosures.missing |
Required scopes
| Call | Scope |
|---|---|
| Read catalog entries and templates, download record | catalog:read |
| Create, publish or withdraw a catalog entry | catalog:write |