Get Workflow Run

To view a workflow run, send a GET request to https://api.copy.ai/api/workflow/<workflow_id>/run/<run_id>.

You will receive a response with the details of the workflow run.

For example:

{
	"status": "success",
	"data": {
		"status": "COMPLETE",
		"input": {
			"Input 1": "Inputs vary depending on the workflow used.",
      "Input 2": "The best way to see an example is to try it!"
		},
		"output": {
			"Output 1": "Outputs vary depending on the workflow used.",
			"Output 2": "The best way to see an example is to try it!"
		},
		"metadata": {
      "api": true
    },
		"createdAt": "2023-04-06T22:34:46.704Z",
		"id": "<run_id>",
		"credits": 2
	}
}

Run Status Types

Status	Description
`NEW`	The workflow run has just been created and is ready to be queued for processing.
`WAITING`	The workflow run is waiting for required resources or conditions to be met before it can proceed.
`PROCESSING`	The workflow run is currently being executed and processed.
`COMPLETE`	The workflow run has successfully finished processing and all steps have been completed.
`RETRYING`	The workflow run encountered an issue and is retrying the failed steps(s) before proceeding.
`FAILED`	The workflow run has failed to complete due to an error, and further retries were unsuccessful.

Tracking / Poll for Progress

This endpoint can be used to check the progress of your workflow run in real-time.

You can do this by repeatedly calling the endpoint with a short delay between requests.

When the workflow is done running, the status will change to COMPLETE.