{"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/cloud:aliyun-ocr/get-async-job-result":{"post":{"operationId":"cloud_aliyun_ocr_get_async_job_result","summary":"This topic describes the syntax and examples of the GetAsyncJobResult operation for querying asynchronous…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"JobId":{"type":"string","description":"The RequestId returned by the asynchronous operation. You can use this ID to query the actual result of the asynchronous operation"}}}}}},"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/cloud:aliyun-ocr/recognize-bank-card":{"post":{"operationId":"cloud_aliyun_ocr_recognize_bank_card","summary":"Describes the syntax and examples of the RecognizeBankCard operation","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other…"}}}}}},"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/cloud:aliyun-ocr/recognize-business-license":{"post":{"operationId":"cloud_aliyun_ocr_recognize_business_license","summary":"Describes the syntax and examples for the RecognizeBusinessLicense operation in the OCR category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other…"}}}}}},"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/cloud:aliyun-ocr/recognize-character":{"post":{"operationId":"cloud_aliyun_ocr_recognize_character","summary":"Describes the syntax and examples of the RecognizeCharacter operation in the OCR category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL","MinHeight","OutputProbability"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other than China (Shanghai),…"},"MinHeight":{"type":"integer","description":"The minimum height of the text in the image, in pixels"},"OutputProbability":{"type":"string","description":"Specifies whether to output the probability of the text box. Valid values: true: outputs the probability of the text box. false: does not…"}}}}}},"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/cloud:aliyun-ocr/recognize-driver-license":{"post":{"operationId":"cloud_aliyun_ocr_recognize_driver_license","summary":"Recognizes the text on a driver's license","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS…"},"Side":{"type":"string","enum":["face","back"],"description":"The page of the driver's license in the uploaded photo. face: Front page. back: Back page"}}}}}},"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/cloud:aliyun-ocr/recognize-driving-license":{"post":{"operationId":"cloud_aliyun_ocr_recognize_driving_license","summary":"Recognizes vehicle licenses and describes the syntax and examples for the RecognizeDrivingLicense operation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The image URL. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see…"},"Side":{"type":"string","enum":["face","back"],"description":"The page of the vehicle license in the uploaded photo. Valid values: face: Front page. back: Back page"}}}}}},"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/cloud:aliyun-ocr/recognize-identity-card":{"post":{"operationId":"cloud_aliyun_ocr_recognize_identity_card","summary":"Describes the syntax and examples for the RecognizeIdentityCard operation in the optical character…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your local machine or…"},"Side":{"type":"string","enum":["face","back"],"description":"The side of the ID card. face: The side with the portrait. back: The side with the national emblem"}}}}}},"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/cloud:aliyun-ocr/recognize-license-plate":{"post":{"operationId":"cloud_aliyun_ocr_recognize_license_plate","summary":"Describes the syntax and examples of the RecognizeLicensePlate operation in the OCR category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The license plate recognition feature currently supports the China (Shanghai) and China (Shenzhen) regions. If you selected the China…"}}}}}},"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/cloud:aliyun-ocr/recognize-pdf":{"post":{"operationId":"cloud_aliyun_ocr_recognize_pdf","summary":"Describes the syntax and examples of the RecognizePdf operation in the optical character recognition (OCR)…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"FileURL":{"type":"string","description":"The URL of the file. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other…"}}}}}},"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/cloud:aliyun-ocr/recognize-qr-code":{"post":{"operationId":"cloud_aliyun_ocr_recognize_qr_code","summary":"Recognizes QR codes in images","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Tasks"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"Tasks":{"type":"string","description":"1 (JSON-encoded)"}}}}}},"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/cloud:aliyun-ocr/recognize-quota-invoice":{"post":{"operationId":"cloud_aliyun_ocr_recognize_quota_invoice","summary":"Describes the syntax and examples of the RecognizeQuotaInvoice operation in the OCR category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your local machine or…"}}}}}},"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/cloud:aliyun-ocr/recognize-table":{"post":{"operationId":"cloud_aliyun_ocr_recognize_table","summary":"Recognizes table content in images","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL","OutputFormat","UseFinanceModel","AssureDirection","HasLine","SkipDetection"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The image URL. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your local machine or in an…"},"OutputFormat":{"type":"string","enum":["html","json","xlsx"],"description":"The output format. Set the value to json. The html and xlsx formats are deprecated. If you set this parameter to html or xlsx, the output…"},"UseFinanceModel":{"type":"string","description":"Specifies whether to use the financial statement model. Valid values: true: Use the financial statement model. false: Do not use the…"},"AssureDirection":{"type":"string","description":"Specifies whether the image orientation is upright. Valid values: true: The image is upright. false: The image is inverted"},"HasLine":{"type":"string","description":"Specifies whether the table has no lines. Valid values: true: The table has no lines, or has only horizontal lines without vertical lines.…"},"SkipDetection":{"type":"string","description":"Specifies whether to skip detection. Valid values: true: Skip detection. false: Do not skip detection"}}}}}},"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/cloud:aliyun-ocr/recognize-taxi-invoice":{"post":{"operationId":"cloud_aliyun_ocr_recognize_taxi_invoice","summary":"Describes the syntax and examples of the RecognizeTaxiInvoice operation in the optical character recognition…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored locally or in an OSS…"}}}}}},"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/cloud:aliyun-ocr/recognize-ticket-invoice":{"post":{"operationId":"cloud_aliyun_ocr_recognize_ticket_invoice","summary":"Describes the syntax and examples of the RecognizeTicketInvoice operation in the optical character…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other…"}}}}}},"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/cloud:aliyun-ocr/recognize-train-ticket":{"post":{"operationId":"cloud_aliyun_ocr_recognize_train_ticket","summary":"Describes the syntax and examples of the RecognizeTrainTicket operation in the optical character recognition…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other…"}}}}}},"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/cloud:aliyun-ocr/recognize-vatinvoice":{"post":{"operationId":"cloud_aliyun_ocr_recognize_vatinvoice","summary":"Recognizes key fields in value-added tax (VAT) invoices","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileURL","FileType"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"FileURL":{"type":"string","description":"The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see…"},"FileType":{"type":"string","enum":["jpg"],"description":"The format of the input image. Set this parameter to `jpg`"}}}}}},"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/cloud:aliyun-ocr/recognize-vincode":{"post":{"operationId":"cloud_aliyun_ocr_recognize_vincode","summary":"This topic describes the syntax and examples of the RecognizeVINCode operation in the OCR category","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImageURL"],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"},"ImageURL":{"type":"string","description":"The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other…"}}}}}},"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/cloud:aliyun-ocr/version":{"post":{"operationId":"cloud_aliyun_ocr_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ocr.cn-shanghai.aliyuncs.com"],"default":"https://ocr.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://ocr.cn-shanghai.aliyuncs.com"}}}}}},"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"}}}}}}}