Table of contents

Harvest API

The Harvest API lets you manually trigger harvests, rather than waiting for internal processes to decide the best time for harvesting to take place.

Through the same API, you are able to harvest an individual item, or all items inside a specific container.

Harvesting a single item

To initiate a harvest of a single item, make the following request:

POST /api/control/harvest
{
	"location_id": "{location_id}",
	"item_id": "{item_id}",
	"extractors": ["{extractor1}", "{extractor2}"],
	"override_extractors": {bool},
	"new_extractors": {bool},
	"force": {bool},
	"priority": {priority}
}
  • location_id - (string) ID of the Location of the item
  • item_id - (string) The ID for the item to harvest. (For more information, see the Item Object documentation and the Stow Project Homepage)
  • extractors - (array of strings) of the extractor(s) to run. See list below. NOTE: If you are calling extractors to run, you must first configure them on the Extractors page in the UI.
  • override_extractors - (bool) If true the requested extractors will run whether or not the extractor is enabled. If false the requested extractors will only run if enabled in the UI.
  • new_extractors - (bool) If true only extractors enabled since the item/container was last harvested will run - previoulsy run extractors will not run again.
  • force - (bool) Whether to force the harvesting or not. If true harvesting will happen regardless of the etag field, otherwise the item will only be harvested if it has changed since the last harvest.
  • priority - (int 1 to 10). The priority of the harvest. 1=highest priority, 10=lowest priority. Harvest requests without a priority specified will be assigned a priority of 5. Any values <= 0 will be assigned a priority of 5. Any values > 10 will be set to 10.

Harvesting an entire container

To initiate a harvest of all items inside a container, make the following request:

POST /api/control/harvest
{
	"location_id": "{location_id}",
	"container_id": "{container_id}",
	"extractors": ["{extractor1}", "{extractor2}"],
	"override_extractors": {bool},
	"new_extractors": {bool},
	"force": {bool},
	"priority": {priority}
}
  • location_id - (string) ID of the Location of the container
  • container_id - (string) ID of the container to harvest
  • extractors - (array of strings) of the extractor(s) to run. See list below. NOTE: If you are calling extractors to run, you must first configure them on the Extractors page in the UI.
  • override_extractors - (bool) If true the requested extractors will run whether or not the extractor is enabled. If false the requested extractors will only run if enabled in the UI.
  • new_extractors - (bool) If true only extractors enabled since the item/container was last harvested will run - previoulsy run extractors will not run again.
  • force - (bool) Whether to force the harvesting or not. If true harvesting will happen regardless of the etag field, otherwise the items will only be harvested if they have changed since the last harvest.
  • priority - (int 1 to 10). The priority of the harvest. 1=highest priority, 10=lowest priority. Harvest requests without a priority specified will be assigned a priority of 5. Any values <= 0 will be assigned a priority of 5. Any values > 10 will be set to 10.

Extractors

Use the api name when specifying which extractors to run.

Extractor Name: api name

Amazon Transcribe (Speech-to-Text): amazon_transcribe

Archive: archive

Audio Info: audioinfo

Audio Peak: audiopeak

Audio Previews: audio_previews

Black Scene Detect: black_scenes

Captions: captions

CaptionsV2: captionsv2

CSV: csv

DBF: dbf

Documents: document_pages

DPX: dpx

DRM: drm

Email: email

EXIV2: exiv2

FDX: fdx

Geocoding: geocoding

Hashes: hashes

HTML: html

JSON: json

Language ID - Apptek: languageid_apptek

Language ID - Google: googlelanguage

M2TS: m2ts

MediaInfo: mediainfo

MIME Type: mime_type

OCR: ocr

OfficeX: officex

PDF: pdf

People: people

Speech-to-Text - Apptek: apptek

Speech-to-Text - Google: speech_to_text_google

Speech-to-Text - IBM Watson: speech_to_text_watson

Speech-to-Text - Microsoft: speech_to_text_microsoft

Speech-to-Text - VoiceBase: speech_to_text_voicebase

Speech-to-Text - Speechmatic: speech_to_text_speechmatic

Stow: stow

Thumbnails: thumbnailer

Tokens: tokens

Video Main Frames: video_main_frames

Video Previews: video_previews

Vision - Amazon Rekognition: amazonrekog

Vision - Google: google_vision

Vision - Kairos: kairos

Vision - LogoGrab: logograb

Vision - Microsoft: azure

Vision - PicPurify: picpurify

Vision - Valossa: valossa

Volume Detect: volumedetect

Weather: weather

XML: xml

This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.