Smart_Budget_Recommendation_API.postman_collection.json

{
	"info": {
		"_postman_id": "smart-budget-recommendation-api",
		"name": "Smart Budget Recommendation API",
		"description": "API collection for Smart Budget Recommendation service",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Health & Status",
			"item": [
				{
					"name": "Root",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{base_url}}/",
							"host": ["{{base_url}}"],
							"path": [""]
						},
						"description": "Root endpoint"
					}
				},
				{
					"name": "Health Check",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{base_url}}/health",
							"host": ["{{base_url}}"],
							"path": ["health"]
						},
						"description": "Health check endpoint"
					}
				}
			]
		},
		{
			"name": "Expenses",
			"item": [
				{
					"name": "Create Expense",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"user_id\": \"68a834c3f4694b11efedacd2\",\n  \"amount\": 5000.0,\n  \"category\": \"Groceries\",\n  \"description\": \"Monthly groceries\",\n  \"date\": \"2025-12-25T10:00:00Z\",\n  \"type\": \"expense\"\n}"
						},
						"url": {
							"raw": "{{base_url}}/expenses",
							"host": ["{{base_url}}"],
							"path": ["expenses"]
						},
						"description": "Create a new expense"
					}
				},
				{
					"name": "Get Expenses",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{base_url}}/expenses?user_id=68a834c3f4694b11efedacd2",
							"host": ["{{base_url}}"],
							"path": ["expenses"],
							"query": [
								{
									"key": "user_id",
									"value": "68a834c3f4694b11efedacd2"
								}
							]
						},
						"description": "Get expenses for a user"
					}
				}
			]
		},
		{
			"name": "Budgets",
			"item": [
				{
					"name": "Create Budget",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"user_id\": \"68a834c3f4694b11efedacd2\",\n  \"category\": \"688c80ca990b63f0e945ecf1\",\n  \"amount\": 10000.0,\n  \"period\": \"monthly\",\n  \"start_date\": \"2025-12-01T00:00:00Z\",\n  \"end_date\": \"2025-12-31T23:59:59Z\"\n}"
						},
						"url": {
							"raw": "{{base_url}}/budgets",
							"host": ["{{base_url}}"],
							"path": ["budgets"]
						},
						"description": "Create a new budget"
					}
				},
				{
					"name": "Get Budgets",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{base_url}}/budgets?user_id=68a834c3f4694b11efedacd2",
							"host": ["{{base_url}}"],
							"path": ["budgets"],
							"query": [
								{
									"key": "user_id",
									"value": "68a834c3f4694b11efedacd2"
								}
							]
						},
						"description": "Get budgets for a user"
					}
				}
			]
		},
		{
			"name": "Recommendations",
			"item": [
				{
					"name": "Get Budget Recommendations",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{base_url}}/recommendations/68a834c3f4694b11efedacd2?month=1&year=2026",
							"host": ["{{base_url}}"],
							"path": ["recommendations", "68a834c3f4694b11efedacd2"],
							"query": [
								{
									"key": "month",
									"value": "1",
									"description": "Target month (1-12), optional"
								},
								{
									"key": "year",
									"value": "2026",
									"description": "Target year, optional"
								}
							]
						},
						"description": "Get smart budget recommendations for a user based on past spending behavior"
					}
				},
				{
					"name": "Check and Get Recommendations",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n  \"user_id\": \"6741abd38d30ab5b7176397f\",\n  \"category_id\": \"677f6c117ca4500f15dbf108\",\n  \"budget_amount\": 10000.0\n}"
						},
						"url": {
							"raw": "{{base_url}}/recommendations/check?month=1&year=2026",
							"host": ["{{base_url}}"],
							"path": ["recommendations", "check"],
							"query": [
								{
									"key": "month",
									"value": "1",
									"description": "Target month (1-12), optional"
								},
								{
									"key": "year",
									"value": "2026",
									"description": "Target year, optional"
								}
							]
						},
						"description": "Check if user has previous data for a category and return recommendations if available"
					}
				}
			]
		},
		{
			"name": "Category Expenses",
			"item": [
				{
					"name": "Get Category Expenses",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{base_url}}/category-expenses/68a834c3f4694b11efedacd2?months=3",
							"host": ["{{base_url}}"],
							"path": ["category-expenses", "68a834c3f4694b11efedacd2"],
							"query": [
								{
									"key": "months",
									"value": "3",
									"description": "Number of months to analyze (default: 3)"
								}
							]
						},
						"description": "Get average expenses by category for the past N months"
					}
				}
			]
		}
	],
	"variable": [
		{
			"key": "base_url",
			"value": "https://logicgoinfotechspaces-smart-budget-recommendation.hf.space",
			"type": "string",
			"description": "Hugging Face Space URL (lowercase, hyphens). Check your Space page for the exact URL. For local development, use: http://localhost:7860"
		},
		{
			"key": "hf_token",
			"value": "",
			"type": "string",
			"description": "Hugging Face Access Token (optional, only if space is private). Get from: https://huggingface.co/settings/tokens"
		}
	],
	"auth": {
		"type": "bearer",
		"bearer": [
			{
				"key": "token",
				"value": "{{hf_token}}",
				"type": "string"
			}
		]
	}
}