Optimizely

Optimizely Search Synonyms API

The Search Synonyms API from Optimizely — 5 operation(s) for search synonyms.

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/SearchSynonyms List catalog search synonyms · Returns the EntitySet SearchSynonyms #
Ask an LLM
“Which search synonyms are configured for the storefront catalog?”
“How do I list every word-to-synonym mapping in admin?”
Tell an agent
List all catalog search synonyms.
Show every configured search synonym pair.
POST /api/v1/admin/SearchSynonyms Add a catalog search synonym · Post a new entity to EntitySet SearchSynonyms #
Ask an LLM
“How do I make product search treat two words as the same?”
“Can a new search synonym work in both directions?”
Tell an agent
Add search synonym {synonym} for the word {word}.
Create a synonym mapping {word} to {synonym}, bidirectional {bidirectional}.
GET /api/v1/admin/SearchSynonyms({id}) Get one catalog search synonym · Returns the entity with the key from SearchSynonyms #
Ask an LLM
“Is there a call to read a single search synonym entry?”
“Is a particular synonym mapping bidirectional?”
Tell an agent
Get search synonym {id}.
Show the word and synonym on entry {id}.
PUT /api/v1/admin/SearchSynonyms({id}) Replace a catalog search synonym · Replace entity in EntitySet SearchSynonyms #
Ask an LLM
“What's the call to overwrite a search synonym entry in full?”
“Do I need to send both the word and synonym when replacing an entry?”
Tell an agent
Replace synonym entry {id} with word {word} and synonym {synonym}.
Overwrite synonym {id} in full for language {languageId}.
DELETE /api/v1/admin/SearchSynonyms({id}) Delete a catalog search synonym · Delete entity in EntitySet SearchSynonyms #
Ask an LLM
“How do I remove one search synonym so words stop matching?”
“Can I delete a synonym only if its ETag matches?”
Tell an agent destructive · confirm first
Delete search synonym {id}.
Delete synonym entry {id} if ETag is {etag}.
PATCH /api/v1/admin/SearchSynonyms({id}) Update a catalog search synonym · Update entity in EntitySet SearchSynonyms #
Ask an LLM
“How do I make an existing synonym one-way only?”
“Can I change just the synonym word on an existing entry?”
Tell an agent
Set bidirectional on synonym {id} to {bidirectional}.
Change the synonym on entry {id} to {synonym}.
GET /api/v1/admin/SearchSynonyms/Default.Default() Get the default search synonym template · Call operation Default #
Ask an LLM
“What does a default search synonym record contain?”
“Where do I get blank values for a new synonym entry?”
Tell an agent
Get the default search synonym template.
Show default fields for a new catalog synonym.
DELETE /api/v1/admin/searchsynonyms/delete Bulk delete catalog search synonyms · Search synonyms delete route #
Ask an LLM
“Can I remove many search synonyms at once?”
“Can I bulk delete synonym entries by ID?”
Tell an agent destructive · confirm first
Bulk delete search synonyms {ids}.
Remove all these synonym entries: {ids}.
GET /api/v1/admin/searchsynonyms({key})/customproperties({custompropertyKey}) Get a custom property on a search synonym · Search synonyms get custom property by key and custompropertykey #
Ask an LLM
“Where would I read a custom property on a search synonym?”
“Can I fetch an extra attribute stored on a synonym entry?”
Tell an agent
Get custom property {prop} on search synonym {key}.
Show custom field {prop} for search synonym {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-search-synonyms-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-search-synonyms-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-search-synonyms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Search Synonyms API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Search Synonyms
paths:
  /api/v1/admin/SearchSynonyms:
    get:
      tags:
      - Search Synonyms
      summary: Returns the EntitySet SearchSynonyms
      operationId: SearchSynonyms_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:
      - Search Synonyms
      summary: Post a new entity to EntitySet SearchSynonyms
      operationId: SearchSynonyms_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SearchSynonym'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SearchSynonyms({id}):
    get:
      tags:
      - Search Synonyms
      summary: Returns the entity with the key from SearchSynonyms
      operationId: SearchSynonyms_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:
      - Search Synonyms
      summary: Replace entity in EntitySet SearchSynonyms
      operationId: SearchSynonyms_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.SearchSynonym'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Search Synonyms
      summary: Delete entity in EntitySet SearchSynonyms
      operationId: SearchSynonyms_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:
      - Search Synonyms
      summary: Update entity in EntitySet SearchSynonyms
      operationId: SearchSynonyms_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.SearchSynonym'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SearchSynonyms/Default.Default():
    get:
      tags:
      - Search Synonyms
      summary: Call operation Default
      operationId: SearchSynonyms_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/searchsynonyms/delete:
    delete:
      tags:
      - Search Synonyms
      operationId: SearchSynonyms_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: Search synonyms delete route
      x-summary-source: derived
  /api/v1/admin/searchsynonyms({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Search Synonyms
      operationId: SearchSynonyms_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: Search synonyms get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.SearchSynonym:
      required:
      - word
      - synonym
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        word:
          maxLength: 255
          minLength: 0
          type: string
        synonym:
          maxLength: 255
          minLength: 0
          type: string
        bidirectional:
          type: boolean
        languageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        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