Redline a Contract with Playbook

Run AI-generated redlines on a contract using a previously uploaded playbook. Returns suggested edits with risk scores and explanations.

OAuth Scope required: public.jurist.redlineWithPlaybook

post/jurist/redline-with-playbook

Request

Base URL
https://ironcladapp.com/public/api/v1
URL
https://ironcladapp.com/public/api/v1/jurist/redline-with-playbook
Auth
API key in header Authorization and OAuth 2
Authorization code: https://ironcladapp.com/oauth/authorize
Client credentials
Token URL: https://ironcladapp.com/oauth/token scopes: public.jurist.redlineWithPlaybook

playbookTokenstring required

Token returned from the upload endpoint referencing the playbook file.

contractTokenstring required

Token returned from the upload endpoint referencing the contract file.

rolestring

The negotiating role. Influences how redlines are suggested.

negotiationPosturestring

The negotiation posture to apply.

documentCategorystring

The category of the contract document.

documentOriginstring

The origin of the contract document.

userContextstring

Additional context to provide to the AI when generating redlines.

intent'redline' | 'respond_to_counterparty'

The intent of the redlining operation.

clauseImportanceMatrixobject

A map of clause names to their importance level. Influences how aggressively each clause is redlined.

autoDetectMissingFieldsboolean

When true, the AI will attempt to auto-detect and fill in missing negotiation parameters.

{
  "role": "buyer",
  "negotiationPosture": "firm",
  "documentCategory": "MSA",
  "documentOrigin": "third_party"
}

200

redlinedDocumentUrlstring

Signed URL to download the redlined DOCX with tracked changes applied. Valid for 7 days. Omitted if no redlines were generated.

{
  "redlines": [
    {
      "edit": {
        "riskScore": "medium"
      }
    }
  ]
}