# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Documents API
  version: 1.0.0
extends: openapi/conga-documents-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: 51
- target: $.paths['/v1/cs-packages/{packageId}/documents'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder or update all documents in a package
      effect: write
      questions:
      - Can I change the order documents appear in within a signing package?
      - How do I update several documents of a Conga Sign package in one call?
      instructions:
      - text: Reorder the documents in package {packageId}.
        slots:
          packageId: path.packageId
      - text: Update the document list of package {packageId} in a single request.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a document to a package
      effect: write
      questions:
      - How do I upload another document to a package I already created?
      - Can I attach a new file to an existing signing transaction?
      instructions:
      - text: Add the file {File} as a new document in package {packageId}.
        slots:
          File: requestBody.File
          packageId: path.packageId
      - text: Upload a new document to package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several documents from a package
      effect: destructive
      questions:
      - Can I remove multiple documents from a package at once?
      - What's the way to bulk-delete documents by their IDs from a signing package?
      instructions:
      - text: Delete the selected documents from package {packageId} in one go.
        slots:
          packageId: path.packageId
      - text: Bulk remove documents from package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/all-documents/zip'].get
  update:
    x-apievangelist-phrasing:
      intent: Download all documents including supporting docs as zip
      effect: read
      questions:
      - How do I download every document in a package, supporting documents included, as a zip?
      - Can I get the signable documents and the supporting attachments together in one archive?
      - Is there an option to flatten the PDFs in the full documents zip?
      instructions:
      - text: Download a zip of all documents and supporting documents for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Get the full documents archive for package {packageId} with flatten set to {flatten}.
        slots:
          packageId: path.packageId
          flatten: query.flatten
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/signConfirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a document can be signed
      effect: write
      questions:
      - How do I confirm the application is allowed to run signing on a document?
      - Can I submit a signed hash to confirm a signature on a package document?
      instructions:
      - text: Create a signature confirmation for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Confirm signing for package {packageId} using signed hash {signedHash}.
        slots:
          packageId: path.packageId
          signedHash: requestBody.signedHash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/signed_documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign every document in a package
      effect: write
      questions:
      - Can I sign all documents in a package in a single call?
      - How do I apply a hand-drawn signature across every document in a transaction?
      instructions:
      - text: Sign all documents in package {packageId}.
        slots:
          packageId: path.packageId
      - text: Sign every document in package {packageId} with handdrawn signature {handdrawn}.
        slots:
          packageId: path.packageId
          handdrawn: requestBody.handdrawn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/visibility'].get
  update:
    x-apievangelist-phrasing:
      intent: See which recipients can view which documents
      effect: read
      questions:
      - Which signers can see which documents during the signing ceremony?
      - How do I check document visibility settings for a package?
      instructions:
      - text: Show the document visibility configuration for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Tell me which recipients can view each document in package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/visibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Set which recipients can view documents
      effect: write
      questions:
      - How do I hide a document from certain signers in a package?
      - Can I change which recipients are allowed to see each document during signing?
      instructions:
      - text: Update document visibility for package {packageId} with configurations {configurations}.
        slots:
          packageId: path.packageId
          configurations: requestBody.configurations
      - text: Restrict which signers can view documents in package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/zip'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the signable documents as a zip
      effect: read
      questions:
      - How do I download only the signable documents of a package as a zip?
      - Can I get a zip of the documents added to a package without the supporting files?
      instructions:
      - text: Download the zipped signable documents for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Get the documents zip for package {packageId} with flatten {flatten}.
        slots:
          packageId: path.packageId
          flatten: query.flatten
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document's details
      effect: read
      questions:
      - What metadata, approvals and fields does a specific document in a package have?
      - How do I look up one document's name, description and index in a package?
      instructions:
      - text: Get the details of document {documentId} in package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Show approvals and fields on document {documentId} of package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a document's properties (PUT)
      effect: write
      questions:
      - Can I overwrite a document's properties with a full PUT update?
      - How do I rename a document in a package using the PUT endpoint?
      instructions:
      - text: Replace document {documentId} in package {packageId} via PUT, setting the name to {name}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
          name: requestBody.name
      - text: PUT updated properties onto document {documentId} of package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a document via multipart or JSON (POST)
      effect: write
      questions:
      - Can I update a single document by posting multipart data instead of JSON?
      - How do I change a document's description with the POST update endpoint?
      instructions:
      - text: Post a multipart update to document {documentId} in package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Set the description of document {documentId} in package {packageId} to {description} using POST.
        slots:
          documentId: path.documentId
          packageId: path.packageId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one document from a package
      effect: destructive
      questions:
      - How do I remove a single document from a signing package?
      - Can I delete just one file from a package and keep the rest?
      instructions:
      - text: Delete document {documentId} from package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Remove only document {documentId} from package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/fields'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a document's approvals and imprint fields
      effect: write
      questions:
      - How do I replace all signature approvals and imprint fields on a document?
      - What happens if I send an empty approvals array when replacing document fields?
      instructions:
      - text: Replace approvals on document {documentId} in package {packageId} with {approvals}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
          approvals: requestBody.approvals
      - text: Swap the imprint fields on document {documentId} of package {packageId} for {imprintFields}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
          imprintFields: requestBody.imprintFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/layout'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a saved layout to a document
      effect: write
      questions:
      - Can I apply a saved field layout to a document by its name?
      - How do I drop fields that fall outside the page when applying a layout?
      instructions:
      - text: Apply layout {layoutId} to document {documentId} in package {packageId}.
        slots:
          layoutId: query.layoutId
          documentId: path.documentId
          packageId: path.packageId
      - text: Apply the layout named {layoutName} to document {documentId} of package {packageId}.
        slots:
          layoutName: query.layoutName
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a document's custom metadata
      effect: write
      questions:
      - How do I set custom metadata on a document in a package?
      - Can I overwrite internal metadata on a document, or only custom metadata?
      instructions:
      - text: Overwrite the custom metadata of document {documentId} in package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Update custom metadata on document {documentId} of package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/original'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the original uploaded PDF
      effect: read
      questions:
      - How do I get the original PDF as it was first added to a package, before signing?
      - Can I download the unsigned original version of a document?
      instructions:
      - text: Download the original PDF of document {documentId} in package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Fetch the pre-signing original of document {documentId} from package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/pages/{index}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document page as an image
      effect: read
      questions:
      - Can I render a single page of a document as a PNG image?
      - How do I preview page 3 of a document in a package?
      instructions:
      - text: Get page {index} of document {documentId} in package {packageId} as a PNG.
        slots:
          index: path.index
          documentId: path.documentId
          packageId: path.packageId
      - text: Render page {index} of document {documentId} from package {packageId}.
        slots:
          index: path.index
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/documents/{documentId}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a document as PDF
      effect: read
      questions:
      - How do I download one document from a package as a PDF even if it was uploaded as Word?
      - Can I always get the PDF version of a specific document?
      instructions:
      - text: Download document {documentId} from package {packageId} as a PDF.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      - text: Get the current PDF rendition of document {documentId} in package {packageId}.
        slots:
          documentId: path.documentId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload several files to document storage
      effect: write
      questions:
      - How do I upload a batch of files and attach them to a record at once?
      - Can I tag several uploaded files and mark them searchable in one request?
      instructions:
      - text: Upload these files {files} and attach them to {objectType} record {objectId}.
        slots:
          files: requestBody.files
          objectType: query.objectType
          objectId: query.objectId
      - text: Store multiple files {files} in document management with tags {tags}.
        slots:
          files: requestBody.files
          tags: query.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several stored documents by ID
      effect: destructive
      questions:
      - Can I delete a list of stored documents in one request?
      - What's the way to bulk-remove documents from document management by their IDs?
      instructions:
      - text: Delete this list of documents from document management.
      - text: Bulk-remove the stored documents with these IDs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several stored documents by ID
      effect: read
      questions:
      - Can I retrieve many stored documents at once by passing their IDs?
      - Is there a way to skip invalid IDs when fetching documents in bulk?
      instructions:
      - text: Fetch stored documents {documentId} in bulk.
        slots:
          documentId: query.documentId
      - text: Get documents {documentId} and ignore invalid IDs {ignoreInvalidIds}.
        slots:
          documentId: query.documentId
          ignoreInvalidIds: query.ignoreInvalidIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/multipart-uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a multipart upload for a large file
      effect: write
      questions:
      - How do I begin uploading a very large document in parts?
      - What upload ID and key do I need before sending file parts?
      instructions:
      - text: Initiate a multipart upload for document {DocumentName} on {ObjectType} {ObjectId}.
        slots:
          DocumentName: requestBody.DocumentName
          ObjectType: requestBody.ObjectType
          ObjectId: requestBody.ObjectId
      - text: Start a large-file upload session named {DocumentName}.
        slots:
          DocumentName: requestBody.DocumentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/objects/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a record's documents filtered by file type
      effect: read
      questions:
      - Which PDF files are attached to a given record?
      - Can I filter a record's documents by file type using only its object ID?
      instructions:
      - text: List {fileType} files attached to object {objectId}.
        slots:
          fileType: query.fileType
          objectId: path.objectId
      - text: Get documents for record {objectId} by file type.
        slots:
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/objects/{objectType}/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents attached to a record
      effect: read
      questions:
      - What documents are attached to a specific agreement record?
      - How do I find all files stored against a record of a given object type?
      instructions:
      - text: List documents attached to {objectType} record {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Show every stored file on {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/objects/{objectType}/{objectId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all documents attached to a record
      effect: destructive
      questions:
      - Can I wipe every document attached to one record?
      - How do I remove all stored files for a record by its object type and ID?
      instructions:
      - text: Delete all documents attached to {objectType} record {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Remove every stored file from {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/objects/{objectType}/{objectId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List document versions for a record
      effect: read
      questions:
      - What version history exists for the documents on a record?
      - Can I see every document version stored against one agreement?
      instructions:
      - text: List document versions for {objectType} record {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Show the version history of files attached to {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search stored documents by criteria
      effect: read
      questions:
      - How can I search document management for files matching a condition?
      - Can a document search return the total count along with the results?
      instructions:
      - text: Search stored documents where {Criteria}.
        slots:
          Criteria: requestBody.Criteria
      - text: Find documents matching {Criteria}, returning {Limit} results with a total count.
        slots:
          Criteria: requestBody.Criteria
          Limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload one file to document storage
      effect: write
      questions:
      - How do I upload a single Word or PDF file and attach it to a record?
      - Can I upload one file as a new version of an existing document?
      instructions:
      - text: Upload file {file} to {objectType} record {objectId}.
        slots:
          file: requestBody.file
          objectType: query.objectType
          objectId: query.objectId
      - text: Upload {file} as new version {newVersionId} of document {documentId}.
        slots:
          file: requestBody.file
          newVersionId: query.newVersionId
          documentId: query.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a stored document's file
      effect: write
      questions:
      - How do I replace the file behind an existing stored document?
      - Can I update a stored document and change its description at the same time?
      instructions:
      - text: Replace stored document {documentId} with file {file}.
        slots:
          documentId: path.documentId
          file: requestBody.file
      - text: Update document {documentId} and set its description to {description}.
        slots:
          documentId: path.documentId
          description: query.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one stored document
      effect: destructive
      questions:
      - Can I delete a single stored document by its ID?
      - Is there an option to permanently hard-delete a document?
      instructions:
      - text: Delete stored document {documentId}.
        slots:
          documentId: path.documentId
      - text: Hard-delete document {documentId} with hardDelete {hardDelete}.
        slots:
          documentId: path.documentId
          hardDelete: query.hardDelete
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a stored document
      effect: write
      questions:
      - How do I make a copy of an existing stored document?
      - Can I duplicate a document in document management?
      instructions:
      - text: Clone stored document {documentId}.
        slots:
          documentId: path.documentId
      - text: Make a copy of document {documentId}.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/exists'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a stored document exists
      effect: read
      questions:
      - Is there a quick way to confirm a document ID still exists?
      - Can I check that a stored document is present before downloading it?
      instructions:
      - text: Check whether document {documentId} exists.
        slots:
          documentId: path.documentId
      - text: Confirm stored document {documentId} is present.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stored document's metadata
      effect: read
      questions:
      - What tags, description and checkout details does a stored document have?
      - Where can I read a document's metadata without downloading the file?
      instructions:
      - text: Get metadata for stored document {documentId}.
        slots:
          documentId: path.documentId
      - text: Show the tags and checkout info on document {documentId}.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update metadata across all document versions
      effect: write
      questions:
      - How do I change a document's tags or description on every version at once?
      - Can I mark a stored document as checked out by someone?
      instructions:
      - text: Set tags {Tags} on all versions of document {documentId}.
        slots:
          Tags: requestBody.Tags
          documentId: path.documentId
      - text: Mark document {documentId} checked out by {CheckoutBy}.
        slots:
          documentId: path.documentId
          CheckoutBy: requestBody.CheckoutBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/multipart-uploads'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload one part of a multipart upload
      effect: write
      questions:
      - How do I send each chunk of a large file during a multipart upload?
      - What part number and ETag come back for each uploaded file part?
      instructions:
      - text: Upload part {partNumber} of document {documentId} for upload {uploadId}.
        slots:
          partNumber: query.partNumber
          documentId: path.documentId
          uploadId: query.uploadId
      - text: Send chunk {partNumber} using key {key} for large-file document {documentId}.
        slots:
          partNumber: query.partNumber
          key: query.key
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/multipart-uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a multipart upload
      effect: write
      questions:
      - How do I finish a multipart upload once all parts are sent?
      - Which ETags do I pass to combine the uploaded parts into one file?
      instructions:
      - text: Complete multipart upload {UploadId} for document {documentId} with ETags {ETags}.
        slots:
          UploadId: requestBody.UploadId
          documentId: path.documentId
          ETags: requestBody.ETags
      - text: Combine the uploaded parts of document {documentId} into the final file.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/multipart-uploads'].delete
  update:
    x-apievangelist-phrasing:
      intent: Abort an incomplete multipart upload
      effect: destructive
      questions:
      - Can I cancel a large-file upload that never finished?
      - What gets cleaned up when a multipart upload is aborted?
      instructions:
      - text: Abort multipart upload {UploadId} for document {documentId}.
        slots:
          UploadId: requestBody.UploadId
          documentId: path.documentId
      - text: Cancel the unfinished large-file upload on document {documentId}.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a stored document's versions
      effect: read
      questions:
      - How many versions does a particular stored document have?
      - Can I see the version list for one document ID?
      instructions:
      - text: List versions of stored document {documentId}.
        slots:
          documentId: path.documentId
      - text: Show the version history for document {documentId}.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific version of a stored document
      effect: read
      questions:
      - How do I retrieve an older version of a stored document?
      - Can I fetch one exact version of a document by version ID?
      instructions:
      - text: Get version {versionId} of document {documentId}.
        slots:
          versionId: path.versionId
          documentId: path.documentId
      - text: Retrieve document {documentId} as it was at version {versionId}.
        slots:
          documentId: path.documentId
          versionId: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{documentId}/versions/{versionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one version of a stored document
      effect: destructive
      questions:
      - Can I remove a single version of a document but keep the others?
      - How do I delete an unwanted document version?
      instructions:
      - text: Delete version {versionId} of document {documentId}.
        slots:
          versionId: path.versionId
          documentId: path.documentId
      - text: Remove only version {versionId} from stored document {documentId}.
        slots:
          versionId: path.versionId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get document info by version ID
      effect: read
      questions:
      - Can I look up a document's metadata when I only have its version ID?
      - What information comes back for a document version ID?
      instructions:
      - text: Get document information for version ID {id}.
        slots:
          id: path.id
      - text: Look up the document behind version {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/document-management/v1/documents/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a stored document file
      effect: read
      questions:
      - How do I download the actual file content of a stored document?
      - Can I download a document using its version ID?
      instructions:
      - text: Download the file for document version {id}.
        slots:
          id: path.id
      - text: Save a copy of stored document {id} locally.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a batch of documents to another format
      effect: write
      questions:
      - How do I convert a batch of Word documents to PDF in one request?
      - Can converted documents be delivered to more than one destination?
      instructions:
      - text: Convert these documents to PDF using request {request}.
        slots:
          request: query.request
      - text: Run a batch format conversion with request {request}.
        slots:
          request: query.request
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a document from templates and data
      effect: write
      questions:
      - How do I merge a template with data from several sources to generate a PDF?
      - Can I generate a document by merging an XAuthor template with platform data?
      instructions:
      - text: Generate a document from merge templates using request {request}.
        slots:
          request: query.request
      - text: Merge templates with data sources and produce the output described in {request}.
        slots:
          request: query.request
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/join'].post
  update:
    x-apievangelist-phrasing:
      intent: Join documents into a single file
      effect: write
      questions:
      - Can I combine Word documents from different sources into a single document?
      - How do I join several documents and deliver the merged result?
      instructions:
      - text: Join the documents described in {request} into one file.
        slots:
          request: query.request
      - text: Combine documents from multiple sources using join request {request}.
        slots:
          request: query.request
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/process'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a multi-step document processing request
      effect: write
      questions:
      - Is there a general endpoint to process a batch of documents in one request?
      - Can I submit a document processing job that isn't tied to one document ID?
      instructions:
      - text: Submit document processing request {request} for multiple documents.
        slots:
          request: query.request
      - text: Process documents in bulk with request {request}.
        slots:
          request: query.request
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/protect'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply or remove protection on several documents
      effect: write
      questions:
      - How do I add edit restrictions to a batch of documents?
      - Can I remove protection from documents fetched from multiple sources?
      instructions:
      - text: Apply protection to the documents in request {request}.
        slots:
          request: query.request
      - text: Remove protection from a batch of documents using {request}.
        slots:
          request: query.request
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/{documentId}/convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert one document to another format
      effect: write
      questions:
      - How do I convert a single stored document to PDF by its ID?
      - Can I convert just one document and send the result to a destination?
      instructions:
      - text: Convert document {documentId} to PDF.
        slots:
          documentId: path.documentId
      - text: Convert document {documentId} using conversion request {request}.
        slots:
          documentId: path.documentId
          request: query.request
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/{documentId}/process'].post
  update:
    x-apievangelist-phrasing:
      intent: Process a single document by ID
      effect: write
      questions:
      - Can I run processing steps on one specific document by its ID?
      - What's the call for processing a single document rather than a batch?
      instructions:
      - text: Process document {documentId}.
        slots:
          documentId: path.documentId
      - text: Run processing request {request} on document {documentId}.
        slots:
          request: query.request
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/documents/{documentId}/protect'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply or remove protection on one document
      effect: write
      questions:
      - How do I apply edit restrictions to one Word document by its ID?
      - Can I unprotect a single document and deliver it somewhere?
      instructions:
      - text: Protect document {documentId} against editing.
        slots:
          documentId: path.documentId
      - text: Change protection on document {documentId} using request {request}.
        slots:
          documentId: path.documentId
          request: query.request
      method: generated
      generated: '2026-10-01'