Start an asynchronous download

Download result of an analysis previously run.

POST

https://api.textreveal.com/api/2.0/analyze/{id}/download

The asynchronous download feature is recommended for larger datasets (beyond 2,000 documents).

Parameters

id*uuid
The unique identifier of the analysis.

Request Body

conceptsstring[]
Detected concept in the documents. This concept must be part of the instance.
Example: "environment"
dateobject
Extract date of the documents. Must be within the instance's date range.
Example: {"end":"2019-02-01", "start":"2019-02-01"}
entitiesstring[]
Detected entity in the documents. This entity must be part of the instance.
Example: "apple"
fields(string (enum))[]
List of fields to be extracted in documents.
Values: "concepts", "document_entity_negative", "document_entity_neutral", "document_entity_polarity", "document_entity_positive", "document_negative", "document_neutral", "document_polarity", "document_positive", "entities", "extract_date", "id", "language", "mentions", "qscore", "sentences", "thread", "title", "url", "summary"
limitinteger | object
sortobject

Request

{
  "concepts": [
    "environment"
  ],
  "date": {
    "end": "2019-02-01",
    "start": "2019-02-01"
  },
  "entities": [
    "apple"
  ],
  "fields": [
    "title"
  ],
  "limit": 500,
  "sort": {
    "field": "document_polarity",
    "order": "ASC"
  }
}

Response - 200

A download hash

hashstring
The hash of launched download
Example: "9a8b7c5d6e"

Response

{
  "hash": "9a8b7c5d6e"
}

Response - 202

The instance is still in progress. Retry later.

Response - 204

No content. The instance can be stopped, failed or having no data to download.