Run Extract

Starts an extract job in DocumentPro.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

number

Optional page chunk size.

boolean

Whether to detect layout during parsing.

boolean

Whether to detect tables during parsing.

stringrequired

The document_id to process.

string

Optional end regex for splitting.

string

Optional page range selection, for example 1-3.

string

The query model to use for extraction.

string

Optional split regex for parsing segments.

string

Optional start regex for splitting.

stringrequired

The workflow template_id to use for extraction.

boolean

Whether to use all regex matches.

boolean

Whether to use OCR while parsing.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/documentPro/0.0.8/actions/run-extract" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "document_id": "",
  "template_id": ""
}'

{
  "success": true,
  "data": [
    {
      "created_at": "string",
      "request_id": "string",
      "request_status": "string",
      "response_body": {},
      "updated_at": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.