Connections

A connection represents access

A Connection describes access to a provider or service. It holds necessary configuration and references protected secrets. A Model can require a capability without containing private account keys.

Parameter	Expected values	Description
Provider	Supported service	Identifies protocol and capabilities
Account or endpoint	Service configuration	Selects the resource
Authentication	Secret reference or authorization	Grants protected access
Scope	Authorized users, team and uses	Limits use
Verification	Connection check result	Distinguishes configured from usable

Example

Your team connects its AI provider and permits quote drafting. A runtime profile selects that Connection with residency and usage constraints. The Clients Model remains reusable by another business with its own connections.

Change and revoke

Changing a key or revoking access affects operations using it. Diagnostics identify the connection needing correction rather than silently selecting another provider. Secrets do not belong in prompts, Model sources or public diagnostics.

Runtime profiles organize capability selection; permissions govern use.

Applied examples : Declare the required resource

The Model declares a connection capability; the profile determines which document to produce.

Configuration

Fragment placed in publication. Properties and accepted values.

{
  "kind": "workspace-application",
  "license": "Proprietary",
  "requiredCapabilities": [],
  "requiredConnections": [
    "document.export"
  ]
}

Variation and connection

Fragment placed in documentProfiles[]. Properties and accepted values.

{
  "contract": "DocumentProfile@3",
  "key": "client-quotes-export",
  "source": {
    "kind": "record-query",
    "recordProfileKey": "client",
    "queryBindingKey": "client-quotes",
    "viewKey": "quotes-table"
  },
  "exportFormats": [
    "markdown"
  ],
  "budget": {
    "maximumRows": 100,
    "maximumPages": 4,
    "maximumOutputBytes": 1000000
  }
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. Runtime profile
2. Connections
3. Residency
4. Save

SurfaceClients / North StudioExample

ConnectionsDeclare the required resource

Clients

Connection

Document export

Required capability

document.export

Access

Verify before activation