# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Meltwater Bring Your Own Content (BYOC) API
  version: 1.0.0
extends: openapi/meltwater-bring-your-own-content-byoc-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['/v3/imports/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Import my own documents into Meltwater
      effect: write
      questions:
      - How do I bring my own content into the Meltwater platform?
      - Can I tag a batch of imported documents so I can find them later?
      - Is there a way to upload documents for a specific company on my account?
      instructions:
      - text: 'Import these documents: {documents}.'
        slots:
          documents: requestBody.documents
      - text: Ingest {documents} and label the import with tag {import_tag}.
        slots:
          documents: requestBody.documents
          import_tag: query.import_tag
      - text: Upload {documents} into company {company_id}'s content.
        slots:
          documents: requestBody.documents
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/imports/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List my content import batches
      effect: read
      questions:
      - Which of my content import batches failed last week?
      - Can I see every import batch that is still pending?
      - What batches were imported under a particular import tag?
      instructions:
      - text: List my import batches with status {status}.
        slots:
          status: query.status
      - text: Show import batches created between {start} and {end} in timezone {tz}.
        slots:
          start: query.start
          end: query.end
          tz: query.tz
      - text: List the import batches assigned to import tag {import_tag}.
        slots:
          import_tag: query.import_tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/imports/batches/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one import batch
      effect: read
      questions:
      - Did my uploaded content batch finish importing, and how many documents made it?
      - Where can I see the statistics for a single import batch I submitted?
      instructions:
      - text: Get the status and statistics of import batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Check whether import batch {batch_id} has finished, with times in {tz}.
        slots:
          batch_id: path.batch_id
          tz: query.tz
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/imports/import_tags/{import_tag}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for an import tag
      effect: read
      questions:
      - How many documents have been imported under one of my import tags?
      - What is the overall status of everything I brought in with a given import tag?
      instructions:
      - text: Get the status and statistics for import tag {import_tag}.
        slots:
          import_tag: path.import_tag
      - text: Summarise everything imported under tag {import_tag} for company {company_id}.
        slots:
          import_tag: path.import_tag
          company_id: query.company_id
      method: generated
      generated: '2026-10-01'