{"info":{"_postman_id":"eab919c8-bb24-00a7-f635-0b40e2d767a9","name":"Diligen API Documentation","description":"

The Diligen API provides a set of methods for document analysis and text classification in general.

\n

Overview

\n

All methods require that both the Content-Type and Accept headers be set as application/json. All methods return a standard API response.

\n

A successful response from the API looks like this:

\n
{\n    \"status\": 200,\n    \"data\": \"Data can be any type of object.\"\n}\n

An unsuccessful response from the API looks like this:

\n
{\n    \"status\": 404,\n    \"error\": {\n        \"code\": 404,\n        \"message\": \"Document URL not found.\"\n    }\n}\n\n

The data and error sections do not co-exist in a given response.

\n

Authentication and API URL

\n

auth_token Access Key

\n

The access key, known as an auth_token, is required to use the Diligen API and must be sent with each request to the API.

\n

You can retrieve your access key at https://YOUR_SUBDOMAIN.diligen.com/diligenapi. If that page does not show an access key, you must first enable API access with a request to help@diligen.com.

\n

With each API request, pass the auth_token in the header. The value corresponding to the auth_token must be prepended by Bearer (see the sample requests for an example).

\n

client_id

\n

Each API user has a client_id. This must be passed in the header client_id with each request. The client_id is usually the subdomain associated with your account, ie. YOUR_SUBDOMAIN in https://YOUR_SUBDOMAIN.diligen.com/.

\n

When using the examples below, replace the URL YOUR_SUBDOMAIN.api.diligen.com with the diligen.com subdomain associated with your API account. Examples below that have the api.diligen.com subdomain are valid for all users and do not need to be substituted with your account's particular subdomain.

\n

Error Codes

\n

Standard HTTP status codes are used to document errors. The expected error code is different for each method and documented separately below.

\n

Rate Limits

\n

The /extract, /analyze and /classify methods have a rate limit of 100 requests per second. These methods process requests asynchronously, so multiple requests can be submitted to the API at once without waiting for a response from the API.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication and API URL","slug":"authentication-and-api-url"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate Limits","slug":"rate-limits"}],"owner":"3888993","collectionId":"eab919c8-bb24-00a7-f635-0b40e2d767a9","publishedId":"RVnWhKBx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2783FF"},"publishDate":"2018-04-04T15:04:17.000Z"},"item":[{"name":"extract","id":"f740573f-5afd-8010-4198-9603592bc7b7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"path\":\"http://www.pdf995.com/samples/pdf.pdf\"\n}"},"url":"https://api.diligen.com/extract","description":"

Given a path to a PDF file, this method extracts text along with its formatting. It also reconstructs paragraphs and detects header/footer text.

\n

The path variable can be to any URL.

\n

The possible error codes for this method are 404 - Not Found when the path does not exists, 504 - Timeout when it takes too long to parse the document, 500 - Internal Server Error, and 400 - Bad request when the request body is not valid.

\n

See examples on the right for more details.

\n","urlObject":{"protocol":"https","path":["extract"],"host":["api","diligen","com"],"query":[],"variable":[]}},"response":[{"id":"57afd857-6ec5-1451-9899-0b5f95559096","name":"extract [success]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"path\":\"http://www.pdf995.com/samples/pdf.pdf\"\n}"},"url":"https://api.diligen.com/extract"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 17:50:25 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\" : 200,\r\n \"data\" : {\r\n \"metadata\" : {\r\n \"creator\" : \"Microsoft® Word 2016\",\r\n \"margin\" : {\r\n \"top\" : 0,\r\n \"bottom\" : 0,\r\n \"left\" : 72,\r\n \"right\" : 87\r\n },\r\n \"number_of_pages\" : 1,\r\n \"author\" : \"harun\",\r\n \"modification_date\" : \"Fri Mar 09 12:48:28 EST 2018\",\r\n \"producer\" : \"Microsoft® Word 2016\",\r\n \"language\" : \"en-US\",\r\n \"creation_date\" : \"Fri Mar 09 12:48:28 EST 2018\"\r\n },\r\n \"segments\" : [ {\r\n \"index\" : 0,\r\n \"lines\" : [ {\r\n \"index\" : 0,\r\n \"text\" : \"Sample Loan Agreement \",\r\n \"margins\" : {\r\n \"left\" : 242,\r\n \"right\" : 242,\r\n \"top\" : 83,\r\n \"bottom\" : 88\r\n },\r\n \"type\" : \"Heading\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 0,\r\n \"style_ranges\" : [ {\r\n \"text\" : \"Sample Loan Agreement \",\r\n \"start\" : 0,\r\n \"end\" : 22,\r\n \"styles\" : [ \"Bold\" ]\r\n } ],\r\n \"font_size\" : 12.0,\r\n \"font_name\" : \"TimesNewRomanPS-BoldMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 242,\r\n \"right\" : 242,\r\n \"top\" : 83,\r\n \"bottom\" : 88\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Center\",\r\n \"type\" : \"Heading\",\r\n \"text\" : \"Sample Loan Agreement \"\r\n }, {\r\n \"index\" : 1,\r\n \"lines\" : [ {\r\n \"index\" : 1,\r\n \"text\" : \" \",\r\n \"margins\" : {\r\n \"left\" : 306,\r\n \"right\" : 303,\r\n \"top\" : 96,\r\n \"bottom\" : 101\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 1,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 306,\r\n \"right\" : 303,\r\n \"top\" : 96,\r\n \"bottom\" : 101\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Center\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \" \"\r\n }, {\r\n \"index\" : 2,\r\n \"lines\" : [ {\r\n \"index\" : 2,\r\n \"text\" : \"Dated July 29, 2011 \",\r\n \"margins\" : {\r\n \"left\" : 261,\r\n \"right\" : 261,\r\n \"top\" : 108,\r\n \"bottom\" : 113\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 2,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 261,\r\n \"right\" : 261,\r\n \"top\" : 108,\r\n \"bottom\" : 113\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Center\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \"Dated July 29, 2011 \"\r\n }, {\r\n \"index\" : 3,\r\n \"lines\" : [ {\r\n \"index\" : 3,\r\n \"text\" : \" \",\r\n \"margins\" : {\r\n \"left\" : 306,\r\n \"right\" : 303,\r\n \"top\" : 121,\r\n \"bottom\" : 126\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 3,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 306,\r\n \"right\" : 303,\r\n \"top\" : 121,\r\n \"bottom\" : 126\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Center\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \" \"\r\n }, {\r\n \"index\" : 4,\r\n \"lines\" : [ {\r\n \"index\" : 4,\r\n \"text\" : \"By and Between \",\r\n \"margins\" : {\r\n \"left\" : 269,\r\n \"right\" : 269,\r\n \"top\" : 133,\r\n \"bottom\" : 138\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 4,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 269,\r\n \"right\" : 269,\r\n \"top\" : 133,\r\n \"bottom\" : 138\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Center\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \"By and Between \"\r\n }, {\r\n \"index\" : 5,\r\n \"lines\" : [ {\r\n \"index\" : 5,\r\n \"text\" : \" \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 146,\r\n \"bottom\" : 151\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 5,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 146,\r\n \"bottom\" : 151\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \" \"\r\n }, {\r\n \"index\" : 6,\r\n \"lines\" : [ {\r\n \"index\" : 6,\r\n \"text\" : \"George Brown and My Company, Inc. \",\r\n \"margins\" : {\r\n \"left\" : 216,\r\n \"right\" : 226,\r\n \"top\" : 159,\r\n \"bottom\" : 164\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 6,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 216,\r\n \"right\" : 226,\r\n \"top\" : 159,\r\n \"bottom\" : 164\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Center\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \"George Brown and My Company, Inc. \"\r\n }, {\r\n \"index\" : 7,\r\n \"lines\" : [ {\r\n \"index\" : 7,\r\n \"text\" : \" \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 171,\r\n \"bottom\" : 176\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 7,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 171,\r\n \"bottom\" : 176\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \" \"\r\n }, {\r\n \"index\" : 8,\r\n \"lines\" : [ {\r\n \"index\" : 8,\r\n \"text\" : \"Terms of the Loan Agreement: \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 394,\r\n \"top\" : 184,\r\n \"bottom\" : 189\r\n },\r\n \"type\" : \"Heading\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 8,\r\n \"style_ranges\" : [ {\r\n \"text\" : \"Terms of the Loan Agreement: \",\r\n \"start\" : 0,\r\n \"end\" : 29,\r\n \"styles\" : [ \"Bold\" ]\r\n } ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPS-BoldMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 394,\r\n \"top\" : 184,\r\n \"bottom\" : 189\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Heading\",\r\n \"text\" : \"Terms of the Loan Agreement: \"\r\n }, {\r\n \"index\" : 9,\r\n \"lines\" : [ {\r\n \"index\" : 9,\r\n \"text\" : \" \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 197,\r\n \"bottom\" : 202\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 9,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 197,\r\n \"bottom\" : 202\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \" \"\r\n }, {\r\n \"index\" : 10,\r\n \"lines\" : [ {\r\n \"index\" : 10,\r\n \"text\" : \"1. Mr. Brown may provide Loans to My Company Inc. from time to time to help pay for company \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 107,\r\n \"top\" : 209,\r\n \"bottom\" : 214\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : false,\r\n \"index_in_page\" : 10,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n }, {\r\n \"index\" : 11,\r\n \"text\" : \"expenses. \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 497,\r\n \"top\" : 222,\r\n \"bottom\" : 227\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 11,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 497,\r\n \"top\" : 209,\r\n \"bottom\" : 227\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \"1. Mr. Brown may provide Loans to My Company Inc. from time to time to help pay for company expenses. \"\r\n }, {\r\n \"index\" : 11,\r\n \"lines\" : [ {\r\n \"index\" : 12,\r\n \"text\" : \" \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 235,\r\n \"bottom\" : 240\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 12,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 235,\r\n \"bottom\" : 240\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \" \"\r\n }, {\r\n \"index\" : 12,\r\n \"lines\" : [ {\r\n \"index\" : 13,\r\n \"text\" : \"2. The Loans are noninterest bearing and payable to Mr. Brown upon demand. \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 194,\r\n \"top\" : 247,\r\n \"bottom\" : 252\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 13,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 194,\r\n \"top\" : 247,\r\n \"bottom\" : 252\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \"2. The Loans are noninterest bearing and payable to Mr. Brown upon demand. \"\r\n }, {\r\n \"index\" : 13,\r\n \"lines\" : [ {\r\n \"index\" : 14,\r\n \"text\" : \" \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 260,\r\n \"bottom\" : 265\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 14,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 537,\r\n \"top\" : 260,\r\n \"bottom\" : 265\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \" \"\r\n }, {\r\n \"index\" : 14,\r\n \"lines\" : [ {\r\n \"index\" : 15,\r\n \"text\" : \"3. Mr. Brown does not have any obligation to provide Loans to My Company and may do so only if he \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 87,\r\n \"top\" : 273,\r\n \"bottom\" : 278\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : false,\r\n \"index_in_page\" : 15,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n }, {\r\n \"index\" : 16,\r\n \"text\" : \"wishes. \",\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 507,\r\n \"top\" : 285,\r\n \"bottom\" : 290\r\n },\r\n \"type\" : \"Paragraph\",\r\n \"eol\" : true,\r\n \"index_in_page\" : 16,\r\n \"style_ranges\" : [ ],\r\n \"font_size\" : 11.0,\r\n \"font_name\" : \"TimesNewRomanPSMT\"\r\n } ],\r\n \"prev\" : -1,\r\n \"next\" : -1,\r\n \"margins\" : {\r\n \"left\" : 72,\r\n \"right\" : 507,\r\n \"top\" : 273,\r\n \"bottom\" : 290\r\n },\r\n \"page_number\" : 1,\r\n \"page_width\" : 612.0,\r\n \"page_height\" : 792.0,\r\n \"alignment\" : \"Left\",\r\n \"type\" : \"Paragraph\",\r\n \"text\" : \"3. Mr. Brown does not have any obligation to provide Loans to My Company and may do so only if he wishes. \"\r\n } ]\r\n }\r\n}"},{"id":"a8cee2e9-498e-5691-e449-92c600317ba2","name":"extract [not found]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"path\":\"http://www.pdf995.com/samples/pdf.pdf\"\n}"},"url":"https://api.diligen.com/extract"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 17:53:22 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"error\": {\n \"code\": 404,\n \"message\": \"File not found.\"\n }\n}"},{"id":"bcbe8969-96b0-61ea-f4dd-7920e7354188","name":"extract [timeout]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"path\":\"http://www.pdf995.com/samples/pdf.pdf\"\n}"},"url":"https://api.diligen.com/extract"},"status":"Gateway Timeout","code":504,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 18:17:26 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.4.v20170414)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 504,\n \"error\": {\n \"code\": 504,\n \"message\": \"Pdf parsing failed due to timeout.\"\n }\n}"}],"_postman_id":"f740573f-5afd-8010-4198-9603592bc7b7"},{"name":"meta","id":"79e8dd74-113a-aa84-7ed0-0ed9c140d870","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"path\":\"http://www.pdf995.com/samples/pdf.pdf\"\n}"},"url":"https://api.diligen.com/meta","description":"

Given a path, this method extracts meta data from the document.

\n

This method is a subset of the extract method. The extract method returns all the segments and a metadata section. If you just need the document's metadata, this can be obtained with this method without having to parse the entire document.

\n

The path variable can be a valid URL.

\n

The possible error codes for this method are 404 - Not Found when the path does not exists, 500 - Internal Server Error, and 400 - Bad request when the request body is not valid.

\n

See examples on the right for more details.

\n","urlObject":{"protocol":"https","path":["meta"],"host":["api","diligen","com"],"query":[],"variable":[]}},"response":[{"id":"b6f53f6b-2611-0be3-2f8f-da2ebc2d7e3b","name":"meta [success]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"path\":\"http://www.pdf995.com/samples/pdf.pdf\"\n}"},"url":"https://api.diligen.com/meta"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 09 Mar 2018 17:50:49 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"creator\": \"Microsoft® Word 2016\",\n \"number_of_pages\": 1,\n \"author\": \"harun\",\n \"modification_date\": \"Fri Mar 09 12:48:28 EST 2018\",\n \"producer\": \"Microsoft® Word 2016\",\n \"language\": \"en-US\",\n \"creation_date\": \"Fri Mar 09 12:48:28 EST 2018\"\n }\n}"}],"_postman_id":"79e8dd74-113a-aa84-7ed0-0ed9c140d870"},{"name":"classify","id":"22bddf4f-94b2-3f04-2db9-f91ae3e79ae0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"model\": \"my_model\",\n \"contents\": [\n \"This is paragraph 1.\",\n \"This is paragraph 2.\",\n \"This is paragraph 3.\"\n ]\n}"},"url":"https://YOUR_SUBDOMAIN.diligen.com/classify","description":"

Given the id of a classifier model and a list of string values, this method returns the predicted classes of each string for that model. For samples responses on success and failure, see the examples on the right panel.

\n

In the URL above, replace foo with the subdomain associated with your Diligen account.

\n","urlObject":{"protocol":"https","path":["classify"],"host":["YOUR_SUBDOMAIN","diligen","com"],"query":[],"variable":[]}},"response":[{"id":"048405be-def8-5e2c-1db0-64e12116ff80","name":"classify [success]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"model\": \"my_model\",\n \"contents\": [\n \"This is paragraph 1.\",\n \"This is paragraph 2.\",\n \"This is paragraph 3.\"\n ]\n}"},"url":"https://YOUR_SUBDOMAIN.diligen.com/classify"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 16:44:11 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": [\n {\n \"0\": 0.9913275834716618,\n \"1\": 0.008672416528338167\n },\n {\n \"0\": 0.9913275834716618,\n \"1\": 0.008672416528338167\n },\n {\n \"0\": 0.9913275834716618,\n \"1\": 0.008672416528338167\n }\n ]\n}"},{"id":"b8abd614-bce4-d1da-0313-586713764fdc","name":"classify [failure] (model not found)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"model\": \"my_model\",\n \"contents\": [\n \"This is paragraph 1.\",\n \"This is paragraph 2.\",\n \"This is paragraph 3.\"\n ]\n}"},"url":"https://YOUR_SUBDOMAIN.diligen.com/classify"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 16:44:11 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\" : 404,\r\n \"error\" : {\r\n \"code\" : 404,\r\n \"message\" : \"Model \\\"my_model\\\" not found\",\r\n \"errors\" : null\r\n }\r\n}"}],"_postman_id":"22bddf4f-94b2-3f04-2db9-f91ae3e79ae0"},{"name":"analyze","id":"ef56aa8b-a00e-ade8-b35d-b6491682eb03","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"clauses","value":"item1; item2; item3"},{"key":"client_id","value":"YOUR_ID"},{"key":"auth_token","value":"Bearer YOUR_KEY"}],"body":{"mode":"raw","raw":"{\n \"status\": 200,\n \"data\": {\n \"metadata\": {\n \"creator\": \"Microsoft® Word 2016\",\n \"margin\": {\n \"top\": 0,\n \"bottom\": 0,\n \"left\": 72,\n \"right\": 87\n },\n \"number_of_pages\": 1,\n \"author\": \"harun\",\n \"modification_date\": \"Fri Mar 09 12:48:28 EST 2018\",\n \"producer\": \"Microsoft® Word 2016\",\n \"language\": \"en-US\",\n \"creation_date\": \"Fri Mar 09 12:48:28 EST 2018\"\n },\n \"segments\": [\n {\n \"index\": 0,\n \"lines\": [\n {\n \"index\": 0,\n \"text\": \"Sample Loan Agreement \",\n \"margins\": {\n \"left\": 242,\n \"right\": 242,\n \"top\": 83,\n \"bottom\": 88\n },\n \"type\": \"Heading\",\n \"eol\": true,\n \"index_in_page\": 0,\n \"style_ranges\": [\n {\n \"text\": \"Sample Loan Agreement \",\n \"start\": 0,\n \"end\": 22,\n \"styles\": [\n \"Bold\"\n ]\n }\n ],\n \"font_size\": 12,\n \"font_name\": \"TimesNewRomanPS-BoldMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 242,\n \"right\": 242,\n \"top\": 83,\n \"bottom\": 88\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Heading\",\n \"text\": \"Sample Loan Agreement \"\n },\n {\n \"index\": 1,\n \"lines\": [\n {\n \"index\": 1,\n \"text\": \" \",\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 96,\n \"bottom\": 101\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 1,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 96,\n \"bottom\": 101\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 2,\n \"lines\": [\n {\n \"index\": 2,\n \"text\": \"Dated July 29, 2011 \",\n \"margins\": {\n \"left\": 261,\n \"right\": 261,\n \"top\": 108,\n \"bottom\": 113\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 2,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 261,\n \"right\": 261,\n \"top\": 108,\n \"bottom\": 113\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \"Dated July 29, 2011 \"\n },\n {\n \"index\": 3,\n \"lines\": [\n {\n \"index\": 3,\n \"text\": \" \",\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 121,\n \"bottom\": 126\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 3,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 121,\n \"bottom\": 126\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 4,\n \"lines\": [\n {\n \"index\": 4,\n \"text\": \"By and Between \",\n \"margins\": {\n \"left\": 269,\n \"right\": 269,\n \"top\": 133,\n \"bottom\": 138\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 4,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 269,\n \"right\": 269,\n \"top\": 133,\n \"bottom\": 138\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \"By and Between \"\n },\n {\n \"index\": 5,\n \"lines\": [\n {\n \"index\": 5,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 146,\n \"bottom\": 151\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 5,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 146,\n \"bottom\": 151\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 6,\n \"lines\": [\n {\n \"index\": 6,\n \"text\": \"George Brown and My Company, Inc. \",\n \"margins\": {\n \"left\": 216,\n \"right\": 226,\n \"top\": 159,\n \"bottom\": 164\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 6,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 216,\n \"right\": 226,\n \"top\": 159,\n \"bottom\": 164\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \"George Brown and My Company, Inc. \"\n },\n {\n \"index\": 7,\n \"lines\": [\n {\n \"index\": 7,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 171,\n \"bottom\": 176\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 7,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 171,\n \"bottom\": 176\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 8,\n \"lines\": [\n {\n \"index\": 8,\n \"text\": \"Terms of the Loan Agreement: \",\n \"margins\": {\n \"left\": 72,\n \"right\": 394,\n \"top\": 184,\n \"bottom\": 189\n },\n \"type\": \"Heading\",\n \"eol\": true,\n \"index_in_page\": 8,\n \"style_ranges\": [\n {\n \"text\": \"Terms of the Loan Agreement: \",\n \"start\": 0,\n \"end\": 29,\n \"styles\": [\n \"Bold\"\n ]\n }\n ],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPS-BoldMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 394,\n \"top\": 184,\n \"bottom\": 189\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Heading\",\n \"text\": \"Terms of the Loan Agreement: \"\n },\n {\n \"index\": 9,\n \"lines\": [\n {\n \"index\": 9,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 197,\n \"bottom\": 202\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 9,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 197,\n \"bottom\": 202\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 10,\n \"lines\": [\n {\n \"index\": 10,\n \"text\": \"1. Mr. Brown may provide Loans to My Company Inc. from time to time to help pay for company \",\n \"margins\": {\n \"left\": 72,\n \"right\": 107,\n \"top\": 209,\n \"bottom\": 214\n },\n \"type\": \"Paragraph\",\n \"eol\": false,\n \"index_in_page\": 10,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n },\n {\n \"index\": 11,\n \"text\": \"expenses. \",\n \"margins\": {\n \"left\": 72,\n \"right\": 497,\n \"top\": 222,\n \"bottom\": 227\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 11,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 497,\n \"top\": 209,\n \"bottom\": 227\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \"1. Mr. Brown may provide Loans to My Company Inc. from time to time to help pay for company expenses. \"\n },\n {\n \"index\": 11,\n \"lines\": [\n {\n \"index\": 12,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 235,\n \"bottom\": 240\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 12,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 235,\n \"bottom\": 240\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 12,\n \"lines\": [\n {\n \"index\": 13,\n \"text\": \"2. The Loans are noninterest bearing and payable to Mr. Brown upon demand. \",\n \"margins\": {\n \"left\": 72,\n \"right\": 194,\n \"top\": 247,\n \"bottom\": 252\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 13,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 194,\n \"top\": 247,\n \"bottom\": 252\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \"2. The Loans are noninterest bearing and payable to Mr. Brown upon demand. \"\n },\n {\n \"index\": 13,\n \"lines\": [\n {\n \"index\": 14,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 260,\n \"bottom\": 265\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 14,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 260,\n \"bottom\": 265\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 14,\n \"lines\": [\n {\n \"index\": 15,\n \"text\": \"3. Mr. Brown does not have any obligation to provide Loans to My Company and may do so only if he \",\n \"margins\": {\n \"left\": 72,\n \"right\": 87,\n \"top\": 273,\n \"bottom\": 278\n },\n \"type\": \"Paragraph\",\n \"eol\": false,\n \"index_in_page\": 15,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n },\n {\n \"index\": 16,\n \"text\": \"wishes. \",\n \"margins\": {\n \"left\": 72,\n \"right\": 507,\n \"top\": 285,\n \"bottom\": 290\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 16,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 507,\n \"top\": 273,\n \"bottom\": 290\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \"3. Mr. Brown does not have any obligation to provide Loans to My Company and may do so only if he wishes. \"\n }\n ]\n }\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/analyze","description":"

This method returns the result of a complete analysis on a given document. The response of the extract method can be used directly as a request body for this method.

\n

The request should specify a list of desired clauses. The values for this key should be provided in a list separated by a semi-colon. See the example request. Not specifying the clauses value will return all clauses, but this action may result in timeouts for larger documents as there is a large number of available clauses.

\n

See examples on the right for details.

\n","urlObject":{"protocol":"https","path":["analyze"],"host":["YOUR_SUBDOMAIN","api","diligen","com"],"query":[],"variable":[]}},"response":[{"id":"063037fa-5a1d-168d-c114-bca23ff446ea","name":"analyze [success]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"},{"key":"clauses","value":"my_clause1; my_clause2; my_clause3; my_clause4"}],"body":{"mode":"raw","raw":"{\n \"status\": 200,\n \"data\": {\n \"metadata\": {\n \"creator\": \"Microsoft® Word 2016\",\n \"margin\": {\n \"top\": 0,\n \"bottom\": 0,\n \"left\": 72,\n \"right\": 87\n },\n \"number_of_pages\": 1,\n \"author\": \"harun\",\n \"modification_date\": \"Fri Mar 09 12:48:28 EST 2018\",\n \"producer\": \"Microsoft® Word 2016\",\n \"language\": \"en-US\",\n \"creation_date\": \"Fri Mar 09 12:48:28 EST 2018\"\n },\n \"segments\": [\n {\n \"index\": 0,\n \"lines\": [\n {\n \"index\": 0,\n \"text\": \"Sample Loan Agreement \",\n \"margins\": {\n \"left\": 242,\n \"right\": 242,\n \"top\": 83,\n \"bottom\": 88\n },\n \"type\": \"Heading\",\n \"eol\": true,\n \"index_in_page\": 0,\n \"style_ranges\": [\n {\n \"text\": \"Sample Loan Agreement \",\n \"start\": 0,\n \"end\": 22,\n \"styles\": [\n \"Bold\"\n ]\n }\n ],\n \"font_size\": 12,\n \"font_name\": \"TimesNewRomanPS-BoldMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 242,\n \"right\": 242,\n \"top\": 83,\n \"bottom\": 88\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Heading\",\n \"text\": \"Sample Loan Agreement \"\n },\n {\n \"index\": 1,\n \"lines\": [\n {\n \"index\": 1,\n \"text\": \" \",\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 96,\n \"bottom\": 101\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 1,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 96,\n \"bottom\": 101\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 2,\n \"lines\": [\n {\n \"index\": 2,\n \"text\": \"Dated July 29, 2011 \",\n \"margins\": {\n \"left\": 261,\n \"right\": 261,\n \"top\": 108,\n \"bottom\": 113\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 2,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 261,\n \"right\": 261,\n \"top\": 108,\n \"bottom\": 113\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \"Dated July 29, 2011 \"\n },\n {\n \"index\": 3,\n \"lines\": [\n {\n \"index\": 3,\n \"text\": \" \",\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 121,\n \"bottom\": 126\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 3,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 306,\n \"right\": 303,\n \"top\": 121,\n \"bottom\": 126\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 4,\n \"lines\": [\n {\n \"index\": 4,\n \"text\": \"By and Between \",\n \"margins\": {\n \"left\": 269,\n \"right\": 269,\n \"top\": 133,\n \"bottom\": 138\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 4,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 269,\n \"right\": 269,\n \"top\": 133,\n \"bottom\": 138\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \"By and Between \"\n },\n {\n \"index\": 5,\n \"lines\": [\n {\n \"index\": 5,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 146,\n \"bottom\": 151\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 5,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 146,\n \"bottom\": 151\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 6,\n \"lines\": [\n {\n \"index\": 6,\n \"text\": \"George Brown and My Company, Inc. \",\n \"margins\": {\n \"left\": 216,\n \"right\": 226,\n \"top\": 159,\n \"bottom\": 164\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 6,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 216,\n \"right\": 226,\n \"top\": 159,\n \"bottom\": 164\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Center\",\n \"type\": \"Paragraph\",\n \"text\": \"George Brown and My Company, Inc. \"\n },\n {\n \"index\": 7,\n \"lines\": [\n {\n \"index\": 7,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 171,\n \"bottom\": 176\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 7,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 171,\n \"bottom\": 176\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 8,\n \"lines\": [\n {\n \"index\": 8,\n \"text\": \"Terms of the Loan Agreement: \",\n \"margins\": {\n \"left\": 72,\n \"right\": 394,\n \"top\": 184,\n \"bottom\": 189\n },\n \"type\": \"Heading\",\n \"eol\": true,\n \"index_in_page\": 8,\n \"style_ranges\": [\n {\n \"text\": \"Terms of the Loan Agreement: \",\n \"start\": 0,\n \"end\": 29,\n \"styles\": [\n \"Bold\"\n ]\n }\n ],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPS-BoldMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 394,\n \"top\": 184,\n \"bottom\": 189\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Heading\",\n \"text\": \"Terms of the Loan Agreement: \"\n },\n {\n \"index\": 9,\n \"lines\": [\n {\n \"index\": 9,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 197,\n \"bottom\": 202\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 9,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 197,\n \"bottom\": 202\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 10,\n \"lines\": [\n {\n \"index\": 10,\n \"text\": \"1. Mr. Brown may provide Loans to My Company Inc. from time to time to help pay for company \",\n \"margins\": {\n \"left\": 72,\n \"right\": 107,\n \"top\": 209,\n \"bottom\": 214\n },\n \"type\": \"Paragraph\",\n \"eol\": false,\n \"index_in_page\": 10,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n },\n {\n \"index\": 11,\n \"text\": \"expenses. \",\n \"margins\": {\n \"left\": 72,\n \"right\": 497,\n \"top\": 222,\n \"bottom\": 227\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 11,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 497,\n \"top\": 209,\n \"bottom\": 227\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \"1. Mr. Brown may provide Loans to My Company Inc. from time to time to help pay for company expenses. \"\n },\n {\n \"index\": 11,\n \"lines\": [\n {\n \"index\": 12,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 235,\n \"bottom\": 240\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 12,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 235,\n \"bottom\": 240\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 12,\n \"lines\": [\n {\n \"index\": 13,\n \"text\": \"2. The Loans are noninterest bearing and payable to Mr. Brown upon demand. \",\n \"margins\": {\n \"left\": 72,\n \"right\": 194,\n \"top\": 247,\n \"bottom\": 252\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 13,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 194,\n \"top\": 247,\n \"bottom\": 252\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \"2. The Loans are noninterest bearing and payable to Mr. Brown upon demand. \"\n },\n {\n \"index\": 13,\n \"lines\": [\n {\n \"index\": 14,\n \"text\": \" \",\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 260,\n \"bottom\": 265\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 14,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 537,\n \"top\": 260,\n \"bottom\": 265\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \" \"\n },\n {\n \"index\": 14,\n \"lines\": [\n {\n \"index\": 15,\n \"text\": \"3. Mr. Brown does not have any obligation to provide Loans to My Company and may do so only if he \",\n \"margins\": {\n \"left\": 72,\n \"right\": 87,\n \"top\": 273,\n \"bottom\": 278\n },\n \"type\": \"Paragraph\",\n \"eol\": false,\n \"index_in_page\": 15,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n },\n {\n \"index\": 16,\n \"text\": \"wishes. \",\n \"margins\": {\n \"left\": 72,\n \"right\": 507,\n \"top\": 285,\n \"bottom\": 290\n },\n \"type\": \"Paragraph\",\n \"eol\": true,\n \"index_in_page\": 16,\n \"style_ranges\": [],\n \"font_size\": 11,\n \"font_name\": \"TimesNewRomanPSMT\"\n }\n ],\n \"prev\": -1,\n \"next\": -1,\n \"margins\": {\n \"left\": 72,\n \"right\": 507,\n \"top\": 273,\n \"bottom\": 290\n },\n \"page_number\": 1,\n \"page_width\": 612,\n \"page_height\": 792,\n \"alignment\": \"Left\",\n \"type\": \"Paragraph\",\n \"text\": \"3. Mr. Brown does not have any obligation to provide Loans to My Company and may do so only if he wishes. \"\n }\n ]\n }\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/analyze"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": 200,\n \"data\": {\n \"my_clause1\": [\n {\n \"locations\": [\n {\n \"page\": 1,\n \"segment_index\": 10\n }\n ],\n }\n ],\n \"my_clause2\": [],\n \"my_clause3\": [],\n \"my_clause4\": [],\n \"contract_date\": [\n {\n \"text\": \"July 29, 2011\",\n \"locations\": [\n {\n \"page\": 1,\n \"segment_index\": 2\n }\n ],\n \"text_normalized\": \"2011-7-29\",\n \"extracted_by\": \"MonthDDYYYY\"\n }\n ],\n \"document_type\": [\n {\n \"text\": \"contract\",\n \"locations\": []\n }\n ],\n \"contract_parties\": [\n {\n \"text\": \"George Brown\",\n \"locations\": [\n {\n \"page\": 1,\n \"segment_index\": 6\n }\n ],\n \"text_normalized\": \"George Brown\"\n },\n {\n \"text\": \"My Company, Inc.\",\n \"locations\": [\n {\n \"page\": 1,\n \"segment_index\": 7\n }\n ],\n \"text_normalized\": \"My Company, Inc.\"\n }\n ],\n \"contract_name\": [\n {\n \"text\": \"Sample Loan Agreement\",\n \"locations\": [\n {\n \"page\": 1,\n \"segment_index\": 0\n }\n ],\n \"text_normalized\": \"Sample Loan Agreement\"\n }\n ]\n }\n}"}],"_postman_id":"ef56aa8b-a00e-ade8-b35d-b6491682eb03"},{"name":"train","id":"95b4d96f-9e30-4888-ac31-75739a7bad02","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"id\": \"my_model\",\n \"data\": [\n {\n \"segment\": \"Positive example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Negative example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Netagive example 3\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Positive example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 4\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n }\n ]\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/train","description":"

This method builds a model for text classification. As compared to the train2 method, this method does not require separate train and test sets. When it is not possible to seperate the dataset into test and train sets, this method can be used instead. The results will vary slighly between models, but neither method is better than the other. train2 differs in that it provides control over the composition of the train and test sets.

\n","urlObject":{"protocol":"https","path":["train"],"host":["YOUR_SUBDOMAIN","api","diligen","com"],"query":[],"variable":[]}},"response":[{"id":"b5694960-3aaa-a9d1-8070-f93489a1256c","name":"self-train [success]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"id\": \"my_model\",\n \"data\": [\n {\n \"segment\": \"Positive example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Negative example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Netagive example 3\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Positive example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 4\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n }\n ]\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/train"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 18:37:04 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\" : 200,\r\n \"data\" : \"Model is trained and saved successfully\"\r\n}"}],"_postman_id":"95b4d96f-9e30-4888-ac31-75739a7bad02"},{"name":"train2","id":"2bc2b005-545b-31a4-05e2-dd227d9d74ab","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"id\": \"my_model-v2\",\n \"name\": \"my_model\",\n \"training\": {\n \"name\": \"my_model-train\",\n \"version\": \"v2\",\n \"instances\": [\n {\n \"segment\": \"Positive example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Negative example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Netagive example 3\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n }\n ]\n },\n \"test\": {\n \"name\": \"my_model-test\",\n \"version\": \"v2\",\n \"instances\": [\n {\n \"segment\": \"Positive example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 4\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n }\n ]\n }\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/train2","description":"

Given a training and a test set, this method builds a model for text classification.

\n","urlObject":{"protocol":"https","path":["train2"],"host":["YOUR_SUBDOMAIN","api","diligen","com"],"query":[],"variable":[]}},"response":[{"id":"b97736a8-cff3-57bb-327f-40ef4d0b4957","name":"train [success]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"id\": \"my_model-v2\",\n \"name\": \"my_model\",\n \"training\": {\n \"name\": \"my_model-train\",\n \"version\": \"v2\",\n \"instances\": [\n {\n \"segment\": \"Positive example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 1\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Negative example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n },\n {\n \"segment\": \"Netagive example 3\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n }\n ]\n },\n \"test\": {\n \"name\": \"my_model-test\",\n \"version\": \"v2\",\n \"instances\": [\n {\n \"segment\": \"Positive example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\"\n },\n {\n \"segment\": \"Negative example 4\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"0\"\n }\n ]\n }\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/train2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 18:30:08 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"data\": {\n \"status\": \"success\",\n \"parameters\": {\n \"threshold\": 3,\n \"log_reg_type\": \"L1\",\n \"reg_value\": 3.0000000000000013\n },\n \"f1\": 0.3333333333333333,\n \"testSetSize\": 2,\n \"falsePositives\": {\n \"name\": \"false-positives\",\n \"version\": \"v0\",\n \"instances\": []\n },\n \"falseNegatives\": {\n \"name\": \"false-negatives\",\n \"version\": \"v0\",\n \"instances\": [\n {\n \"segment\": \"Positive example 2\",\n \"startIndex\": 0,\n \"endIndex\": 18,\n \"label\": \"1\",\n \"segmentSubstring\": \"Positive example 2\"\n }\n ]\n }\n }\n}"}],"_postman_id":"2bc2b005-545b-31a4-05e2-dd227d9d74ab"},{"name":"delete","id":"68e11a82-4714-17e8-5086-3f02a79e8c8e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"model_id\":\"my_model\"\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/delete","description":"

A model that is created with the train or the quick-train methods above can be deleted from your API by this method.

\n","urlObject":{"protocol":"https","path":["delete"],"host":["YOUR_SUBDOMAIN","api","diligen","com"],"query":[],"variable":[]}},"response":[{"id":"0bd2077b-fd14-590a-5f6d-2556eafcfde3","name":"delete [not found]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"model_id\":\"my_model\"\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/delete"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 20:54:11 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\" : 404,\r\n \"error\" : {\r\n \"code\" : 404,\r\n \"message\" : \"Model my_model not found\",\r\n \"errors\" : null\r\n }\r\n}"},{"id":"3a41a580-9696-51ae-0059-51a9781dbd1a","name":"delete [success]","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"auth_token","value":"Bearer YOUR_KEY"},{"key":"client_id","value":"YOUR_ID"}],"body":{"mode":"raw","raw":"{\n \"model_id\":\"my_model\"\n}"},"url":"https://YOUR_SUBDOMAIN.api.diligen.com/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 09 Mar 2018 18:37:52 GMT","name":"Date","description":""},{"key":"Server","value":"Jetty(9.4.z-SNAPSHOT)","name":"Server","description":""},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\" : 200,\r\n \"data\" : \"Model my_model is deleted successfully\"\r\n}"}],"_postman_id":"68e11a82-4714-17e8-5086-3f02a79e8c8e"}],"event":[{"listen":"prerequest","script":{"id":"f37a2145-aaba-428f-a27c-7c469e17bd7d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"67328a90-7fd3-417f-95d6-2df8b966a9de","type":"text/javascript","exec":[""]}}]}