API demonstration

A proposed request and response shape. These endpoints are not implemented.

Read this before experimenting

Demonstration only. Never send a real password, API key, or production data to these URLs.

Every endpoint in this section is a demonstration. The reserved example hostname does not provide an API. No tokens are issued by this reference site.

Proposed request

A project-scoped list operation illustrates the intended naming style. The placeholder value is not a usable credential.

curl https://api.example/v1/projects/catalog/assets \
  -H "Authorization: Bearer DEMONSTRATION_TOKEN"

Proposed response

This response demonstrates a possible object representation. It is not generated from storage and does not show live project state.

{
  "data": [{
    "key": "site-v1/card.8ac420.webp",
    "contentType": "image/webp",
    "deliveryPath": "/projects/catalog/site-v1/card.8ac420.webp"
  }],
  "nextCursor": null
}

Future error semantics

The intended API should distinguish validation, authorization, missing objects, and rate limits using appropriate HTTP status codes. No API availability or compatibility commitment is made by these examples.