postman_collection.json

{
	"info": {
		"_postman_id": "image-colorization-api",
		"name": "Image Colorization API",
		"description": "API collection for Text-Guided Image Colorization using Hugging Face Inference API",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Health Check",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{base_url}}/health",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"health"
					]
				},
				"description": "Check if the API is running and models are loaded"
			},
			"response": []
		},
		{
			"name": "API Info",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{base_url}}/api",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"api"
					]
				},
				"description": "Get API information and available endpoints"
			},
			"response": []
		},
		{
			"name": "Colorize Image - Basic",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Authorization",
						"value": "Bearer {{firebase_token}}",
						"type": "text"
					}
				],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "file",
							"type": "file",
							"src": [],
							"description": "Image file to colorize"
						}
					]
				},
				"url": {
					"raw": "{{base_url}}/colorize",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"colorize"
					]
				},
				"description": "Colorize an image with default settings"
			},
			"response": []
		},
		{
			"name": "Colorize Image - With Prompt",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Authorization",
						"value": "Bearer {{firebase_token}}",
						"type": "text"
					}
				],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "file",
							"type": "file",
							"src": [],
							"description": "Image file to colorize"
						},
						{
							"key": "positive_prompt",
							"value": "vibrant natural colors, high quality photo",
							"type": "text",
							"description": "Additional descriptive text to enhance the caption"
						}
					]
				},
				"url": {
					"raw": "{{base_url}}/colorize",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"colorize"
					]
				},
				"description": "Colorize an image with custom positive prompt"
			},
			"response": []
		},
		{
			"name": "Colorize Image - Full Options",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Authorization",
						"value": "Bearer {{firebase_token}}",
						"type": "text"
					}
				],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "file",
							"type": "file",
							"src": [],
							"description": "Image file to colorize"
						},
						{
							"key": "positive_prompt",
							"value": "vibrant natural colors, high quality photo, detailed lighting",
							"type": "text",
							"description": "Additional descriptive text to enhance the caption"
						},
						{
							"key": "negative_prompt",
							"value": "low quality, monochrome, blurry, grainy",
							"type": "text",
							"description": "Words or phrases to avoid during generation"
						},
						{
							"key": "seed",
							"value": "123",
							"type": "text",
							"description": "Random seed for reproducible generation"
						},
						{
							"key": "num_inference_steps",
							"value": "8",
							"type": "text",
							"description": "Number of inference steps"
						}
					]
				},
				"url": {
					"raw": "{{base_url}}/colorize",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"colorize"
					]
				},
				"description": "Colorize an image with all available options"
			},
			"response": []
		},
		{
			"name": "Download Result",
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Authorization",
						"value": "Bearer {{firebase_token}}",
						"type": "text"
					}
				],
				"url": {
					"raw": "{{base_url}}/download/{{result_id}}",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"download",
						"{{result_id}}"
					]
				},
				"description": "Download colorized image by result ID (requires authentication)"
			},
			"response": []
		},
		{
			"name": "Get Result (Public)",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{base_url}}/results/{{filename}}",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"results",
						"{{filename}}"
					]
				},
				"description": "Public endpoint to access colorized images by filename"
			},
			"response": []
		},
		{
			"name": "Colorize Image - Without Auth",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "file",
							"type": "file",
							"src": [],
							"description": "Image file to colorize"
						},
						{
							"key": "positive_prompt",
							"value": "colorize this image with vibrant colors",
							"type": "text"
						}
					]
				},
				"url": {
					"raw": "{{base_url}}/colorize",
					"host": [
						"{{base_url}}"
					],
					"path": [
						"colorize"
					]
				},
				"description": "Colorize image without authentication (only works if DISABLE_AUTH=true)"
			},
			"response": []
		}
	],
	"variable": [
		{
			"key": "base_url",
			"value": "https://YOUR_SPACE_URL",
			"type": "string",
			"description": "Base URL of your Hugging Face Space or local server"
		},
		{
			"key": "firebase_token",
			"value": "YOUR_FIREBASE_ID_TOKEN",
			"type": "string",
			"description": "Firebase authentication token"
		},
		{
			"key": "result_id",
			"value": "",
			"type": "string",
			"description": "Result ID from colorize response"
		},
		{
			"key": "filename",
			"value": "",
			"type": "string",
			"description": "Filename from colorize response (e.g., uuid.png)"
		}
	]
}