cURL

curl --request POST \
  --url https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "app_id": "app_1406",
  "prompt": "Extract the invoice number, invoice date, and total amount from the invoice."
}
'

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    app_id: 'app_1406',
    prompt: 'Extract the invoice number, invoice date, and total amount from the invoice.'
  })
};

fetch('https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

response = requests.post(
    "https://adp-global.laiye.com/open/agentic_doc_processor/laiye/v1/app-manage/ai-recommend",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    json={
        "app_id": "app_1406",
        "prompt": "Generate fields for invoice number, invoice date, and total amount.",
    },
    timeout=120,
)
response.raise_for_status()
result = response.json()
if result.get("code") not in ("success", 200, "200"):
    raise RuntimeError(result.get("message") or result.get("code"))

HttpResponse<String> response = Unirest.post("https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app_id\": \"app_1406\",\n  \"prompt\": \"Extract the invoice number, invoice date, and total amount from the invoice.\"\n}")
  .asString();

const url = 'https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend';
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    app_id: 'app_1406',
    prompt: 'Extract the invoice number, invoice date, and total amount from the invoice.'
  })
};

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_doc_processor/{tenant_name}/v1/app-manage/ai-recommend"

	payload := strings.NewReader("{\n  \"app_id\": \"app_1406\",\n  \"prompt\": \"Extract the invoice number, invoice date, and total amount from the invoice.\"\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_doc_processor/{tenant_name}/v1/app-manage/ai-recommend");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-KEY", "<api-key>");
request.AddJsonBody("{\n  \"app_id\": \"app_1406\",\n  \"prompt\": \"Extract the invoice number, invoice date, and total amount from the invoice.\"\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_doc_processor/{tenant_name}/v1/app-manage/ai-recommend",
  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([
    'app_id' => 'app_1406',
    'prompt' => 'Extract the invoice number, invoice date, and total amount from the invoice.'
  ]),
  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": "success",
  "message": "",
  "tips": null,
  "data": {
    "app_id": "app_1406",
    "app_name": "",
    "extract_fields": [
      {
        "field_name": "Invoice number",
        "field_type": "string",
        "field_prompt": "Extract the unique identifier of the tax invoice."
      },
      {
        "field_name": "Invoice date",
        "field_type": "date",
        "field_prompt": "Extract the invoice issue date."
      }
    ]
  }
}

Application Management

Generate extraction field prompts

Generate field names, field types, field prompts, and other configuration references from a sample document or prompt. Standard applications require at least one of prompt, file_url, or file_base64. High-speed applications still require file_url or file_base64, and prompt is only an auxiliary instruction. When app_id belongs to a high-speed custom extraction application, the endpoint returns a configuration preview containing common_rule, field_rule, and table_rule. It does not save a configuration version or automatically populate the Web application. An HTTP 200 response can still represent a business failure, so callers must check both the HTTP status and the response code.

POST

open

agentic_doc_processor

{tenant_name}

app-manage

ai-recommend

cURL

curl --request POST \
  --url https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "app_id": "app_1406",
  "prompt": "Extract the invoice number, invoice date, and total amount from the invoice."
}
'

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    app_id: 'app_1406',
    prompt: 'Extract the invoice number, invoice date, and total amount from the invoice.'
  })
};

fetch('https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

response = requests.post(
    "https://adp-global.laiye.com/open/agentic_doc_processor/laiye/v1/app-manage/ai-recommend",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    json={
        "app_id": "app_1406",
        "prompt": "Generate fields for invoice number, invoice date, and total amount.",
    },
    timeout=120,
)
response.raise_for_status()
result = response.json()
if result.get("code") not in ("success", 200, "200"):
    raise RuntimeError(result.get("message") or result.get("code"))

HttpResponse<String> response = Unirest.post("https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app_id\": \"app_1406\",\n  \"prompt\": \"Extract the invoice number, invoice date, and total amount from the invoice.\"\n}")
  .asString();

const url = 'https://adp-global.laiye.com/open/agentic_doc_processor/{tenant_name}/v1/app-manage/ai-recommend';
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    app_id: 'app_1406',
    prompt: 'Extract the invoice number, invoice date, and total amount from the invoice.'
  })
};

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_doc_processor/{tenant_name}/v1/app-manage/ai-recommend"

	payload := strings.NewReader("{\n  \"app_id\": \"app_1406\",\n  \"prompt\": \"Extract the invoice number, invoice date, and total amount from the invoice.\"\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_doc_processor/{tenant_name}/v1/app-manage/ai-recommend");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-KEY", "<api-key>");
request.AddJsonBody("{\n  \"app_id\": \"app_1406\",\n  \"prompt\": \"Extract the invoice number, invoice date, and total amount from the invoice.\"\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_doc_processor/{tenant_name}/v1/app-manage/ai-recommend",
  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([
    'app_id' => 'app_1406',
    'prompt' => 'Extract the invoice number, invoice date, and total amount from the invoice.'
  ]),
  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": "success",
  "message": "",
  "tips": null,
  "data": {
    "app_id": "app_1406",
    "app_name": "",
    "extract_fields": [
      {
        "field_name": "Invoice number",
        "field_type": "string",
        "field_prompt": "Extract the unique identifier of the tax invoice."
      },
      {
        "field_name": "Invoice date",
        "field_type": "date",
        "field_prompt": "Extract the invoice issue date."
      }
    ]
  }
}

Authorizations

X-API-KEY

string

header

required

Production API Key. You can find it under My API in the ADP platform. Make sure the API Key is active and belongs to the production environment.

Path Parameters

tenant_name

string

default:laiye

required

Tenant name. Default: laiye.

Body

application/json

Option 1
Option 2
Option 3

Field configuration generation request. Standard applications require at least one of prompt, file_url, or file_base64. High-speed applications still require file_url or file_base64, and prompt is only supporting guidance. Because the application type is resolved from app_id, OpenAPI cannot fully express the two conditional contracts from request fields alone.

app_id

string

required

Application ID. When you pass a high-speed custom extraction application, the response returns a high-speed auto-configuration preview.

prompt

string

required

User-provided generation instruction. Standard applications can use prompt alone; high-speed applications must also provide a file.

file_base64

string

Base64-encoded file. Required for high-speed applications if file_url is not provided.

file_url

string<uri>

File URL. Required for high-speed applications if file_base64 is not provided.

doc_type

string

Document type. You can provide this for standard application recommendations. High-speed applications detect the document type automatically.

doc_type_description

string

Document type description. You can provide this for standard application recommendations.

Response

Field configuration generation result. High-speed applications return a configuration preview and do not save a configuration version.

code

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

message

string

Response message.

tips

string | null

Details. Defaults to null.

data

object

Show child attributes

Product docs

Other docs

Generate extraction field prompts

Authorizations

Path Parameters

Body

Response