Skip to main content
PUT
/
api
/
registry
/
mirrors
/
{platform}
Publish community mirror
curl --request PUT \
  --url https://agenticadvertising.org/api/registry/mirrors/{platform} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formats": [
    {}
  ],
  "catalog_etag": "<string>",
  "properties": [
    {}
  ],
  "placements": [
    {}
  ],
  "placement_tags": {},
  "collections": [
    {}
  ],
  "signals": [
    {}
  ],
  "signal_tags": {},
  "contact": "<unknown>",
  "superseded_by": "<string>"
}
'
{
  "platform": "example_platform",
  "catalog_etag": "<string>",
  "superseded_by": "<string>",
  "publisher_domains": [
    "<string>"
  ],
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token in the Authorization header. Two token types are accepted:

  • Organization API key (sk_...) issued via the dashboard. Org-scoped, long-lived, for server-to-server use.
  • User JWT obtained via the OAuth 2.1 authorization code flow with PKCE. User-scoped, short-lived. Discover the authorization server at /.well-known/oauth-authorization-server and the protected-resource metadata at /.well-known/oauth-protected-resource/api.

Path Parameters

​
platform
string
required

Lowercase platform identifier.

Pattern: ^[a-z0-9_-]{1,64}$
Example:

"example_platform"

Body

application/json

Catalog-only adagents.json body for a community mirror. At least one of formats, properties, placements, collections, or signals must be present and non-empty. The service regenerates $schema and last_updated before persisting.

​
formats
object[]
required
Minimum array length: 1
​
catalog_etag
string
Required string length: 1 - 255
​
properties
object[]
​
placements
object[]
​
placement_tags
object
​
collections
object[]
​
signals
object[]
​
signal_tags
object
​
contact
any
​
superseded_by
string

HTTPS URL for the canonical successor adagents.json document. Set this before deleting a mirror so buyers can migrate cached references.

Pattern: ^https:\/\/
​
{key}
any

Response

Community mirror published

​
success
enum<boolean>
required
Available options:
true
​
platform
string
required

Lowercase platform identifier, normalized by the service.

Pattern: ^[a-z0-9_-]{1,64}$
Example:

"example_platform"

​
catalog_etag
string | null
required
​
superseded_by
string | null
required

HTTPS successor document URL, when this mirror has been superseded.

Pattern: ^https:\/\/
​
publisher_domains
string[]
required

Publisher domains updated from this community mirror catalog.

​
updated_at
string<date-time>
required