Skip to content

Create enrichment workflow definition

Request

Security
OAuth2(Required scopes: enrichment-workflows.write)
Bodyapplication/jsonrequired
namestringrequired

Name of the workflow

definitionstringrequired

YAML definition of the workflow

descriptionstring
projectIdsArray of strings
curl -i -X POST \
  https://api.cloud.hypatos.ai/v2/enrichment-workflows \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "definition": "string",
    "description": "string",
    "projectIds": [
      "string"
    ]
  }'

Responses

Workflow definition created

Bodyapplication/json
idstringrequired

Unique ID of the workflow definition

namestringrequired

Name of the workflow

descriptionstring
companyIdstring
createdAtstring, (date-time)
updatedAtstring, (date-time)
definitionstringrequired

YAML definition of the workflow

projectIdsArray of strings
versioninteger
versionStringstring
updatedBystring
createdByIdstring
updatedByIdstring
Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "companyId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "definition": "string",
  "projectIds": [
    "string"
  ],
  "version": 0,
  "versionString": "string",
  "updatedBy": "string",
  "createdById": "string",
  "updatedById": "string"
}