{
  "opencollection": "1.0.0",
  "info": {
    "name": "Materials Project Defect Tasks Materials Similarity API",
    "version": "0.86.4rc5.dev1+g77c2c1315"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-API-KEY",
      "value": "{{X-API-KEY}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Materials Similarity",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get SimilarityDoc documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/materials/similarity/",
            "params": [
              {
                "name": "material_ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of material_id values to query on"
              },
              {
                "name": "_page",
                "value": "",
                "type": "query",
                "description": "Page number to request (takes precedent over _limit and _skip)."
              },
              {
                "name": "_per_page",
                "value": "",
                "type": "query",
                "description": "Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000."
              },
              {
                "name": "_skip",
                "value": "",
                "type": "query",
                "description": "Number of entries to skip in the search."
              },
              {
                "name": "_limit",
                "value": "",
                "type": "query",
                "description": "Max number of entries to return in a single query. Limited to 1000."
              },
              {
                "name": "_fields",
                "value": "",
                "type": "query",
                "description": "Fields to project from SimilarityDoc as a list of comma separated strings.                    Fields include: `builder_meta` `nsites` `elements` `nelements` `composition` `composition_reduced` `formula_pretty` `formula_anonymous` `chemsys` `volume` `density` `density_atomic` `symmetry` `material_id` `deprecated` `deprecation_reasons` `last_updated` `origins` `warnings` `structure` `property_name` `sim` `feature_vector` `method`"
              },
              {
                "name": "_all_fields",
                "value": "",
                "type": "query",
                "description": "Include all fields."
              }
            ]
          },
          "docs": "Get SimilarityDoc documents"
        },
        {
          "info": {
            "name": "Get SimilarityDoc documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/materials/similarity/match/",
            "params": [
              {
                "name": "feature_vector_hex",
                "value": "",
                "type": "query",
                "description": "A compressed, hex representation of a row unit vector of floats."
              },
              {
                "name": "feature_vector_norm",
                "value": "",
                "type": "query",
                "description": "The norm of the feature vector"
              },
              {
                "name": "method",
                "value": "",
                "type": "query",
                "description": "The method used to embed a structure as a feature vector."
              },
              {
                "name": "_limit",
                "value": "",
                "type": "query",
                "description": "Max number of entries to return in a single query. Limited to 10 by default"
              }
            ]
          },
          "docs": "Get SimilarityDoc documents"
        }
      ]
    }
  ],
  "bundled": true
}