{"openapi":"3.1.0","info":{"title":"SQuADDS ML API","description":"HTTP API for the machine-learning models of SQuADDS. Every model is an entry of the registry; `/v1` is the API, and the original routes `/health`, `/models` and `/predict` are kept unchanged.","version":"2.0.0"},"paths":{"/":{"get":{"summary":"Root Route","operationId":"root_route__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Root Route  Get"}}}}}}},"/v1/health":{"get":{"tags":["v1"],"summary":"Health V1","operationId":"health_v1_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health V1 V1 Health Get"}}}}}}},"/v1/models":{"get":{"tags":["v1"],"summary":"Models V1","operationId":"models_v1_v1_models_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Models V1 V1 Models Get"}}}}}}},"/v1/models/{model_id}":{"get":{"tags":["v1"],"summary":"Model V1","operationId":"model_v1_v1_models__model_id__get","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Model V1 V1 Models  Model Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/models/{model_id}/schema":{"get":{"tags":["v1"],"summary":"Schema V1","operationId":"schema_v1_v1_models__model_id__schema_get","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","default":"json","title":"Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Schema V1 V1 Models  Model Id  Schema Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/models/{model_id}/predict":{"post":{"tags":["v1"],"summary":"Predict V1","operationId":"predict_v1_v1_models__model_id__predict_post","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredictResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inputs":{"description":"The model's inputs (see GET /v1/models/{model_id}/schema); file models take the file as inputs.file_base64"},"options":{"type":"object"}},"required":["inputs"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"},"inputs":{"type":"string","description":"JSON of the other input fields"},"options":{"type":"string","description":"JSON of the options"}},"required":["file"]}}}}}},"/health":{"get":{"tags":["legacy"],"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health Health Get"}}}}}}},"/models":{"get":{"tags":["legacy"],"summary":"List Models","operationId":"list_models_models_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response List Models Models Get"}}}}}}},"/predict":{"post":{"tags":["legacy"],"summary":"Predict","operationId":"predict_predict_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PredictionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Predict Predict Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PredictResponse":{"properties":{"model_id":{"type":"string","title":"Model Id"},"family":{"type":"string","title":"Family"},"revision":{"type":"string","title":"Revision"},"outputs":{"additionalProperties":true,"type":"object","title":"Outputs","description":"Family specific outputs"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Family specific metadata: names, units, orders, checks"},"timing_s":{"additionalProperties":true,"type":"object","title":"Timing S","description":"Seconds: total, queue and family specific steps"},"cached":{"type":"boolean","title":"Cached"}},"type":"object","required":["model_id","family","revision","outputs","metadata","timing_s","cached"],"title":"PredictResponse"},"PredictionOptions":{"properties":{"include_scaled_outputs":{"type":"boolean","title":"Include Scaled Outputs","description":"Include raw scaled model outputs alongside inverse-transformed values.","default":false}},"type":"object","title":"PredictionOptions"},"PredictionRequest":{"properties":{"model_id":{"type":"string","title":"Model Id","description":"The deployed model identifier."},"inputs":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"items":{"additionalProperties":{"type":"number"},"type":"object"},"type":"array"}],"title":"Inputs","description":"Either a single input object or a batch of input objects."},"options":{"$ref":"#/components/schemas/PredictionOptions"}},"type":"object","required":["model_id","inputs"],"title":"PredictionRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}