Get Document Validation Custom Rule

curl --request GET \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "rule_id": "<string>",
  "kind": "regex",
  "display_name": "<string>",
  "description": "<string>",
  "requires_visual_processing": true,
  "can_update": true,
  "can_delete": true,
  "include_violation_details": true,
  "pattern": "<string>",
  "flags": [
    "IGNORECASE"
  ],
  "terms": [
    "<string>"
  ],
  "case_sensitive": true,
  "rule_intent": "<string>",
  "violation_definition": "<string>",
  "non_violation_definition": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

assistant

api

tenants

{tenant}

document_validation

rules

{rule_id}

Get Document Validation Custom Rule

curl --request GET \
  --url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}', 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://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/document_validation/rules/{rule_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "rule_id": "<string>",
  "kind": "regex",
  "display_name": "<string>",
  "description": "<string>",
  "requires_visual_processing": true,
  "can_update": true,
  "can_delete": true,
  "include_violation_details": true,
  "pattern": "<string>",
  "flags": [
    "IGNORECASE"
  ],
  "terms": [
    "<string>"
  ],
  "case_sensitive": true,
  "rule_intent": "<string>",
  "violation_definition": "<string>",
  "non_violation_definition": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

rule_id

string

required

tenant

string | null

required

The domain of the customer

Example:

"example.com"

Response

Successful Response

rule_id

string

required

Stable rule ID.

kind

enum<string>

required

The executable rule kind.

Available options:

regex,

blacklist,

llm

display_name

string

required

Human-readable label for the UI.

description

string

required

Human-readable description of the rule.

requires_visual_processing

boolean

required

Whether the rule requires multimodal attachment input.

can_update

boolean

required

Whether the caller may modify the rule definition.

can_delete

boolean

required

Whether the caller may delete the rule definition.

include_violation_details

boolean

default:true

Whether violation details (matched_text, snippet) are included by default for this rule.

pattern

string | null

Regex pattern for editable custom regex rules.

flags

enum<string>[] | null

Regex flags for editable custom regex rules.

Available options:

IGNORECASE,

MULTILINE,

DOTALL

terms

string[] | null

Blacklist terms for editable custom blacklist rules.

case_sensitive

boolean | null

Blacklist case-sensitivity for editable custom blacklist rules.

rule_intent

string | null

High-level purpose of the rule, when LLM-based.

violation_definition

string | null

What counts as a violation, when LLM-based.

non_violation_definition

string | null

What should not be flagged, when LLM-based.