Mathpix OCR API

https://docs.mathpix.com
Admin
Mathpix OCR recognizes printed and handwritten STEM document content including math equations, text,...
Tokens:80,333
Snippets:545
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### API Request Examples

Source: https://docs.mathpix.com/reference/math-commands

Examples of how to send an image to the Mathpix API using various programming languages.

```bash
curl -X POST https://api.mathpix.com/v3/text \
-H 'app_id: APP_ID' \
-H 'app_key: APP_KEY' \
-H 'Content-Type: application/json' \
--data '{"src": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/long_division.jpg"}'
```

```python
import requests
r = requests.post("https://api.mathpix.com/v3/text",
    json={
        "src": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/long_division.jpg"
    },
    headers={
        "app_id": "APP_ID",
        "app_key": "APP_KEY",
        "Content-type": "application/json"
    }
)
print(r.json())
```

```javascript
const response = await fetch("https://api.mathpix.com/v3/text", {
  method: "POST",
  headers: {
    app_id: "APP_ID",
    app_key: "APP_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    src: "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/long_division.jpg",
  }),
});
const result = await response.json();
console.log(result);
```

```go
body := bytes.NewBufferString(`{
    "src": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/long_division.jpg"
}`)
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/text", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
```

```java
HttpClient client = HttpClient.newHttpClient();
String body = """
    {
      "src": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/long_division.jpg"
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mathpix.com/v3/text"))
    .header("app_id", "APP_ID")
    .header("app_key", "APP_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

--------------------------------

### API Response Example

Source: https://docs.mathpix.com/reference/math-commands

Example JSON response from the Mathpix API containing LaTeX output.

```json
{
  "request_id": "4ed529ef-79a9-4032-b414-5a02ee990568",
  "version": "SuperNet-200",
  "is_printed": true,
  "is_handwritten": false,
  "confidence": 1,
  "confidence_rate": 1,
  "latex_styled": "8 \\longdiv { 7 2 0 0 }",
  "text": "\\( 8 \\longdiv { 7 2 0 0 } \\)"
}
```

--------------------------------

### API Request Examples

Source: https://docs.mathpix.com/guides/image-ocr

Implementation examples for calling the Mathpix v3/text endpoint across various programming languages.

```bash
curl -X POST https://api.mathpix.com/v3/text \
-H 'app_id: APP_ID' \
-H 'app_key: APP_KEY' \
-H 'Content-Type: application/json' \
--data '{"src": "https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg", "formats": ["text", "data", "html"], "data_options": {"include_asciimath": true, "include_latex": true}}'
```

```python
import requests, json
r = requests.post("https://api.mathpix.com/v3/text",
    json={
        "src": "https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg",
        "formats": ["text", "data", "html"],
        "data_options": {"include_asciimath": True, "include_latex": True}
    },
    headers={
        "app_id": "APP_ID",
        "app_key": "APP_KEY",
        "Content-type": "application/json"
    }
)
print(json.dumps(r.json(), indent=4, sort_keys=True))
```

```javascript
const response = await fetch("https://api.mathpix.com/v3/text", {
  method: "POST",
  headers: {
    app_id: "APP_ID",
    app_key: "APP_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    src: "https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg",
    formats: ["text", "data", "html"],
    data_options: { include_asciimath: true, include_latex: true },
  }),
});
const result = await response.json();
console.log(JSON.stringify(result, null, 2));
```

```go
body := bytes.NewBufferString(`{
    "src": "https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg",
    "formats": ["text", "data", "html"],
    "data_options": {"include_asciimath": true, "include_latex": true}
}`)
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/text", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
```

```java
HttpClient client = HttpClient.newHttpClient();
String body = """
    {
      "src": "https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg",
      "formats": ["text", "data", "html"],
      "data_options": { "include_asciimath": true, "include_latex": true }
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mathpix.com/v3/text"))
    .header("app_id", "APP_ID")
    .header("app_key", "APP_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

--------------------------------

### Process Strokes API Examples

Source: https://docs.mathpix.com/reference/post-v3-strokes

Examples demonstrating how to send handwriting stroke coordinates to the Mathpix API using various programming languages.

```bash
curl -X POST https://api.mathpix.com/v3/strokes \
-H 'app_id: APP_ID' \
-H 'app_key: APP_KEY' \
-H 'Content-Type: application/json' \
--data '{ "strokes": {"strokes": {  
  "x": [[131,131,130,130,131,133,136,146,151,158,161,162,162,162,162,159,155,147,142,137,136,138,143,160,171,190,197,202,202,202,201,194,189,177,170,158,153,150,148],[231,231,233,235,239,248,252,260,264,273,277,280,282,283],[273,272,271,270,267,262,257,249,243,240,237,235,234,234,233,233],[296,296,297,299,300,301,301,302,303,304,305,306,306,305,304,298,294,286,283,281,281,282,284,284,285,287,290,293,294,299,301,308,309,314,315,316]],  
  "y": [[213,213,212,211,210,208,207,206,206,209,212,217,220,227,230,234,236,238,239,239,239,239,239,239,241,247,252,259,261,264,266,269,270,271,271,271,270,269,268],[231,231,232,235,238,246,249,257,261,267,270,272,273,274],[230,230,230,231,234,240,246,258,268,273,277,281,281,283,283,284],[192,192,191,189,188,187,187,187,188,188,190,193,195,198,200,205,208,213,215,215,215,214,214,214,214,216,218,220,221,223,223,223,223,221,221,220]]  
  }}}'  
```

```python
import requests, json  
strokes_data = {  
    "strokes": {  
        "x": [  
            [131,131,130,130,131,133,136,146,151,158,161,162,162,162,162,159,155,147,142,137,136,138,143,160,171,190,197,202,202,202,201,194,189,177,170,158,153,150,148],  
            [231,231,233,235,239,248,252,260,264,273,277,280,282,283],  
            [273,272,271,270,267,262,257,249,243,240,237,235,234,234,233,233],  
            [296,296,297,299,300,301,301,302,303,304,305,306,306,305,304,298,294,286,283,281,281,282,284,284,285,287,290,293,294,299,301,308,309,314,315,316]  
        ],  
        "y": [  
            [213,213,212,211,210,208,207,206,206,209,212,217,220,227,230,234,236,238,239,239,239,239,239,239,241,247,252,259,261,264,266,269,270,271,271,271,270,269,268],  
            [231,231,232,235,238,246,249,257,261,267,270,272,273,274],  
            [230,230,230,231,234,240,246,258,268,273,277,281,281,283,283,284],  
            [192,192,191,189,188,187,187,187,188,188,190,193,195,198,200,205,208,213,215,215,215,214,214,214,214,216,218,220,221,223,223,223,223,221,221,220]  
        ]  
    }  
}  
r = requests.post("https://api.mathpix.com/v3/strokes",  
    json={"strokes": strokes_data},  
    headers={  
        "app_id": "APP_ID",  
        "app_key": "APP_KEY",  
        "Content-type": "application/json"  
    }  
)  
print(json.dumps(r.json(), indent=4, sort_keys=True))  
```

```javascript
const response = await fetch("https://api.mathpix.com/v3/strokes", {  
  method: "POST",  
  headers: {  
    app_id: "APP_ID",  
    app_key: "APP_KEY",  
    "Content-Type": "application/json",  
  },  
  body: JSON.stringify({  
    strokes: {  
      strokes: {  
        x: [  
          [131,131,130,130,131,133,136,146,151,158,161,162,162,162,162,159,155,147,142,137,136,138,143,160,171,190,197,202,202,202,201,194,189,177,170,158,153,150,148],  
          [231,231,233,235,239,248,252,260,264,273,277,280,282,283],  
          [273,272,271,270,267,262,257,249,243,240,237,235,234,234,233,233],  
          [296,296,297,299,300,301,301,302,303,304,305,306,306,305,304,298,294,286,283,281,281,282,284,284,285,287,290,293,294,299,301,308,309,314,315,316],  
        ],  
        y: [  
          [213,213,212,211,210,208,207,206,206,209,212,217,220,227,230,234,236,238,239,239,239,239,239,239,241,247,252,259,261,264,266,269,270,271,271,271,270,269,268],  
          [231,231,232,235,238,246,249,257,261,267,270,272,273,274],  
          [230,230,230,231,234,240,246,258,268,273,277,281,281,283,283,284],  
          [192,192,191,189,188,187,187,187,188,188,190,193,195,198,200,205,208,213,215,215,215,214,214,214,214,216,218,220,221,223,223,223,223,221,221,220],  
        ],  
      },  
    },  
  }),  
});  
const result = await response.json();  
console.log(JSON.stringify(result, null, 2));  
```

--------------------------------

### Markdown Link Example

Source: https://docs.mathpix.com/reference/post-v3-pdf

Example of a Markdown link syntax used in the output.

```markdown
Visit [our docs](https://mathpix.com/docs) to learn more
```

--------------------------------

### Configure Page Info Inclusion

Source: https://docs.mathpix.com/reference/post-v3-text

Example of including only margin notes in the output.

```json
"include_page_info": ["margin_note"]
```

--------------------------------

### Example errored files response

Source: https://docs.mathpix.com/guides/files-api-migrate-from-scs

JSON structure returned when no files have failed.

```json
{
  "files": [],
  "next_page_token": null
}
```

--------------------------------

### Example Completed Batch Response

Source: https://docs.mathpix.com/guides/batch-processing

This is an example of a completed batch response from the Mathpix API. It includes recognized LaTeX for each processed item.

```json
{
  "keys": ["algebra", "inverted"],
  "results": {
    "algebra": {
      "detection_list": [],
      "detection_map": {
        "contains_chart": 0,
        "contains_diagram": 0,
        "contains_graph": 0,
        "contains_table": 0,
        "is_blank": 0,
        "is_inverted": 0,
        "is_not_math": 0,
        "is_printed": 0
      },
      "latex_simplified": "12 + 5 x - 8 = 12 x - 10",
      "latex_confidence": 0.99640350138238,
      "position": {
        "height": 208,
        "top_left_x": 0,
        "top_left_y": 0,
        "width": 1380
      }
    },
    "inverted": {
      "detection_list": ["is_inverted", "is_printed"],
      "latex_simplified": "x ^ { 2 } + y ^ { 2 } = 9",
      "latex_confidence": 0.99982263230866
    }
  }
}
```

--------------------------------

### Example Response

Source: https://docs.mathpix.com/guides/files-api-quickstart

The JSON response returned after a successful document submission.

```json
{
  "file_id": "b1c9c3a8-55e4-4a09-b7d0-218ba5de4c4d"
}
```

--------------------------------

### Configure conversion formats

Source: https://docs.mathpix.com/reference/supported-formats

Example of a JSON object used to enable specific output formats in the conversion request.

```json
{"docx": true, "tex.zip": true}
```

--------------------------------

### Batch API JavaScript Request Example

Source: https://docs.mathpix.com/reference/post-v3-batch

This JavaScript example uses the fetch API to send a POST request to the batch API for asynchronous image processing.

```javascript
const base = "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/";
const response = await fetch("https://api.mathpix.com/v3/batch", {
  method: "POST",
  headers: {
    app_id: "APP_ID",
    app_key: "APP_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    urls: {
      inverted: base + "inverted.jpg",
      algebra: base + "algebra.jpg",
    },
    formats: ["latex_simplified"],
  }),
});
const { batch_id } = await response.json();
console.log(`Batch ID: ${batch_id}`);

```

--------------------------------

### Numbers as Math Delimiters

Source: https://docs.mathpix.com/reference/post-v3-text

Example of wrapping numbers in math delimiters.

```text
Answer: \( 17 \)
```

--------------------------------

### API Response Example

Source: https://docs.mathpix.com/guides/image-ocr

A sample JSON response containing text, HTML, and data fields as requested.

```json
{
  "request_id": "054135c6-fca6-4a46-8f74-2814fa13dc8e",
  "version": "SuperNet-200",
  "is_printed": false,
  "is_handwritten": true,
  "confidence": 1,
  "confidence_rate": 1,
  "text": "\\( f(x)=\\left\\{\\begin{array}{ll}x^{2} & \\text { if } x<0 \\\\ 2 x & \\text { if } x \\geq 0\\end{array}\\right. \\)",
  "html": "<div><span class=\"math-inline\">...</span></div>",
  "data": [
    {
      "type": "asciimath",
      "value": "f(x)={[x^(2),\" if \"x < 0],[2x,\" if \"x >= 0]:}"
    },
    {
      "type": "latex",
      "value": "f(x)=\\left\\{\\begin{array}{ll}x^{2} & \\text { if } x<0 \\\\ 2 x & \\text { if } x \\geq 0\\end{array}\\right."
    }
  ]
}
```

--------------------------------

### Batch Job Response Example

Source: https://docs.mathpix.com/guides/files-api-quickstart

The expected JSON response structure after successfully submitting a batch job.

```json
{
  "file_count": 2,
  "job_id": "quickstart-batch"
}
```

--------------------------------

### Example response with line_data

Source: https://docs.mathpix.com/guides/image-ocr

A sample JSON response showing the structure of the line_data array, including text and diagram regions.

```json
{
  "auto_rotate_confidence": 0,
  "auto_rotate_degrees": 0,
  "confidence": 0.6602140300674364,
  "confidence_rate": 0.9949494895122919,
  "image_height": 733,
  "image_width": 932,
  "is_handwritten": false,
  "is_printed": true,
  "line_data": [
    {
      "after_hyphen": false,
      "cnt": [[0,77],[0,32],[867,54],[865,98]],
      "confidence": 0.6602140300674364,
      "confidence_rate": 0.9949494895122919,
      "conversion_output": true,
      "id": "1177a9c84cba4101ad53c10053113218",
      "included": true,
      "is_handwritten": false,
      "is_printed": true,
      "text": "Equivalent resistance between points \\( A \\) \\& \\( B \\) in the adjacent circuit is -",
      "type": "text"
    },
    {
      "cnt": [[6,243],[652,243],[652,683],[6,683]],
      "conversion_output": false,
      "error_id": "image_not_supported",
      "id": "0c78ec14187d4193be93a9d30182efba",
      "included": false,
      "is_handwritten": false,
      "is_printed": true,
      "type": "diagram"
    }
  ],
  "request_id": "3c37d6b3-e3fe-4b85-9aeb-0d8d8a104679",
  "text": "Equivalent resistance between points \\( A \\) \\& \\( B \\) in the adjacent circuit is -",
  "version": "SuperNet-200"
}
```

--------------------------------

### Example conversion status response

Source: https://docs.mathpix.com/guides/pdf-processing

A sample JSON response indicating the status of various conversion formats.

```json
{
  "status": "completed",
  "conversion_status": {
    "docx": { "status": "completed" },
    "tex.zip": { "status": "completed" }
  }
}  
```

--------------------------------

### Submit MMD document for conversion

Source: https://docs.mathpix.com/reference/post-v3-converter

Examples of sending a POST request to the converter endpoint using various programming languages.

```json
{
  "mmd": "_full mmd text_",
  "formats": { "docx": true, "tex.zip": true }
}

```

```bash
curl -X POST https://api.mathpix.com/v3/converter \
-H 'app_id: APP_ID' \
-H 'app_key: APP_KEY' \
-H 'Content-Type: application/json' \
--data '{"mmd": "_full mmd text_", "formats": {"docx": true, "tex.zip": true}}'

```

```python
import requests
r = requests.post("https://api.mathpix.com/v3/converter",
    json={
        "mmd": "_full mmd text_",
        "formats": {"docx": True, "tex.zip": True}
    },
    headers={
        "app_id": "APP_ID",
        "app_key": "APP_KEY",
        "Content-type": "application/json"
    }
)
print(r.json())  # {"conversion_id": "..."}

```

```javascript
const response = await fetch("https://api.mathpix.com/v3/converter", {
  method: "POST",
  headers: {
    app_id: "APP_ID",
    app_key: "APP_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    mmd: "_full mmd text_",
    formats: { docx: true, "tex.zip": true },
  }),
});
const { conversion_id } = await response.json();
console.log(`Conversion ID: ${conversion_id}`);

```

```go
body := bytes.NewBufferString(`{
    "mmd": "_full mmd text_",
    "formats": {"docx": true, "tex.zip": true}
}`)
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/converter", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result)) // {"conversion_id": "..."}

```

```java
HttpClient client = HttpClient.newHttpClient();
String body = """
    {
      "mmd": "_full mmd text_",
      "formats": { "docx": true, "tex.zip": true }
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mathpix.com/v3/converter"))
    .header("app_id", "APP_ID")
    .header("app_key", "APP_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

```

--------------------------------

### Submit Batch Request with Go

Source: https://docs.mathpix.com/guides/batch-processing

This Go program demonstrates how to construct and send a batch request to the Mathpix API using the `net/http` package. It sets up the request body, headers, and prints the response.

```go
body := bytes.NewBufferString(`{ 
    "urls": { 
        "inverted": { 
            "url": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/inverted.jpg", 
            "ocr_behavior": "text", 
            "formats": ["text", "html", "data"], 
            "data_options": {"include_asciimath": true} 
        }, 
        "algebra": { 
            "url": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/algebra.jpg", 
            "ocr_behavior": "text", 
            "formats": ["text", "html", "data"], 
            "data_options": {"include_asciimath": true} 
        } 
    } 
}`)
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/batch", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
```

--------------------------------

### Batch API Go Request Example

Source: https://docs.mathpix.com/reference/post-v3-batch

This Go code snippet demonstrates how to make a POST request to the batch API using the http package.

```go
body := bytes.NewBufferString(`{
    "urls": {
        "inverted": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/inverted.jpg",
        "algebra": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/algebra.jpg"
    },
    "formats": ["latex_simplified"]
}`) 
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/batch", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result)) // {"batch_id": 17}

```

--------------------------------

### Batch API Response Example

Source: https://docs.mathpix.com/reference/post-v3-batch

This is an example of a successful response from the batch API, containing a unique batch ID for tracking.

```json
{
  "batch_id": 17
}

```

--------------------------------

### Submit Batch Request with Java

Source: https://docs.mathpix.com/guides/batch-processing

This Java example shows how to make a batch request to the Mathpix API using `HttpClient`. It defines the request body as a string and prints the response body.

```java
HttpClient client = HttpClient.newHttpClient();
String body = """
    {
      "urls": {
        "inverted": {
          "url": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/inverted.jpg",
          "ocr_behavior": "text",
          "formats": ["text", "html", "data"],
          "data_options": { "include_asciimath": true }
        },
        "algebra": {
          "url": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/algebra.jpg",
          "ocr_behavior": "text",
          "formats": ["text", "html", "data"],
          "data_options": { "include_asciimath": true }
        }
      }
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mathpix.com/v3/batch"))
    .header("app_id", "APP_ID")
    .header("app_key", "APP_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

--------------------------------

### Example Batch API Response

Source: https://docs.mathpix.com/guides/batch-processing

This is an example of the response you will receive after submitting a successful batch request to the Mathpix API. It contains a unique batch ID.

```json
{
  "batch_id": 18
}
```

--------------------------------

### Download results using Go

Source: https://docs.mathpix.com/guides/markdown-conversion

Iterate through supported extensions to download and save conversion results using the net/http package.

```go
conversionId := "CONVERSION_ID"  
for _, ext := range []string{"docx", "tex.zip", "html"} {  
    req, _ := http.NewRequest("GET", "https://api.mathpix.com/v3/converter/"+conversionId+"."+ext, nil)  
    req.Header.Set("app_id", "APP_ID")  
    req.Header.Set("app_key", "APP_KEY")  
    resp, _ := http.DefaultClient.Do(req)  
    data, _ := io.ReadAll(resp.Body)  
    resp.Body.Close()  
    os.WriteFile("result."+ext, data, 0644)  
}  
```

--------------------------------

### Query PDF Results with Java

Source: https://docs.mathpix.com/reference/pdf-results

This Java example shows how to query PDF processing results using `HttpClient`. It includes parameters for pagination and date filtering. The `app_key` must be provided in the request headers.

```java
// Example: Query PDF processing results with pagination and date filter  
HttpClient client = HttpClient.newHttpClient();  
HttpRequest request = HttpRequest.newBuilder()  
    .uri(URI.create("https://api.mathpix.com/v3/pdf-results?per_page=100&from_date=2020-06-26T03%3A08%3A22.827Z"))  
    .header("app_key", "APP_KEY")  
    .GET()  
    .build();  
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());  
System.out.println(response.body());  
```

--------------------------------

### SMILES Output Format

Source: https://docs.mathpix.com/reference/post-v3-text

Example of the SMILES tag structure.

```xml
<smiles inchi="..." inchikey="...">...</smiles>
```

--------------------------------

### Query API Usage with Java

Source: https://docs.mathpix.com/reference/ocr-usage

This Java example shows how to query API usage grouped by usage type for a date range using HttpClient. Replace APP_ID and APP_KEY with your actual credentials.

```java
// Example: Query API usage grouped by usage type for a date range  
HttpClient client = HttpClient.newHttpClient();  
HttpRequest request = HttpRequest.newBuilder()  
    .uri(URI.create("https://api.mathpix.com/v3/ocr-usage?from_date=2021-01-01T00%3A00%3A00.000Z&to_date=2021-01-02T00%3A00%3A00.000Z&group_by=usage_type&timespan=month"))  
    .header("app_id", "APP_ID")  
    .header("app_key", "APP_KEY")  
    .GET()  
    .build();  
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());  
System.out.println(response.body());  

```

--------------------------------

### Download results using Python

Source: https://docs.mathpix.com/guides/markdown-conversion

Use the requests library to fetch conversion results and write them to the local filesystem.

```python
import requests  
headers = {"app_id": "APP_ID", "app_key": "APP_KEY"}  
conversion_id = "CONVERSION_ID"  
# Download DOCX  
r = requests.get(f"https://api.mathpix.com/v3/converter/{conversion_id}.docx", headers=headers)  
with open("result.docx", "wb") as f:  
    f.write(r.content)  
# Download LaTeX zip  
r = requests.get(f"https://api.mathpix.com/v3/converter/{conversion_id}.tex.zip", headers=headers)  
with open("result.tex.zip", "wb") as f:  
    f.write(r.content)  
# Download HTML  
r = requests.get(f"https://api.mathpix.com/v3/converter/{conversion_id}.html", headers=headers)  
with open("result.html", "wb") as f:  
    f.write(r.content)  
```

--------------------------------

### Download results using Java

Source: https://docs.mathpix.com/guides/markdown-conversion

Use HttpClient to download conversion results for multiple formats and write them to disk.

```java
HttpClient client = HttpClient.newHttpClient();  
String conversionId = "CONVERSION_ID";  
for (String ext : List.of("docx", "tex.zip", "html")) {  
    HttpRequest request = HttpRequest.newBuilder()  
        .uri(URI.create("https://api.mathpix.com/v3/converter/" + conversionId + "." + ext))  
        .header("app_id", "APP_ID").header("app_key", "APP_KEY").GET().build();  
    HttpResponse<byte[]> response = client.send(request, HttpResponse.BodyHandlers.ofByteArray());  
    Files.write(Path.of("result." + ext), response.body());  
}  
```

--------------------------------

### LaTeX Brace Simplification

Source: https://docs.mathpix.com/reference/post-v3-text

Example of removing unnecessary braces in LaTeX output.

```latex
x^2
```

--------------------------------

### Process Equation Image with JavaScript

Source: https://docs.mathpix.com/reference/post-v3-latex

This JavaScript example demonstrates how to use the fetch API to send an image URL to the v3/latex endpoint. It configures the request method, headers, and JSON body, then logs the response.

```javascript
const response = await fetch("https://api.mathpix.com/v3/latex", {
  method: "POST",
  headers: {
    app_id: "APP_ID",
    app_key: "APP_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    src: "https://cdn.mathpix.com/examples/equation.jpg",
    formats: ["latex_simplified", "text"],
  }),
});
const result = await response.json();
console.log(result);
```

--------------------------------

### Conversion response example

Source: https://docs.mathpix.com/reference/post-v3-converter

The JSON response returned after a successful conversion request.

```json
{
  "conversion_id": "2024_01_15_abc123def456"
}

```

--------------------------------

### GET v3/pdf/{pdf_id}

Source: https://docs.mathpix.com/reference/post-v3-pdf

Check the processing status of a PDF document by its ID.

```APIDOC
## GET v3/pdf/{pdf_id}

### Description
Check the processing status of a PDF. Poll the 'status' field to determine when results are ready, as progress fields like 'percent_done' may reach 100 before output files are fully assembled.

### Method
GET

### Endpoint
https://api.mathpix.com/v3/pdf/{pdf_id}

### Parameters
#### Path Parameters
- **pdf_id** (string) - Required - The PDF tracking ID

### Response
#### Success Response (200)
- **status** (string) - Current processing status (received, loaded, split, completed, error)
- **num_pages** (integer) - Total number of pages in PDF document
- **num_pages_completed** (integer) - Current number of pages processed
- **percent_done** (number) - Percentage of pages OCR-ed
- **app_id** (string) - The app ID that submitted the request
- **group_id** (string) - The group ID associated with the request
- **input_file** (string) - Original filename of the uploaded document
- **version** (string) - Release identifier for the PDF processing pipeline
- **conversion_status** (object) - Status of each requested conversion format
```

--------------------------------

### Download PDF conversion results

Source: https://docs.mathpix.com/reference/post-v3-pdf

Examples for downloading converted files using various programming languages. Ensure the conversion status is completed before attempting to download.

```bash
curl https://api.mathpix.com/v3/pdf/PDF_ID.docx \  
-H 'app_id: APP_ID' \  
-H 'app_key: APP_KEY' \  
-o output.docx  
```

```python
import requests  
r = requests.get("https://api.mathpix.com/v3/pdf/PDF_ID.docx",  
    headers={"app_id": "APP_ID", "app_key": "APP_KEY"}  
)  
with open("output.docx", "wb") as f:  
    f.write(r.content)  
```

```javascript
import { writeFile } from "fs/promises";  
const response = await fetch("https://api.mathpix.com/v3/pdf/PDF_ID.docx", {  
  headers: { app_id: "APP_ID", app_key: "APP_KEY" },  
});  
const buffer = await response.arrayBuffer();  
await writeFile("output.docx", Buffer.from(buffer));  
```

```go
req, _ := http.NewRequest("GET", "https://api.mathpix.com/v3/pdf/PDF_ID.docx", nil)  
req.Header.Set("app_id", "APP_ID")  
req.Header.Set("app_key", "APP_KEY")  
resp, _ := http.DefaultClient.Do(req)  
defer resp.Body.Close()  
out, _ := os.Create("output.docx")  
defer out.Close()  
io.Copy(out, resp.Body)  
```

```java
HttpClient client = HttpClient.newHttpClient();  
HttpRequest request = HttpRequest.newBuilder()  
    .uri(URI.create("https://api.mathpix.com/v3/pdf/PDF_ID.docx"))  
    .header("app_id", "APP_ID")  
    .header("app_key", "APP_KEY")  
    .GET()  
    .build();  
HttpResponse<Path> response = client.send(request,  
    HttpResponse.BodyHandlers.ofFile(Path.of("output.docx")));  
System.out.println("Saved to " + response.body());  
```

--------------------------------

### Process Equation Image with Go

Source: https://docs.mathpix.com/reference/post-v3-latex

This Go code snippet shows how to make a POST request to the v3/latex endpoint using the http package. It constructs the JSON body, sets headers, sends the request, and prints the response body.

```go
body := bytes.NewBufferString(`{
    "src": "https://cdn.mathpix.com/examples/equation.jpg",
    "formats": ["latex_simplified", "text"]
}`)
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/latex", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
```

--------------------------------

### Math Fonts as Math Delimiters

Source: https://docs.mathpix.com/reference/post-v3-text

Example of wrapping math fonts in math delimiters.

```text
Answer: \( 2 \mathrm { ms } \)
```

--------------------------------

### Example API response

Source: https://docs.mathpix.com/reference/post-v3-strokes

The JSON structure returned by the API after processing stroke data.

```json
{
  "request_id": "cea6b8e4-0ab4-550a-c467-ce2eb00430be",
  "text": "\\( 3 x^{2} \\)",
  "latex_styled": "3 x^{2}",
  "confidence": 1,
  "confidence_rate": 1,
  "is_printed": false,
  "is_handwritten": true,
  "image_height": 142,
  "image_width": 199,
  "version": "SuperNet-200"
}
```

--------------------------------

### Request word-by-word data via API

Source: https://docs.mathpix.com/guides/image-ocr

Examples of how to configure the v3/text endpoint to return word-level data across various programming languages.

```json
{
  "src": "https://mathpix.com/examples/text_with_math_0.jpg",
  "include_word_data": true
}
```

```bash
curl -X POST https://api.mathpix.com/v3/text \
-H 'app_id: APP_ID' \
-H 'app_key: APP_KEY' \
-H 'Content-Type: application/json' \
--data '{"src": "https://mathpix.com/examples/text_with_math_0.jpg", "include_word_data": true}'
```

```python
import requests, json
r = requests.post("https://api.mathpix.com/v3/text",
    json={
        "src": "https://mathpix.com/examples/text_with_math_0.jpg",
        "include_word_data": True
    },
    headers={
        "app_id": "APP_ID",
        "app_key": "APP_KEY",
        "Content-type": "application/json"
    }
)
print(json.dumps(r.json(), indent=4, sort_keys=True))
```

```javascript
const response = await fetch("https://api.mathpix.com/v3/text", {
  method: "POST",
  headers: {
    app_id: "APP_ID",
    app_key: "APP_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    src: "https://mathpix.com/examples/text_with_math_0.jpg",
    include_word_data: true,
  }),
});
const result = await response.json();
console.log(JSON.stringify(result, null, 2));
```

```go
body := bytes.NewBufferString(`{
    "src": "https://mathpix.com/examples/text_with_math_0.jpg",
    "include_word_data": true
}`)
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/text", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
```

```java
HttpClient client = HttpClient.newHttpClient();
String body = """
    {
      "src": "https://mathpix.com/examples/text_with_math_0.jpg",
      "include_word_data": true
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mathpix.com/v3/text"))
    .header("app_id", "APP_ID")
    .header("app_key", "APP_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

--------------------------------

### Go HTTP Client Batch Request with Callback

Source: https://docs.mathpix.com/guides/batch-processing

Construct and send a batch processing request in Go using the standard HTTP client, including the callback configuration.

```go
body := bytes.NewBufferString(`{
    "urls": {
        "inverted": "https://raw.githubusercontent.com/Mathpix/api-examples/master/images/inverted.jpg"
    },
    "formats": ["latex_simplified"],
    "callback": {
        "post": "https://your-server.com/webhook",
        "headers": {"Authorization": "Bearer YOUR_TOKEN"}
    }
}`)
req, _ := http.NewRequest("POST", "https://api.mathpix.com/v3/batch", body)
req.Header.Set("app_id", "APP_ID")
req.Header.Set("app_key", "APP_KEY")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
result, _ := io.ReadAll(resp.Body)
fmt.Println(string(result))
```

--------------------------------

### Example JSON response

Source: https://docs.mathpix.com/reference/image-results

The structure of the JSON object returned by the OCR results endpoint.

```json
{
  "ocr_results": [
    {
      "timestamp": "2021-07-02T18:48:46.080Z",
      "endpoint": "/v3/text",
      "request_args": {
        "tags": ["test_tag2", "test_tag3"],
        "formats": ["text"]
      },
      "result": {
        "text": "\\( 12+5 x-8=12 x-10 \\)",
        "confidence": 1,
        "is_printed": false,
        "request_id": "a4301400-f66b-9821-d35c-babea8a26992",
        "is_handwritten": true,
        "confidence_rate": 1,
        "auto_rotate_degrees": 0,
        "auto_rotate_confidence": 0.0027393347044402105,
        "version": "SuperNet-200"
      },
      "detections": {
        "contains_algorithm": false,
        "contains_chemistry": false,
        "contains_diagram": false,
        "is_handwritten": true,
        "is_printed": false,
        "contains_table": false,
        "contains_triangle": false
      },
      "image_id": "a4301400-f66b-9821-d35c-babea8a26992"
    }
  ]
}
```

--------------------------------

### Make Authenticated Request with Java

Source: https://docs.mathpix.com/guides/authentication

This Java example illustrates how to perform an authenticated POST request using HttpClient, setting headers and the request body.

```java
HttpClient client = HttpClient.newHttpClient();
String body = """
    {
      "src": "https://mathpix-ocr-examples.s3.amazonaws.com/cases_hw.jpg"
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mathpix.com/v3/text"))
    .header("app_id", "APP_ID")
    .header("app_key", "APP_KEY")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

--------------------------------

### Example errored files response

Source: https://docs.mathpix.com/guides/files-api-quickstart

The JSON structure returned when querying the errored files endpoint.

```json
{
  "files": [
    {
      "file_id": "f7d3a210-6c4e-49f3-bd5e-8e1c2f4d6b9a",
      "filename": "f7d3a210-6c4e-49f3-bd5e-8e1c2f4d6b9a.pdf",
      "status": "error",
      "custom_id": "manual"
    }
  ],
  "next_page_token": null
}
```

--------------------------------

### API Response Examples

Source: https://docs.mathpix.com/guides/pdf-processing

Sample JSON responses returned by the API during different stages of processing.

```json
{
  "status": "split",
  "num_pages": 12,
  "num_pages_completed": 4,
  "percent_done": 33.33
}
```

```json
{
  "status": "split",
  "num_pages": 12,
  "num_pages_completed": 12,
  "percent_done": 100
}
```

```json
{
  "status": "completed",
  "num_pages": 12,
  "num_pages_completed": 12,
  "percent_done": 100
}
```

--------------------------------

### Example job status response

Source: https://docs.mathpix.com/guides/files-api-migrate-from-scs

JSON structure returned when querying the job status endpoint.

```json
{
  "job_id": "2026-05-contracts",
  "status": "completed",
  "file_count": 2,
  "files_completed": 2,
  "files_errored": 0,
  "created_at": "2026-07-21T19:37:01.227Z",
  "modified_at": "2026-07-21T19:39:20.328Z"
}
```
Tokens:
Raw