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
- GETGet a Workflow Run
- POSTReplay a Workflow Run
- POSTCancel a Workflow Run
- PATCHUpdate Run Data Retention Configuration
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Files
Workflows
Update Run Data Retention Configuration
Update the data retention configuration for a specific workflow run.
PATCH
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
/
runs
/
{run_id}
/
retention
Copy
Ask AI
{
"id": "<string>",
"result": "<any>",
"input": {},
"output": {},
"status": "RUNNING",
"origin": "WORKFLOW",
"error": "<string>",
"started_at": "2023-12-25",
"ended_at": "2023-12-25",
"app_id": "<string>",
"workflow_app_id": "<string>",
"workflow_id": "<string>",
"workflow_version_draft": {
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"collection_id": "<string>",
"record_id": "<string>",
"version": 123,
"usage": {
"total": 123,
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
{}
]
}
],
"steps": {}
},
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"retention_due_at": "2023-12-25",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
Path Parameters
The ID of the app
The ID of the workflow
The ID of the workflow run.
Query Parameters
Show child attributes
Show child attributes
Body
Schema for updating run data retention configuration
Response
200 - application/json
The response is of type object
.
Copy
Ask AI
{
"id": "<string>",
"result": "<any>",
"input": {},
"output": {},
"status": "RUNNING",
"origin": "WORKFLOW",
"error": "<string>",
"started_at": "2023-12-25",
"ended_at": "2023-12-25",
"app_id": "<string>",
"workflow_app_id": "<string>",
"workflow_id": "<string>",
"workflow_version_draft": {
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"collection_id": "<string>",
"record_id": "<string>",
"version": 123,
"usage": {
"total": 123,
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
{}
]
}
],
"steps": {}
},
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"retention_due_at": "2023-12-25",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
Assistant
Responses are generated using AI and may contain mistakes.