{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ai:nanonets/image-classification-model-create-new-model":{"post":{"operationId":"ai_nanonets_image_classification_model_create_new_model","summary":"Create New Model","description":"POST /ImageCategorization/Model","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-predict-prediction-file-by-page-id":{"get":{"operationId":"ai_nanonets_ocr_predict_prediction_file_by_page_id","summary":"Get Prediction File By Page ID","description":"GET /Inferences/Model/{model_id}/ImageLevelInferences/{id}","tags":["ai"],"parameters":[{"name":"model_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","required":true,"description":"The ID of the page that was received from the async prediction endpoint","schema":{"type":"string","description":"The ID of the page that was received from the async prediction endpoint"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-predict-all-prediction-files":{"get":{"operationId":"ai_nanonets_ocr_predict_all_prediction_files","summary":"Get All Prediction Files","description":"GET /Inferences/Model/{model_id}/ImageLevelInferences?start_day_interval={start_day}&current_batch_day={end_day}","tags":["ai"],"parameters":[{"name":"model_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_day_interval","in":"query","required":true,"description":"The number of days since 1st Jan 1970 GMT which represents the start of the period","schema":{"type":"integer","description":"The number of days since 1st Jan 1970 GMT which represents the start of the period"}},{"name":"current_batch_day","in":"query","required":true,"description":"The number of days since 1st Jan 1970 GMT which represents the end of the period","schema":{"type":"integer","description":"The number of days since 1st Jan 1970 GMT which represents the end of the period"}},{"name":"start_day","in":"query","required":true,"description":"Path parameter {start_day}","schema":{"type":"string","description":"Path parameter {start_day}"}},{"name":"end_day","in":"query","required":true,"description":"Path parameter {end_day}","schema":{"type":"string","description":"Path parameter {end_day}"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-predict-get-file-prediction-by-file-id":{"get":{"operationId":"ai_nanonets_ocr_predict_get_file_prediction_by_file_id","summary":"Get Prediction File By File ID","description":"GET /Inferences/Model/{model_id}/InferenceRequestFiles/GetPredictions/{request_file_id}","tags":["ai"],"parameters":[{"name":"model_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"request_file_id","in":"query","required":true,"description":"The ID of the file that was received from the async prediction endpoint","schema":{"type":"string","description":"The ID of the file that was received from the async prediction endpoint"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:nanonets/get-full-text-file-content":{"post":{"operationId":"ai_nanonets_get_full_text_file_content","summary":"Get Full Text","description":"POST /OCR/FullText","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-model-get-model-by-id":{"get":{"operationId":"ai_nanonets_ocr_model_get_model_by_id","summary":"Get Model by Id","description":"GET /OCR/Model/{model_id}","tags":["ai"],"parameters":[{"name":"model_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-predict-image-file-async-prediction":{"post":{"operationId":"ai_nanonets_ocr_predict_image_file_async_prediction","summary":"Async Prediction for image file","description":"POST /OCR/Model/{model_id}/LabelFile/?async=true","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model_id","async","body"],"properties":{"model_id":{"type":"string"},"async":{"type":"string","description":"This parameter specifies whether you'd like to upload the file for processing and then query the results with a unique id at a later point…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-predict-image-url-async":{"post":{"operationId":"ai_nanonets_ocr_predict_image_url_async","summary":"Async Prediction for image url","description":"POST /OCR/Model/{model_id}/LabelUrls/?async=true","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model_id","async","body"],"properties":{"model_id":{"type":"string"},"async":{"type":"boolean","description":"This parameter specifies whether you'd like to upload the file for processing and then query the results with a unique id at a later point…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/image-classification-model-predict-file-prediction":{"post":{"operationId":"ai_nanonets_image_classification_model_predict_file_prediction","summary":"Prediction for image File","description":"POST /ImageCategorization/LabelFile","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/image-classification-model-predict-image-url-prediction":{"post":{"operationId":"ai_nanonets_image_classification_model_predict_image_url_prediction","summary":"Prediction for image URLs","description":"POST /ImageCategorization/LabelUrls","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/image-classification-model-get-all-models":{"get":{"operationId":"ai_nanonets_image_classification_model_get_all_models","summary":"Get All Models","description":"GET /ImageCategorization/Models","tags":["ai"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ai:nanonets/image-classification-model-train-new-model-training":{"post":{"operationId":"ai_nanonets_image_classification_model_train_new_model_training","summary":"Train Model","description":"POST /ImageCategorization/Train","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/image-classification-model-upload-training-images-file":{"post":{"operationId":"ai_nanonets_image_classification_model_upload_training_images_file","summary":"Upload training images by File","description":"POST /ImageCategorization/UploadFile","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/image-classification-model-upload-by-urls":{"post":{"operationId":"ai_nanonets_image_classification_model_upload_by_urls","summary":"Upload training images by Url","description":"POST /ImageCategorization/UploadUrls","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-model-create-new-model":{"post":{"operationId":"ai_nanonets_ocr_model_create_new_model","summary":"Create New Model","description":"POST /OCR/Model","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-predict-image-file":{"post":{"operationId":"ai_nanonets_ocr_predict_image_file","summary":"Prediction for image file","description":"POST /OCR/Model/{model_id}/LabelFile","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model_id","l","body"],"properties":{"model_id":{"type":"string"},"l":{"type":"string","description":"language hints eg: en, vi (not specifying generally gives best results)"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-predict-image-urls-post":{"post":{"operationId":"ai_nanonets_ocr_predict_image_urls_post","summary":"Prediction for image url","description":"POST /OCR/Model/{model_id}/LabelUrls","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model_id","l","body"],"properties":{"model_id":{"type":"string"},"l":{"type":"string","description":"language hints eg: en, vi (not specifying generally gives best results)"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-train-model":{"post":{"operationId":"ai_nanonets_ocr_train_model","summary":"Train Model","description":"POST /OCR/Model/{model_id}/Train","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model_id"],"properties":{"model_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-upload-training-images-file":{"post":{"operationId":"ai_nanonets_ocr_upload_training_images_file","summary":"Upload training images by File","description":"POST /OCR/Model/{model_id}/UploadFile","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model_id","body"],"properties":{"model_id":{"type":"string"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ai:nanonets/ocr-upload-training-images-by-url":{"post":{"operationId":"ai_nanonets_ocr_upload_training_images_by_url","summary":"Upload training images by Url","description":"POST /OCR/Model/{model_id}/UploadUrls","tags":["ai"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model_id","body"],"properties":{"model_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}