Stellar Home
Stellar Home · Ações GPT
FastAPI
GET /api/stellar/healthPerform a Health Check## Perform a Health Check Endpoint to perform a healthcheck on
POST /api/stellar/calculateGetPOST /api/stellar/get_roof_insightsGetPOST /api/stellar/proposalGet
Esquema API original
{
"openapi": "3.1.0",
"info": {
"title": "FastAPI",
"version": "0.1.0"
},
"servers": [
{
"url": "https://api.staging.stellarhome.ai/"
}
],
"paths": {
"/api/stellar/health": {
"get": {
"tags": [
"healthcheck"
],
"summary": "Perform a Health Check",
"description": "## Perform a Health Check\nEndpoint to perform a healthcheck on",
"operationId": "get_health_api_stellar_health_get",
"responses": {
"200": {
"description": "Return HTTP Status Code 200 (OK)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthCheck"
}
}
}
}
}
}
},
"/api/stellar/calculate": {
"post": {
"summary": "Get",
"operationId": "get_api_stellar_calculate_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelInference"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearer": []
}
]
}
},
"/api/stellar/get_roof_insights": {
"post": {
"summary": "Get",
"operationId": "get_api_stellar_get_roof_insights_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoofInsightsModelInference"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearer": []
}
]
}
},
"/api/stellar/proposal": {
"post": {
"summary": "Get",
"operationId": "get_api_stellar_proposal_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProposalModelInference"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"OAuth2PasswordBearer": []
}
]
}
}
},
"components": {
"schemas": {
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"HealthCheck": {
"properties": {
"status": {
"type": "string",
"title": "Status",
"default": "OK"
}
},
"type": "object",
"title": "HealthCheck",
"description": "Response model to validate and return when performing a health check."
},
"ModelInference": {
"properties": {
"address": {
"type": "string",
"title": "Address"
},
"image": {
"type": "string",
"title": "Image"
}
},
"type": "object",
"required": [
"address",
"image"
],
"title": "ModelInference"
},
"ModelResponse": {
"properties": {
"address": {
"type": "string",
"title": "Address"
},
"sat_buff": {
"type": "string",
"title": "Sat Buff"
},
"seg_buff": {
"type": "string",
"title": "Seg Buff"
},
"segment_score": {
"type": "number",
"title": "Segment Score"
},
"area_stellar": {
"type": "number",
"title": "Area Stellar"
},
"light_intensity_stellar": {
"type": "number",
"title": "Light Intensity Stellar"
},
"yearly_savings_stellar": {
"type": "number",
"title": "Yearly Savings Stellar"
},
"area_sunroof": {
"type": "number",
"title": "Area Sunroof"
},
"light_intensity_sunroof": {
"type": "number",
"title": "Light Intensity Sunroof"
},
"yearly_savings_sunroof": {
"type": "number",
"title": "Yearly Savings Sunroof"
}
},
"type": "object",
"required": [
"address",
"sat_buff",
"seg_buff",
"segment_score",
"area_stellar",
"light_intensity_stellar",
"yearly_savings_stellar",
"area_sunroof",
"light_intensity_sunroof",
"yearly_savings_sunroof"
],
"title": "ModelResponse"
},
"ProposalModelInference": {
"properties": {
"address": {
"type": "string",
"title": "Address"
},
"name": {
"type": "string",
"title": "Name"
},
"email": {
"type": "string",
"title": "Email"
}
},
"type": "object",
"required": [
"address",
"name",
"email"
],
"title": "ProposalModelInference"
},
"RoofInsightsModelInference": {
"properties": {
"address": {
"type": "string",
"title": "Address"
},
"electricity_bill_value": {
"type": "number",
"title": "Electricity Bill Value"
}
},
"type": "object",
"required": [
"address",
"electricity_bill_value"
],
"title": "RoofInsightsModelInference"
},
"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"
}
},
"securitySchemes": {
"OAuth2PasswordBearer": {
"type": "oauth2",
"flows": {
"password": {
"scopes": {},
"tokenUrl": "token"
}
}
}
}
}
}