{
  "openapi": "3.1.0",
  "info": {
    "title": "Ethical Stack research API",
    "version": "0.6.0",
    "description": "Read-only sourced ethical assessments. No authentication. Unknown values never satisfy minimum score filters."
  },
  "servers": [
    {
      "url": "https://ethicalstack.ai/api/v1"
    }
  ],
  "paths": {
    "/profiles": {
      "get": {
        "operationId": "search_profiles",
        "description": "Find AI profiles by task, keyword and documented criteria. Unknown scores never satisfy minimums. Returns small summaries; fetch assessments for cited detail.",
        "parameters": [
          {
            "name": "dimensions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "energy",
                  "training-rights",
                  "privacy",
                  "openness",
                  "labour",
                  "military-contracts",
                  "israel-palestine"
                ]
              },
              "minItems": 1,
              "maxItems": 7,
              "uniqueItems": true
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "task",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "category",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "products",
                "harnesses",
                "models",
                "providers"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "localOption",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "weightAccess",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "open",
                "hosted",
                "planned",
                "unverified"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "minScores",
            "in": "query",
            "required": false,
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "energy": {
                      "type": "number",
                      "minimum": 1,
                      "maximum": 10
                    },
                    "training-rights": {
                      "type": "number",
                      "minimum": 1,
                      "maximum": 10
                    },
                    "privacy": {
                      "type": "number",
                      "minimum": 1,
                      "maximum": 10
                    },
                    "openness": {
                      "type": "number",
                      "minimum": 1,
                      "maximum": 10
                    },
                    "labour": {
                      "type": "number",
                      "minimum": 1,
                      "maximum": 10
                    },
                    "military-contracts": {
                      "type": "number",
                      "minimum": 1,
                      "maximum": 10
                    }
                  }
                }
              }
            }
          },
          {
            "name": "bdsStatus",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "priority-boycott",
                "pressure",
                "not-listed",
                "not-checked"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "sortBy",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "name",
                "overall",
                "energy",
                "training-rights",
                "privacy",
                "openness",
                "labour",
                "military-contracts"
              ]
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 10000
            },
            "style": "form",
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "Versioned research response. Scores, scope, confidence, unknowns, source-check dates and methodology are retained.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters"
          },
          "404": {
            "description": "Unknown profile"
          },
          "422": {
            "description": "Profile is not assessed for the requested task"
          },
          "503": {
            "description": "Research snapshot unavailable"
          }
        }
      }
    },
    "/assessment": {
      "get": {
        "operationId": "get_assessment",
        "description": "Get a profile’s selected ethical assessments with source-check dates, confidence, scope, unknowns and the published overall calculation. Use a category/id key.",
        "parameters": [
          {
            "name": "dimensions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "energy",
                  "training-rights",
                  "privacy",
                  "openness",
                  "labour",
                  "military-contracts",
                  "israel-palestine"
                ]
              },
              "minItems": 1,
              "maxItems": 7,
              "uniqueItems": true
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "task",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "style": "form",
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "Versioned research response. Scores, scope, confidence, unknowns, source-check dates and methodology are retained.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters"
          },
          "404": {
            "description": "Unknown profile"
          },
          "422": {
            "description": "Profile is not assessed for the requested task"
          },
          "503": {
            "description": "Research snapshot unavailable"
          }
        }
      }
    },
    "/compare": {
      "get": {
        "operationId": "compare_profiles",
        "description": "Compare two or three profiles with cited findings. A task selects capability-specific assessments and the published task rank. Does not invent compatibility or personalized scores.",
        "parameters": [
          {
            "name": "dimensions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "energy",
                  "training-rights",
                  "privacy",
                  "openness",
                  "labour",
                  "military-contracts",
                  "israel-palestine"
                ]
              },
              "minItems": 1,
              "maxItems": 7,
              "uniqueItems": true
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "task",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 64
            },
            "style": "form",
            "explode": false
          },
          {
            "name": "keys",
            "in": "query",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "minItems": 2,
              "maxItems": 3,
              "uniqueItems": true
            },
            "style": "form",
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "Versioned research response. Scores, scope, confidence, unknowns, source-check dates and methodology are retained.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters"
          },
          "404": {
            "description": "Unknown profile"
          },
          "422": {
            "description": "Profile is not assessed for the requested task"
          },
          "503": {
            "description": "Research snapshot unavailable"
          }
        }
      }
    },
    "/methodology": {
      "get": {
        "operationId": "get_methodology",
        "description": "Read scoring rubrics, evidence limits, method versions and the published overall/BDS calculation.",
        "parameters": [
          {
            "name": "dimensions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "energy",
                  "training-rights",
                  "privacy",
                  "openness",
                  "labour",
                  "military-contracts",
                  "israel-palestine"
                ]
              },
              "minItems": 1,
              "maxItems": 7,
              "uniqueItems": true
            },
            "style": "form",
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "Versioned research response. Scores, scope, confidence, unknowns, source-check dates and methodology are retained.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid parameters"
          },
          "404": {
            "description": "Unknown profile"
          },
          "422": {
            "description": "Profile is not assessed for the requested task"
          },
          "503": {
            "description": "Research snapshot unavailable"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ResearchResponse": {
        "type": "object",
        "required": [
          "schemaVersion",
          "catalogVersion",
          "methodology",
          "methodVersions",
          "guidance"
        ],
        "properties": {
          "schemaVersion": {
            "const": "ethicalstack.research.v1"
          },
          "catalogVersion": {
            "type": "string"
          },
          "methodology": {
            "type": "string",
            "format": "uri"
          },
          "methodVersions": {
            "type": "object"
          },
          "guidance": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      }
    }
  }
}