{
  "opencollection": "1.0.0",
  "info": {
    "name": "Marqo REST API",
    "version": "2.26"
  },
  "items": [
    {
      "info": {
        "name": "Telemetry",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Root Health Check",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/"
          },
          "docs": "Root Health Check"
        },
        {
          "info": {
            "name": "Health Check",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/health"
          },
          "docs": "Health Check"
        },
        {
          "info": {
            "name": "Memory Usage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/memory"
          },
          "docs": "Memory Usage"
        }
      ]
    },
    {
      "info": {
        "name": "Models",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Loaded Models",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/models"
          },
          "docs": "List Loaded Models"
        },
        {
          "info": {
            "name": "Eject Model",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8882/models/eject",
            "params": [
              {
                "name": "model_name",
                "value": "",
                "type": "query"
              },
              {
                "name": "model_device",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Eject Model"
        }
      ]
    },
    {
      "info": {
        "name": "Indexes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Indexes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/indexes"
          },
          "docs": "List Indexes"
        },
        {
          "info": {
            "name": "Create Index",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8882/indexes/:index_name",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create Index"
        },
        {
          "info": {
            "name": "Delete Index",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8882/indexes/:index_name",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ]
          },
          "docs": "Delete Index"
        },
        {
          "info": {
            "name": "Get Index Settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/indexes/:index_name/settings",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ]
          },
          "docs": "Get Index Settings"
        },
        {
          "info": {
            "name": "Get Index Stats",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/indexes/:index_name/stats",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ]
          },
          "docs": "Get Index Stats"
        }
      ]
    },
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add Or Update Documents",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8882/indexes/:index_name/documents",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add Or Update Documents"
        },
        {
          "info": {
            "name": "Delete Documents",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:8882/indexes/:index_name/documents",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Delete Documents"
        },
        {
          "info": {
            "name": "Get Document By Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8882/indexes/:index_name/documents/:document_id",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              },
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "expose_facets",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get Document By Id"
        }
      ]
    },
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search Index",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8882/indexes/:index_name/search",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search Index"
        }
      ]
    },
    {
      "info": {
        "name": "Recommendations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Recommend Similar Documents",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8882/indexes/:index_name/recommend",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Recommend Similar Documents"
        }
      ]
    },
    {
      "info": {
        "name": "Embeddings",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Generate Embeddings",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:8882/indexes/:index_name/embed",
            "params": [
              {
                "name": "index_name",
                "value": "",
                "type": "path",
                "description": "Name of the Marqo index."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate Embeddings"
        }
      ]
    }
  ],
  "bundled": true
}