Harvest API in Wasabi AiR

The Harvest API enables you to manually trigger harvests, rather than waiting for internal processes to decide the best time for harvesting to take place. Through the same API, you can 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}"],
	"profile_id": "{profile_id}",
	"override_extractors": {bool},
	"new_extractors_only": {bool},
	"force": {bool},
	"priority": {priority}
}

• location_id - (string) The ID of the location of the item.
• item_id - (string) The ID for the item to harvest. (For more information, see the Items API and the Stow Project homepage).
• extractors - (array of strings) The extractor(s) to run (as listed below). If you are calling extractors to run, you must first configure them on the Extractors page in the user interface.
• profile_id - (string) The ID of the extractor profile being used for analysis. If omitted, the extractor profile set for a container is used.
• override_extractors - (bool) If true, the requested extractors run whether or not the extractor is enabled. If false, the requested extractors run only if enabled in the user interface.
• new_extractors_only - (bool) If true, extractors run only if they were enabled since the item/container was last harvested. Previously run extractors do not run again.
• force - (bool) An indication of whether or not to force the harvesting. If true, harvesting happens regardless of the etag field; otherwise, the item is harvested only 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 are assigned a priority of 5. Any values <= 0 are assigned a priority of 5. Any values > 10 are 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}"],
	"profile_id": "{profile_id}",
	"override_extractors": {bool},
	"new_extractors_only": {bool},
	"force": {bool},
	"ignore_recently_walked": {bool},
	"priority": {priority}
}

• location_id - (string) The ID of the location of the container.
• container_id - (string) The ID of the container to harvest.
• extractors - (array of strings) The extractor(s) to run (as listed below). If you are calling extractors to run, you must first configure them on the Extractors page in the user interface.
• profile_id - (string) The ID of the extractor profile being used for analysis. If omitted, the extractor profile set for the container is used.
• override_extractors - (bool) If true, the requested extractors run whether or not the extractor is enabled. If false, the requested extractors runs only if enabled in the user interface.
• new_extractors_only - (bool) If true, extractors run only if they were enabled since the item/container was last harvested. Previously run extractors do not run again.
• force - (bool) An indication of whether or not to force the harvesting. If true, harvesting happens regardless of the etag field; otherwise, the items are harvested only if they have changed since the last harvest.
• ignore_recently_walked - (bool) If true, it ignores if the container has been recently walked or not.
• priority - (int 1 to 10) The priority of the harvest (1=highest priority, 10=lowest priority). Harvest requests without a priority specified are assigned a priority of 5. Any values <= 0 are assigned a priority of 5. Any values > 10 are set to 10.

Extractors

Use the API Name when specifying the extractors to run.