Get
/workflow/{workflow_id}/run
You can view the details of all workflow runs for a workflow via the API.
To view all workflow runs, send a GET request to https://api.copy.ai/api/workflow/<workflow_id>/run.
You will receive a response with the details for all runs for that workflow.
For example:
JSON
{
"status": "success",
"data":
{
"total": 2,
"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-29T15:08:01.326Z",
"id": "<run_id>",
"credits": 2
},
{
"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": null,
"createdAt": "2023-04-29T15:08:01.326Z",
"id": "<run_id>",
"credits": 2
}
]
}
}Security
API Key: ApiKeyAuth
Header parameter namex-copy-ai-api-key
Copy.ai API key for authentication
Header parameters
x-copy-ai-api-key
stringRequired
Copy.ai API key
Path parameters
workflow_id
stringRequired
ID of the workflow
Query parameters
size
integer
Number of runs to include in pagination (up to 100, defaults to 10).
Default10
page
integer
Used to specify further pages (starts at 1).
Default1
Responses
200
Success
success
{
"status": "success",
"data": {
"total": "3",
"data": [
{
"metadata": {
"interestingValue": "interestingValue"
},
"createdAt": "2023-09-27T18:24:47Z",
"id": "WRUN-6fe9e53c-945a-4aa3-a87e-d64c3cc0dcb0",
"workflowRunId": "WRUN-6fe9e53c-945a-4aa3-a87e-d64c3cc0dcb0",
"workflowId": "PKGW-d0f4f3eb-16b9-4973-8e1e-939af867ce56",
"credits": "22"
},
{
"createdAt": "2023-09-27T18:24:46.998Z",
"id": "WRUN-137a0cd4-7dc3-412d-8d1c-854bddbdc230",
"workflowRunId": "WRUN-137a0cd4-7dc3-412d-8d1c-854bddbdc230",
"workflowId": "PKGW-d0f4f3eb-16b9-4973-8e1e-939af867ce56",
"credits": "0"
}
]
}
}object
status
string
data
object
total
integer
data
Array of object (WorkflowRunData)
object
id
string
workflowRunId
string
workflowId
string
output
object
metadata
object
createdAt
string (date-time)
credits
integer
400
Bad Request
404
Not Found