ExchangeKey exchange.key@1
Generated at from
openvibe-contracts v0.419.0 and
openvibe-sdk v0.161.0.
- Version
- 1.0.0
- Owner
- exchange
- Visibility
- public
- Status
- active
- Compatibility
- backward
- Decision
- ADR-025
- Schema
https://openvibe.network/contracts/exchange/key.v1.json
Exchange API platform ExchangeKey response. Private account data is available only to its owner.
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
id | string | yes | ||
name | string | yes | ||
prefix | string | yes | ||
monthly_cap_usd | number | yes |
| |
allowed_models | array of string | yes | ||
created_at | string | yes |
| |
revoked_at | string | null | yes |
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: platform
{
"id": "xkey_example",
"name": "App",
"prefix": "ovx_exampl",
"monthly_cap_usd": 10,
"allowed_models": [
"m"
],
"created_at": "2026-11-09T00:00:00Z",
"revoked_at": null
}Rejected: platform
{}Validate
const contracts = require('openvibe-contracts');
contracts.validate('exchange.key@1', value); // { valid, errors: [{ path, message }] }