API Reference¶
The Dataspace Ecosystem provides a set of REST APIs that allow you to create assets, policies, and link them together into contract definitions, while managing each one independently. You can also negotiate contracts, transfer data, and handle decentralized identities, all programmatically. Every API uses JSON-LD (JSON for Linked Data) as its request/response format.
Each API corresponds to a specific architectural component. The Control Plane API manages business logic (assets, policies, contracts), the Data Plane API handles actual data movement, and the Identity API manages trust and credentials. Understanding which component owns which API helps you navigate the ecosystem effectively.
New to the Dataspace Ecosystem?
If this is your first time exploring the Dataspace Ecosystem, we recommend reading these pages first for essential context:
- Introduction — What the ecosystem is and why it exists
- Key Concepts — Fundamental terms: assets, policies, contracts, DIDs, VCs
- Architecture Overview — How the components fit together and which APIs they expose
-
Overview
API structure, authentication methods, common request/response patterns, pagination, filtering, and error handling.
-
Control Plane API
Management and protocol APIs for assets, policies, contract definitions, contract negotiations, and transfer processes.
-
Data Plane API
Public and control APIs for data transfer endpoints and data consumption tracking.
-
Identity API
DID resolution, credential management, verifiable presentations, and STS (Secure Token Service) endpoints.
Next Steps¶
- Start with the API Overview for common patterns and conventions
- Explore individual API pages for endpoint-specific documentation
- Review the Architecture Overview to understand how components and APIs relate
- Follow the Getting Started guide to deploy services and start making API calls