Deploy agreement
deploy_agreementDeploy an authored agreement JSON on-chain using a pre-signed EIP-712 permit and receive the deployed record.
Instructions
Deploys authored agreement JSON using an EIP-712 permit; the API submits the on-chain transaction and returns the deployed agreement record. Provide a pre-signed permit (signer, deadline, signature), or call prepare_deployment_typed_data first to obtain the payload to sign. Always run preflight_deployment before deploying. Requires the agreements.write scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| docUri | No | Optional document URI recorded on-chain with the agreement. | |
| signer | No | Wallet address (0x...) that signed the permit. | |
| chainId | No | Target EVM chain ID (e.g. 59141 for Linea Sepolia). | |
| deadline | No | Permit deadline in unix seconds. Must match the signed payload. | |
| agreement | Yes | Complete authored agreement JSON document with metadata, variables, content, and execution sections. | |
| observers | No | Observer email addresses. | |
| documentId | No | Optional hosted document ID paired with docUri for GET /v0/agreements/documents/{documentId}. | |
| initValues | No | Deployment-time values for variables referenced by execution.initialize.data. | |
| signatureR | No | Permit signature r component (0x... 32 bytes). | |
| signatureS | No | Permit signature s component (0x... 32 bytes). | |
| signatureV | No | Permit signature v component (27 or 28). | |
| displayName | Yes | Human-readable name for the deployed agreement record. | |
| participants | No | Wallet mappings for participant variables. |