Postman_Collection.json

{
	"info": {
		"_postman_id": "pdf-extractor-api",
		"name": "PDF Layout Extractor API",
		"description": "API collection for PDF Layout Extractor on Hugging Face Spaces\n\n⚠️ IMPORTANT: Use '/api/predict' for simple synchronous extraction. Use '/api/upload' for async processing with progress tracking.",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Predict - Extract PDF (Synchronous)",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "file",
							"type": "file",
							"src": [],
							"description": "⚠️ Key must be exactly 'file' (not 'pdf' or 'files')"
						}
					]
				},
				"url": {
					"raw": "https://saifisvibin-volaris-pdf-tool.hf.space/api/predict",
					"protocol": "https",
					"host": [
						"saifisvibin-volaris-pdf-tool",
						"hf",
						"space"
					],
					"path": [
						"api",
						"predict"
					]
				},
				"description": "✅ RECOMMENDED: Simple synchronous endpoint. Upload a PDF file and get extracted text, tables, and figures in JSON format immediately.\n\nRequirements:\n- Method: POST\n- Key: 'file' (exactly, case-sensitive)\n- Type: File\n- Returns: Complete results in one response"
			},
			"response": []
		},
		{
			"name": "Upload - Async Processing (with Progress)",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "files[]",
							"type": "file",
							"src": [],
							"description": "⚠️ Key must be exactly 'files[]' (array format)"
						},
						{
							"key": "extraction_mode",
							"type": "text",
							"value": "images",
							"description": "Optional: 'images', 'markdown', or 'both'"
						}
					]
				},
				"url": {
					"raw": "https://saifisvibin-volaris-pdf-tool.hf.space/api/upload",
					"protocol": "https",
					"host": [
						"saifisvibin-volaris-pdf-tool",
						"hf",
						"space"
					],
					"path": [
						"api",
						"upload"
					]
				},
				"description": "Advanced: Async processing with progress tracking. Returns a task_id, then poll /api/progress/<task_id> for status.\n\nRequirements:\n- Method: POST\n- Key: 'files[]' (array format, supports multiple files)\n- Type: File\n- Returns: task_id for progress tracking"
			},
			"response": []
		},
		{
			"name": "Get Progress",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "https://saifisvibin-volaris-pdf-tool.hf.space/api/progress/:task_id",
					"protocol": "https",
					"host": [
						"saifisvibin-volaris-pdf-tool",
						"hf",
						"space"
					],
					"path": [
						"api",
						"progress",
						":task_id"
					],
					"variable": [
						{
							"key": "task_id",
							"value": "your-task-id-here",
							"description": "Task ID returned from /api/upload"
						}
					]
				},
				"description": "Get progress status for an async upload task. Use the task_id returned from /api/upload."
			},
			"response": []
		},
		{
			"name": "Device Info",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "https://saifisvibin-volaris-pdf-tool.hf.space/api/device-info",
					"protocol": "https",
					"host": [
						"saifisvibin-volaris-pdf-tool",
						"hf",
						"space"
					],
					"path": [
						"api",
						"device-info"
					]
				},
				"description": "Get device information (CPU/GPU availability)"
			},
			"response": []
		}
	]
}