Generated by API Evangelist
Written by API Evangelist tooling for CData's API. It is a proposal applied on top of the contract, not a document CData publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for CData Connect AI REST API Embedded Cache API
version: 1.0.0
extends: openapi/cdata-cache-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['/job/cacheConnection'].post
update:
x-apievangelist-phrasing:
intent: Set the PostgreSQL cache connection
effect: write
questions:
- How do I point Connect AI caching at my own PostgreSQL database?
- Which connection string fields does the cache connection need, like server, port and password?
- Can I change the Postgres database that caching jobs write to?
instructions:
- text: Set the cache connection using the PostgreSQL connection string {connectionString}.
slots:
connectionString: requestBody.connectionString
- text: Update our caching database to {connectionString} directly through the API.
slots:
connectionString: requestBody.connectionString
method: generated
generated: '2026-09-26'
- target: $.paths['/job/cacheConnection/formLink'].post
update:
x-apievangelist-phrasing:
intent: Get a form link for a user to set their cache DB
effect: write
questions:
- Can I send a user to a hosted page where they enter their own PostgreSQL cache details?
- How do I control where the user lands after saving the cache connection form?
- Is there a way to lock the cache connection name so the user can't edit it?
instructions:
- text: Generate a cache connection form link that returns the user to {redirectURL}.
slots:
redirectURL: requestBody.redirectURL
- text: Create a cache setup page link named {name} with editable name set to {editableName}, redirecting to {redirectURL}.
slots:
name: requestBody.name
editableName: requestBody.editableName
redirectURL: requestBody.redirectURL
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
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.