Configure a Static API Endpoint

The static API is currently in beta.
A static API endpoint can be generated and used as an input and output for your pipeline. When an endpoint is live, you will be able to submit images to the pipeline with an API request and receive image output and predictions (if applicable) in the response.

Adding a Static API Endpoint

To add a static endpoint to your pipeline:
Use the Inputs tab to add input sources.
  1. 1.
    Navigate to the "Inputs" tab of your batch deployment.
  2. 2.
    Click the "Add Input" button on the far right. If you do not see this option, ensure you are in "Edit" mode.
  3. 3.
    Select "Static API Endpoint"
Select Static API Endpoint to accept input from an API
4. Enter a name for your input source in the Input Name field. This is how it will display in your list of input sources.
5. Under Output Data, select the method of returning images in the API response:
  • As base64 encoded images
  • As signed URLs
Click "Save Input" when complete. Your new endpoint will be generated. Click the copy icon to copy the URL to your clipboard.
Use the "copy" button to copy the API URL
Note: It may take as long as 1-2 hours for your endpoint and pipeline to be fully active and ready to accept requests.

Using the Static API Endpoint

To use your static API endpoint to process image data, please see the Static API Guide:

Removing a Static API Endpoint

Static API Endpoints can be removed through the "Inputs" tab.
  1. 1.
    Navigate to the "Inputs" tab.
  2. 2.
    Under the Connected Inputs table, find the endpoint you want to remove and click "Remove" under the Actions column.
  3. 3.
    You will be prompted to confirm the deletion. Click "Remove Input" to permanently remove the input source from your pipeline.