Reconstruct charts from a saved extraction or split

curl --request POST \
  --url https://api.runpulse.com/charts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "split_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_range": "<string>",
  "charts_config": {
    "data_points": 20,
    "agentic_zoom": false,
    "export_formats": [
      "excel"
    ]
  },
  "async": false
}
'

import requests

url = "https://api.runpulse.com/charts"

payload = {
    "extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "split_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "page_range": "<string>",
    "charts_config": {
        "data_points": 20,
        "agentic_zoom": False,
        "export_formats": ["excel"]
    },
    "async": False
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    extraction_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    split_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    page_range: '<string>',
    charts_config: {data_points: 20, agentic_zoom: false, export_formats: ['excel']},
    async: false
  })
};

fetch('https://api.runpulse.com/charts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpulse.com/charts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'extraction_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'split_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'page_range' => '<string>',
    'charts_config' => [
        'data_points' => 20,
        'agentic_zoom' => false,
        'export_formats' => [
                'excel'
        ]
    ],
    'async' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpulse.com/charts"

	payload := strings.NewReader("{\n  \"extraction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"split_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_range\": \"<string>\",\n  \"charts_config\": {\n    \"data_points\": 20,\n    \"agentic_zoom\": false,\n    \"export_formats\": [\n      \"excel\"\n    ]\n  },\n  \"async\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.runpulse.com/charts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"extraction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"split_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_range\": \"<string>\",\n  \"charts_config\": {\n    \"data_points\": 20,\n    \"agentic_zoom\": false,\n    \"export_formats\": [\n      \"excel\"\n    ]\n  },\n  \"async\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.runpulse.com/charts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"extraction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"split_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_range\": \"<string>\",\n  \"charts_config\": {\n    \"data_points\": 20,\n    \"agentic_zoom\": false,\n    \"export_formats\": [\n      \"excel\"\n    ]\n  },\n  \"async\": false\n}"

response = http.request(request)
puts response.read_body

{
  "charts_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "count": 1,
  "exports": [
    {
      "filename": "<string>",
      "url": "<string>",
      "chart_id": "<string>"
    }
  ],
  "excel_url": "<string>",
  "extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "split_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_range": "<string>",
  "charts": [
    {
      "id": "<string>",
      "page_number": 2,
      "bounding_box": [
        {
          "x": 0.5,
          "y": 0.5
        }
      ],
      "title": "<string>",
      "x_axis": {
        "title": "<string>"
      },
      "y_axis": {
        "title": "<string>"
      },
      "series": [
        {
          "name": "<string>",
          "color": "<string>",
          "data": [
            [
              123
            ]
          ]
        }
      ],
      "confidence": 0.5,
      "warnings": [
        "<string>"
      ]
    }
  ],
  "results": {},
  "export_warnings": [
    "<string>"
  ],
  "credits_used": 123
}

{
  "job_id": "<string>",
  "message": "<string>",
  "queuedAt": "2023-11-07T05:31:56Z",
  "credits_used": 123
}

Pipeline Steps

Charts

Detect and digitize charts from a completed extraction or split. The response includes normalized source bounding boxes, reconstructed data series, axis metadata, confidence scores, and optional export files.

Provide exactly one of extraction_id or split_id. When using an extraction, page_range can limit processing to selected 1-indexed pages. Split requests inherit their pages from the split and therefore cannot also provide page_range.

Export URLs require authentication and are consumed after one successful download. Request every required format up front and store the downloaded bytes rather than the URL.

Set async: true to return immediately with a job_id. Poll GET /job/{job_id} for the completed ChartsResponse.

Requires the charts_endpoint feature flag to be enabled for your organization. Billed at 1 credit per reconstructed chart.

POST

charts

Reconstruct charts from a saved extraction or split

curl --request POST \
  --url https://api.runpulse.com/charts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "split_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_range": "<string>",
  "charts_config": {
    "data_points": 20,
    "agentic_zoom": false,
    "export_formats": [
      "excel"
    ]
  },
  "async": false
}
'

import requests

url = "https://api.runpulse.com/charts"

payload = {
    "extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "split_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "page_range": "<string>",
    "charts_config": {
        "data_points": 20,
        "agentic_zoom": False,
        "export_formats": ["excel"]
    },
    "async": False
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    extraction_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    split_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    page_range: '<string>',
    charts_config: {data_points: 20, agentic_zoom: false, export_formats: ['excel']},
    async: false
  })
};

fetch('https://api.runpulse.com/charts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runpulse.com/charts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'extraction_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'split_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'page_range' => '<string>',
    'charts_config' => [
        'data_points' => 20,
        'agentic_zoom' => false,
        'export_formats' => [
                'excel'
        ]
    ],
    'async' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runpulse.com/charts"

	payload := strings.NewReader("{\n  \"extraction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"split_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_range\": \"<string>\",\n  \"charts_config\": {\n    \"data_points\": 20,\n    \"agentic_zoom\": false,\n    \"export_formats\": [\n      \"excel\"\n    ]\n  },\n  \"async\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.runpulse.com/charts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"extraction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"split_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_range\": \"<string>\",\n  \"charts_config\": {\n    \"data_points\": 20,\n    \"agentic_zoom\": false,\n    \"export_formats\": [\n      \"excel\"\n    ]\n  },\n  \"async\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.runpulse.com/charts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"extraction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"split_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"page_range\": \"<string>\",\n  \"charts_config\": {\n    \"data_points\": 20,\n    \"agentic_zoom\": false,\n    \"export_formats\": [\n      \"excel\"\n    ]\n  },\n  \"async\": false\n}"

response = http.request(request)
puts response.read_body

{
  "charts_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "count": 1,
  "exports": [
    {
      "filename": "<string>",
      "url": "<string>",
      "chart_id": "<string>"
    }
  ],
  "excel_url": "<string>",
  "extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "split_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_range": "<string>",
  "charts": [
    {
      "id": "<string>",
      "page_number": 2,
      "bounding_box": [
        {
          "x": 0.5,
          "y": 0.5
        }
      ],
      "title": "<string>",
      "x_axis": {
        "title": "<string>"
      },
      "y_axis": {
        "title": "<string>"
      },
      "series": [
        {
          "name": "<string>",
          "color": "<string>",
          "data": [
            [
              123
            ]
          ]
        }
      ],
      "confidence": 0.5,
      "warnings": [
        "<string>"
      ]
    }
  ],
  "results": {},
  "export_warnings": [
    "<string>"
  ],
  "credits_used": 123
}

{
  "job_id": "<string>",
  "message": "<string>",
  "queuedAt": "2023-11-07T05:31:56Z",
  "credits_used": 123
}

Overview

Pipeline Step 2 (terminal) — Charts reuses a completed extraction or split. It does not accept a document upload directly.

Reconstruct line, scatter, bar, pie, donut, and well-log charts as auditable data. Each result contains the source page and normalized bounding box, reconstructed series, axis metadata, a confidence score, and warnings. You can also request Excel, CSV, or LAS exports. The endpoint can run synchronously or asynchronously and is billed at 1 credit per reconstructed chart. It must be enabled for your organization.

Request

Provide exactly one source:

Field	Type	Required	Description
`extraction_id`	UUID	One source	A completed, saved extraction.
`split_id`	UUID	One source	A completed split. Results are grouped by split topic.
`page_range`	string	No	Extraction mode only. 1-indexed pages such as `"1-3,5"`. Split mode inherits its pages.
`charts_config`	object	No	Reconstruction and export options.
`async`	boolean	No	Defaults to `false`. With `true`, returns a `job_id` immediately for polling.

`charts_config`

Field	Type	Default	Description
`data_points`	integer, 2–500	`20`	Requested samples per continuous series.
`agentic_zoom`	boolean	`false`	Inspect difficult regions at higher resolution. This can improve recovery at additional latency.
`export_formats`	array	`["excel"]`	Any of `excel`, `csv`, and `las`. Use `[]` to disable exports. LAS applies only to compatible well logs.

Options belong inside charts_config. Top-level data_points, agentic_zoom, export_formats, generate_las, and layout_confidence are rejected.

curl -X POST https://api.runpulse.com/charts \
  -H "x-api-key: $PULSE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "extraction_id": "0d904c3c-8eb8-4abd-a455-04c3a83c5b43",
    "page_range": "1-3,5",
    "async": true,
    "charts_config": {
      "data_points": 100,
      "agentic_zoom": true,
      "export_formats": ["excel", "csv"]
    }
  }'

For a split, replace extraction_id with split_id and omit page_range.

Response

With async: true, the endpoint returns HTTP 202:

{
  "job_id": "90705060-b7b9-48c3-9593-7c7d62ce280e",
  "status": "pending",
  "message": "Chart extraction started. Poll GET /job/{job_id} for results."
}

Poll GET /job/{job_id} until the job reaches a terminal status. The completed chart response is returned in the job response’s result field. charts_id belongs to that completed result; it is not duplicated in the initial async acknowledgement. Extraction mode returns a flat charts array. Split mode returns results, keyed by topic, with each topic’s inherited pages and charts. count is the total number of charts across the response.

{
  "charts_id": "90705060-b7b9-48c3-9593-7c7d62ce280e",
  "extraction_id": "0d904c3c-8eb8-4abd-a455-04c3a83c5b43",
  "page_range": "1-3,5",
  "count": 1,
  "charts": [
    {
      "id": "fig-1",
      "page_number": 2,
      "bounding_box": [
        {"x": 0.12, "y": 0.18},
        {"x": 0.88, "y": 0.18},
        {"x": 0.88, "y": 0.76},
        {"x": 0.12, "y": 0.76}
      ],
      "type": "line",
      "title": "Monthly price",
      "x_axis": {"type": "categorical", "title": "Month"},
      "y_axis": {"type": "linear", "title": "Price"},
      "series": [
        {
          "name": "Series 1",
          "color": "#1769aa",
          "line_style": "solid",
          "data": [["Jan", 102.4], ["Feb", 105.1]]
        }
      ],
      "confidence": 0.94,
      "warnings": []
    }
  ],
  "exports": [
    {
      "format": "excel",
      "filename": "charts.xlsx",
      "url": "https://api.runpulse.com/results/90705060-b7b9-48c3-9593-7c7d62ce280e/charts/charts.xlsx"
    }
  ],
  "excel_url": "https://api.runpulse.com/results/90705060-b7b9-48c3-9593-7c7d62ce280e/charts/charts.xlsx",
  "credits_used": 1
}

excel_url is a compatibility alias. New integrations should iterate over exports. If an export cannot be produced, export_warnings explains why without failing the chart reconstruction.

Export Downloads

Every export URL:

requires the same API key as the chart request;
belongs to the organization that created the chart result;
is deleted after one successful stream;
must not be prefetched by an agent, UI, or link preview.

curl -H "x-api-key: $PULSE_API_KEY" \
  "https://api.runpulse.com/results/90705060-b7b9-48c3-9593-7c7d62ce280e/charts/charts.xlsx" \
  --output charts.xlsx

Store the downloaded file. Do not store the URL as a durable artifact reference.

Retrieve Results

Authenticated applications can hydrate saved views without rerunning reconstruction:

Endpoint	Purpose
`GET /api/v1/charts/{charts_id}`	Read one owned result by ID.
`GET /api/v1/charts/extraction/{extraction_id}/latest`	Read the newest result associated with an extraction, including split and pipeline runs.
`GET /api/v1/charts/extraction/{extraction_id}/public/latest`	Read the newest result only while that extraction’s public sharing and retention windows are active.

The public route intentionally returns 404 for missing, private, expired, and deleted extractions so it does not disclose which condition failed.

Accuracy

Chart output is reconstructed from pixels and OCR, so treat values as estimates. Review confidence and warnings, and validate consequential data against the source using the returned page_number and bounding_box. agentic_zoom can help with small labels or dense curves, but does not guarantee exact source values.

Extract

Create the saved extraction consumed by Charts.

Chaining Steps

Reuse extraction and split IDs across downstream steps.

Authorizations

x-api-key

string

header

required

Body

application/json

Option 1
Option 2

Input for POST /charts. Provide exactly one target ID.

extraction_id

string<uuid>

required

Completed extraction to process.

split_id

string<uuid>

Completed split whose topic page groups should be processed.

page_range

string

Optional 1-indexed pages for extraction mode, for example "1-3,5". Do not provide this with split_id; split pages are inherited.

Pattern: ^[0-9, -]+$

charts_config

object

Chart reconstruction options. Defaults are used when omitted.

Show child attributes

async

boolean

default:false

When true, returns immediately with a job ID. Poll GET /job/{job_id} for the completed chart result.

Response

Completed chart reconstruction.

charts_id

string<uuid>

required

count

integer

required

Total reconstructed charts across the response.

Required range: x >= 0

exports

object[]

required

Show child attributes

excel_url

string<uri> | null

required

deprecated

Compatibility alias for the Excel item in exports.

extraction_id

string<uuid> | null

split_id

string<uuid>

page_range

string

charts

object[]

Present in extraction mode.

Show child attributes

results

object

Split-mode results keyed by topic name.

Show child attributes

export_warnings

string[]

credits_used

number<float>

⌘I

API Reference

Pipeline Steps

Batch & Pipelines

Forms

Jobs, Results & Webhooks

Account & Usage

Legacy Support

Charts

Overview

Request

`charts_config`

Response

Export Downloads

Retrieve Results

Accuracy

Extract

Chaining Steps

Authorizations

Body

Response

​Overview

​Request

​charts_config

​Response

​Export Downloads

​Retrieve Results

​Accuracy

​Related

Extract

Chaining Steps

Authorizations

Body

Response

Overview

Request

`charts_config`

Response

Export Downloads

Retrieve Results

Accuracy

Related