Authentication Reference Overview
Get a Token
API documentation for "Get a Token" request.
Validate a Token
Validate your token, and get information about your account.
Ordering API Reference Overview
Orders Heartbeat v2
Check the heartbeat of the Orders API.
Place an Order v2
Place an Order for one or more catalog IDs to the Orders V2 API
Get Order Status v2
Get the status of an Order by Order ID. This is version 2 of the Orders API.
Place Order with Callbacks
To place an order and get a callback notification when the order has completed or failed, use the OrderCB API. If you don't need callbacks, use the Ordering V2 API.
Catalog V2 API Reference
Catalog V2 Heartbeat
Check the heartbeat of the Catalog API
Search the Catalog
Get a Record by ID
Search for a record by its identifier.
Workflow Reference API Overview
Workflows Heartbeat
Check the heartbeat of the Workflow API
Get Task Definition
Get a Task Definition from the Task Registry
List All Tasks
List all tasks in the GBDX task registry.
Register a task
Register a new task or an updated version of an existing task.
Delete a Task
Delete a task from the task registry. Deleting a task requires a version number. Only one version of a task can be deleted at a time.
List Workflows
List workflows in the GBDX workflow system
Submit a Workflow
Submit a workflow to the GBDX workflow system
Get Workflow Status
Get a Workflow by Workflow ID, see status.
Workflow status events
Get a Workflow's status events by Workflow Identifier.
Cancel a Workflow
Cancel a workflow that's running, GBDX workflow system
List workflow filters
List available filters for the workflow system
Task Definition Schema
Get the Task Definition schema from the Workflow Endpoint.
Workflow Definition Schema
Get the Workflow schema from the Workflow Endpoint.
STDOUT output from a workflow task
Retrieve STDOUT output from a completed task in a workflow
STDERR output from a workflow task
Retrieve STDERR output from a completed task in a workflow
Submit a batch workflow
Submit a batch workflow that spawns multiple workflows.
Get a batch workflow
Get a batch workflow by ID.
Cancel a batch workflow
Storage Service Guide Reference
Update a Prefix
Update a Prefix using the GBDX S3 Storage service
Get Temp S3 Creds for Prefix
Get temporary S3 credentials from the GBDX S3 Storage Service
Delete a Prefix
Delete an existing prefix using the GBDX Storage Service
Get Prefix Size
Use the GBDX S3 Storage Service to get the size of a prefix
Get Download URL for an object
Get a temporary download URL for an object using the GBDX S3 storage service
Python Examples
Python example script for sending a request to the GBDX Storage service and accessing the contents of the S3 bucket.
AnswerFactory Project Reference Overview
Overview of the AnswerFactory Project API
Check Availability of AnswerFactory Project Endpoints
AnswerFactory Project Heartbeat
Check Uniqueness of AnswerFactory Project Name
Create AnswerFactory Project
Delete AnswerFactory Project
Retrieve AnswerFactory Project
Retrieve Listing of AnswerFactory Projects for Account
Retrieve a listing of projects for the current users account
Update AnswerFactory Project
AnswerFactory Recipe Reference Overview
Overview of the AnswerFactory Recipe API
Check Availability of AnswerFactory Recipe Endpoints
AnswerFactory Recipe Heartbeat
Create a Recipe with JSON Object
Create a recipe with JSON object for recipe definition
Create a Recipe with JSON String
Create a recipe with JSON string for recipe definition
Delete a Recipe
Recipe Listing
Retrieve a short, "id, name" listing of recipes available to the current users account
Retrieve a Recipe
Retrieve Listing of Recipes for Account
Retrieve a listing of recipes available to the current users account
Send Recipe Suggestion
Send a suggestion for a new recipe/new algorithms.
Update a Recipe with JSON Object
Update a recipe with JSON object for recipe definition
Update a Recipe with JSON String
Update a recipe with JSON string for recipe definition
Recipe Runner Blueprints
Get the list of blueprints for the automated recipe builder.
Recipe Runner Blueprint Build
Run the automated recipe builder based on a selected blueprint.
AnswerFactory Answer Reference Overview
Overview of the AnswerFactory Answer API
Retrieve Answer
The response for this endpoint is usually limited to a certain number of answers (like to 1000 vectors for vector answers) to not overload user interfaces. To get full answers use the Retrieve Answer Fully endpoint.
Retrieve Answer Fully
The response for this endpoint will return all answers and could potentially overload user interfaces. To get a limited set of answers use the Retrieve Answer endpoint.
Retrieve Answer IDAHO Images
Retrieve Answer Status
Retrieve Answer Status v2
Retrieve Answer Table
Retrieve Answer TMS
WARNING: EXPERIMENTAL. The response for this endpoint will return answer as a TMS service. To stream the answer in a different format use one of the other Answer endpoints listed.
Retrieve Results
AnswerFactory Estimate Reference Overview
Overview of the AnswerFactory Estimate API
Retrieve Estimate for Existing AnswerFactory Project
Retrieve Estimate for New AnswerFactory Project
AnswerFactory Tag Reference Overview
Overview of the AnswerFactory Tagging API
Add Item to Tagged Cell
Create Tagged Cell
Remove Item to Tagged Cell
Retrieve Items for Cell
Retrieve Items for Cell and Tag
Vector Services Index Query Reference Overview
Overview of the Index Query API
Check Availability of Vector Service Endpoints
Vector Service Heartbeat
Index Query: Aggregation by Bounding Box
Groups vector items for a given index, aggregation definition, date range, and bounding box.
Index Query: Aggregation by Shape
Groups vector items for a given index, aggregation definition, date range, and shape.