# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Bulk Enhance API version: 1.0.0 extends: openapi/diffbot-bulk-enhance-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: 9 - target: $.paths['/kg/v3/enhance/bulk'].post update: x-apievangelist-phrasing: intent: Submit a bulk enhance job for many records effect: write questions: - How do I enrich a large batch of people or company records at once? - Can I get a webhook callback when a bulk enhance job completes? - What similarity threshold decides whether a record in a bulk enhance counts as a match? instructions: - text: Submit a bulk enhance job named {name}. slots: name: query.name - text: Start bulk enhance job {name} and notify {webhookurl} when it finishes. slots: name: query.name webhookurl: query.webhookurl - text: Run a bulk enhance with a match threshold of {threshold}. slots: threshold: query.threshold method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/status'].get update: x-apievangelist-phrasing: intent: List all bulk enhance jobs on my token effect: read questions: - Which bulk enhance jobs have I submitted and what state are they in? - Can I see every enhance bulkjob on my account in one call? instructions: - text: List all my bulk enhance jobs and their statuses. - text: Show every enhance bulkjob running under my token. method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/{bulkjobId}/status'].get update: x-apievangelist-phrasing: intent: Check the status of one bulk enhance job effect: read questions: - Is my bulk enhance job finished yet? - How can I poll the progress of a single enhance bulkjob by its ID? instructions: - text: Check the status of bulk enhance job {bulkjobId}. slots: bulkjobId: path.bulkjobId - text: Poll bulkjob {bulkjobId} until it reports complete. slots: bulkjobId: path.bulkjobId method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/{bulkjobId}'].get update: x-apievangelist-phrasing: intent: Download bulk enhance results via query string effect: read questions: - How do I download the enriched records from a completed bulk enhance job? - Can I get only the records that matched from a bulk enhance result? - Is it possible to export bulk enhance results as a spreadsheet file with a GET link? instructions: - text: Download the results of bulk enhance job {bulkjobId}. slots: bulkjobId: path.bulkjobId - text: Fetch only matched records from bulkjob {bulkjobId} as {format}. slots: bulkjobId: path.bulkjobId format: query.format - text: Get the first {head} results of bulk enhance job {bulkjobId}. slots: head: query.head bulkjobId: path.bulkjobId method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/{bulkjobId}'].post update: x-apievangelist-phrasing: intent: Download bulk enhance results with a POST body effect: read questions: - Can I send export options in a request body when downloading bulk enhance results? - Is there a POST way to pull a bulk enhance export with a long column spec? instructions: - text: Post an export request for bulkjob {bulkjobId} with column spec {exportspec}. slots: bulkjobId: path.bulkjobId exportspec: requestBody.exportspec - text: Using a POST body, download results {from} through {size} of bulkjob {bulkjobId}. slots: from: requestBody.from size: requestBody.size bulkjobId: path.bulkjobId method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/report/{bulkjobId}/{reportId}'].get update: x-apievangelist-phrasing: intent: Download a bulk enhance coverage report effect: read questions: - How do I see how many records in my bulk enhance job had coverage for each field? - Where can I download the coverage report for a finished bulk enhance? instructions: - text: Download coverage report {reportId} for bulk enhance job {bulkjobId}. slots: reportId: path.reportId bulkjobId: path.bulkjobId - text: Get the field coverage report {reportId} of bulkjob {bulkjobId}. slots: reportId: path.reportId bulkjobId: path.bulkjobId method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/{bulkjobId}/delete'].get update: x-apievangelist-phrasing: intent: Delete a bulk enhance job effect: destructive questions: - Can I permanently remove an old bulk enhance job? - What is the way to delete a bulkjob I no longer need? instructions: - text: Delete bulk enhance job {bulkjobId}. slots: bulkjobId: path.bulkjobId - text: Remove bulkjob {bulkjobId} from my account. slots: bulkjobId: path.bulkjobId method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/{bulkjobId}/{jobIdx}'].get update: x-apievangelist-phrasing: intent: Get one record's result from a bulk enhance job effect: read questions: - Can I fetch just one enriched record out of a bulk enhance job by its position? - How do I look up the result for a single input row in a bulkjob? instructions: - text: Get result number {jobIdx} from bulk enhance job {bulkjobId}. slots: jobIdx: path.jobIdx bulkjobId: path.bulkjobId - text: Show the enriched record at index {jobIdx} of bulkjob {bulkjobId}. slots: jobIdx: path.jobIdx bulkjobId: path.bulkjobId method: generated generated: '2026-09-26' - target: $.paths['/kg/v3/enhance/bulk/{bulkjobId}/stop'].get update: x-apievangelist-phrasing: intent: Stop a running bulk enhance job effect: destructive questions: - Can I halt a bulk enhance job that is still processing? - What stops an active enhance bulkjob before it finishes? instructions: - text: Stop bulk enhance job {bulkjobId}. slots: bulkjobId: path.bulkjobId - text: Halt the active bulkjob {bulkjobId} now. slots: bulkjobId: path.bulkjobId method: generated generated: '2026-09-26'