Skip to main content
POST
/
v1
/
workflows
Create Workflow
curl --request POST \
  --url https://api.getmaxim.ai/v1/workflows \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "type": "HTTP",
  "folderId": "<string>",
  "description": "<string>",
  "environmentId": "<string>",
  "config": {
    "language": "<string>"
  }
}
'
{
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "name": "<string>",
    "type": "HTTP",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "folderId": "<string>",
    "config": null
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required

Unique identifier for the workspace

Minimum string length: 1
name
string
required

Name of the workflow

Minimum string length: 1
type
enum<string>
required

Type of workflow (HTTP or VOICE)

Available options:
HTTP,
VOICE
folderId
string

Unique identifier for the folder

description
string

Description of the workflow

environmentId
string

Default environment identifier for the workflow

config
object

Optional workflow configuration overrides

Response

Workflow created successfully

data
object
required