Docling Serve API#

The docling-serve-api module defines the core, framework-agnostic Java API used to communicate with a Docling Serve backend. It provides the request/response model and the main DoclingServeApi interface. You can use any implementation of this interface to talk to a running Docling Serve instance.

The base Java version is 17. This module has no other required dependencies, although it is compatible with both Jackson 2.x and 3.x.

If you need a ready-to-use HTTP implementation, see the reference client: - Docling Serve Client: docling-serve-client

When to use this module#

You want a stable, typed Java model for Docling Serve requests/responses without committing to a specific HTTP stack.
You plan to create your own client implementation (e.g., different HTTP lib, reactive runtime) but still rely on the shared API model.
You want to write code that is portable across different client implementations.

Installation#

Add the API dependency to your project.

GradleMaven

dependencies {
  implementation("ai.docling:docling-serve-api:0.4.2")
}

<dependency>
  <groupId>ai.docling</groupId>
  <artifactId>docling-serve-api</artifactId>
  <version>0.4.2</version>
</dependency>

Note: The API module does not perform network I/O by itself. To call a live service, combine it with an implementation such as docling-serve-client.

Quick start#

Below is a minimal example using the reference client to create an implementation of DoclingServeApi, build a conversion request, and retrieve Markdown output. The request/response types all come from docling-serve-api.

import java.net.URI;
import ai.docling.serve.api.DoclingServeApi;
import ai.docling.serve.api.convert.request.ConvertDocumentRequest;
import ai.docling.serve.api.convert.request.options.ConvertDocumentOptions;
import ai.docling.serve.api.convert.request.options.OutputFormat;
import ai.docling.serve.api.convert.request.source.HttpSource;
import ai.docling.serve.api.convert.request.target.InBodyTarget;
import ai.docling.serve.api.convert.response.ConvertDocumentResponse;

DoclingServeApi api = DoclingServeApi.builder()
    .baseUrl("http://localhost:8000") // your Docling Serve URL
    .logRequests() // log HTTP requests
    .logResponses() // log HTTP responses
    .prettyPrint() // pretty-print JSON requests/responses
    .build();

ConvertDocumentRequest request = ConvertDocumentRequest.builder()
    .source(HttpSource.builder().url(URI.create("https://arxiv.org/pdf/2408.09869"))
        .build())
    .options(ConvertDocumentOptions.builder()
        .toFormat(OutputFormat.MARKDOWN) // request Markdown output
        .includeImages(true)
        .build())
    .target(InBodyTarget.builder().build()) // get results in the HTTP response body
    .build();

ConvertDocumentResponse response = api.convertSource(request);
System.out.println(response.getDocument().getMarkdownContent());

Core concepts#

The `DoclingServeApi` interface#

Defined in ai.docling.serve.api.DoclingServeApi, this interface exposes many operations:

Any HTTP or non-HTTP implementation can implement this interface. The reference implementation is provided by the docling-serve-client module.

Extension Points#

The docling-serve-api module uses the Java Service Provider Interface to define an extension point for building/customizing instances of DoclingServeApi. An application (or downstream framework) can create an implementation of ai.docling.serve.api.spi.DoclingServeApiBuilderFactory and register it via the META-INF/services/ai.docling.serve.api.spi.DoclingServeApiBuilderFactory file, or providing an implementation using Java modules.

This is exactly what the docling-serve-client module does to provide its implementation. See module-info.java and DoclingServeClientBuilderFactory.java.

Requests: `ConvertDocumentRequest`#

Create a request via the builder:

ConvertDocumentRequest request = ConvertDocumentRequest.builder()
    .source(/* one of the supported sources */)
    .options(/* conversion options */)
    .target(/* optional delivery target */)
    .build();

Supported sources (ai.docling.serve.api.convert.request.source): - HttpSource — fetch content from a URL (optional custom headers) - FileSource — embed content as Base64 with a filename

Targets (ai.docling.serve.api.convert.request.target): - InBodyTarget — receive results directly in the API response body (default use case) - PutTarget — the service uploads converted content via HTTP PUT to a specified URI - ZipTarget — receive a zipped result

Options (ai.docling.serve.api.convert.request.options.ConvertDocumentOptions) let you control: - Input/output formats (e.g., fromFormats, toFormats) - OCR (e.g., doOcr, forceOcr, ocrEngine, ocrLang) - PDF processing (e.g., pdfBackend) - Tables (e.g., tableMode, tableCellMatching) - Pipelines and page ranges (e.g., pipeline, pageRange) - Timeouts and error behavior (e.g., documentTimeout, abortOnError) - Enrichments (code/formula/picture), image handling, scaling, page break placeholder - VLM pipeline hints

Explore the options package for the full list of knobs you can turn.

Responses: `ConvertDocumentResponse` and `DocumentResponse`#

ConvertDocumentResponse contains the converted document (if any), errors, processing status, total processing_time, and detailed timings map.
DocumentResponse holds the actual content fields you requested, such as md_content (Markdown), html_content, text_content, and a json_content map. It also includes the filename and doctags_content when relevant.

Health checks#

You can ping the service to check readiness and basic status:

import ai.docling.serve.api.health.HealthCheckResponse;

HealthCheckResponse health = api.health();
System.out.println("Service status: " + health.getStatus());

Error handling#

Conversion may succeed partially (e.g., some pages) while returning warnings or errors. Always inspect ConvertDocumentResponse#getErrors() and consider status:

ConvertDocumentResponse response = api.convertSource(request);

if (response.getErrors() != null && !response.getErrors().isEmpty()) {
  response.getErrors().forEach(err ->
      System.err.println("Component: " + err.getComponentType() + 
          ", Module: " + err.getModuleName() + 
          ", Message: " + err.getErrorMessage()));
}

if (response.getDocument() != null && response.getDocument().getMarkdownContent() != null) {
  // Use the output
}

The exact transport-level exceptions (e.g., timeouts, connectivity) depend on the client implementation you use. The reference client throws standard Java exceptions for HTTP and I/O failures.

Validation errors#

In the case of a request validation error (i.e. docling-serve throws a 422 error), the docling-java API will throw an ai.docling.serve.api.validation.ValidationException which can be caught and inspected.

Logging and builders#

DoclingServeApi exposes a toBuilder() method so implementations can be duplicated and tweaked. Most client builders, including the reference client, also expose logRequests() and logResponses() for simple diagnostics:

DoclingServeApi newApi = api.toBuilder()
    .logRequests()
    .logResponses()
    .build();

Version compatibility#

The API is tested against all published versions of Docling Serve each week. Below are the latest run results:

Results for ghcr.io/docling-project/docling-serve as of 2025-12-29T04:37:33.543934569Z#

Here are the results:

Tag	Result	Details
v1.9.0	✅ SUCCESS	Click for run details
v1.8.0	✅ SUCCESS	Click for run details
v1.7.2	✅ SUCCESS	Click for run details
v1.7.1	✅ SUCCESS	Click for run details
v1.7.0	✅ SUCCESS	Click for run details
v1.6.0	✅ SUCCESS	Click for run details
v1.5.1	✅ SUCCESS	Click for run details
v1.5.0	✅ SUCCESS	Click for run details
v1.4.1	✅ SUCCESS	Click for run details
v1.4.0	✅ SUCCESS	Click for run details
v1.3.1	✅ SUCCESS	Click for run details
v1.3.0	✅ SUCCESS	Click for run details
v1.2.2	✅ SUCCESS	Click for run details
v1.2.1	✅ SUCCESS	Click for run details
v1.2.0	✅ SUCCESS	Click for run details
v1.1.0	✅ SUCCESS	Click for run details
v1.0.1	✅ SUCCESS	Click for run details
v1.0.0	✅ SUCCESS	Click for run details

Details#

ghcr.io/docling-project/docling-serve:v1.9.0#

Click to expand

###### Message

Click to collapse

Tag v1.9.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
[INFO] 2025-12-29 04:37:22,755 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:37:22,757 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/det/ch_PP-OCRv4_det_infer.onnx
[INFO] 2025-12-29 04:37:22,826 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:37:22,826 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/cls/ch_ppocr_mobile_v2.0_cls_infer.onnx
[INFO] 2025-12-29 04:37:22,862 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:37:22,862 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/rec/ch_PP-OCRv4_rec_infer.onnx
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:44884 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:44890 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:44890 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.8.0#

Click to expand

###### Message

Click to collapse

Tag v1.8.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
[INFO] 2025-12-29 04:36:11,621 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:36:11,624 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/det/ch_PP-OCRv4_det_infer.onnx
[INFO] 2025-12-29 04:36:11,750 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:36:11,750 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/cls/ch_ppocr_mobile_v2.0_cls_infer.onnx
[INFO] 2025-12-29 04:36:11,811 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:36:11,811 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/rec/ch_PP-OCRv4_rec_infer.onnx
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:54478 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:54480 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:54480 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.7.2#

Click to expand

###### Message

Click to collapse

Tag v1.7.2 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
[INFO] 2025-12-29 04:34:13,115 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:34:13,118 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/det/ch_PP-OCRv4_det_infer.onnx
[INFO] 2025-12-29 04:34:13,214 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:34:13,214 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/cls/ch_ppocr_mobile_v2.0_cls_infer.onnx
[INFO] 2025-12-29 04:34:13,275 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:34:13,275 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/rec/ch_PP-OCRv4_rec_infer.onnx
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:37880 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:37892 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:37892 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.7.1#

Click to expand

###### Message

Click to collapse

Tag v1.7.1 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
[INFO] 2025-12-29 04:32:36,526 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:32:36,531 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/det/ch_PP-OCRv4_det_infer.onnx
[INFO] 2025-12-29 04:32:36,661 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:32:36,661 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/cls/ch_ppocr_mobile_v2.0_cls_infer.onnx
[INFO] 2025-12-29 04:32:36,723 [RapidOCR] base.py:22: Using engine_name: onnxruntime
[INFO] 2025-12-29 04:32:36,723 [RapidOCR] main.py:53: Using /opt/app-root/src/.cache/docling/models/RapidOcr/onnx/PP-OCRv4/rec/ch_PP-OCRv4_rec_infer.onnx
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:59182 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:59184 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:59184 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.7.0#

Click to expand

###### Message

Click to collapse

Tag v1.7.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:45172 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:45182 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:45182 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.6.0#

Click to expand

###### Message

Click to collapse

Tag v1.6.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:55500 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:55502 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:55502 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.5.1#

Click to expand

###### Message

Click to collapse

Tag v1.5.1 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:54714 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:54716 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:54716 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.5.0#

Click to expand

###### Message

Click to collapse

Tag v1.5.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:40416 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:40420 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:40420 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.4.1#

Click to expand

###### Message

Click to collapse

Tag v1.4.1 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:51754 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:51764 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:51764 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.4.0#

Click to expand

###### Message

Click to collapse

Tag v1.4.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:47300 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:47308 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:47308 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.3.1#

Click to expand

###### Message

Click to collapse

Tag v1.3.1 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:59856 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:59870 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:59870 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.3.0#

Click to expand

###### Message

Click to collapse

Tag v1.3.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:43758 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:43766 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:43766 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.2.2#

Click to expand

###### Message

Click to collapse

Tag v1.2.2 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:44474 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:44484 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:44484 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.2.1#

Click to expand

###### Message

Click to collapse

Tag v1.2.1 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:44932 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:44934 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:44934 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.2.0#

Click to expand

###### Message

Click to collapse

Tag v1.2.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:56908 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:56912 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:56912 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.1.0#

Click to expand

###### Message

Click to collapse

Tag v1.1.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:37986 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:37988 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:37988 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.0.1#

Click to expand

###### Message

Click to collapse

Tag v1.0.1 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:42290 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:42302 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:42302 - "POST /v1/convert/source HTTP/1.1" 200 OK

ghcr.io/docling-project/docling-serve:v1.0.0#

Click to expand

###### Message

Click to collapse

Tag v1.0.0 is ok

###### Docling server logs

click to expand

Starting production server 🚀

Server started at http://0.0.0.0:5001
Documentation at http://0.0.0.0:5001/docs
Scalar docs at http://0.0.0.0:5001/scalar

Logs:
INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:5001 (Press CTRL+C to quit)
INFO:     172.17.0.1:39954 - "GET /health HTTP/1.1" 200 OK
INFO:     172.17.0.1:39960 - "GET /health HTTP/1.1" 200 OK
WARNING:docling_core.types.doc.document:Parameter `strict_text` has been deprecated and will be ignored.
INFO:     172.17.0.1:39960 - "POST /v1/convert/source HTTP/1.1" 200 OK

Docling Serve API#

When to use this module#

Installation#

Quick start#

Core concepts#

The DoclingServeApi interface#

Extension Points#

Requests: ConvertDocumentRequest#

Responses: ConvertDocumentResponse and DocumentResponse#

Health checks#

Error handling#

Validation errors#

Logging and builders#

Version compatibility#

Results for ghcr.io/docling-project/docling-serve as of 2025-12-29T04:37:33.543934569Z#

Details#

ghcr.io/docling-project/docling-serve:v1.9.0#

ghcr.io/docling-project/docling-serve:v1.8.0#

ghcr.io/docling-project/docling-serve:v1.7.2#

ghcr.io/docling-project/docling-serve:v1.7.1#

ghcr.io/docling-project/docling-serve:v1.7.0#

ghcr.io/docling-project/docling-serve:v1.6.0#

ghcr.io/docling-project/docling-serve:v1.5.1#

ghcr.io/docling-project/docling-serve:v1.5.0#

ghcr.io/docling-project/docling-serve:v1.4.1#

ghcr.io/docling-project/docling-serve:v1.4.0#

ghcr.io/docling-project/docling-serve:v1.3.1#

ghcr.io/docling-project/docling-serve:v1.3.0#

ghcr.io/docling-project/docling-serve:v1.2.2#

ghcr.io/docling-project/docling-serve:v1.2.1#

ghcr.io/docling-project/docling-serve:v1.2.0#

ghcr.io/docling-project/docling-serve:v1.1.0#

ghcr.io/docling-project/docling-serve:v1.0.1#

ghcr.io/docling-project/docling-serve:v1.0.0#

The `DoclingServeApi` interface#

Requests: `ConvertDocumentRequest`#

Responses: `ConvertDocumentResponse` and `DocumentResponse`#