PaddleOCR official API Overview

The PaddleOCR official API SDKs are client libraries for the PaddleOCR official API. They submit local files or file URLs to hosted PaddleOCR services, poll asynchronous jobs, and parse typed results. They do not run local PaddleOCR inference or load local models.

The current clients include Python, TypeScript, Go, and the paddleocr api command in the PaddleOCR CLI.

Authentication

First obtain an access token from the AI Studio Access Token page.

All SDKs and the CLI read PADDLEOCR_ACCESS_TOKEN by default:

export PADDLEOCR_ACCESS_TOKEN="your-access-token"

You can also pass the token explicitly when constructing a client or invoking the CLI. Missing or invalid credentials are reported through typed authentication errors.

Documentation Entry Points

• Python SDK: best for projects already using the paddleocr Python package; provides sync PaddleOCRClient and async AsyncPaddleOCRClient.
• TypeScript SDK: best for Node.js 18+ server-side projects.
• Go SDK: best for statically typed services that need context cancellation and binary deployment.
• CLI: best for scripts, debugging, and quick no-code validation.

Comments