Workflows
Get a Workflow
API Reference
Collections
Records
Workflows
- GETDiscover Workflows
- GETGet Discoverable Workflow
- GETGet Discoverable Workflow Version
- POSTRun Discoverable Workflow
- POSTCancel a Discoverable Workflow Run
- GETGet Workflows
- GETGet a Workflow
- GETGet Workflow Runs
- POSTRun a Workflow
- POSTReplay a Workflow Run
- GETGet a Workflow Run
- POSTCancel a Workflow Run
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Workflows
Get a Workflow
Retrieve a specific workflow by its ID.
GET
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
curl --request GET \
--url https://api.withcortex.ai/apps/{app_id}/workflows/{workflow_id}
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"visibility": "PUBLIC",
"version": {
"id": "<string>",
"description": "<string>",
"version": 123,
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"steps": [
{
"type": "code",
"key": "<string>",
"conditional": "<string>",
"loop": "<string>",
"code": "<string>"
}
]
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"steps": [
{
"type": "code",
"key": "<string>",
"conditional": "<string>",
"loop": "<string>",
"code": "<string>"
}
]
}
Response
200 - application/json
Available options:
PUBLIC
, PRIVATE
Available options:
file
Was this page helpful?
curl --request GET \
--url https://api.withcortex.ai/apps/{app_id}/workflows/{workflow_id}
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"visibility": "PUBLIC",
"version": {
"id": "<string>",
"description": "<string>",
"version": 123,
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"steps": [
{
"type": "code",
"key": "<string>",
"conditional": "<string>",
"loop": "<string>",
"code": "<string>"
}
]
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"steps": [
{
"type": "code",
"key": "<string>",
"conditional": "<string>",
"loop": "<string>",
"code": "<string>"
}
]
}