Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Document Generation API

6 actions 6 updates phrasing extends openapi/conga-document-generation-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 6

$.info

$.paths['/api/clm/v1/contracts/{contractId}/generate'].post

$.paths['/api/clm/v1/contracts/{contractId}/joindocuments'].post

$.paths['/api/clm/v1/contracts/{contractId}/previewdocument'].post

$.paths['/api/clm/v1/contracts/{contractId}/regenerate'].post

$.paths['/api/clm/v1/contracts/{contractId}/supportingdocument'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contracts Document Generation API
  version: 1.0.0
extends: openapi/conga-document-generation-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: 5
- target: $.paths['/api/clm/v1/contracts/{contractId}/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a contract document from a template
      effect: write
      questions:
      - How do I generate the first contract document from a template in Conga CLM?
      - Can I add a watermark when generating a contract document?
      - Which output formats and protection levels can a generated contract use?
      instructions:
      - text: Generate a new document for contract {contractId} from template {TemplateId}.
        slots:
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
      - text: Generate contract {contractId} from template {TemplateId} as {OutputFormat} with watermark {WatermarkText}.
        slots:
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
          OutputFormat: requestBody.OutputFormat
          WatermarkText: requestBody.WatermarkText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/joindocuments'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge several contract documents into one
      effect: write
      questions:
      - Can I combine multiple documents on a contract into a single file?
      - Do the documents I join have to belong to the same contract?
      instructions:
      - text: Join documents {DocumentIds} on contract {contractId} into one file.
        slots:
          DocumentIds: requestBody.DocumentIds
          contractId: path.contractId
      - text: Merge documents {DocumentIds} of contract {contractId} using output options {DocumentOutputOptions}.
        slots:
          DocumentIds: requestBody.DocumentIds
          contractId: path.contractId
          DocumentOutputOptions: requestBody.DocumentOutputOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/previewdocument'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a contract document from a template
      effect: read
      questions:
      - Can I see what a contract would look like from a template before generating it for real?
      - Is there a preview option that doesn't change the contract?
      instructions:
      - text: Preview contract {contractId} rendered with template {TemplateId}.
        slots:
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
      - text: Show me a {OutputFormat} preview of contract {contractId} using template {TemplateId}.
        slots:
          OutputFormat: requestBody.OutputFormat
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a contract document
      effect: write
      questions:
      - How do I rebuild a contract document after the contract data changed?
      - Does regenerating a contract document change the contract status?
      instructions:
      - text: Regenerate the document for contract {contractId} with template {TemplateId}.
        slots:
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
      - text: Rebuild contract {contractId}'s document from {TemplateId} at protection level {ProtectionLevel}, keeping its status.
        slots:
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
          ProtectionLevel: requestBody.ProtectionLevel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/supportingdocument'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a supporting document for a contract
      effect: write
      questions:
      - Can I generate an extra supporting document, like an exhibit, for a contract?
      - Will creating a supporting document change where the contract is in its lifecycle?
      instructions:
      - text: Generate a supporting document for contract {contractId} from template {TemplateId}.
        slots:
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
      - text: Create a {OutputFormat} supporting document on {contractId} using template {TemplateId}.
        slots:
          OutputFormat: requestBody.OutputFormat
          contractId: path.contractId
          TemplateId: requestBody.TemplateId
      method: generated
      generated: '2026-10-01'