{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sensible Classification Configuration Reference document API",
    "version": "v0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Reference document",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all reference documents in a document type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sensible.so/v0/document_types/:type-id/goldens",
            "params": [
              {
                "name": "type-id",
                "value": "",
                "type": "path",
                "description": "The unique document type identifier in v4 UUID format. Find IDs using the `/document_types` endpoint."
              }
            ]
          },
          "docs": "List all reference documents in a document type"
        },
        {
          "info": {
            "name": "Create reference document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/document_types/:type-id/goldens",
            "params": [
              {
                "name": "type-id",
                "value": "",
                "type": "path",
                "description": "The unique document type identifier in v4 UUID format. Find IDs using the `/document_types` endpoint."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Specify document metadata in the request, and get back an `upload_url` at which to put the PDF, for example with `curl -T ./sample.pdf`."
        },
        {
          "info": {
            "name": "Extract all text from reference document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/extract_text_from_golden/:type-name",
            "params": [
              {
                "name": "type-name",
                "value": "",
                "type": "path",
                "description": "User-friendly name for a document type"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get all the text (lines) for a reference document as standardized output. The output is an array of pages with metadata such as text positioning. If you specify a configuration, Sensible uses preprocessors defined in the configuration to process the text."
        },
        {
          "info": {
            "name": "Get reference document metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sensible.so/v0/document_types/:type-id/goldens/:document-name",
            "params": [
              {
                "name": "type-id",
                "value": "",
                "type": "path",
                "description": "The unique document type identifier in v4 UUID format. Find IDs using the `/document_types` endpoint."
              },
              {
                "name": "document-name",
                "value": "best_scan_form_no_1234",
                "type": "path",
                "description": "Unique name for a document. Find it in the Sensible app or from the `/document_types/{type-id}}/goldens` endpoint."
              }
            ]
          },
          "docs": "Get download URL and other metadata for a reference document."
        },
        {
          "info": {
            "name": "Update metadata for a reference document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sensible.so/v0/document_types/:type-id/goldens/:document-name",
            "params": [
              {
                "name": "type-id",
                "value": "",
                "type": "path",
                "description": "The unique document type identifier in v4 UUID format. Find IDs using the `/document_types` endpoint."
              },
              {
                "name": "document-name",
                "value": "best_scan_form_no_1234",
                "type": "path",
                "description": "Unique name for a document. Find it in the Sensible app or from the `/document_types/{type-id}}/goldens` endpoint."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update metadata for a reference document"
        },
        {
          "info": {
            "name": "Delete reference document",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sensible.so/v0/document_types/:type-id/goldens/:document-name",
            "params": [
              {
                "name": "type-id",
                "value": "",
                "type": "path",
                "description": "The unique document type identifier in v4 UUID format. Find IDs using the `/document_types` endpoint."
              },
              {
                "name": "document-name",
                "value": "best_scan_form_no_1234",
                "type": "path",
                "description": "Unique name for a document. Find it in the Sensible app or from the `/document_types/{type-id}}/goldens` endpoint."
              }
            ]
          },
          "docs": "Delete a reference document and break associations to any configs."
        },
        {
          "info": {
            "name": "Unassociate reference document from configuration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sensible.so/v0/document_types/:type-id/goldens/:document-name/configuration",
            "params": [
              {
                "name": "type-id",
                "value": "",
                "type": "path",
                "description": "The unique document type identifier in v4 UUID format. Find IDs using the `/document_types` endpoint."
              },
              {
                "name": "document-name",
                "value": "best_scan_form_no_1234",
                "type": "path",
                "description": "Unique name for a document. Find it in the Sensible app or from the `/document_types/{type-id}}/goldens` endpoint."
              }
            ]
          },
          "docs": "Break the association between a reference document and its configuration."
        }
      ]
    }
  ],
  "bundled": true
}