Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author AI Redline API

5 actions 5 updates phrasing extends openapi/conga-airedline-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/check-in'].post
$.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/preview'].post
$.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/risks'].post
$.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/risks/{attachmentId}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for X-Author AI Redline API
  version: 1.0.0
extends: openapi/conga-airedline-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/check-in'].post
  update:
    x-apievangelist-phrasing:
      intent: Check in a document with AI redline changes
      effect: write
      questions:
      - How do I publish the clause changes suggested by AI redlining back to the agreement?
      - Can I check in an AI-redlined document with chosen publish options?
      instructions:
      - text: Check in the AI redline changes for attachment {attachmentId} on agreement {contractId}.
        slots:
          attachmentId: requestBody.attachmentId
          contractId: path.contractId
      - text: Publish AI-redlined clause changes {clauseChangesDetails} to agreement {contractId}.
        slots:
          clauseChangesDetails: requestBody.clauseChangesDetails
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a document with AI redline changes
      effect: read
      questions:
      - Can I see what the agreement would look like after the AI redline edits before committing?
      - How do I preview AI-suggested clause changes on an attachment?
      instructions:
      - text: Preview the AI redline changes on attachment {attachmentId} of agreement {contractId}.
        slots:
          attachmentId: requestBody.attachmentId
          contractId: path.contractId
      - text: Show a preview of agreement {contractId} with clause changes {clauseChangesDetails} applied.
        slots:
          contractId: path.contractId
          clauseChangesDetails: requestBody.clauseChangesDetails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/risks'].post
  update:
    x-apievangelist-phrasing:
      intent: Analyze document content for AI redline risks
      effect: read
      questions:
      - Can AI flag risky language in the agreement text I'm drafting?
      - How do I submit document content to get an AI risk analysis?
      instructions:
      - text: Analyze this content {documentContent} for risks on agreement {contractId}.
        slots:
          documentContent: requestBody.documentContent
          contractId: path.contractId
      - text: Run an AI redline risk check on agreement {contractId}'s draft text.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/AI/redline/risks/{attachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get AI redline risks for an attachment
      effect: read
      questions:
      - What risks did AI find in a specific agreement attachment?
      - Where can I read the AI risk results already computed for an attachment?
      instructions:
      - text: Get the AI redline risks for attachment {attachmentId} on agreement {contractId}.
        slots:
          attachmentId: path.attachmentId
          contractId: path.contractId
      - text: Show risk findings for file {attachmentId} of agreement {contractId}.
        slots:
          attachmentId: path.attachmentId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'