{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sensible Classification Configuration Document API",
    "version": "v0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Document",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Classify document by type (sync)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/classify",
            "params": [
              {
                "name": "document_types",
                "value": "1040s, pay_stubs, bank_statements",
                "type": "query",
                "description": "Comma-delimited list of document types Sensible uses to classify the document.  If you don't specify this, Sensible uses all the document types you define in your account."
              }
            ]
          },
          "docs": "\n**Note:** Use this Classify endpoint for testing. Use the asynchronous Classify endpoint for production.\n\nClassify a document into one of the document types you defined in your Sensible account. For more information, see [Classifying documents by type](https://docs.sensible.so/docs/classify).\n\nUse this endpoint:\n\n - In an extraction workflow. For example, determine which documents to extract prior to calling a Sensible extraction endpoint.\n - Outside an extraction workflow. For example, determi"
        },
        {
          "info": {
            "name": "Classify document by type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/classify/async",
            "params": [
              {
                "name": "document_types",
                "value": "1040s, pay_stubs, bank_statements",
                "type": "query",
                "description": "Comma-delimited list of document types Sensible uses to classify the document.  If you don't specify this, Sensible uses all the document types you define in your account."
              }
            ]
          },
          "docs": "Classify a document into one of the document types you defined in your Sensible account. For more information, see [Classifying documents by type](https://docs.sensible.so/docs/classify).\nTo retrieve document's classification, poll the `download_link` in this endpoint's response until it returns a non-error response.\n\nUse this endpoint:\n\n - In an extraction workflow. For example, determine which documents to extract prior to calling a Sensible extraction endpoint.\n - Outside an extraction workfl"
        },
        {
          "info": {
            "name": "Extract data from a document using specified config",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/extract/:document_type/:config_name",
            "params": [
              {
                "name": "document_type",
                "value": "senseml_basics",
                "type": "path",
                "description": "Type of document to extract from. Create your custom type in the Sensible app (for example, `rate_confirmation`, `certificate_of_insurance`, or `home_inspection_report`). To quickly test this endpoint using the `Try It` button in this interactive explorer, use the `senseml_basics` tutorial document type with this [example document](https://raw.githubusercontent.com/sensible-hq/sensible-docs/v0/assets/pdfs/1_extract_your_first_data.pdf). As a convenience, Sensible automatically detects the best-fit extraction from among the extraction queries (\"configs\") in the document type. For example, if you create an `auto_insurance_quotes` document type, you can add `carrier 1`, `carrier 2`, and `carrier 3` configs to the document type in the Sensible app. Sensible then automatically classifies each document you upload by its carrier, so you can use the same document type for each carrier without specifying the carrier in the extraction request."
              },
              {
                "name": "config_name",
                "value": "anyco_insurance_auto_declarations",
                "type": "path",
                "description": "User-friendly name of the config to use to extract data from the document."
              },
              {
                "name": "environment",
                "value": "",
                "type": "query",
                "description": "If you specify `development`, extracts preferentially using config versions published to the development environment in the Sensible app. The extraction runs all configs in the doc type before picking the best fit. For each config, falls back to production version if no development version of the config exists."
              },
              {
                "name": "document_name",
                "value": "test.pdf",
                "type": "query",
                "description": "If you specify the filename of the document using this parameter, then Sensible returns the filename in the extraction response."
              }
            ]
          },
          "docs": "This endpoint's behavior identical to the [Extract data from a document](https://docs.sensible.so/reference/extract-data-from-a-document) endpoint's behavior, except that Sensible uses the specified config to extract data from the document instead of automatically choosing the best-scoring extraction in the document type.\n"
        },
        {
          "info": {
            "name": "Extract data from a document (sync)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/extract/:document_type",
            "params": [
              {
                "name": "document_type",
                "value": "senseml_basics",
                "type": "path",
                "description": "Type of document to extract from. Create your custom type in the Sensible app (for example, `rate_confirmation`, `certificate_of_insurance`, or `home_inspection_report`). To quickly test this endpoint using the `Try It` button in this interactive explorer, use the `senseml_basics` tutorial document type with this [example document](https://raw.githubusercontent.com/sensible-hq/sensible-docs/v0/assets/pdfs/1_extract_your_first_data.pdf). As a convenience, Sensible automatically detects the best-fit extraction from among the extraction queries (\"configs\") in the document type. For example, if you create an `auto_insurance_quotes` document type, you can add `carrier 1`, `carrier 2`, and `carrier 3` configs to the document type in the Sensible app. Sensible then automatically classifies each document you upload by its carrier, so you can use the same document type for each carrier without specifying the carrier in the extraction request."
              },
              {
                "name": "environment",
                "value": "",
                "type": "query",
                "description": "If you specify `development`, extracts preferentially using config versions published to the development environment in the Sensible app. The extraction runs all configs in the doc type before picking the best fit. For each config, falls back to production version if no development version of the config exists."
              },
              {
                "name": "document_name",
                "value": "test.pdf",
                "type": "query",
                "description": "If you specify the filename of the document using this parameter, then Sensible returns the filename in the extraction response."
              }
            ]
          },
          "docs": "\n**Note:** Use this endpoint for testing. Use the asynchronous extraction endpoints when in production.\n\nExtract data from a local document synchronously.\n\nTo explore this endpoint, use this interactive API reference, or use one of the following options:\n\n- For a quick \"hello world\" response to this endpoint, see the [API quickstart](https://docs.sensible.so/docs/quickstart)\n- For a step-by-step tutorial about calling this endpoint, see [Try synchronous extraction](https://docs.sensible.so/docs/"
        },
        {
          "info": {
            "name": "Extract doc at a Sensible URL using specified config",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/generate_upload_url/:document_type/:config_name",
            "params": [
              {
                "name": "document_type",
                "value": "senseml_basics",
                "type": "path",
                "description": "Type of document to extract from. Create your custom type in the Sensible app (for example, `rate_confirmation`, `certificate_of_insurance`, or `home_inspection_report`). To quickly test this endpoint using the `Try It` button in this interactive explorer, use the `senseml_basics` tutorial document type with this [example document](https://raw.githubusercontent.com/sensible-hq/sensible-docs/v0/assets/pdfs/1_extract_your_first_data.pdf). As a convenience, Sensible automatically detects the best-fit extraction from among the extraction queries (\"configs\") in the document type. For example, if you create an `auto_insurance_quotes` document type, you can add `carrier 1`, `carrier 2`, and `carrier 3` configs to the document type in the Sensible app. Sensible then automatically classifies each document you upload by its carrier, so you can use the same document type for each carrier without specifying the carrier in the extraction request."
              },
              {
                "name": "environment",
                "value": "",
                "type": "query",
                "description": "If you specify `development`, extracts preferentially using config versions published to the development environment in the Sensible app. The extraction runs all configs in the doc type before picking the best fit. For each config, falls back to production version if no development version of the config exists."
              },
              {
                "name": "document_name",
                "value": "test.pdf",
                "type": "query",
                "description": "If you specify the filename of the document using this parameter, then Sensible returns the filename in the extraction response."
              },
              {
                "name": "config_name",
                "value": "anyco_insurance_auto_declarations",
                "type": "path",
                "description": "User-friendly name of the config to use to extract data from the document."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint's behavior is identical to the [Extract doc at a Sensible URL](https://docs.sensible.so/reference/generate-an-upload-url) endpoint's behavior, except that Sensible uses the specified config to extract data from the document instead of automatically choosing the best-scoring extraction in the document type.\n"
        },
        {
          "info": {
            "name": "Extract doc at your URL using config",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sensible.so/v0/extract_from_url/:document_type/:config_name",
            "params": [
              {
                "name": "document_type",
                "value": "senseml_basics",
                "type": "path",
                "description": "Type of document to extract from. Create your custom type in the Sensible app (for example, `rate_confirmation`, `certificate_of_insurance`, or `home_inspection_report`). To quickly test this endpoint using the `Try It` button in this interactive explorer, use the `senseml_basics` tutorial document type with this [example document](https://raw.githubusercontent.com/sensible-hq/sensible-docs/v0/assets/pdfs/1_extract_your_first_data.pdf). As a convenience, Sensible automatically detects the best-fit extraction from among the extraction queries (\"configs\") in the document type. For example, if you create an `auto_insurance_quotes` document type, you can add `carrier 1`, `carrier 2`, and `carrier 3` configs to the document type in the Sensible app. Sensible then automatically classifies each document you upload by its carrier, so you can use the same document type for each carrier without specifying the carrier in the extraction request."
              },
              {
                "name": "environment",
                "value": "",
                "type": "query",
                "description": "If you specify `development`, extracts preferentially using config versions published to the development environment in the Sensible app. The extraction runs all configs in the doc type before picking the best fit. For each config, falls back to production version if no development version of the config exists."
              },
              {
                "name": "document_name",
                "value": "test.pdf",
                "type": "query",
                "description": "If you specify the filename of the document using this parameter, then Sensible returns the filename in the extraction response."
              },
              {
                "name": "config_name",
                "value": "anyco_insurance_auto_declarations",
                "type": "path",
                "description": "User-friendly name of the config to use to extract data from the document."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint's behavior is identical to the [Extract doc at your URL](https://docs.sensible.so/reference/extract-from-url) endpoint's behavior, except that Sensible uses the specified config to extract data from the document instead of automatically choosing the best-scoring extraction in the document type.\n"
        }
      ]
    }
  ],
  "bundled": true
}