Download OpenAPI specification:Download
API for submitting signed intents, proposing solutions, and managing templates. The Orchestrator verifies each proposal against the user's signed intent and the configured template.
Submit and retrieve signed user intents, and propose solutions for them.
An intent encodes what a user wants to happen, parameterized against a compiled template. Submitting a proposal triggers ZK proof generation to verify the solution satisfies the policy defined by the intent and its template.
Submit a signed intent.
The signature is verified and the referenced template must exist before the intent is stored.
required | object (Intent) The data payload that is being signed. |
required | object or object or object (Signature) |
{- "payload": {
- "attrs": {
- "fields": {
- "property1": null,
- "property2": null
}
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "template_id": "string"
}, - "signature": {
- "Ed25519": {
- "pub_key": "string",
- "signature": "string"
}
}
}{- "message": "string"
}Get a stored intent by its ID.
| intent_id required | string <uuid> (IntentId) Intent ID |
{- "payload": {
- "attrs": {
- "fields": {
- "property1": null,
- "property2": null
}
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "template_id": "string"
}, - "signature": {
- "Ed25519": {
- "pub_key": "string",
- "signature": "string"
}
}
}Submit a proposal for a pending intent, triggering the delta mandate pipeline.
The intent and its template must exist and the intent must not yet have a proposal. Evidence will be extracted from the proposed solution, then validated against the template and intent. Upon success, a proof is generated.
| intent_id required | string <uuid> (IntentId) Intent ID |
| metadata required | any Additional metadata shared with the evidence layer. The content is agreed between the template provider and evidence layer. |
| solution required | string Identifier of the proposed solution. Examples include a URL, a UCP product variant ID, or another identifier agreed between the template provider and evidence layer. |
{- "metadata": null,
- "solution": "string"
}{- "message": "string"
}Upload and delete compiled templates.
Templates define the rules that intents and proposals must satisfy.
Compile, validate, and store a template from its source.
The compiled template is content-addressed by its SHA-256 hash, so submitting the same source twice returns the same template ID.
{- "template_id": "string"
}Compile and validate a template from its source without storing it.
This performs the same compilation validation as template submission, but does not create a template ID or write the compiled template to storage.
{- "message": "string"
}Set the runtime configuration.
| evidence_extractor_url required | string New base URL of the evidence extractor service or the empty string to use the default. |
{- "evidence_extractor_url": "string"
}{- "message": "string"
}