Augmentations

List Augmentations

Query Parameters

workspace_id*Workspace Id

Workspace ID

app_id?|

Filter by app ID

limit?Limit

Maximum number of items to return (1-200)

Default50

Range1 <= value <= 200

cursor?|

Cursor for pagination (from previous response's next_cursor)

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/?workspace_id=string"

{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "augmentations": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "workspace_id": "string",
      "app_id": "string",
      "stage_ids": [
        "string"
      ],
      "branch_id": "main",
      "is_template": true,
      "created_at": "string",
      "updated_at": "string",
      "created_by": "string",
      "updated_by": "string",
      "tags": []
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Create Augmentation

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

workspace_id*Workspace Id

app_id*App Id

name*Name

description?string|null

input_schema?|null

output_schema?|null

shared?Shared

Defaultfalse

is_template?Is Template

Defaultfalse

default_timeout_seconds?Default Timeout Seconds

Default600

tags?array<string>

Default[]

metadata?|null

`application/json`

curl -X POST "https://loading/v1/orgs/string/augmentations/" \  -H "Content-Type: application/json" \  -d '{    "workspace_id": "string",    "app_id": "string",    "name": "string"  }'

{
  "message": "string",
  "augmentation": {
    "id": "string",
    "name": "string",
    "description": "string",
    "workspace_id": "string",
    "app_id": "string",
    "stage_ids": [
      "string"
    ],
    "branch_id": "main",
    "is_template": true,
    "created_at": "string",
    "updated_at": "string",
    "created_by": "string",
    "updated_by": "string",
    "tags": []
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

List Executions

Query Parameters

augmentation_id*Augmentation Id

Augmentation ID to list executions for

status?|

Filter by status

limit?Limit

Maximum number of items to return (1-200)

Default50

Range1 <= value <= 200

cursor?|

Cursor for pagination (from previous response's next_cursor)

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/executions?augmentation_id=string"

{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "executions": [
    {
      "execution_id": "string",
      "augmentation_id": "string",
      "status": "pending",
      "current_stage_number": 0,
      "total_stages": 0,
      "completed_stages": 0,
      "progress_percentage": 0,
      "created_at": "string",
      "started_at": "string",
      "completed_at": "string",
      "execution_time_ms": 0,
      "error": "string",
      "environment_id": "string",
      "release_id": "string",
      "paused_at": "string",
      "paused_step_id": "string",
      "paused_stage_index": 0,
      "approval_decision": "string",
      "approval_decided_by": "string",
      "approval_decided_at": "string",
      "approval_reason": "string",
      "pending_input": {}
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Execution Stats

Query Parameters

augmentation_id*Augmentation Id

Augmentation ID to get stats for

workspace_id*Workspace Id

Workspace ID

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/executions/stats?augmentation_id=string&workspace_id=string"

{
  "total_executions": 0,
  "success_rate": 0,
  "average_duration_ms": 0,
  "completed_count": 0,
  "failed_count": 0
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Augmentation

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/string?workspace_id=string"

{
  "id": "string",
  "name": "string",
  "description": "string",
  "workspace_id": "string",
  "app_id": "string",
  "stage_ids": [
    "string"
  ],
  "branch_id": "main",
  "is_template": true,
  "created_at": "string",
  "updated_at": "string",
  "created_by": "string",
  "updated_by": "string",
  "tags": [],
  "stages": [
    {}
  ],
  "input_schema": {},
  "output_schema": {}
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete Augmentation

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/augmentations/string?workspace_id=string"

{
  "message": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Update Augmentation

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string|null

description?string|null

input_schema?|null

output_schema?|null

shared?boolean|null

default_timeout_seconds?integer|null

tags?array<string>|null

metadata?|null

`application/json`

curl -X PUT "https://loading/v1/orgs/string/augmentations/string?workspace_id=string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "message": "string",
  "augmentation": {
    "id": "string",
    "name": "string",
    "description": "string",
    "workspace_id": "string",
    "app_id": "string",
    "stage_ids": [
      "string"
    ],
    "branch_id": "main",
    "is_template": true,
    "created_at": "string",
    "updated_at": "string",
    "created_by": "string",
    "updated_by": "string",
    "tags": []
  },
  "branch_id": "string",
  "branch_name": "string",
  "branch_was_auto_created": false,
  "branch_message": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

List Stages

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/string/stages"

[
  {
    "id": "string",
    "augmentation_id": "string",
    "name": "string",
    "description": "string",
    "execution_mode": "sequential",
    "order": 0,
    "step_ids": [
      "string"
    ],
    "timeout_seconds": 0,
    "created_at": "string",
    "updated_at": "string"
  }
]

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Create Stage

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

Query Parameters

name*Name

workspace_id*Workspace Id

Workspace ID

execution_mode?StageExecutionMode

Execution mode for steps within a stage

Default"sequential"

Value in"sequential" | "parallel"

order?integer|null

description?string|null

timeout_seconds?Timeout Seconds

Default300

`application/json`

curl -X POST "https://loading/v1/orgs/string/augmentations/string/stages?name=string&workspace_id=string"

{
  "id": "string",
  "augmentation_id": "string",
  "name": "string",
  "description": "string",
  "execution_mode": "sequential",
  "order": 0,
  "step_ids": [
    "string"
  ],
  "timeout_seconds": 0,
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Stage

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/string/stages/string"

{
  "id": "string",
  "augmentation_id": "string",
  "name": "string",
  "description": "string",
  "execution_mode": "sequential",
  "order": 0,
  "step_ids": [
    "string"
  ],
  "input_schema": {
    "fields": {
      "property1": {},
      "property2": {}
    },
    "required_fields": [
      "string"
    ]
  },
  "output_schema": {
    "fields": {
      "property1": {},
      "property2": {}
    },
    "consolidation_strategy": "merge"
  },
  "condition": {},
  "skip_on_error": false,
  "timeout_seconds": 0,
  "max_retries": 0,
  "metadata": {},
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete Stage

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/augmentations/string/stages/string?workspace_id=string"

null

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Update Stage

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string|null

description?string|null

execution_mode?|null

order?integer|null

input_schema?|null

output_schema?|null

condition?|null

skip_on_error?boolean|null

timeout_seconds?integer|null

max_retries?integer|null

metadata?|null

`application/json`

curl -X PUT "https://loading/v1/orgs/string/augmentations/string/stages/string?workspace_id=string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "augmentation_id": "string",
  "name": "string",
  "description": "string",
  "execution_mode": "sequential",
  "order": 0,
  "step_ids": [
    "string"
  ],
  "input_schema": {
    "fields": {
      "property1": {},
      "property2": {}
    },
    "required_fields": [
      "string"
    ]
  },
  "output_schema": {
    "fields": {
      "property1": {},
      "property2": {}
    },
    "consolidation_strategy": "merge"
  },
  "condition": {},
  "skip_on_error": false,
  "timeout_seconds": 0,
  "max_retries": 0,
  "metadata": {},
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

List Steps

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/string/stages/string/steps"

[
  {
    "id": "string",
    "stage_id": "string",
    "augmentation_id": "string",
    "name": "string",
    "description": "string",
    "step_type": "source_ingest",
    "order": 0,
    "depends_on": [
      {
        "stage_id": "string",
        "step_id": "string",
        "stage_name": "string",
        "step_name": "string",
        "stage_name_normalized": "",
        "step_name_normalized": "",
        "cross_stage": false,
        "variable_path": "string"
      }
    ],
    "timeout_seconds": 0,
    "event_config": {
      "enabled": true,
      "event_mode": "domain",
      "event_action": "string",
      "stream_tokens": true,
      "event_name": "string",
      "publish_variables": [
        "string"
      ],
      "message_template": "string",
      "variable_mappings": [
        {
          "source": "string",
          "target": "string",
          "transform": "string"
        }
      ],
      "include_endpoint_payload": false,
      "include_execution_context": false,
      "include_step_metadata": true,
      "endpoint_payload_fields": [
        "string"
      ],
      "execution_context_fields": [
        "string"
      ]
    },
    "created_at": "string",
    "updated_at": "string"
  }
]

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Create Step

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*Name

description?string|null

step_type*StepType

Available step types

Value in

"source_ingest" | "source_query" | "transformation" | "inference" | "tool_call" | "memory_update" | "memory_query" | "artifact_create" | "artifact_query" | "thread_update" | "thread_query" | "artifact_get" | "source_get" | "get_message" | "approval" | "volume_write" | "volume_read" | "volume_list" | "volume_search" | "volume_search_all" | "volume_delete" | "volume_lock" | "volume_unlock"

order?integer|null

depends_on?array<string>

Names of steps within the SAME STAGE that this step depends on. In PARALLEL stages, step waits for dependencies to complete. In SEQUENTIAL stages, used for visualization (order field determines execution).

input_schema?|null

tool_config?|null

prompt_config?|null

source_config?|null

transform_config?|null

memory_update_config?|null

memory_query_config?|null

thread_update_config?|null

thread_query_config?|null

artifact_create_config?|null

artifact_query_config?|null

artifact_get_config?|null

source_get_config?|null

get_message_config?|null

condition?||||null

skip_on_error?Skip On Error

Defaultfalse

event_config?|null

timeout_seconds?Timeout Seconds

Default60

max_retries?Max Retries

Default0

retry_delay_ms?Retry Delay Ms

Default1000

metadata?

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/augmentations/string/stages/string/steps?workspace_id=string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "step_type": "source_ingest"  }'

{
  "id": "string",
  "stage_id": "string",
  "augmentation_id": "string",
  "name": "string",
  "description": "string",
  "step_type": "source_ingest",
  "order": 0,
  "depends_on": [
    {
      "stage_id": "string",
      "step_id": "string",
      "stage_name": "string",
      "step_name": "string",
      "stage_name_normalized": "",
      "step_name_normalized": "",
      "cross_stage": false,
      "variable_path": "string"
    }
  ],
  "timeout_seconds": 0,
  "event_config": {
    "enabled": true,
    "event_mode": "domain",
    "event_action": "string",
    "stream_tokens": true,
    "event_name": "string",
    "publish_variables": [
      "string"
    ],
    "message_template": "string",
    "variable_mappings": [
      {
        "source": "string",
        "target": "string",
        "transform": "string"
      }
    ],
    "include_endpoint_payload": false,
    "include_execution_context": false,
    "include_step_metadata": true,
    "endpoint_payload_fields": [
      "string"
    ],
    "execution_context_fields": [
      "string"
    ]
  },
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Step

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

step_id*Step Id

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/string/stages/string/steps/string"

{
  "id": "string",
  "stage_id": "string",
  "augmentation_id": "string",
  "name": "string",
  "description": "string",
  "step_type": "source_ingest",
  "order": 0,
  "depends_on": [
    {
      "stage_id": "string",
      "step_id": "string",
      "stage_name": "string",
      "step_name": "string",
      "stage_name_normalized": "",
      "step_name_normalized": "",
      "cross_stage": false,
      "variable_path": "string"
    }
  ],
  "input_schema": {
    "fields": {
      "property1": {},
      "property2": {}
    },
    "required_fields": [
      "string"
    ],
    "auto_map": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tool_config": {
    "tool_type": "instance",
    "tool_name": "string",
    "tool_server": "string",
    "tool_instance_id": "string",
    "action": "execute",
    "parameter_templates": {
      "property1": "string",
      "property2": "string"
    },
    "parameters_mapping": {
      "property1": "string",
      "property2": "string"
    },
    "static_parameters": {},
    "connection_exposure": "namespace",
    "timeout_seconds": 30,
    "retry_on_failure": false,
    "retry_count": 3,
    "requires_confirmation": true,
    "output_variable_name": "string"
  },
  "prompt_config": {
    "prompt_template": "string",
    "system_message": "string",
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    },
    "logical_model_id": "string",
    "model": "string",
    "temperature": 0.7,
    "max_tokens": 1000,
    "output_format": "string",
    "response_schema": {},
    "response_is_array": false,
    "response_schema_mode": "auto",
    "available_tool_instances": [
      "string"
    ],
    "tool_execution_mode": "single_turn",
    "max_tool_rounds": 3,
    "tool_instance_params": {
      "property1": {},
      "property2": {}
    },
    "tool_connection_exposure": {
      "property1": "string",
      "property2": "string"
    },
    "tool_confirmation_overrides": {
      "property1": true,
      "property2": true
    },
    "dynamic_tool_discovery": false,
    "rich_response": false,
    "output_schema": {}
  },
  "source_config": {
    "query": "string",
    "search_scope": "namespace",
    "source_ids_variable": "string",
    "include_parent_scopes": true,
    "top_k": 5,
    "score_threshold": 0.7,
    "include_content": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n",
    "source_ids": [
      "string"
    ],
    "ingest_endpoint_files": true,
    "endpoint_files_variable": "endpoint_payload.files",
    "auto_process": true,
    "smart_chunking": false,
    "indexing_level": "standard",
    "chunk_size": 512,
    "chunk_overlap_size": 50,
    "enable_ocr": true,
    "source_name_template": "string",
    "source_type": "string",
    "chunk_overlap": true,
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    }
  },
  "transform_config": {
    "transform_type": "string",
    "expression": "string",
    "mapping": {
      "property1": "string",
      "property2": "string"
    },
    "filter_condition": {},
    "aggregation": {
      "property1": "string",
      "property2": "string"
    }
  },
  "memory_update_config": {
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    },
    "content_template": "string",
    "content_is_json": false,
    "key": "string",
    "key_template": "string",
    "memory_type": "fact",
    "scope": "namespace",
    "importance": 0,
    "importance_variable": "string",
    "ttl_seconds": 0,
    "tags": [
      "string"
    ],
    "tags_variable": "string",
    "metadata_template": "string",
    "reconcile_similar": false,
    "similarity_threshold": 0.85,
    "reconcile_strategy": "smart_merge",
    "reconcile_top_k": 3,
    "max_merged_length": 2000
  },
  "memory_query_config": {
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    },
    "query": "{{ endpoint_payload.message }}",
    "search_scope": "thread",
    "include_parent_scopes": true,
    "thread_id_variable": "string",
    "memory_types": [
      "fact"
    ],
    "tags": [
      "string"
    ],
    "min_importance": 0,
    "include_expired": false,
    "top_k": 10,
    "score_threshold": 0.7,
    "include_content": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n"
  },
  "thread_update_config": {
    "content_template": "string",
    "role": "system",
    "source": "user_input",
    "thread_id": "string",
    "thread_id_template": "string",
    "metadata_template": "string",
    "tool_name": "string",
    "tool_call_id": "string",
    "include_artifact_refs": true
  },
  "thread_query_config": {
    "thread_id": "string",
    "thread_id_template": "string",
    "max_messages": 20,
    "include_system": true,
    "include_tool": true,
    "ascending": true,
    "include_message_sources": [
      "string"
    ],
    "exclude_message_sources": [
      "string"
    ],
    "combined_context_separator": "\n\n"
  },
  "artifact_create_config": {
    "name": "string",
    "description": "string",
    "artifact_type": "text",
    "content_template": "string",
    "content_is_json": false,
    "content_text_template": "string",
    "scope": "thread",
    "thread_id_variable": "string",
    "ttl_seconds": 60,
    "is_pinned": false,
    "source_tool": "string",
    "source_tool_action": "string",
    "extract_summary": true,
    "extract_keywords": true,
    "skip_indexing": false,
    "tags": [
      "string"
    ],
    "tags_template": "string",
    "metadata_template": "string",
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    }
  },
  "artifact_query_config": {
    "query": "{{ endpoint_payload.message }}",
    "search_scope": "namespace",
    "include_parent_scopes": true,
    "thread_id_variable": "string",
    "artifact_types": [
      "string"
    ],
    "source_tools": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "include_expired": false,
    "top_k": 5,
    "score_threshold": 0,
    "include_content": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n"
  },
  "artifact_get_config": {
    "artifact_ids": [
      "string"
    ],
    "artifact_ids_template": "string",
    "include_content": true,
    "include_file_content": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n",
    "context_template": "string"
  },
  "source_get_config": {
    "source_ids": [
      "string"
    ],
    "source_ids_template": "string",
    "include_extracted_text": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n",
    "context_template": "string"
  },
  "get_message_config": {
    "message_id": "string",
    "message_id_template": "string"
  },
  "approval_config": {
    "instructions": "string",
    "timeout_seconds": 86400,
    "timeout_action": "reject",
    "notify_roles": [
      "string"
    ]
  },
  "condition": {},
  "skip_on_error": false,
  "event_config": {
    "enabled": true,
    "event_mode": "domain",
    "event_action": "string",
    "stream_tokens": true,
    "event_name": "string",
    "publish_variables": [
      "string"
    ],
    "message_template": "string",
    "variable_mappings": [
      {
        "source": "string",
        "target": "string",
        "transform": "string"
      }
    ],
    "include_endpoint_payload": false,
    "include_execution_context": false,
    "include_step_metadata": true,
    "endpoint_payload_fields": [
      "string"
    ],
    "execution_context_fields": [
      "string"
    ]
  },
  "timeout_seconds": 0,
  "max_retries": 0,
  "retry_delay_ms": 0,
  "metadata": {},
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Delete Step

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

step_id*Step Id

Query Parameters

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X DELETE "https://loading/v1/orgs/string/augmentations/string/stages/string/steps/string?workspace_id=string"

null

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Update Step

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

step_id*Step Id

Query Parameters

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string|null

description?string|null

order?integer|null

depends_on?array<string>|

input_schema?|null

tool_config?|null

prompt_config?|null

source_config?|null

transform_config?|null

memory_update_config?|null

memory_query_config?|null

thread_update_config?|null

thread_query_config?|null

artifact_create_config?|null

artifact_query_config?|null

artifact_get_config?|null

source_get_config?|null

get_message_config?|null

condition?||||null

skip_on_error?boolean|null

event_config?|null

timeout_seconds?integer|null

max_retries?integer|null

retry_delay_ms?integer|null

metadata?|null

Response Body

`application/json`

curl -X PUT "https://loading/v1/orgs/string/augmentations/string/stages/string/steps/string?workspace_id=string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "stage_id": "string",
  "augmentation_id": "string",
  "name": "string",
  "description": "string",
  "step_type": "source_ingest",
  "order": 0,
  "depends_on": [
    {
      "stage_id": "string",
      "step_id": "string",
      "stage_name": "string",
      "step_name": "string",
      "stage_name_normalized": "",
      "step_name_normalized": "",
      "cross_stage": false,
      "variable_path": "string"
    }
  ],
  "input_schema": {
    "fields": {
      "property1": {},
      "property2": {}
    },
    "required_fields": [
      "string"
    ],
    "auto_map": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tool_config": {
    "tool_type": "instance",
    "tool_name": "string",
    "tool_server": "string",
    "tool_instance_id": "string",
    "action": "execute",
    "parameter_templates": {
      "property1": "string",
      "property2": "string"
    },
    "parameters_mapping": {
      "property1": "string",
      "property2": "string"
    },
    "static_parameters": {},
    "connection_exposure": "namespace",
    "timeout_seconds": 30,
    "retry_on_failure": false,
    "retry_count": 3,
    "requires_confirmation": true,
    "output_variable_name": "string"
  },
  "prompt_config": {
    "prompt_template": "string",
    "system_message": "string",
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    },
    "logical_model_id": "string",
    "model": "string",
    "temperature": 0.7,
    "max_tokens": 1000,
    "output_format": "string",
    "response_schema": {},
    "response_is_array": false,
    "response_schema_mode": "auto",
    "available_tool_instances": [
      "string"
    ],
    "tool_execution_mode": "single_turn",
    "max_tool_rounds": 3,
    "tool_instance_params": {
      "property1": {},
      "property2": {}
    },
    "tool_connection_exposure": {
      "property1": "string",
      "property2": "string"
    },
    "tool_confirmation_overrides": {
      "property1": true,
      "property2": true
    },
    "dynamic_tool_discovery": false,
    "rich_response": false,
    "output_schema": {}
  },
  "source_config": {
    "query": "string",
    "search_scope": "namespace",
    "source_ids_variable": "string",
    "include_parent_scopes": true,
    "top_k": 5,
    "score_threshold": 0.7,
    "include_content": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n",
    "source_ids": [
      "string"
    ],
    "ingest_endpoint_files": true,
    "endpoint_files_variable": "endpoint_payload.files",
    "auto_process": true,
    "smart_chunking": false,
    "indexing_level": "standard",
    "chunk_size": 512,
    "chunk_overlap_size": 50,
    "enable_ocr": true,
    "source_name_template": "string",
    "source_type": "string",
    "chunk_overlap": true,
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    }
  },
  "transform_config": {
    "transform_type": "string",
    "expression": "string",
    "mapping": {
      "property1": "string",
      "property2": "string"
    },
    "filter_condition": {},
    "aggregation": {
      "property1": "string",
      "property2": "string"
    }
  },
  "memory_update_config": {
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    },
    "content_template": "string",
    "content_is_json": false,
    "key": "string",
    "key_template": "string",
    "memory_type": "fact",
    "scope": "namespace",
    "importance": 0,
    "importance_variable": "string",
    "ttl_seconds": 0,
    "tags": [
      "string"
    ],
    "tags_variable": "string",
    "metadata_template": "string",
    "reconcile_similar": false,
    "similarity_threshold": 0.85,
    "reconcile_strategy": "smart_merge",
    "reconcile_top_k": 3,
    "max_merged_length": 2000
  },
  "memory_query_config": {
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    },
    "query": "{{ endpoint_payload.message }}",
    "search_scope": "thread",
    "include_parent_scopes": true,
    "thread_id_variable": "string",
    "memory_types": [
      "fact"
    ],
    "tags": [
      "string"
    ],
    "min_importance": 0,
    "include_expired": false,
    "top_k": 10,
    "score_threshold": 0.7,
    "include_content": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n"
  },
  "thread_update_config": {
    "content_template": "string",
    "role": "system",
    "source": "user_input",
    "thread_id": "string",
    "thread_id_template": "string",
    "metadata_template": "string",
    "tool_name": "string",
    "tool_call_id": "string",
    "include_artifact_refs": true
  },
  "thread_query_config": {
    "thread_id": "string",
    "thread_id_template": "string",
    "max_messages": 20,
    "include_system": true,
    "include_tool": true,
    "ascending": true,
    "include_message_sources": [
      "string"
    ],
    "exclude_message_sources": [
      "string"
    ],
    "combined_context_separator": "\n\n"
  },
  "artifact_create_config": {
    "name": "string",
    "description": "string",
    "artifact_type": "text",
    "content_template": "string",
    "content_is_json": false,
    "content_text_template": "string",
    "scope": "thread",
    "thread_id_variable": "string",
    "ttl_seconds": 60,
    "is_pinned": false,
    "source_tool": "string",
    "source_tool_action": "string",
    "extract_summary": true,
    "extract_keywords": true,
    "skip_indexing": false,
    "tags": [
      "string"
    ],
    "tags_template": "string",
    "metadata_template": "string",
    "execution_mode": "single",
    "for_each_config": {
      "collection_path": "string",
      "item_alias": "string",
      "item_id_path": "string",
      "item_filter": {
        "type": "all_variables_present",
        "variables": [
          "string"
        ],
        "variable": "string",
        "value": null,
        "expression": "string",
        "step_name": "string",
        "negate": false
      },
      "max_concurrency": 5,
      "continue_on_failure": true,
      "response_separator": "\n\n---\n\n"
    }
  },
  "artifact_query_config": {
    "query": "{{ endpoint_payload.message }}",
    "search_scope": "namespace",
    "include_parent_scopes": true,
    "thread_id_variable": "string",
    "artifact_types": [
      "string"
    ],
    "source_tools": [
      "string"
    ],
    "tags": [
      "string"
    ],
    "include_expired": false,
    "top_k": 5,
    "score_threshold": 0,
    "include_content": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n"
  },
  "artifact_get_config": {
    "artifact_ids": [
      "string"
    ],
    "artifact_ids_template": "string",
    "include_content": true,
    "include_file_content": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n",
    "context_template": "string"
  },
  "source_get_config": {
    "source_ids": [
      "string"
    ],
    "source_ids_template": "string",
    "include_extracted_text": true,
    "include_metadata": true,
    "build_combined_context": true,
    "context_separator": "\n\n---\n\n",
    "context_template": "string"
  },
  "get_message_config": {
    "message_id": "string",
    "message_id_template": "string"
  },
  "approval_config": {
    "instructions": "string",
    "timeout_seconds": 86400,
    "timeout_action": "reject",
    "notify_roles": [
      "string"
    ]
  },
  "condition": {},
  "skip_on_error": false,
  "event_config": {
    "enabled": true,
    "event_mode": "domain",
    "event_action": "string",
    "stream_tokens": true,
    "event_name": "string",
    "publish_variables": [
      "string"
    ],
    "message_template": "string",
    "variable_mappings": [
      {
        "source": "string",
        "target": "string",
        "transform": "string"
      }
    ],
    "include_endpoint_payload": false,
    "include_execution_context": false,
    "include_step_metadata": true,
    "endpoint_payload_fields": [
      "string"
    ],
    "execution_context_fields": [
      "string"
    ]
  },
  "timeout_seconds": 0,
  "max_retries": 0,
  "retry_delay_ms": 0,
  "metadata": {},
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Move Step

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

stage_id*Stage Id

step_id*Step Id

Query Parameters

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

target_stage_id*Target Stage Id

The ID of the stage to move the step to

target_order?|

The order position in the target stage. If not provided, the step will be added at the end.

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/augmentations/string/stages/string/steps/string/move?workspace_id=string" \  -H "Content-Type: application/json" \  -d '{    "target_stage_id": "string"  }'

{
  "message": "Step moved successfully",
  "old_stage_id": "string",
  "new_stage_id": "string",
  "old_step_id": "string",
  "new_step_id": "string",
  "step": {
    "id": "string",
    "stage_id": "string",
    "augmentation_id": "string",
    "name": "string",
    "description": "string",
    "step_type": "source_ingest",
    "order": 0,
    "depends_on": [
      {
        "stage_id": "string",
        "step_id": "string",
        "stage_name": "string",
        "step_name": "string",
        "stage_name_normalized": "",
        "step_name_normalized": "",
        "cross_stage": false,
        "variable_path": "string"
      }
    ],
    "input_schema": {
      "fields": {
        "property1": {},
        "property2": {}
      },
      "required_fields": [
        "string"
      ],
      "auto_map": {
        "property1": "string",
        "property2": "string"
      }
    },
    "tool_config": {
      "tool_type": "instance",
      "tool_name": "string",
      "tool_server": "string",
      "tool_instance_id": "string",
      "action": "execute",
      "parameter_templates": {
        "property1": "string",
        "property2": "string"
      },
      "parameters_mapping": {
        "property1": "string",
        "property2": "string"
      },
      "static_parameters": {},
      "connection_exposure": "namespace",
      "timeout_seconds": 30,
      "retry_on_failure": false,
      "retry_count": 3,
      "requires_confirmation": true,
      "output_variable_name": "string"
    },
    "prompt_config": {
      "prompt_template": "string",
      "system_message": "string",
      "execution_mode": "single",
      "for_each_config": {
        "collection_path": "string",
        "item_alias": "string",
        "item_id_path": "string",
        "item_filter": {
          "type": "all_variables_present",
          "variables": [
            "string"
          ],
          "variable": "string",
          "value": null,
          "expression": "string",
          "step_name": "string",
          "negate": false
        },
        "max_concurrency": 5,
        "continue_on_failure": true,
        "response_separator": "\n\n---\n\n"
      },
      "logical_model_id": "string",
      "model": "string",
      "temperature": 0.7,
      "max_tokens": 1000,
      "output_format": "string",
      "response_schema": {},
      "response_is_array": false,
      "response_schema_mode": "auto",
      "available_tool_instances": [
        "string"
      ],
      "tool_execution_mode": "single_turn",
      "max_tool_rounds": 3,
      "tool_instance_params": {
        "property1": {},
        "property2": {}
      },
      "tool_connection_exposure": {
        "property1": "string",
        "property2": "string"
      },
      "tool_confirmation_overrides": {
        "property1": true,
        "property2": true
      },
      "dynamic_tool_discovery": false,
      "rich_response": false,
      "output_schema": {}
    },
    "source_config": {
      "query": "string",
      "search_scope": "namespace",
      "source_ids_variable": "string",
      "include_parent_scopes": true,
      "top_k": 5,
      "score_threshold": 0.7,
      "include_content": true,
      "include_metadata": true,
      "build_combined_context": true,
      "context_separator": "\n\n---\n\n",
      "source_ids": [
        "string"
      ],
      "ingest_endpoint_files": true,
      "endpoint_files_variable": "endpoint_payload.files",
      "auto_process": true,
      "smart_chunking": false,
      "indexing_level": "standard",
      "chunk_size": 512,
      "chunk_overlap_size": 50,
      "enable_ocr": true,
      "source_name_template": "string",
      "source_type": "string",
      "chunk_overlap": true,
      "execution_mode": "single",
      "for_each_config": {
        "collection_path": "string",
        "item_alias": "string",
        "item_id_path": "string",
        "item_filter": {
          "type": "all_variables_present",
          "variables": [
            "string"
          ],
          "variable": "string",
          "value": null,
          "expression": "string",
          "step_name": "string",
          "negate": false
        },
        "max_concurrency": 5,
        "continue_on_failure": true,
        "response_separator": "\n\n---\n\n"
      }
    },
    "transform_config": {
      "transform_type": "string",
      "expression": "string",
      "mapping": {
        "property1": "string",
        "property2": "string"
      },
      "filter_condition": {},
      "aggregation": {
        "property1": "string",
        "property2": "string"
      }
    },
    "memory_update_config": {
      "execution_mode": "single",
      "for_each_config": {
        "collection_path": "string",
        "item_alias": "string",
        "item_id_path": "string",
        "item_filter": {
          "type": "all_variables_present",
          "variables": [
            "string"
          ],
          "variable": "string",
          "value": null,
          "expression": "string",
          "step_name": "string",
          "negate": false
        },
        "max_concurrency": 5,
        "continue_on_failure": true,
        "response_separator": "\n\n---\n\n"
      },
      "content_template": "string",
      "content_is_json": false,
      "key": "string",
      "key_template": "string",
      "memory_type": "fact",
      "scope": "namespace",
      "importance": 0,
      "importance_variable": "string",
      "ttl_seconds": 0,
      "tags": [
        "string"
      ],
      "tags_variable": "string",
      "metadata_template": "string",
      "reconcile_similar": false,
      "similarity_threshold": 0.85,
      "reconcile_strategy": "smart_merge",
      "reconcile_top_k": 3,
      "max_merged_length": 2000
    },
    "memory_query_config": {
      "execution_mode": "single",
      "for_each_config": {
        "collection_path": "string",
        "item_alias": "string",
        "item_id_path": "string",
        "item_filter": {
          "type": "all_variables_present",
          "variables": [
            "string"
          ],
          "variable": "string",
          "value": null,
          "expression": "string",
          "step_name": "string",
          "negate": false
        },
        "max_concurrency": 5,
        "continue_on_failure": true,
        "response_separator": "\n\n---\n\n"
      },
      "query": "{{ endpoint_payload.message }}",
      "search_scope": "thread",
      "include_parent_scopes": true,
      "thread_id_variable": "string",
      "memory_types": [
        "fact"
      ],
      "tags": [
        "string"
      ],
      "min_importance": 0,
      "include_expired": false,
      "top_k": 10,
      "score_threshold": 0.7,
      "include_content": true,
      "include_metadata": true,
      "build_combined_context": true,
      "context_separator": "\n\n---\n\n"
    },
    "thread_update_config": {
      "content_template": "string",
      "role": "system",
      "source": "user_input",
      "thread_id": "string",
      "thread_id_template": "string",
      "metadata_template": "string",
      "tool_name": "string",
      "tool_call_id": "string",
      "include_artifact_refs": true
    },
    "thread_query_config": {
      "thread_id": "string",
      "thread_id_template": "string",
      "max_messages": 20,
      "include_system": true,
      "include_tool": true,
      "ascending": true,
      "include_message_sources": [
        "string"
      ],
      "exclude_message_sources": [
        "string"
      ],
      "combined_context_separator": "\n\n"
    },
    "artifact_create_config": {
      "name": "string",
      "description": "string",
      "artifact_type": "text",
      "content_template": "string",
      "content_is_json": false,
      "content_text_template": "string",
      "scope": "thread",
      "thread_id_variable": "string",
      "ttl_seconds": 60,
      "is_pinned": false,
      "source_tool": "string",
      "source_tool_action": "string",
      "extract_summary": true,
      "extract_keywords": true,
      "skip_indexing": false,
      "tags": [
        "string"
      ],
      "tags_template": "string",
      "metadata_template": "string",
      "execution_mode": "single",
      "for_each_config": {
        "collection_path": "string",
        "item_alias": "string",
        "item_id_path": "string",
        "item_filter": {
          "type": "all_variables_present",
          "variables": [
            "string"
          ],
          "variable": "string",
          "value": null,
          "expression": "string",
          "step_name": "string",
          "negate": false
        },
        "max_concurrency": 5,
        "continue_on_failure": true,
        "response_separator": "\n\n---\n\n"
      }
    },
    "artifact_query_config": {
      "query": "{{ endpoint_payload.message }}",
      "search_scope": "namespace",
      "include_parent_scopes": true,
      "thread_id_variable": "string",
      "artifact_types": [
        "string"
      ],
      "source_tools": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "include_expired": false,
      "top_k": 5,
      "score_threshold": 0,
      "include_content": true,
      "build_combined_context": true,
      "context_separator": "\n\n---\n\n"
    },
    "artifact_get_config": {
      "artifact_ids": [
        "string"
      ],
      "artifact_ids_template": "string",
      "include_content": true,
      "include_file_content": true,
      "include_metadata": true,
      "build_combined_context": true,
      "context_separator": "\n\n---\n\n",
      "context_template": "string"
    },
    "source_get_config": {
      "source_ids": [
        "string"
      ],
      "source_ids_template": "string",
      "include_extracted_text": true,
      "include_metadata": true,
      "build_combined_context": true,
      "context_separator": "\n\n---\n\n",
      "context_template": "string"
    },
    "get_message_config": {
      "message_id": "string",
      "message_id_template": "string"
    },
    "approval_config": {
      "instructions": "string",
      "timeout_seconds": 86400,
      "timeout_action": "reject",
      "notify_roles": [
        "string"
      ]
    },
    "condition": {},
    "skip_on_error": false,
    "event_config": {
      "enabled": true,
      "event_mode": "domain",
      "event_action": "string",
      "stream_tokens": true,
      "event_name": "string",
      "publish_variables": [
        "string"
      ],
      "message_template": "string",
      "variable_mappings": [
        {
          "source": "string",
          "target": "string",
          "transform": "string"
        }
      ],
      "include_endpoint_payload": false,
      "include_execution_context": false,
      "include_step_metadata": true,
      "endpoint_payload_fields": [
        "string"
      ],
      "execution_context_fields": [
        "string"
      ]
    },
    "timeout_seconds": 0,
    "max_retries": 0,
    "retry_delay_ms": 0,
    "metadata": {},
    "created_at": "string",
    "updated_at": "string"
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Execute Augmentation

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

augmentation_id*Augmentation Id

namespace_id*Namespace Id

workspace_id*Workspace Id

app_id*App Id

thread_id?string|null

payload?

timeout_seconds?integer|null

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/augmentations/string/execute" \  -H "Content-Type: application/json" \  -d '{    "augmentation_id": "string",    "namespace_id": "string",    "workspace_id": "string",    "app_id": "string"  }'

{
  "message": "string",
  "execution_id": "string",
  "status": "pending"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Execution Status

Path Parameters

org_id*Org Id

execution_id*Execution Id

Query Parameters

namespace_id?|

Namespace ID (optional, improves lookup performance)

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/executions/string"

{
  "execution_id": "string",
  "augmentation_id": "string",
  "status": "pending",
  "current_stage_number": 0,
  "total_stages": 0,
  "completed_stages": 0,
  "progress_percentage": 0,
  "created_at": "string",
  "started_at": "string",
  "completed_at": "string",
  "execution_time_ms": 0,
  "error": "string",
  "environment_id": "string",
  "release_id": "string",
  "paused_at": "string",
  "paused_step_id": "string",
  "paused_stage_index": 0,
  "approval_decision": "string",
  "approval_decided_by": "string",
  "approval_decided_at": "string",
  "approval_reason": "string",
  "pending_input": {},
  "stage_results": [],
  "output_data": {}
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Cancel Execution

Path Parameters

org_id*Org Id

execution_id*Execution Id

Query Parameters

namespace_id*Namespace Id

Namespace ID

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/string/augmentations/executions/string/cancel?namespace_id=string"

null

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Augmentation Variables

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

Query Parameters

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/string/variables?workspace_id=string"

{
  "augmentation_id": "string",
  "all_variables": [
    {
      "path": "string",
      "name": "string",
      "description": "string",
      "type": "any",
      "source": "endpoint_payload",
      "availability": "always",
      "stage_name": "string",
      "step_name": "string",
      "field_schema": {}
    }
  ],
  "endpoint_payload": [
    {
      "path": "string",
      "name": "string",
      "description": "string",
      "type": "any",
      "source": "endpoint_payload",
      "availability": "always",
      "stage_name": "string",
      "step_name": "string",
      "field_schema": {}
    }
  ],
  "execution_context": [
    {
      "path": "string",
      "name": "string",
      "description": "string",
      "type": "any",
      "source": "endpoint_payload",
      "availability": "always",
      "stage_name": "string",
      "step_name": "string",
      "field_schema": {}
    }
  ],
  "parameters": [
    {
      "path": "string",
      "name": "string",
      "description": "string",
      "type": "any",
      "source": "endpoint_payload",
      "availability": "always",
      "stage_name": "string",
      "step_name": "string",
      "field_schema": {}
    }
  ],
  "connections": [
    {
      "path": "string",
      "name": "string",
      "description": "string",
      "type": "any",
      "source": "endpoint_payload",
      "availability": "always",
      "stage_name": "string",
      "step_name": "string",
      "field_schema": {}
    }
  ],
  "volumes": [
    {
      "volume_name": "string",
      "volume_id": "string",
      "access_level": "string",
      "path_pattern": "string",
      "available_methods": [
        "string"
      ],
      "top_level_paths": [
        "string"
      ]
    }
  ],
  "stages": {
    "property1": {
      "stage_name": "string",
      "stage_id": "string",
      "outputs": [
        {
          "path": "string",
          "name": "string",
          "description": "string",
          "type": "any",
          "source": "endpoint_payload",
          "availability": "always",
          "stage_name": "string",
          "step_name": "string",
          "field_schema": {}
        }
      ],
      "steps": {
        "property1": [
          {
            "path": "string",
            "name": "string",
            "description": "string",
            "type": "any",
            "source": "endpoint_payload",
            "availability": "always",
            "stage_name": "string",
            "step_name": "string",
            "field_schema": {}
          }
        ],
        "property2": [
          {
            "path": "string",
            "name": "string",
            "description": "string",
            "type": "any",
            "source": "endpoint_payload",
            "availability": "always",
            "stage_name": "string",
            "step_name": "string",
            "field_schema": {}
          }
        ]
      }
    },
    "property2": {
      "stage_name": "string",
      "stage_id": "string",
      "outputs": [
        {
          "path": "string",
          "name": "string",
          "description": "string",
          "type": "any",
          "source": "endpoint_payload",
          "availability": "always",
          "stage_name": "string",
          "step_name": "string",
          "field_schema": {}
        }
      ],
      "steps": {
        "property1": [
          {
            "path": "string",
            "name": "string",
            "description": "string",
            "type": "any",
            "source": "endpoint_payload",
            "availability": "always",
            "stage_name": "string",
            "step_name": "string",
            "field_schema": {}
          }
        ],
        "property2": [
          {
            "path": "string",
            "name": "string",
            "description": "string",
            "type": "any",
            "source": "endpoint_payload",
            "availability": "always",
            "stage_name": "string",
            "step_name": "string",
            "field_schema": {}
          }
        ]
      }
    }
  }
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Variables At Context

Path Parameters

org_id*Org Id

augmentation_id*Augmentation Id

Query Parameters

workspace_id*Workspace Id

Workspace ID

stage_name?|

Current stage name

stage_id?|

Current stage ID (preferred over stage_name for new steps)

step_name?|

Current step name (can be empty for new steps)

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/string/variables/context?workspace_id=string"

{
  "available": [
    {
      "path": "string",
      "name": "string",
      "description": "string",
      "type": "any",
      "source": "endpoint_payload",
      "availability": "always",
      "stage_name": "string",
      "step_name": "string",
      "field_schema": {}
    }
  ],
  "current_stage": "string",
  "current_step": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Get Step Output Schema

Path Parameters

org_id*Org Id

step_id*Step Id

Step ID

Query Parameters

workspace_id*Workspace Id

Workspace ID

Header Parameters

authorization?string|null

Response Body

`application/json`

curl -X GET "https://loading/v1/orgs/string/augmentations/steps/string/outputs?workspace_id=string"

{
  "step_id": "string",
  "step_name": "string",
  "step_type": "string",
  "outputs": [
    {
      "name": "string",
      "path": "string",
      "type": "any",
      "description": "string"
    }
  ]
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

Submit Approval Decision

Path Parameters

execution_id*Execution Id

Query Parameters

workspace_id*Workspace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

decision*Decision

'approved' or 'rejected'

reason?|

Reason for the decision

Response Body

`application/json`

curl -X POST "https://loading/v1/orgs/{org_id}/augmentations/executions/string/approval?workspace_id=string" \  -H "Content-Type: application/json" \  -d '{    "decision": "string"  }'

{
  "execution_id": "string",
  "decision": "string",
  "status": "string",
  "message": "string"
}

{
  "error": "AUTHENTICATION_FAILED",
  "message": "Authentication required",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 401
}

{
  "error": "FORBIDDEN",
  "message": "You don't have permission to perform this action",
  "details": {
    "required_permission": "resource:action"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 403
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "The requested resource was not found",
  "details": {
    "resource_type": "example",
    "resource_id": "xxx"
  },
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 404
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

{
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred",
  "details": {},
  "timestamp": "2025-01-01T00:00:00.000000",
  "status_code": 500
}

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

401application/json

403application/json

404application/json

422application/json

500application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`