Partial Update | AISquare Studio

Endpoint for FE to sync UI state (e.g. file selections) back to the session.

Path parameters

action_session_idintegerRequired

Request

This endpoint expects an object.

statusenumOptional

ACTIVE - Active
COMPLETED - Completed
ARCHIVED - Archived

* `ACTIVE` - Active * `COMPLETED` - Completed * `ARCHIVED` - Archived

Allowed values:

workflow_statusenumOptional

Tracks the progress of the underlying creation/action intent

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

Tracks the progress of the underlying creation/action intent * `not_started` - Not Started * `in_progress` - In Progress * `completed` - Completed * `failed` - Failed

Allowed values:

Response

uidstringRead-onlyformat: "uuid"

statusenum

ACTIVE - Active
COMPLETED - Completed
ARCHIVED - Archived

* `ACTIVE` - Active * `COMPLETED` - Completed * `ARCHIVED` - Archived

Allowed values:

workflow_statusenum

Tracks the progress of the underlying creation/action intent

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

Tracks the progress of the underlying creation/action intent * `not_started` - Not Started * `in_progress` - In Progress * `completed` - Completed * `failed` - Failed

Allowed values:

current_stateanyRead-only

contextanyRead-only

job_infostringRead-only

1	import requests
2
3	url = "https://api.example.com/api/v2/actions/1/"
4
5	payload = {}
6	headers = {"Content-Type": "application/json"}
7
8	response = requests.patch(url, json=payload, headers=headers)
9
10	print(response.json())

1	{
2	"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"status": "ACTIVE",
4	"workflow_status": "not_started",
5	"job_info": "Job scheduled for processing user action session 1."
6	}