Iris_ml_project/docs/api-reference.md

45 lines
797 B
Markdown

# API Reference
## Endpoints
### GET /
Returns the home page HTML.
### GET /predict
Returns the prediction form HTML.
### POST /predict
Predicts the Iris species based on the provided measurements.
**Request Parameters**
| Parameter | Type | Description |
|-----------|------|-------------|
| sepal_length | float | Length of the sepal in cm |
| sepal_width | float | Width of the sepal in cm |
| petal_length | float | Length of the petal in cm |
| petal_width | float | Width of the petal in cm |
**Response**
```json
{
"prediction": "Iris Setosa"
}
```
Possible prediction values:
- "Iris Setosa"
- "Iris Versicolor"
- "Iris Virginica"
## Error Handling
The API uses standard HTTP status codes to indicate the success or failure of requests.
- 200: Success
- 500: Server error