Optimizely

Optimizely Documents API

The Documents API from Optimizely — 5 operation(s) for documents.

GitHub OpenAPI

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/Documents List catalog documents · Returns the EntitySet Documents #
Ask an LLM
“Which documents, like spec sheets or manuals, are attached across my catalog?”
“Can I filter documents by type or by the record they belong to?”
Tell an agent
List all catalog documents.
Find documents matching {filter}.
POST /api/v1/admin/Documents Add a document to a record · Post a new entity to EntitySet Documents #
Ask an LLM
“How do I attach a spec sheet PDF to a product?”
“What do I need to supply to register a new document, like file path and parent table?”
Tell an agent
Add document {name} at {filePath} of type {documentType}, described as {description}, to {parentTable} record {parentId}.
Register a new document named {name} pointing to file {filePath}.
GET /api/v1/admin/Documents({id}) Get a catalog document · Returns the entity with the key from Documents #
Ask an LLM
“Where is the file for a particular document stored?”
“Which record and language is a specific document tied to?”
Tell an agent
Get document {id}.
Show the file path and parent record of document {id}.
PUT /api/v1/admin/Documents({id}) Replace a catalog document · Replace entity in EntitySet Documents #
Ask an LLM
“How do I overwrite a document record in full?”
“Does replacing a document clear its language if I leave it out?”
Tell an agent
Replace document {id} with name {name} and file path {filePath}.
Overwrite document {id} entirely, setting document type {documentType}.
DELETE /api/v1/admin/Documents({id}) Delete a catalog document · Delete entity in EntitySet Documents #
Ask an LLM
“How do I delete a document that is out of date?”
“Can deleting a document be made conditional on its ETag?”
Tell an agent destructive · confirm first
Delete document {id}.
Delete document {id} only if its ETag is {etag}.
PATCH /api/v1/admin/Documents({id}) Update a catalog document · Update entity in EntitySet Documents #
Ask an LLM
“Can I point an existing document at a new file without resending everything?”
“How do I change just the description of a document?”
Tell an agent
Point document {id} at the new file {filePath}.
Change the description of document {id} to {description}.
GET /api/v1/admin/Documents/Default.Default() Get a blank document template · Call operation Default #
Ask an LLM
“What default values does a new document record start with?”
“Is there an empty document template I can fetch before adding one?”
Tell an agent
Fetch the default document template.
Show default field values for a new document record.
DELETE /api/v1/admin/documents/delete Bulk delete catalog documents · Documents delete route #
Ask an LLM
“How do I delete many documents at once?”
“Can I purge a list of documents by their IDs in one request?”
Tell an agent destructive · confirm first
Bulk delete documents {ids}.
Remove these documents in one call: {ids}.
GET /api/v1/admin/documents({key})/customproperties({custompropertyKey}) Get a custom property on a document · Documents get custom property by key and custompropertykey #
Ask an LLM
“What value is stored in a custom property on a document?”
“Can I read one custom property of a document record?”
Tell an agent
Get custom property {custompropertyKey} on document {key}.
Show document {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-documents-api-openapi.yml

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-documents-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.

GitHub Google LinkedIn

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

OpenAPI Specification

optimizely-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Documents API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Documents
paths:
  /api/v1/admin/Documents:
    get:
      tags:
      - Documents
      summary: Returns the EntitySet Documents
      operationId: Documents_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:
      - Documents
      summary: Post a new entity to EntitySet Documents
      operationId: Documents_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Document'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Documents({id}):
    get:
      tags:
      - Documents
      summary: Returns the entity with the key from Documents
      operationId: Documents_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:
      - Documents
      summary: Replace entity in EntitySet Documents
      operationId: Documents_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.Document'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Documents
      summary: Delete entity in EntitySet Documents
      operationId: Documents_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:
      - Documents
      summary: Update entity in EntitySet Documents
      operationId: Documents_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.Document'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Documents/Default.Default():
    get:
      tags:
      - Documents
      summary: Call operation Default
      operationId: Documents_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/documents/delete:
    delete:
      tags:
      - Documents
      operationId: Documents_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: Documents delete route
      x-summary-source: derived
  /api/v1/admin/documents({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Documents
      operationId: Documents_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: Documents get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.Document:
      required:
      - name
      - description
      - filePath
      - documentType
      - parentTable
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 255
          minLength: 0
          type: string
        description:
          maxLength: 255
          minLength: 0
          type: string
        filePath:
          maxLength: 1024
          minLength: 0
          type: string
        documentType:
          maxLength: 100
          minLength: 0
          type: string
        languageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        parentId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        parentTable:
          maxLength: 100
          minLength: 0
          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