Skip to main content
GET
/
v0
/
agreements
/
documents
/
{documentId}
Get agreement document
curl --request GET \
  --url https://test-api.shodai.network/v0/agreements/documents/{documentId} \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "documentId": "7b0f6c2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d",
    "docUri": "https://test-api.shodai.network/v0/agreements/documents/7b0f6c2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d",
    "agreementId": "agr_123",
    "agreementAddress": "0x3333333333333333333333333333333333333333",
    "chainId": 59141,
    "displayName": "Advisory Retainer",
    "contentType": "text/markdown",
    "content": "# Advisory Retainer\n\nService agreement between provider and client.",
    "docHash": "0x325698d320b8d4e884a856480df1d934877cb71cd39f08bd3c5a268bd21d82db",
    "updatedAt": "2026-04-27T16:05:00.000Z"
  },
  "meta": {
    "apiVersion": "v0",
    "requestId": "<string>"
  }
}

Authorizations

X-API-Key
string
header
default:YOUR_API_KEY
required

Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias. OAuth and JWT bearer tokens are not supported.

Path Parameters

documentId
string
required

Opaque hosted agreement document identifier.

Response

Rendered agreement prose document.

data
object
required

Authenticated resolver response for hosted agreement prose associated with an on-chain docUri.

Example:
{
  "documentId": "7b0f6c2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d",
  "docUri": "https://test-api.shodai.network/v0/agreements/documents/7b0f6c2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d",
  "agreementId": "agr_123",
  "agreementAddress": "0x3333333333333333333333333333333333333333",
  "chainId": 59141,
  "displayName": "Advisory Retainer",
  "contentType": "text/markdown",
  "content": "# Advisory Retainer\n\nService agreement between provider and client.",
  "docHash": "0x325698d320b8d4e884a856480df1d934877cb71cd39f08bd3c5a268bd21d82db",
  "updatedAt": "2026-04-27T16:05:00.000Z"
}
meta
object
required