Interface

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/patentpad.com/interfaces/interface_1",
  "$type": "Interface",
  "kind": "api",
  "path": "/",
  "conformsTo": {
    "standard": "openai-chat",
    "operations": {
      "chat.completions.create": "Listing.write"
    }
  }
}

RelationshipsCopy Anchor Link

• An Interface is mounted on many Domains: an Interface answers requests on the hostnames it is mounted on. mountedOn, inverse mounts.
• An Interface reaches one Product: each Interface exposes one Product; a Product is reached through many Interfaces. reaches, inverse reachedVia.
• An Interface speaks many Standards: Callers in a Standard’s shape reach the Interface’s Verbs through the platform’s one translator for that Standard. speaks, inverse spokenBy.

VerbsCopy Anchor Link

1. createCreates an Interface.
   POST /{namespace}/interfacesdoInterface.created
2. getReturns one Interface by id.
   GET /{namespace}/interfaces/{id}readNo Event
3. listReturns Interfaces, newest first, one page at a time.
   GET /{namespace}/interfacesreadNo Event
4. updateChanges the given properties of an Interface.
   PATCH /{namespace}/interfaces/{id}doInterface.updated
5. deleteDeletes an Interface; its history is kept.
   DELETE /{namespace}/interfaces/{id}doInterface.deleted

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Add an interface to ShiftNote.

ExampleCopy Anchor Link

A currency-conversion Product answers developers over the API, coding Agents as an MCP Tool, operators from the CLI, and people on its pricing Site.