Generated by API Evangelist
Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Advanced Object schema API
version: 1.0.0
extends: openapi/optimizely-object-schema-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: 3
- target: $.paths['/schema/objects'].get
update:
x-apievangelist-phrasing:
intent: List data platform objects
effect: read
questions:
- Which objects exist in my Optimizely Data Platform account?
- How can I see the schema of all my data objects at once?
instructions:
- text: List all objects in my data platform schema.
- text: Show every object defined in the account schema.
method: generated
generated: '2026-09-26'
- target: $.paths['/schema/objects'].post
update:
x-apievangelist-phrasing:
intent: Create a custom data object
effect: write
questions:
- How do I add a custom object like tickets to my data schema?
- Can a new object define relations to other objects?
- What does the public read setting do on a new object?
instructions:
- text: Create object {name} (singular {alias}, display name {display_name}) with fields {fields} and public read {public_read}.
slots:
name: requestBody.name
alias: requestBody.alias
display_name: requestBody.display_name
fields: requestBody.fields
public_read: requestBody.public_read
- text: Create custom object {name} with fields {fields} related to {relations}.
slots:
name: requestBody.name
fields: requestBody.fields
relations: requestBody.relations
method: generated
generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_name}'].get
update:
x-apievangelist-phrasing:
intent: Get one data object's schema
effect: read
questions:
- How can I see the fields and relations of one specific object?
- What does the schema of a single object look like?
instructions:
- text: Show the schema of object {object_name}.
slots:
object_name: path.object_name
- text: Get the fields defined on object {object_name}.
slots:
object_name: path.object_name
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.