Export workflow runs (Limited preview)

curl --request POST \
  --url https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "application_id": "app_abc123",
  "run_ids": [
    "run_xyz789"
  ],
  "format": "excel",
  "report_mode": "merged",
  "include_failed_runs": false,
  "max_text_length": 10000
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    application_id: 'app_abc123',
    run_ids: ['run_xyz789'],
    format: 'excel',
    report_mode: 'merged',
    include_failed_runs: false,
    max_text_length: 10000
  })
};

fetch('https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export"

payload = {
    "application_id": "app_abc123",
    "run_ids": ["run_xyz789"],
    "format": "excel",
    "report_mode": "merged",
    "include_failed_runs": False,
    "max_text_length": 10000
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

HttpResponse<String> response = Unirest.post("https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"application_id\": \"app_abc123\",\n  \"run_ids\": [\n    \"run_xyz789\"\n  ],\n  \"format\": \"excel\",\n  \"report_mode\": \"merged\",\n  \"include_failed_runs\": false,\n  \"max_text_length\": 10000\n}")
  .asString();

const url = 'https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    application_id: 'app_abc123',
    run_ids: ['run_xyz789'],
    format: 'excel',
    report_mode: 'merged',
    include_failed_runs: false,
    max_text_length: 10000
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export"

	payload := strings.NewReader("{\n  \"application_id\": \"app_abc123\",\n  \"run_ids\": [\n    \"run_xyz789\"\n  ],\n  \"format\": \"excel\",\n  \"report_mode\": \"merged\",\n  \"include_failed_runs\": false,\n  \"max_text_length\": 10000\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))

}

using RestSharp;


var options = new RestClientOptions("https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
request.AddJsonBody("{\n  \"application_id\": \"app_abc123\",\n  \"run_ids\": [\n    \"run_xyz789\"\n  ],\n  \"format\": \"excel\",\n  \"report_mode\": \"merged\",\n  \"include_failed_runs\": false,\n  \"max_text_length\": 10000\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export",
  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([
    'application_id' => 'app_abc123',
    'run_ids' => [
        'run_xyz789'
    ],
    'format' => 'excel',
    'report_mode' => 'merged',
    'include_failed_runs' => false,
    'max_text_length' => 10000
  ]),
  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;
}

{
  "code": "<string>",
  "message": "<string>",
  "tips": "<string>",
  "data": {
    "file_id": "<string>",
    "download_url": "<string>",
    "filename": "<string>",
    "file_size": 1,
    "format": "excel",
    "report_mode": "merged",
    "total_runs": 100,
    "included_runs": 100,
    "skipped_runs": 100,
    "run_summaries": [
      {
        "run_id": "<string>",
        "status": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "included_nodes": 1,
        "skipped_nodes": 1
      }
    ],
    "export_time": "2023-11-07T05:31:56Z"
  }
}

{
  "detail": [
    {
      "type": "greater_than",
      "loc": [
        "query",
        "limit"
      ],
      "msg": "Input should be greater than 0",
      "input": 0,
      "ctx": {
        "gt": 0
      }
    }
  ]
}

Workflow

Export workflow runs (Limited preview)

Export specified workflow runs as Excel, Word, Markdown, or JSON, and return a temporary download URL plus run summaries. The public contract requires at least one explicit run_id; it does not expose the backend compatibility behavior that treats an empty list as “export all runs for the application.”

The current implementation processes at most 200 runs and generates at most 500,000 rows per request. Temporary files are generally valid for approximately one hour. Limited preview: this route validates only the API Key and tenant; it has no independent administrator-role or application-visibility check. Use it only as an administrator in a controlled tenant, and export only application_id and run_ids that you have independently confirmed you can access. Exports may contain workflow inputs, node outputs, and business data. Protect the downloaded file at the same classification level as its source data.

POST

open

agentic_engine

laiye

app

runs

export

Export workflow runs (Limited preview)

curl --request POST \
  --url https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "application_id": "app_abc123",
  "run_ids": [
    "run_xyz789"
  ],
  "format": "excel",
  "report_mode": "merged",
  "include_failed_runs": false,
  "max_text_length": 10000
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    application_id: 'app_abc123',
    run_ids: ['run_xyz789'],
    format: 'excel',
    report_mode: 'merged',
    include_failed_runs: false,
    max_text_length: 10000
  })
};

fetch('https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export"

payload = {
    "application_id": "app_abc123",
    "run_ids": ["run_xyz789"],
    "format": "excel",
    "report_mode": "merged",
    "include_failed_runs": False,
    "max_text_length": 10000
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

HttpResponse<String> response = Unirest.post("https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"application_id\": \"app_abc123\",\n  \"run_ids\": [\n    \"run_xyz789\"\n  ],\n  \"format\": \"excel\",\n  \"report_mode\": \"merged\",\n  \"include_failed_runs\": false,\n  \"max_text_length\": 10000\n}")
  .asString();

const url = 'https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    application_id: 'app_abc123',
    run_ids: ['run_xyz789'],
    format: 'excel',
    report_mode: 'merged',
    include_failed_runs: false,
    max_text_length: 10000
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export"

	payload := strings.NewReader("{\n  \"application_id\": \"app_abc123\",\n  \"run_ids\": [\n    \"run_xyz789\"\n  ],\n  \"format\": \"excel\",\n  \"report_mode\": \"merged\",\n  \"include_failed_runs\": false,\n  \"max_text_length\": 10000\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))

}

using RestSharp;


var options = new RestClientOptions("https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
request.AddJsonBody("{\n  \"application_id\": \"app_abc123\",\n  \"run_ids\": [\n    \"run_xyz789\"\n  ],\n  \"format\": \"excel\",\n  \"report_mode\": \"merged\",\n  \"include_failed_runs\": false,\n  \"max_text_length\": 10000\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://adp-global.laiye.com/open/agentic_engine/laiye/v1/app/runs/export",
  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([
    'application_id' => 'app_abc123',
    'run_ids' => [
        'run_xyz789'
    ],
    'format' => 'excel',
    'report_mode' => 'merged',
    'include_failed_runs' => false,
    'max_text_length' => 10000
  ]),
  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;
}

{
  "code": "<string>",
  "message": "<string>",
  "tips": "<string>",
  "data": {
    "file_id": "<string>",
    "download_url": "<string>",
    "filename": "<string>",
    "file_size": 1,
    "format": "excel",
    "report_mode": "merged",
    "total_runs": 100,
    "included_runs": 100,
    "skipped_runs": 100,
    "run_summaries": [
      {
        "run_id": "<string>",
        "status": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "included_nodes": 1,
        "skipped_nodes": 1
      }
    ],
    "export_time": "2023-11-07T05:31:56Z"
  }
}

{
  "detail": [
    {
      "type": "greater_than",
      "loc": [
        "query",
        "limit"
      ],
      "msg": "Input should be greater than 0",
      "input": 0,
      "ctx": {
        "gt": 0
      }
    }
  ]
}

Authorizations

X-API-Key

string

header

required

API Key for workflow endpoints.

Body

application/json

application_id

string

required

Workflow application ID.

Minimum string length: 1

run_ids

string[]

required

Explicitly authorized run IDs to export. The public contract does not allow null or an empty array to export all runs.

Required array length: 1 - 200 elements

Minimum string length: 1

node_ids

string[]

Optional node IDs. If omitted, all exportable nodes in each run are included.

Minimum string length: 1

format

enum<string>

default:excel

Available options:

excel,

word,

markdown,

json

report_mode

enum<string>

default:merged

merged produces one combined report; per_run separates output by run.

Available options:

merged,

per_run

include_failed_runs

boolean

default:false

primary_key_variable

string

Optional workflow input-variable name to use as the export primary key.

max_text_length

integer

default:10000

Maximum exported characters for one text value. The route currently defaults to 10,000.

Required range: 1 <= x <= 30000

Response

Workflow-run export result. Treat the download URL as a temporary sensitive link.

code

Business code. A successful response is usually success or 200.

message

string

Response message.

tips

string | null

Details. Defaults to null.

data

object | null

Show child attributes

Product docs

Other docs

Export workflow runs (Limited preview)

Authorizations

Body

Response