Skip to main content
POST
/
v1
/
unstable
/
agent
/
workflows
/
{workflowId}
/
trigger
Trigger a workflow
curl --request POST \
  --url https://api.deepl.com/v1/unstable/agent/workflows/{workflowId}/trigger \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'workflow_request={"input": {"language": "American English"}}'
{
  "task_id": "task-456",
  "ui_url": "https://agent.deepl.com/static/chat/e333fb65-77eb-4669-ba55-201a5e3cff32",
  "polling_url": "/v1/unstable/agent/tasks/task-456",
  "last_modified_date": "2025-12-04T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Path Parameters

​
workflowId
string
required

Unique identifier of the workflow to trigger

Body

multipart/form-data
​
workflow_request
string
required

JSON string containing the workflow input parameters

Example:

"{\"input\": {\"language\": \"American English\"}}"

Response

Successfully triggered the workflow

​
task_id
string
required

Unique identifier for the triggered workflow task

Example:

"task-456"

​
last_modified_date
string<date-time>
required

Timestamp of when the task was last modified (ISO 8601 format)

Example:

"2025-12-04T10:30:00Z"

​
ui_url
string | null

URL to view the task in the agentic system user interface

Example:

"https://agent.deepl.com/static/chat/e333fb65-77eb-4669-ba55-201a5e3cff32"

​
polling_url
string | null

Relative URL endpoint to poll for task status updates

Example:

"/v1/unstable/agent/tasks/task-456"