Generated by API Evangelist
Written by API Evangelist tooling for OneTrust's API. It is a proposal applied on top of the contract, not a document OneTrust publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…
version: 1.0.0
extends: openapi/onetrust-custom-index-management-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: 2
- target: $.paths['/api/consentmanager/v1/custom-indexes'].post
update:
x-apievangelist-phrasing:
intent: Start building a custom data element index
effect: write
questions:
- How do I speed up searches on a data element with a custom index?
- What do I get back to track a custom index build?
instructions:
- text: Create a custom search index with operation {operationName} and parameters {parameters}.
slots:
operationName: requestBody.operationName
parameters: requestBody.parameters
- text: Kick off index creation {operationName} for data elements {parameters} and give me the run ID.
slots:
operationName: requestBody.operationName
parameters: requestBody.parameters
method: generated
generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v1/custom-indexes/{runId}/status'].get
update:
x-apievangelist-phrasing:
intent: Check the status of a custom index build
effect: read
questions:
- Has my custom search index finished building?
- Why did a custom index creation run fail?
instructions:
- text: Check the status of index run {runId}.
slots:
runId: path.runId
- text: Show start time, end time and errors for index creation run {runId}.
slots:
runId: path.runId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.