Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author DAI API

3 actions 3 updates phrasing extends openapi/conga-dai-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 3

$.info

$.paths['/api/xauthor/v1/discovery-ai/contracts/{contractId}/documents/{attachmentId}/status'].get

$.paths['/api/xauthor/v1/discovery-ai/contracts/{contractid}/documents/{attachmentId}/markup-document'].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 X-Author DAI API
  version: 1.0.0
extends: openapi/conga-dai-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: 2
- target: $.paths['/api/xauthor/v1/discovery-ai/contracts/{contractId}/documents/{attachmentId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the AI extraction job status for a document
      effect: read
      questions:
      - Has the Discovery AI extraction finished for a contract document?
      - Is the IDE import job on my contract attachment still pending review?
      instructions:
      - text: Get the extraction job status for attachment {attachment} on contract {contract}.
        slots:
          attachment: path.attachmentId
          contract: path.contractId
      - text: Check whether Discovery AI is done with document {attachment} of contract {contract}.
        slots:
          attachment: path.attachmentId
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/discovery-ai/contracts/{contractid}/documents/{attachmentId}/markup-document'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark up clauses and fields in a contract document
      effect: write
      questions:
      - Can Discovery AI tag the clauses and fields it found inside my contract document?
      - What does the markup step do to an extracted contract attachment?
      instructions:
      - text: Mark up the extracted clauses and fields in attachment {attachment} of contract {contract}.
        slots:
          attachment: path.attachmentId
          contract: path.contractid
      - text: Apply AI markup to document {attachment} on contract {contract} using job {job}.
        slots:
          attachment: path.attachmentId
          contract: path.contractid
          job: requestBody.ideJobId
      method: generated
      generated: '2026-10-01'