OpenBindings Host
Interface for an OpenBindings host — a remote service that provides binding execution, interface resolution, context management, and format discovery. Clients connect to a host for infrastructure capabilities that complement browser-side or local execution. A host composes the binding-executor, interface-creator, context-store, and software-descriptor roles, and adds host-specific operations like interface resolution.
Roles
Operations
Schemas
SoftwareInfo objectIdentity and metadata for a piece of software. Implementations may include additional fields.
name string requiredHuman-readable display name.
version string Software version.
description string Brief description of what this software does.
homepage string URL to documentation or project page.
repository string URL to source code repository.
maintainer string Author or maintaining organization.
FormatInfo objectInformation about a supported binding format.
token string requiredFormat token (e.g., openapi@3.1, asyncapi@3.0, grpc).
description string Human-readable description of this format.
CreateInterfaceSource objectA binding source to extract operations from.
format string requiredFormat token (e.g., openapi@3.1).
name string Key name for this binding source in the output.
location string Location to fetch content from (path or URL).
content any Content provided directly.
outputLocation string Location to reference in the output.
embed boolean If true, embed content inline in the output.
description string Human-readable description for this source.
anyanyCreateInterfaceInput objectopenbindingsVersion string Target OpenBindings spec version.
sources CreateInterfaceSource[] Binding sources to extract from.
name string Interface name override.
version string Interface contract version override.
description string Interface description override.
OpenBindingsInterface objectA valid OpenBindings interface document.
ExecuteSource objectBinding source for execution.
format string requiredFormat token.
location string Location of the binding source (path or URL).
content any Binding source content directly.
anyanyBindingContext objectOpaque runtime context for binding execution. Well-known fields include 'bearerToken', 'apiKey', 'basic'.
ExecutionOptions objectDeveloper-supplied per-request execution options.
headers object cookies object environment object metadata object ExecuteBindingInput objectInput for executing a resolved binding.
source ExecuteSource requiredref string requiredReference within the binding source.
input any Operation input data.
context BindingContext options ExecutionOptions Error objectcode string requiredmessage string requireddetails any ExecuteBindingOutput objectOutput from executing a resolved binding.
output any status integer durationMs number error Error ContextEntry objectA stored context entry.
key string requiredContext store key (typically a normalized API origin, e.g., 'api.example.com').
context object Opaque credential map. Structure is executor-managed; well-known fields include 'bearerToken', 'apiKey', 'basic'.
ResolveInterfaceInput objectInput for resolving an interface from a URL.
url string requiredURL to resolve an OpenBindings interface from. The host fetches and optionally synthesizes the interface.
ResolveInterfaceOutput objectResult of resolving an interface.
interface OpenBindingsInterface The resolved OpenBindings interface.
synthesized boolean True if the interface was synthesized from a non-OBI source.
sourceFormat string Detected source format when synthesized (e.g., openapi@3.1).