Reference/OpenAPI
OpenAPI & contracts
Ether maintains machine-readable contracts alongside human docs.
Product API
| Artifact | Location |
|---|---|
| OpenAPI YAML | ether-core/docs/openapi.yaml |
| Live (when deployed) | GET https://api.tryether.ai/api/openapi |
Covers auth, onboarding, tasks, activity, realtime discovery, and related product routes.
Harness API
| Artifact | Location |
|---|---|
| OpenAPI YAML | ether-core/docs/openapi/harness-v1.yaml |
| Rust types | ether-core/crates/ether-harness-contract |
| TS client | ether-core/packages/ether-os-sdk |
Harness integrators should treat harness-v1.yaml as source of truth for external execution.
Internal engineering docs
Detailed backend docs live in ether-core/docs/:
| Doc | Topic |
|---|---|
harness-integration-guide.md | Harness architecture |
ether-app-harness-contract.md | Realtime + UI fields |
context-taxonomy.md | Memory layers |
auth-strategy.md | OTP + JWT direction |
onboarding-api.md | User onboarding |
This site (ether-docs) is the public integrator narrative; ether-core docs are the engineering archive.
Versioning
- Harness schema version field:
ExecutionBundle.schema_version(currently1) - Breaking API changes should bump OpenAPI
info.versionand publish migration notes here
Testing contracts
bash
# Harness e2e
cargo test -p ether-api --test harness_contract_e2e
# Contract crates
cargo test -p ether-harness-contract
cargo test -p ether-context