Update README.md

README.md

@@ -8,3 +8,67 @@ pinned: false
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+
+
+
+To interact with your FastAPI application using curl, you can use the following commands. The base URL for your API is https://shakeel143-sbburaflaskapi.hf.space.
+
+1. Health Check
+Endpoint: /health
+Method: GET
+Curl Command:
+curl -X GET "https://shakeel143-sbburaflaskapi.hf.space/health"
+
+
+2. Root Endpoint
+Endpoint: /
+Method: GET
+Curl Command:
+curl -X GET "https://shakeel143-sbburaflaskapi.hf.space/"
+
+
+3. List Available Models
+Endpoint: /available-models
+Method: GET
+Curl Command:
+curl -X GET "https://shakeel143-sbburaflaskapi.hf.space/available-models"
+
+
+4. Load a Model
+Endpoint: /load-model/
+Method: POST
+Body: JSON with model_name and optional temperature
+Curl Command:
+curl -X POST "https://shakeel143-sbburaflaskapi.hf.space/load-model/" \
+-H "Content-Type: application/json" \
+-d '{"model_name": "your_model_name", "temperature": 0.7}'
+
+
+5. Chat with a Loaded Model
+Endpoint: /chat/{model_name}
+Method: POST
+Body: JSON with question
+Curl Command:
+curl -X POST "https://shakeel143-sbburaflaskapi.hf.space/chat/your_model_name" \
+-H "Content-Type: application/json" \
+-d '{"question": "Your question here"}'
+
+
+
+
+Example Usage
+
+Health Check:
+curl -X GET "https://shakeel143-sbburaflaskapi.hf.space/health"
+
+Load a Model:
+curl -X POST "https://shakeel143-sbburaflaskapi.hf.space/load-model/" \
+-H "Content-Type: application/json" \
+-d '{"model_name": "example_model", "temperature": 0.7}'
+
+Chat with a Loaded Model:
+
+curl -X POST "https://shakeel143-sbburaflaskapi.hf.space/chat/example_model" \
+-H "Content-Type: application/json" \
+-d '{"question": "What is the capital of France?"}'