Optimly Recommendations API

The Recommendations API from Optimly — 3 operation(s) for recommendations.

GitHub OpenAPI

Operations 3

PATCH /api/recommendations/{rec_id} Patch Recommendation #
GET /api/v2/recommendations Get Keyed Recommendations #
PATCH /api/v2/recommendations/{rec_id} Patch Keyed Recommendation #

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/optimly-ai:optimly-ai-recommendations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

optimly-ai-recommendations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Optimly Recommendations API
  version: 0.1.0
tags:
- name: Recommendations
paths:
  /api/recommendations/{rec_id}:
    patch:
      summary: Patch Recommendation
      description: 'Act on a rec: done/dismissed stamps acted_at (now, or

        the provided backdate) + acted_by; reverting to todo clears both. An

        acted_at-only PATCH edits the date on an already-acted row.'
      operationId: patch_recommendation_api_recommendations__rec_id__patch
      parameters:
      - name: rec_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rec Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Payload
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Patch Recommendation Api Recommendations  Rec Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Recommendations
  /api/v2/recommendations:
    get:
      summary: Get Keyed Recommendations
      description: All recs for the key's brand — same payload as the Clerk route.
      operationId: get_keyed_recommendations_api_v2_recommendations_get
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
      - name: effort
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Effort
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Keyed Recommendations Api V2 Recommendations Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Recommendations
  /api/v2/recommendations/{rec_id}:
    patch:
      summary: Patch Keyed Recommendation
      description: 'Act on a rec: same semantics as the Clerk route, but

        `acted_by` stays NULL — the key acted, not a user (the attribution overlay

        uses `acted_at` only). Shared actor: api/_shared.apply_rec_action.'
      operationId: patch_keyed_recommendation_api_v2_recommendations__rec_id__patch
      parameters:
      - name: rec_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Rec Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Payload
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Patch Keyed Recommendation Api V2 Recommendations  Rec Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Recommendations
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError