Overview
Learn what the Partner API docs cover, how they are organized around the agreement lifecycle, and where to begin. Everything starts with authored agreement JSON. The authored agreement defines what the agreement says, what information it depends on, and how it moves through states and inputs. Deployment and post-deploy operation both build from that authored agreement.
Introduction
Learn what the Partner API docs cover, how they are organized around the agreement lifecycle, and where to begin. Everything starts with authored agreement JSON. The authored agreement defines what the agreement says, what information it depends on, and how it moves through states and inputs. Deployment and post-deploy operation both build from that authored agreement.
What these docs help you do
This docs set is designed to help you:
- Understand how agreements work
- Author agreement JSON
- Validate agreement structure
- Deploy a live agreement
- Operate the deployed agreement through its lifecycle
Learn what the Partner API docs cover, how they are organized around the agreement lifecycle, and where to begin. Everything starts with authored agreement JSON. The authored agreement defines what the agreement says, what information it depends on, and how it moves through states and inputs. Deployment and post-deploy operation both build from that authored agreement.
Agreement Lifecycle
What these docs help you do
The docs follow three phases of the agreement lifecycle.
Authoring Agreements
This section teaches you what an agreement is, how to model it in JSON, and how to confirm that the authored structure is coherent before moving on.
Deploying Agreements
This section teaches you how a valid authored agreement becomes a live deployed agreement by combining it with deployment values, participant wallet mappings, and signed authorization.
Using Agreements
This section teaches you how to work with a live deployed agreement: understand its current position, submit valid inputs, and inspect what changed afterward.
Recommended Path
If this is your first time through the docs, read in this order:
- Understand Agreements
- Author Agreement JSON
- Validate Agreement Structure
- Deploy an Agreement
- Operate a Deployed Agreement
- Simple Agreement
- API Reference
This is a docs path, not an endpoint checklist. The earlier pages help you understand the later ones, and the examples and reference work best once you already understand the agreement model they are showing.
Before you call the API
Partner API requests use the X-API-Key header. If you need an API key, please contact CNS Labs for assistance. When you need exact authentication or schema details, use the API Reference. This page is only here to orient you to the docs and the lifecycle they teach.
How examples and reference fit in
The API Reference is the exact source for request and response details generated from OpenAPI. use examples and reference when you need full artifacts or exact schemas The example pages and the API Reference support the learning path, but they are not the same kind of documentation. How examples and reference fit in The examples are full JSON anchors:
- Simple Agreement
- Complex Agreement
- Validate Agreement Structure
- Deploy an Agreement
- Operate a Deployed Agreement
- Simple Agreement
- API Reference
If you already understand the agreement lifecycle, examples help you inspect complete artifacts and the API Reference helps you verify exact field shapes. If you do not yet understand the agreement model, start with the lifecycle pages first. The docs work best when used in that order: learn the model, inspect full examples, then use the reference for exact details.