Run Pipeline | Documentation

💧 Instill VDP allows you to run your pipelines either in the Pipeline Editor page, in the Pipeline Overview page, or via an API Endpoint.

#Run in the Pipeline Overview Page

Proceed to a pipeline card on the Pipelines page in the console:

Provide the necessary data or upload files as inputs.
Click the Run button to run the pipeline and receive the results.

#Run in the Pipeline Editor Page

To activate your pipeline, adhere to these instructions:

Press the Save located at the top-right corner of the Pipeline Editor page to preserve your progress.
Provide the necessary data or upload files as inputs.
Click the Run button to run the pipeline and receive the results.

#Run via API Endpoint

Running a pipeline via API Endpoint in 💧 Instill VDP is straightforward. You can find the cURL snippet in Pipeline Editor > Toolkit > Trigger Snippet tab.

#Steps to Run Pipeline

Navigate to the Pipeline Editor interface:
- Proceed to the Toolkit > Trigger Snippet tab to locate the cURL snippet.
Set up the API Request:
- Confirm that you have the correct API Endpoint, USER_ID, PIPELINE_ID, and API_TOKEN.
- Arrange the data payload with the necessary fields.
Send the API Request:
- Utilize the supplied cURL command to send a POST request to the API endpoint.
- Check the response to confirm the successful run of the pipeline.

Please make sure to correctly configure the required values:

Authentication: Verify that your API_TOKEN is valid and possesses the required permissions to activate the pipeline. To learn how to create and manage your API Tokens, refer to the API Token Management page.
Data Formatting: Comply with the standard JSON format as outlined in the API document.

By adhering to these instructions, you can incorporate the pipeline run into your existing data workflows.

#Limitation

Currently, the maximum upload size of each request is 32MB. However, when using HTTP to send the request, base64 encoding for binary files reduces the effective maximum upload size to approximately 24MB.

#Example API Request

Please consult the Introduction for guidance on setting up the pipeline recipe. For example, if your pipeline specifies an input variable prompt and an output answer, the corresponding API request command would be:

curl -X POST 'https://api.instill.tech/v1beta/users/USER_ID/pipelines/PIPELINE_ID/trigger' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_TOKEN' \
--data '{
  "data": [
    {
      "variable": {
        "prompt": "hello world"
      }
    }
  ]
}'

This command sends a POST request to run the pipeline, with the variable prompt set to "hello world".

#Corresponding Response

The corresponding response for the above API request will be:

{
  "output": [
    {
      "answer": "Hello user"
    }
  ]
}