Expand description
Sylphx Platform SDK — Product Contract projection.
Sole public schema: project, Binding, Service spec, optional suite door.
Default client is the Platform proto (https://api.sylphx.com/v1), not
runtime BaaS (kv/email/schedules) and not the cluster SDK.
Discovery is Binding api_base. This crate does not compile sibling
product schemas, predecessor product-API peels, or customer Schedule as
Platform proto. Customer Schedule is Compute, not this SDK.
use sylphx_apps_sdk::Client;
let client = Client::new(std::env::var("SYLPHX_TOKEN").unwrap())?;
let _projects = client.list_projects(None, None).await?;Modules§
- types
- Product Contract wire types (Protobuf -> buffa/connectrpc).
Structs§
- Agent
Computer Control Client - Descriptor-generated client for AgentComputerControlService.
- Agent
Computer Data Client - Descriptor-generated client for AgentComputerDataService.
- Agent
Computer Media Client - Descriptor-generated client for AgentComputerMediaService.
- Artifact
Ingest Client - Descriptor-generated client for ArtifactIngestService.
- Build
Connection UrlInput - Connection URL SSOT (ADR-123 dual-oracle of
@sylphx/sdkconnection-url). Input forbuild_connection_url. - Client
- Management-plane client.
- Client
Builder - Builder for
ManagementClient. - Delivery
Client - Descriptor-generated client for DeliveryService.
- List
Options - Pagination options mapped 1:1 onto wire
PageRequest. - Parsed
Connection Url - Connection URL SSOT (ADR-123 dual-oracle of
@sylphx/sdkconnection-url). Parsed Sylphx connection URL components (dual-oracle ofParsedConnectionUrl). - Retry
Config - Retry policy for transient failures.
- Transport
- Production HTTP transport.
- Transport
Config - Shared HTTP client configuration for one plane endpoint.
- Verified
Binding Context - Re-export contract identity for consumers and CLI evidence. Immutable identity and scope proved by Platform binding admission.
Enums§
- Connection
Credential Type - Connection URL SSOT (ADR-123 dual-oracle of
@sylphx/sdkconnection-url). Credential kind — publishable (pk) or secret (sk). - Connection
Env - Connection URL SSOT (ADR-123 dual-oracle of
@sylphx/sdkconnection-url). Target environment encoded in the credential. - Credential
- Credential material for a plane.
- SdkError
- SDK-level errors.
- Verified
Binding Context Error - Re-export contract identity for consumers and CLI evidence. Failure to construct a verified-binding context from incomplete claims.
Constants§
- AGENT_
COMPUTER_ DESCRIPTOR_ GRAPH_ SHA256 - SHA-256 identity of the allowlisted management-rooted descriptor graph.
- AGENT_
COMPUTER_ DESCRIPTOR_ ROOT_ FILE - Canonical aggregate descriptor root for the public management wire.
- AGENT_
COMPUTER_ DESCRIPTOR_ ROOT_ SHA256 - SHA-256 identity of the canonical management root file descriptor.
- API_
TYPES_ CONTRACT_ PACKAGE - Re-export contract identity for consumers and CLI evidence. Schema identity for publish/admission evidence.
- API_
TYPES_ CONTRACT_ REVISION - Re-export contract identity for consumers and CLI evidence. Human-readable contract revision for this crate release.
- DEFAULT_
MANAGEMENT_ BASE_ URL - Default Management API base URL (includes
/v1). - VERIFIED_
BINDING_ CONTEXT_ REVISION - Re-export contract identity for consumers and CLI evidence. Canonical revision of the verified-binding request context contract.
- WIRE_
CONTRACT_ PACKAGE - Deprecated aliases — prefer API_TYPES_CONTRACT_*. Schema identity for publish/admission evidence.
- WIRE_
CONTRACT_ REVISION - Deprecated aliases — prefer API_TYPES_CONTRACT_*. Human-readable contract revision for this crate release.
Functions§
- auth_
header_ pair - Build Authorization / x-app-secret header pair for inspection/tests.
- build_
connection_ url - Connection URL SSOT (ADR-123 dual-oracle of
@sylphx/sdkconnection-url). Build a canonical Sylphx connection URL (dual-oracle ofbuildConnectionUrl). - client_
from_ api_ base - Build a client from a caller-discovered product API base.
- normalize_
management_ base_ url - Normalize a Management API base URL so callers always hit
/v1. - parse_
connection_ url - Connection URL SSOT (ADR-123 dual-oracle of
@sylphx/sdkconnection-url). Parse a Sylphx connection URL (dual-oracle ofparseConnectionUrl). - register_
wire_ types - Add Apps and well-known Protobuf types to the application’s registry.