# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salesforce Batch API
  version: 1.0.0
extends: openapi/salesforce-batch-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/async/64.0/job//batch'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of batches in a Bulk API job
      effect: read
      questions:
      - Have the batches in my Bulk API 1.0 job finished processing?
      - Can I see how many records each batch processed or failed?
      instructions:
      - text: Check the batch status for my bulk job using session {session}.
        slots:
          session: header.X-SFDC-Session
      - text: List the batches in my Bulk API job with {encoding} compression.
        slots:
          encoding: header.Accept-Encoding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/async/64.0/job//batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a batch of records to a Bulk API job
      effect: write
      questions:
      - How do I upload a CSV of records as a new batch in a Bulk API 1.0 job?
      - Can I send a batch file with a specific charset to a bulk job?
      instructions:
      - text: Add file {file} as a new batch in my bulk job.
        slots:
          file: requestBody.File
      - text: Upload {file} with charset {charset} as a batch.
        slots:
          file: requestBody.File
          charset: header.charset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/async/64.0/job//batch/{_batchId}/result'].get
  update:
    x-apievangelist-phrasing:
      intent: List the result sets of a Bulk API batch
      effect: read
      questions:
      - Where are the results of a finished Bulk API batch?
      - Can I get the list of result IDs a batch produced?
      instructions:
      - text: List the results for batch {batch_id}.
        slots:
          batch_id: path._batchId
      - text: Get the result set IDs produced by bulk batch {batch_id}.
        slots:
          batch_id: path._batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/async/64.0/job//batch/{_batchId}/result/{batchResultId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one result set of a Bulk API batch
      effect: read
      questions:
      - Can I download the data for one specific result of a bulk query batch?
      - What rows are in result set 752... of my batch?
      instructions:
      - text: Download result {result_id} of batch {batch_id}.
        slots:
          result_id: path.batchResultId
          batch_id: path._batchId
      - text: Fetch the rows in bulk result {result_id} from batch {batch_id}.
        slots:
          result_id: path.batchResultId
          batch_id: path._batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/composite/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Run up to 25 subrequests in one call
      effect: write
      questions:
      - Can I bundle up to 25 independent REST calls into a single request?
      - Do composite batch subrequests stop when one fails?
      instructions:
      - text: Run these subrequests {requests} as one composite batch.
        slots:
          requests: requestBody.batchRequests
      - text: Execute batch {requests} and set halt on error to {halt}.
        slots:
          requests: requestBody.batchRequests
          halt: requestBody.haltOnError
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/chatter/feed-elements/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Post up to 500 feed elements at once
      effect: write
      questions:
      - Can I post hundreds of Chatter feed items in one request?
      - What is the limit on feed elements in a batch post?
      instructions:
      - text: Post these feed elements {inputs} to Chatter in one batch.
        slots:
          inputs: requestBody.inputs
      - text: Bulk-publish {inputs} as Chatter posts.
        slots:
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/records/batch/{RECORD_IDS}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several records in one call
      effect: read
      questions:
      - Can I fetch the data for several record IDs at once?
      - What is the quickest way to read a handful of records by ID together?
      instructions:
      - text: Get records {record_ids}.
        slots:
          record_ids: path.RECORD_IDS
      - text: Fetch the field values for the batch of record IDs {record_ids}.
        slots:
          record_ids: path.RECORD_IDS
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/favorites/batch'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder and replace all favorites at once
      effect: destructive
      questions:
      - Can I reorder all my favorites in one call?
      - What happens to favorites I leave out of a batch update?
      instructions:
      - text: Replace my favorites with {favorites} in this order.
        slots:
          favorites: requestBody.favorites
      - text: Set my full favorites list to {favorites}, deleting any not listed.
        slots:
          favorites: requestBody.favorites
      method: generated
      generated: '2026-09-26'