Optimizely Contents API

The Contents API from Optimizely — 5 operation(s) for contents.

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/Contents List CMS content revisions · Returns the EntitySet Contents #
Ask an LLM
“How do I list the content records managed in the commerce CMS?”
“Can I filter content by device type or language?”
Tell an agent
List all content records.
Find content matching {filter}.
POST /api/v1/admin/Contents Create a content revision · Post a new entity to EntitySet Contents #
Ask an LLM
“How do I add a new piece of HTML content for a device type?”
“Can I create content targeted at a specific persona or language?”
Tell an agent
Create content {name} of type {type} for {deviceType} with HTML {html}.
Add {type} content {name} with HTML {html} for device {deviceType} and persona {personaId}.
GET /api/v1/admin/Contents({id}) Get a content revision · Returns the entity with the key from Contents #
Ask an LLM
“How do I fetch one content record and its HTML by ID?”
“When was a given content revision approved or published?”
Tell an agent
Get content {id}.
Show the HTML and approval dates of content {id}.
PUT /api/v1/admin/Contents({id}) Replace a content revision · Replace entity in EntitySet Contents #
Ask an LLM
“How do I overwrite a content record in full?”
“Does replacing content require name, type, HTML and device type?”
Tell an agent
Replace content {id} with name {name}, type {type}, device {deviceType} and HTML {html}.
Overwrite every field of content record {id}.
DELETE /api/v1/admin/Contents({id}) Delete a content revision · Delete entity in EntitySet Contents #
Ask an LLM
“How do I delete one content record?”
“Can I delete content only when its ETag still matches?”
Tell an agent destructive · confirm first
Delete content {id}.
Delete content {id} if its ETag is {etag}.
PATCH /api/v1/admin/Contents({id}) Update a content revision · Update entity in EntitySet Contents #
Ask an LLM
“How do I change just the HTML of an existing content record?”
“Can I schedule content to publish to production on a date?”
Tell an agent
Update the HTML of content {id} to {html}.
Schedule content {id} to publish on {publishToProductionOn}.
GET /api/v1/admin/Contents/Default.Default() Get a default content template · Call operation Default #
Ask an LLM
“What default values does a new content record start with?”
“Can I fetch a blank content template?”
Tell an agent
Fetch the default content template.
Show me the defaults for a new content record.
DELETE /api/v1/admin/contents/delete Bulk delete content revisions · Contents delete route #
Ask an LLM
“How do I delete several content records at once?”
“Can I remove content records by passing a list of IDs?”
Tell an agent destructive · confirm first
Bulk delete the content records {ids}.
Remove these content records in one call: {ids}.
GET /api/v1/admin/contents({key})/customproperties({custompropertyKey}) Get a custom property on a content record · Contents get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a content record?”
“Can I fetch one extra property from a piece of content?”
Tell an agent
Get custom property {custompropertyKey} on content {key}.
Show content {key}'s custom property {custompropertyKey}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/optimizely:optimizely-contents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-contents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Contents API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Contents
paths:
  /api/v1/admin/Contents:
    get:
      tags:
      - Contents
      summary: Returns the EntitySet Contents
      operationId: Contents_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Contents
      summary: Post a new entity to EntitySet Contents
      operationId: Contents_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Content'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Contents({id}):
    get:
      tags:
      - Contents
      summary: Returns the entity with the key from Contents
      operationId: Contents_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Contents
      summary: Replace entity in EntitySet Contents
      operationId: Contents_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Content'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Contents
      summary: Delete entity in EntitySet Contents
      operationId: Contents_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Contents
      summary: Update entity in EntitySet Contents
      operationId: Contents_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Content'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Contents/Default.Default():
    get:
      tags:
      - Contents
      summary: Call operation Default
      operationId: Contents_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/contents/delete:
    delete:
      tags:
      - Contents
      operationId: Contents_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Contents delete route
      x-summary-source: derived
  /api/v1/admin/contents({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Contents
      operationId: Contents_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Contents get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.Content:
      required:
      - name
      - type
      - html
      - deviceType
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        contentManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 100
          minLength: 0
          type: string
        type:
          maxLength: 50
          minLength: 0
          type: string
        html:
          type: string
        submittedForApprovalOn:
          format: date-time
          type: string
        approvedOn:
          format: date-time
          type: string
        publishToProductionOn:
          format: date-time
          type: string
        createdByAdminUserProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        approvedByAdminUserProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        revision:
          format: int32
          type: integer
        deviceType:
          maxLength: 50
          minLength: 0
          type: string
        personaId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        languageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        generationType:
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query