Start a run (detect)

POST

workspaces

{workspaceSlug}

pipelines

{pipelineSlug}

runs

Start a run (detect)

curl --request POST \
  --url https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": {
    "countries": [
      "<string>"
    ],
    "languages": [],
    "metadata": {
      "audience": [],
      "purpose": null,
      "tags": []
    }
  }
}
'

import requests

url = "https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/"

payload = {
    "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scope": {
        "countries": ["<string>"],
        "languages": [],
        "metadata": {
            "audience": [],
            "purpose": None,
            "tags": []
        }
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    scope: {
      countries: ['<string>'],
      languages: [],
      metadata: {audience: [], purpose: null, tags: []}
    }
  })
};

fetch('https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/', 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.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/",
  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([
    'fileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'scope' => [
        'countries' => [
                '<string>'
        ],
        'languages' => [
                
        ],
        'metadata' => [
                'audience' => [
                                
                ],
                'purpose' => null,
                'tags' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/"

	payload := strings.NewReader("{\n  \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": {\n    \"countries\": [\n      \"<string>\"\n    ],\n    \"languages\": [],\n    \"metadata\": {\n      \"audience\": [],\n      \"purpose\": null,\n      \"tags\": []\n    }\n  }\n}")

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

	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.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": {\n    \"countries\": [\n      \"<string>\"\n    ],\n    \"languages\": [],\n    \"metadata\": {\n      \"audience\": [],\n      \"purpose\": null,\n      \"tags\": []\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": {\n    \"countries\": [\n      \"<string>\"\n    ],\n    \"languages\": [],\n    \"metadata\": {\n      \"audience\": [],\n      \"purpose\": null,\n      \"tags\": []\n    }\n  }\n}"

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

{
  "id": "<string>",
  "inputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {
    "error": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "pipelineSlug": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "triggerType": "user",
  "triggeredBy": {
    "username": "<string>",
    "avatarUrl": "<string>",
    "displayName": "<string>"
  },
  "workspaceSlug": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "inputFileName": "<string>",
  "outputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outputFileName": "<string>"
}

{
  "id": "<string>",
  "inputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {
    "error": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "pipelineSlug": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "triggerType": "user",
  "triggeredBy": {
    "username": "<string>",
    "avatarUrl": "<string>",
    "displayName": "<string>"
  },
  "workspaceSlug": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "inputFileName": "<string>",
  "outputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outputFileName": "<string>"
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

"<string>"

"<string>"

Path Parameters

workspaceSlug

string

required

URL-safe workspace identifier.

pipelineSlug

string

required

URL slug of the pipeline, unique within its workspace.

Body

application/json

Request payload to start a run (detect) over a file.

Analyzes the file with the pipeline's configuration and returns the run, which holds the findings for review before redaction.

Request payload to start a run (detect) over a file.

Analyzes the file with the pipeline's configuration and returns the run, which holds the findings for review before redaction.

fileId

string<uuid>

required

The file to analyze.

scope

object

Per-document scope (languages, jurisdictions, document labels).

Overrides the pipeline's defaultScope when present; absent falls back to the pipeline default.

Show child attributes

Response

Response type for a pipeline run.

A run is addressed by its own opaque id; the owning pipeline and workspace slugs are carried for context.

Response type for a pipeline run.

A run is addressed by its own opaque id; the owning pipeline and workspace slugs are carried for context.

string

required

Opaque identifier of the run.

Pattern: ^run_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

inputFileId

string<uuid>

required

Source document this run analyzes / redacts.

metadata

object

required

Non-encrypted metadata for filtering/display.

Show child attributes

pipelineSlug

string

required

Handle of the pipeline this run belongs to.

Required string length: 3 - 32

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

startedAt

string<date-time>

required

When the run started.

status

required

Current run status.

The detections are available to fetch from the run's detections endpoint once this reaches analyzed.

Allowed value: "queued"

triggerType

required

How the run was triggered.

Allowed value: "user"

triggeredBy

object

required

Account that triggered the run.

Show child attributes

workspaceSlug

string

required

Handle of the workspace this run belongs to.

Required string length: 3 - 32

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

completedAt

string<date-time>

When the run completed.

error

string

Human-readable failure reason, present only when the run failed.

inputFileName

string

Display name of the source document, for showing the run without a separate file lookup. None if the file was removed (e.g. by retention).

outputFileId

string<uuid>

Redacted document produced by the run, once it completes.

outputFileName

string

Display name of the redacted output, once the run completes.

Start a run (detect)

curl --request POST \
  --url https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope": {
    "countries": [
      "<string>"
    ],
    "languages": [],
    "metadata": {
      "audience": [],
      "purpose": null,
      "tags": []
    }
  }
}
'

import requests

url = "https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/"

payload = {
    "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scope": {
        "countries": ["<string>"],
        "languages": [],
        "metadata": {
            "audience": [],
            "purpose": None,
            "tags": []
        }
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    scope: {
      countries: ['<string>'],
      languages: [],
      metadata: {audience: [], purpose: null, tags: []}
    }
  })
};

fetch('https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/', 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.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/",
  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([
    'fileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'scope' => [
        'countries' => [
                '<string>'
        ],
        'languages' => [
                
        ],
        'metadata' => [
                'audience' => [
                                
                ],
                'purpose' => null,
                'tags' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/"

	payload := strings.NewReader("{\n  \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": {\n    \"countries\": [\n      \"<string>\"\n    ],\n    \"languages\": [],\n    \"metadata\": {\n      \"audience\": [],\n      \"purpose\": null,\n      \"tags\": []\n    }\n  }\n}")

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

	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.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": {\n    \"countries\": [\n      \"<string>\"\n    ],\n    \"languages\": [],\n    \"metadata\": {\n      \"audience\": [],\n      \"purpose\": null,\n      \"tags\": []\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scope\": {\n    \"countries\": [\n      \"<string>\"\n    ],\n    \"languages\": [],\n    \"metadata\": {\n      \"audience\": [],\n      \"purpose\": null,\n      \"tags\": []\n    }\n  }\n}"

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

{
  "id": "<string>",
  "inputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {
    "error": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "pipelineSlug": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "triggerType": "user",
  "triggeredBy": {
    "username": "<string>",
    "avatarUrl": "<string>",
    "displayName": "<string>"
  },
  "workspaceSlug": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "inputFileName": "<string>",
  "outputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outputFileName": "<string>"
}

{
  "id": "<string>",
  "inputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {
    "error": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "pipelineSlug": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "triggerType": "user",
  "triggeredBy": {
    "username": "<string>",
    "avatarUrl": "<string>",
    "displayName": "<string>"
  },
  "workspaceSlug": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "inputFileName": "<string>",
  "outputFileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outputFileName": "<string>"
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

"<string>"

"<string>"

API Reference

Endpoints

Start a run (detect)

Path Parameters

Body

Response