Skip to content

Patch Workflow

Request

Patch by persisted kind after ownership is established.

OOTB workflows accept only workflowConfiguration.steps, name, description, projects, and editors; a protected field sent to an OOTB workflow is rejected with 422. Custom workflows keep their existing partial-update contract.

Security
OAuth2(Required scopes: agent-workflows.write)
Path
idstring, (uuid)(Id)required
Bodyapplication/jsonrequired
Any of:

Partial-update body for a workflow; send only the fields to change. companyId is immutable.

companyIdstring or null(Companyid)
projectsstring or null(Projects)

Comma separated list of projectIds

namestring or null(Name)

Name for Workflow

modelstring or null(Model)

Model id used for prompting

descriptionstring or null(Description)

Description of Workflow

trainingCompanyIdstring or null(Trainingcompanyid)
trainingProjectsstring or null(Trainingprojects)

Comma separated list of training projectIds

similarityThresholdnumber or null(Similaritythreshold)
useOcrTextPagesboolean or null(Useocrtextpages)
editorsArray of strings or null(Editors)

Editor ids that can edit workflow

similarityApiboolean or null(Similarityapi)
useImagesboolean or null(Useimages)
maxNumTrainingDocumentsinteger or null(Maxnumtrainingdocuments)
bboxRegionDetectionModestring or null(BoundingBoxRegionDetectionMode)
Enum:"WORD_MATCHING""LLM"
workflowTypestring or null(WorkflowType)
Enum:"EXTRACTION""PREPROCESSING"
workflowConfigurationobject or null(Dict)
curl -i -X PATCH \
  'https://api.cloud.hypatos.ai/v2/agent-workflows/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "companyId": "string",
    "projects": "string",
    "name": "string",
    "model": "string",
    "description": "string",
    "trainingCompanyId": "string",
    "trainingProjects": "string",
    "similarityThreshold": 0,
    "useOcrTextPages": true,
    "editors": [
      "string"
    ],
    "similarityApi": true,
    "useImages": true,
    "maxNumTrainingDocuments": 0,
    "bboxRegionDetectionMode": "WORD_MATCHING",
    "workflowType": "EXTRACTION",
    "workflowConfiguration": {}
  }'

Responses

Successful Response

Bodyapplication/json
idstring or null, (uuid)(Id)
Example:"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"
companyIdstring(Companyid)required
Example:"6081acde0377a83b93f05a10"
projectsstring(Projects)required

Comma separated list of projectIds

Example:"6299d91c04dd5dd5d81c99bb,63bc7bf22b5bc8f3d0625092"
namestring(Name)required

Name for Workflow

Example:"Some very nice workflow"
modelstring(Model)required

Model id used for prompting

Example:"dcbc075f-a99c-4199-86ed-fb4ed5684dd9"
descriptionstring or null(Description)

Description of Workflow

Example:"Some more verbose description"
trainingCompanyIdstring or null(Trainingcompanyid)
Example:"6081acde0377a83b93f05a10"
trainingProjectsstring or null(Trainingprojects)

Comma separated list of training projectIds used as source documents repository

Example:"6523b5bcac1cb469d7fc1bd9"
createdAtstring or null, (date-time)(Createdat)

Date when Workflow was added

Example:"2023-10-27T11:38:18.000Z"
createdBystring or null(Createdby)

Id of the caller that created the workflow; an OAuth client id when created via this API

Example:"acme-integration"
updatedBystring or null(Updatedby)

Id of the caller that last updated the workflow; an OAuth client id when updated via this API

Example:"acme-integration"
updatedAtstring or null, (date-time)(Updatedat)

Date when Workflow was last modified

Example:"2023-10-27T12:38:18.000Z"
similarityThresholdnumber or null(Similaritythreshold)

Defines the minimum similarity between the uploaded document and context examples from the training project

Example:0.78
useOcrTextPagesboolean or null(Useocrtextpages)

Ability to use ocrTextPages (Google OCR) in the prompt

Default:false
Example:false
editorsArray of strings(Editors)

Editor ids that can edit workflow

similarityApiboolean or null(Similarityapi)

Ability to set similarity service API for document training data

Default:true
Example:true
useImagesboolean or null(Useimages)

Ability to set images usage to workflow

Default:true
Example:false
maxNumTrainingDocumentsinteger(Maxnumtrainingdocuments)

Maximum number of training documents used in the workflow

Default:1
Example:2
bboxRegionDetectionModestring or null(BoundingBoxRegionDetectionMode)

The bounding boxes region detection mode of prompting-settings

Enum:"WORD_MATCHING""LLM"
Example:"WORD_MATCHING"
workflowTypestring or null(WorkflowType)

Type of workflow (EXTRACTION returns value-form entities, PREPROCESSING returns raw JSON)

Default:"EXTRACTION"
Enum:"EXTRACTION""PREPROCESSING"
workflowConfigurationobject or null(Dict)

The workflow's step configuration: the agents to run and how they are chained

versionstring or null(Version)

Workflow version

sourceWorkflowIdstring or null, (uuid)(Sourceworkflowid)

Source workflow identifier for imported workflows

sourceWorkflowVersionstring or null(Sourceworkflowversion)

Concrete source workflow version used for import

isOotbboolean(Isootb)

Whether persisted import provenance classifies this workflow as OOTB

Default:false
Response
{
  "id": "dcbc075f-a99c-4199-86ed-fb4ed5684dd9",
  "companyId": "6081acde0377a83b93f05a10",
  "projects": "6299d91c04dd5dd5d81c99bb,63bc7bf22b5bc8f3d0625092",
  "name": "Some very nice workflow",
  "model": "dcbc075f-a99c-4199-86ed-fb4ed5684dd9",
  "description": "Some more verbose description",
  "trainingCompanyId": "6081acde0377a83b93f05a10",
  "trainingProjects": "6523b5bcac1cb469d7fc1bd9",
  "createdAt": "2023-10-27T11:38:18.000Z",
  "createdBy": "acme-integration",
  "updatedBy": "acme-integration",
  "updatedAt": "2023-10-27T12:38:18.000Z",
  "similarityThreshold": 0.78,
  "useOcrTextPages": false,
  "editors": [
    "string"
  ],
  "similarityApi": true,
  "useImages": false,
  "maxNumTrainingDocuments": 2,
  "bboxRegionDetectionMode": "WORD_MATCHING",
  "workflowType": "EXTRACTION",
  "workflowConfiguration": {},
  "version": "string",
  "sourceWorkflowId": "eb3ffc5d-a273-4862-91d2-41d306d39afe",
  "sourceWorkflowVersion": "string",
  "isOotb": false
}