Request and response schemas

Look up the exact fields, types, defaults, and constraints declared by the customer API.

On this page

AbortUploadRequest AlertRuleCreateRequest AlertRuleListResponse AlertRuleResponse ApiKeyCreateRequest ApiKeyCreateResponse ApiKeyListItem ApiKeyListResponse AuditLogListResponse AuditLogResponse AwsRegisterRequest BackfillIntervalView BackfillListResponse BackfillRequest BackfillResponse BindingSpec ChangeVersionRequest ChannelCreateRequest ChannelListResponse ChannelResponse CloudConnectionCreateRequest CloudConnectionUpdateRequest CompleteUploadRequest CompleteUploadResponse CompletedPart ConfigFieldSchema ConnectorCreateRequest ConnectorDefSchema ConnectorUpdateRequest CurrentUserResponse DagDraftCreateRequest DagDraftListResponse DagDraftResponse DagDraftUpdateRequest DatasetCreateRequest DatasetUpdateRequest DecisionRequest DepPackageCreateRequest DepPackageDependency DepPackageListResponse DepPackageResponse DepPackageUpdateRequest DeploymentListItem DeploymentListResponse DeploymentRequest DeploymentResponse DeviceAuthorizationApproveRequest DeviceAuthorizationApproveResponse DeviceAuthorizationStartResponse DeviceAuthorizationTokenRequest DeviceAuthorizationTokenResponse DiscoverS3BucketsRequest EnvironmentBinding EnvironmentCreateRequest EnvironmentListResponse EnvironmentReorderRequest EnvironmentResponse EnvironmentUpdateRequest FieldModel FlowDetailResponse FlowListItem FlowListResponse FlowRegisterRequest FlowRegisterResponse FlowSpecModel FlowVersionItem FlowVersionListResponse GcpRegisterRequest HTTPValidationError HealthCheckResponse HealthComponentResponse InitiateUploadRequest InitiateUploadResponse LoginRequest LoginResponse LogoutResponse MemberResponse OrgCreateRequest OrgResponse PyPISearchResponse PyPISearchResult QuotaStatusResponse RegisterNodeRequest ReleaseClaimRequest RetryResponse RolePermissionsResponse RollbackRequest RollbackResponse RunRequest RunResponse ScheduleListResponse SchedulePatchRequest ScheduleRequest ScheduleResponse ScheduleTriggerRequest ScopeSpec SecretCopyRequest SecretCreateRequest SecretListResponse SecretMetadataPatchRequest SecretResponse SecretUpdateRequest SecretValueResponse SensorCreateRequest SensorListResponse SensorResponse SubscriptionResponse UpdateDeploymentSettingsRequest UpdateMemberRoleRequest UpdateNodeRequest UploadPartUrl UsageDashboardResponse UsageSummaryResponse UsageTimeseriesResponse ValidateConnectionRequest ValidateConnectionResponse ValidationError

This reference is generated from the application models. Use the endpoint directory to find the appropriate request or response. Required means the field is required in that model; response fields and request fields have different purposes. Omitted response defaults do not imply the caller can write them.

An any or object field is intentionally not fully described by the model. Its resource guide documents validation, payload examples, permissions, and behavior. Nullability is separate from whether a field is required. Treat artifact locators and upload keys as opaque values and return them unchanged where requested.

AbortUploadRequest

Field	Type	Required	Defaults and constraints
`upload_id`	`string`	Yes	None
`artifact_key`	`string`	Yes	None

AlertRuleCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`trigger`	`string`	Yes	None
`flow_name`	`string` or `null`	No	None
`channel_ids`	array of `string` or `null`	No	None
`sla_seconds`	`integer` or `null`	No	None

AlertRuleListResponse

Field	Type	Required	Defaults and constraints
`items`	array of AlertRuleResponse	Yes	None

AlertRuleResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`rule_id`	`string`	Yes	None
`name`	`string`	Yes	None
`trigger`	`string`	Yes	None
`flow_name`	`string` or `null`	No	None
`channel_ids`	array of `string` or `null`	No	None
`sla_seconds`	`integer` or `null`	No	None
`enabled`	`boolean`	No	default: `true`
`created_by`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None

ApiKeyCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`scopes`	array of `string`	No	None
`expires_in_days`	`integer` or `null`	No	None

ApiKeyCreateResponse

Field	Type	Required	Defaults and constraints
`key_id`	`string`	Yes	None
`key`	`string`	Yes	None
`key_prefix`	`string`	Yes	None
`name`	`string`	Yes	None
`scopes`	array of `string`	Yes	None
`created_at`	`string` or `null`	No	None
`expires_at`	`integer` or `null`	No	None

ApiKeyListItem

Field	Type	Required	Defaults and constraints
`key_id`	`string`	Yes	None
`key_prefix`	`string`	Yes	None
`name`	`string`	Yes	None
`scopes`	array of `string`	Yes	None
`created_by`	`string`	Yes	None
`created_at`	`string` or `null`	No	None
`last_used_at`	`string` or `null`	No	None
`expires_at`	`integer` or `null`	No	None

ApiKeyListResponse

Field	Type	Required	Defaults and constraints
`items`	array of ApiKeyListItem	Yes	None

AuditLogListResponse

Field	Type	Required	Defaults and constraints
`items`	array of AuditLogResponse	Yes	None

AuditLogResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`event_time`	`string`	Yes	None
`resource_type`	`string`	Yes	None
`resource_id`	`string`	Yes	None
`action`	`string`	Yes	None
`actor_email`	`string` or `null`	No	None
`before_json`	`object` or `null`	No	None
`after_json`	`object` or `null`	No	None
`ip_address`	`string` or `null`	No	None
`metadata`	`object` or `null`	No	None

AwsRegisterRequest

Field	Type	Required	Defaults and constraints
`role_arn`	`string`	Yes	maxLength: `2048`
`account_id`	`string` or `null`	No	None
`stack_id`	`string` or `null`	No	None

BackfillIntervalView

Field	Type	Required	Defaults and constraints
`index`	`integer`	Yes	None
`logical_epoch`	`integer`	Yes	None
`logical_at`	`string`	Yes	None
`run_id`	`string` or `null`	No	None
`status`	`string`	No	default: `"PENDING"`

BackfillListResponse

Field	Type	Required	Defaults and constraints
`items`	array of BackfillResponse	Yes	None

BackfillRequest

Field	Type	Required	Defaults and constraints
`from`	`string`	Yes	None
`to`	`string`	Yes	None
`parameters`	`object`	No	None
`max_concurrency`	`integer`	No	default: `1`
`dry_run`	`boolean`	No	default: `false`
`interval_seconds`	`integer` or `null`	No	None
`cron_expression`	`string` or `null`	No	None
`environment`	`string` or `null`	No	None

BackfillResponse

Field	Type	Required	Defaults and constraints
`backfill_id`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`status`	`string`	Yes	None
`mode`	`string` or `null`	No	None
`total`	`integer`	Yes	None
`dispatched`	`integer`	Yes	None
`completed`	`integer`	Yes	None
`failed`	`integer`	Yes	None
`max_concurrency`	`integer`	Yes	None
`from_epoch`	`integer`	Yes	None
`to_epoch`	`integer`	Yes	None
`parameters`	`object`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None
`dry_run`	`boolean`	No	default: `false`
`intervals`	array of BackfillIntervalView	No	None

BindingSpec

Field	Type	Required	Defaults and constraints
`environments`	object of EnvironmentBinding	No	None
`require_declaration`	`boolean`	No	default: `false`

ChangeVersionRequest

Field	Type	Required	Defaults and constraints
`flow_version`	`string`	Yes	None

ChannelCreateRequest

Field	Type	Required	Defaults and constraints
`channel_type`	`string`	Yes	None
`name`	`string`	Yes	None
`config_json`	`string` or `null`	No	None

ChannelListResponse

Field	Type	Required	Defaults and constraints
`items`	array of ChannelResponse	Yes	None

ChannelResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`channel_id`	`string`	Yes	None
`channel_type`	`string`	Yes	None
`name`	`string`	Yes	None
`config_json`	`string` or `null`	No	None
`enabled`	`boolean`	No	default: `true`
`created_by`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None

CloudConnectionCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	minLength: `1`; maxLength: `100`
`slug`	`string`	Yes	minLength: `2`; maxLength: `63`
`provider`	`string`	Yes	None
`auth_mode`	`string`	Yes	None
`identity`	`object`	No	None
`secret`	`object`	No	None
`scope`	ScopeSpec	No	None
`bindings`	BindingSpec	No	None
`tier`	`string`	No	default: `"shared_broker"`; pattern: `"^(shared_broker\|tenant_role)$"`

CloudConnectionUpdateRequest

Field	Type	Required	Defaults and constraints
`name`	`string` or `null`	No	None
`scope`	ScopeSpec or `null`	No	None
`bindings`	BindingSpec or `null`	No	None
`identity`	`object` or `null`	No	None

CompleteUploadRequest

Field	Type	Required	Defaults and constraints
`upload_id`	`string`	Yes	None
`artifact_key`	`string`	Yes	None
`parts`	array of CompletedPart	Yes	None
`deployment_name`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`status`	`string`	No	default: `"ACTIVE"`
`schedule`	`string` or `null`	No	None
`timezone`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`namespace`	`string` or `null`	No	None
`flow_spec`	`object` or `null`	No	None
`environment`	`string` or `null`	No	None
`code_hash`	`string` or `null`	No	None
`dep_package_slugs`	array of `string` or `null`	No	None
`execution_mode`	`string`	No	default: `"nano"`

CompleteUploadResponse

Field	Type	Required	Defaults and constraints
`artifact_s3_uri`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`deployment_name`	`string`	Yes	None
`deployment_version`	`integer` or `null`	No	None
`environment`	`string` or `null`	No	None
`code_hash`	`string` or `null`	No	None

CompletedPart

Field	Type	Required	Defaults and constraints
`part_number`	`integer`	Yes	None
`etag`	`string`	Yes	None

ConfigFieldSchema

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`label`	`string`	Yes	None
`type`	`string`	No	default: `"string"`
`required`	`boolean`	No	default: `false`
`default`	`any`	No	None
`placeholder`	`string`	No	default: `""`
`options`	array of object of `string` or `null`	No	None
`min`	`number` or `null`	No	None
`max`	`number` or `null`	No	None
`validation_regex`	`string` or `null`	No	None
`group`	`string`	No	default: `"general"`
`advanced`	`boolean`	No	default: `false`
`depends_on`	`string` or `null`	No	None

ConnectorCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	minLength: `1`; maxLength: `100`
`connector_type_id`	`string`	Yes	minLength: `1`
`config`	`object`	No	None
`enabled`	`boolean`	No	default: `true`

ConnectorDefSchema

Field	Type	Required	Defaults and constraints
`id`	`string`	Yes	None
`name`	`string`	Yes	None
`direction`	`string`	No	default: `"inbound"`
`data_types`	array of `string`	No	None
`cardinality`	`string`	No	default: `"zero_or_many"`
`required`	`boolean`	No	default: `false`
`position_hint`	`string` or `null`	No	None
`metadata`	`object`	No	None

ConnectorUpdateRequest

Field	Type	Required	Defaults and constraints
`name`	`string` or `null`	No	None
`config`	`object` or `null`	No	None
`enabled`	`boolean` or `null`	No	None

CurrentUserResponse

Field	Type	Required	Defaults and constraints
`user_email`	`string`	Yes	None
`super_admin`	`boolean`	Yes	None
`org_id`	`string`	No	default: `""`
`org_name`	`string`	No	default: `""`
`role`	`string`	No	default: `""`

DagDraftCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`canvas_json`	`string`	Yes	None
`flow_name`	`string` or `null`	No	None
`flow_version`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None

DagDraftListResponse

Field	Type	Required	Defaults and constraints
`items`	array of DagDraftResponse	Yes	None

DagDraftResponse

Field	Type	Required	Defaults and constraints
`draft_id`	`string`	Yes	None
`org_id`	`string`	Yes	None
`name`	`string`	Yes	None
`canvas_json`	`string`	Yes	None
`created_by`	`string` or `null`	No	None
`flow_name`	`string` or `null`	No	None
`flow_version`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None

DagDraftUpdateRequest

Field	Type	Required	Defaults and constraints
`name`	`string` or `null`	No	None
`canvas_json`	`string` or `null`	No	None
`flow_name`	`string` or `null`	No	None
`flow_version`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None

DatasetCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	minLength: `1`; maxLength: `200`
`namespace`	`string`	No	default: `"default"`; minLength: `1`; maxLength: `200`
`owner`	`string` or `null`	No	None
`schema`	array of FieldModel	No	None
`freshness_sla_seconds`	`integer` or `null`	No	None
`volume_bounds`	object of `integer` or `null`	No	None
`tags`	array of `string`	No	None
`contract_version`	`string` or `null`	No	None
`contract_ref`	`string` or `null`	No	None

DatasetUpdateRequest

Field	Type	Required	Defaults and constraints
`owner`	`string` or `null`	No	None
`schema`	array of FieldModel or `null`	No	None
`freshness_sla_seconds`	`integer` or `null`	No	None
`volume_bounds`	object of `integer` or `null`	No	None
`tags`	array of `string` or `null`	No	None
`contract_version`	`string` or `null`	No	None
`contract_ref`	`string` or `null`	No	None

DecisionRequest

Field	Type	Required	Defaults and constraints
`comment`	`string` or `null`	No	None

DepPackageCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`python_version`	`string`	No	default: `"3.12"`
`dependencies`	array of DepPackageDependency	Yes	None

DepPackageDependency

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`version_spec`	`string`	No	default: `""`

DepPackageListResponse

Field	Type	Required	Defaults and constraints
`items`	array of DepPackageResponse	Yes	None

DepPackageResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`package_id`	`string`	Yes	None
`slug`	`string` or `null`	No	None
`name`	`string`	Yes	None
`python_version`	`string`	Yes	None
`dependencies`	array of DepPackageDependency	Yes	None
`validation_status`	`string`	Yes	None
`validation_errors`	array of `string` or `null`	No	None
`packaging_status`	`string`	Yes	None
`current_dependency`	`string` or `null`	No	None
`package_s3_uri`	`string` or `null`	No	None
`package_size`	`integer` or `null`	No	None
`error_message`	`string` or `null`	No	None
`build_log_group`	`string` or `null`	No	None
`build_log_stream`	`string` or `null`	No	None
`created_by`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None

DepPackageUpdateRequest

Field	Type	Required	Defaults and constraints
`name`	`string` or `null`	No	None
`python_version`	`string` or `null`	No	None
`dependencies`	array of DepPackageDependency or `null`	No	None

DeploymentListItem

Field	Type	Required	Defaults and constraints
`deployment_name`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`environment`	`string` or `null`	No	None
`schedule`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`dep_package_slugs`	array of `string` or `null`	No	None
`execution_mode`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None
`promoted_from_env`	`string` or `null`	No	None
`promoted_from_deployment`	`string` or `null`	No	None
`promoted_at`	`string` or `null`	No	None

DeploymentListResponse

Field	Type	Required	Defaults and constraints
`items`	array of DeploymentListItem	Yes	None

DeploymentRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`environment`	`string` or `null`	No	None
`schedule`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`dep_package_slugs`	array of `string` or `null`	No	None
`execution_mode`	`string`	No	default: `"nano"`

DeploymentResponse

Field	Type	Required	Defaults and constraints
`deployment_name`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`environment`	`string` or `null`	No	None
`dep_package_slugs`	array of `string` or `null`	No	None
`execution_mode`	`string` or `null`	No	None

DeviceAuthorizationApproveRequest

Field	Type	Required	Defaults and constraints
`user_code`	`string`	Yes	minLength: `8`; maxLength: `32`

DeviceAuthorizationApproveResponse

Field	Type	Required	Defaults and constraints
`status`	`string`	No	default: `"approved"`
`user_email`	`string`	Yes	None
`org_id`	`string`	No	default: `""`
`workspace_name`	`string`	No	default: `""`

DeviceAuthorizationStartResponse

Field	Type	Required	Defaults and constraints
`device_code`	`string`	Yes	None
`user_code`	`string`	Yes	None
`expires_in`	`integer`	Yes	None
`interval`	`integer`	Yes	None

DeviceAuthorizationTokenRequest

Field	Type	Required	Defaults and constraints
`device_code`	`string`	Yes	minLength: `40`; maxLength: `256`

DeviceAuthorizationTokenResponse

Field	Type	Required	Defaults and constraints
`access_token`	`string`	Yes	None
`token_type`	`string`	No	default: `"Bearer"`
`expires_at`	`integer`	Yes	None
`user_email`	`string`	Yes	None
`org_id`	`string`	No	default: `""`
`workspace_name`	`string`	No	default: `""`

DiscoverS3BucketsRequest

Field	Type	Required	Defaults and constraints
`region`	`string`	Yes	minLength: `1`
`access_key_id`	`string`	Yes	minLength: `1`
`secret_access_key`	`string`	Yes	minLength: `1`
`role_arn`	`string` or `null`	No	None

EnvironmentBinding

Field	Type	Required	Defaults and constraints
`enabled`	`boolean`	No	default: `true`
`locations`	array of `string`	No	None
`deployments`	array of `string`	No	None
`max_ttl_seconds`	`integer`	No	default: `3600`; minimum: `900.0`; maximum: `3600.0`

EnvironmentCreateRequest

Field	Type	Required	Defaults and constraints
`env_name`	`string`	Yes	None
`default_executor`	`string` or `null`	No	None
`config_json`	`object` or `null`	No	None
`variables_json`	`object` or `null`	No	None
`is_protected`	`boolean`	No	default: `false`
`promotion_order`	`integer` or `null`	No	None
`upstream_env`	`string` or `null`	No	None
`color`	`string` or `null`	No	None

EnvironmentListResponse

Field	Type	Required	Defaults and constraints
`items`	array of EnvironmentResponse	Yes	None

EnvironmentReorderRequest

Field	Type	Required	Defaults and constraints
`order`	array of `string`	Yes	None

EnvironmentResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`env_name`	`string`	Yes	None
`default_executor`	`string` or `null`	No	None
`config_json`	`object` or `null`	No	None
`variables_json`	`object` or `null`	No	None
`disabled_vars`	array of `string` or `null`	No	None
`is_protected`	`boolean`	No	default: `false`
`is_system`	`boolean`	No	default: `false`
`promotion_order`	`integer` or `null`	No	None
`upstream_env`	`string` or `null`	No	None
`color`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None

EnvironmentUpdateRequest

Field	Type	Required	Defaults and constraints
`default_executor`	`string` or `null`	No	None
`config_json`	`object` or `null`	No	None
`variables_json`	`object` or `null`	No	None
`is_protected`	`boolean` or `null`	No	None
`promotion_order`	`integer` or `null`	No	None
`upstream_env`	`string` or `null`	No	None
`color`	`string` or `null`	No	None

FieldModel

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	minLength: `1`
`type`	`string`	No	default: `"any"`
`required`	`boolean`	No	default: `true`
`nullable`	`boolean`	No	default: `false`

FlowDetailResponse

Field	Type	Required	Defaults and constraints
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`artifact_s3_uri`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None
`schedule`	`string` or `null`	No	None
`status`	`string` or `null`	No	None
`deployment_name`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`namespace`	`string` or `null`	No	None
`deployment_version`	`integer` or `null`	No	None
`code_hash`	`string` or `null`	No	None
`flow_spec`	FlowSpecModel	Yes	None

FlowListItem

Field	Type	Required	Defaults and constraints
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`artifact_s3_uri`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None
`schedule`	`string` or `null`	No	None
`status`	`string` or `null`	No	None
`deployment_name`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`namespace`	`string` or `null`	No	None
`deployment_version`	`integer` or `null`	No	None
`environment`	`string` or `null`	No	None
`code_hash`	`string` or `null`	No	None

FlowListResponse

Field	Type	Required	Defaults and constraints
`items`	array of FlowListItem	Yes	None
`next_token`	`string` or `null`	No	None

FlowRegisterRequest

Field	Type	Required	Defaults and constraints
`flow_spec`	FlowSpecModel	Yes	None
`artifact_s3_uri`	`string` or `null`	No	None
`schedule`	`string` or `null`	No	None
`timezone`	`string` or `null`	No	None
`status`	`string` or `null`	No	None
`deployment_name`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`namespace`	`string` or `null`	No	None

FlowRegisterResponse

Field	Type	Required	Defaults and constraints
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`artifact_s3_uri`	`string` or `null`	No	None
`schedule`	`string` or `null`	No	None
`status`	`string` or `null`	No	None
`deployment_name`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`namespace`	`string` or `null`	No	None
`deployment_version`	`integer` or `null`	No	None
`environment`	`string` or `null`	No	None
`code_hash`	`string` or `null`	No	None

FlowSpecModel

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`version`	`string`	Yes	None
`created_at`	`string` or `null`	No	None
`tasks`	`object`	No	None
`task_runs`	array of `object`	No	None
`edges`	array of array of `string`	No	None
`outputs`	`any` or `null`	No	None
`parameters`	array of `object`	No	None

FlowVersionItem

Field	Type	Required	Defaults and constraints
`flow_version`	`string`	Yes	None
`deployment_version`	`integer` or `null`	No	None
`artifact_s3_uri`	`string` or `null`	No	None
`status`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None

FlowVersionListResponse

Field	Type	Required	Defaults and constraints
`flow_name`	`string`	Yes	None
`items`	array of FlowVersionItem	Yes	None

GcpRegisterRequest

Field	Type	Required	Defaults and constraints
`pool_id`	`string` or `null`	No	None
`provider_id`	`string` or `null`	No	None
`project_number`	`string` or `null`	No	None
`service_account_email`	`string` or `null`	No	None

HTTPValidationError

Field	Type	Required	Defaults and constraints
`detail`	array of ValidationError	No	None

HealthCheckResponse

Field	Type	Required	Defaults and constraints
`status`	`string`	Yes	None
`version`	`string`	Yes	None
`components`	array of HealthComponentResponse	Yes	None
`timestamp`	`string`	Yes	None

HealthComponentResponse

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`status`	`string`	Yes	None
`latency_ms`	`number` or `null`	No	None
`message`	`string` or `null`	No	None

InitiateUploadRequest

Field	Type	Required	Defaults and constraints
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`deployment_name`	`string`	Yes	None
`file_size`	`integer`	Yes	None
`part_size`	`integer`	No	default: `8388608`

InitiateUploadResponse

Field	Type	Required	Defaults and constraints
`upload_id`	`string`	Yes	None
`artifact_key`	`string`	Yes	None
`parts`	array of UploadPartUrl	Yes	None
`expires_at`	`string`	Yes	None

LoginRequest

Field	Type	Required	Defaults and constraints
`email`	`string`	Yes	None

LoginResponse

Field	Type	Required	Defaults and constraints
`access_token`	`string`	Yes	None
`token_type`	`string`	No	default: `"Bearer"`
`expires_at`	`integer`	Yes	None

LogoutResponse

Field	Type	Required	Defaults and constraints
`status`	`string`	Yes	None

MemberResponse

Field	Type	Required	Defaults and constraints
`user_email`	`string`	Yes	None
`org_id`	`string`	Yes	None
`role`	`string`	Yes	None
`joined_at`	`string` or `null`	No	None

OrgCreateRequest

Field	Type	Required	Defaults and constraints
`org_name`	`string`	Yes	None
`plan`	`string`	No	default: `"free"`

OrgResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`org_name`	`string`	Yes	None
`owner_email`	`string`	Yes	None
`plan`	`string`	Yes	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None

PyPISearchResponse

Field	Type	Required	Defaults and constraints
`results`	array of PyPISearchResult	Yes	None

PyPISearchResult

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`version`	`string`	Yes	None
`summary`	`string`	Yes	None
`versions`	array of `string`	Yes	None

QuotaStatusResponse

Field	Type	Required	Defaults and constraints
`plan`	`string`	Yes	None
`runs_used`	`integer`	Yes	None
`runs_limit`	`integer`	Yes	None
`runs_remaining`	`integer`	Yes	None
`compute_used`	`number`	Yes	None
`compute_limit`	`integer`	Yes	None
`api_calls_used`	`integer`	Yes	None
`api_calls_limit`	`integer`	Yes	None
`flows_used`	`integer`	Yes	None
`flows_limit`	`integer`	Yes	None
`over_limit`	`boolean`	Yes	None
`warning`	`boolean`	Yes	None
`details`	array of `string`	Yes	None

RegisterNodeRequest

Field	Type	Required	Defaults and constraints
`node_type`	`string`	Yes	minLength: `1`; maxLength: `128`; pattern: `"^[a-z][a-z0-9_]*$"`
`label`	`string`	Yes	minLength: `1`; maxLength: `200`
`category`	`string`	No	default: `"custom"`
`icon`	`string`	No	default: `"Code"`
`color`	`string`	No	default: `"slate"`
`version`	`string`	No	default: `"1.0.0"`
`author`	`string`	No	default: `""`
`tags`	array of `string`	No	None
`connectors`	array of ConnectorDefSchema	No	None
`config_schema`	array of ConfigFieldSchema	No	None
`import_path`	`string`	No	default: `""`
`documentation_url`	`string`	No	default: `""`
`source_url`	`string`	No	default: `""`

ReleaseClaimRequest

Field	Type	Required	Defaults and constraints
`reason`	`string` or `null`	No	None

RetryResponse

Field	Type	Required	Defaults and constraints
`run_id`	`string`	Yes	None
`parent_run_id`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`status`	`string`	Yes	None
`partial`	`boolean`	No	default: `false`
`reused_task_count`	`integer`	No	default: `0`
`skip_task_ids`	array of `string`	No	None

RolePermissionsResponse

Field	Type	Required	Defaults and constraints
`roles`	object of array of `string`	Yes	None

RollbackRequest

Field	Type	Required	Defaults and constraints
`target_flow_version`	`string`	Yes	None

RollbackResponse

Field	Type	Required	Defaults and constraints
`deployment_name`	`string`	Yes	None
`previous_flow_version`	`string`	Yes	None
`new_flow_version`	`string`	Yes	None
`rolled_back_at`	`string`	Yes	None

RunRequest

Field	Type	Required	Defaults and constraints
`deployment`	`string` or `null`	No	None
`flow_name`	`string` or `null`	No	None
`flow_version`	`string` or `null`	No	None
`parameters`	`object`	No	None
`execute`	`boolean`	No	default: `false`
`executor`	`string` or `null`	No	None
`execution_mode`	`string` or `null`	No	None
`environment`	`string` or `null`	No	None

RunResponse

Field	Type	Required	Defaults and constraints
`run_id`	`string`	Yes	None
`run_slug`	`string` or `null`	No	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`status`	`string`	Yes	None
`environment`	`string` or `null`	No	None
`executor`	`string` or `null`	No	None
`execution_mode`	`string` or `null`	No	None
`trigger_source`	`string` or `null`	No	None
`triggered_by`	`string` or `null`	No	None
`cancelled_by`	`string` or `null`	No	None
`cancelled_at`	`string` or `null`	No	None

ScheduleListResponse

Field	Type	Required	Defaults and constraints
`items`	array of ScheduleResponse	Yes	None

SchedulePatchRequest

Field	Type	Required	Defaults and constraints
`enabled`	`boolean` or `null`	No	None
`timezone`	`string` or `null`	No	None
`catchup_policy`	`none`, `all` or `null`	No	None
`cron_expression`	`string` or `null`	No	None
`interval_seconds`	`integer` or `null`	No	None
`one_time_at`	`string` or `null`	No	None
`start_at`	`string` or `null`	No	None
`end_at`	`string` or `null`	No	None
`parameters`	`object` or `null`	No	None
`environment`	`string` or `null`	No	None

ScheduleRequest

Field	Type	Required	Defaults and constraints
`schedule_id`	`string` or `null`	No	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`deployment_name`	`string` or `null`	No	None
`mode`	`cron`, `interval`, `one_time`, `manual`	Yes	None
`enabled`	`boolean`	No	default: `true`
`timezone`	`string`	No	default: `"America/New_York"`
`catchup_policy`	`none`, `all`	No	default: `"none"`
`cron_expression`	`string` or `null`	No	None
`interval_seconds`	`integer` or `null`	No	None
`one_time_at`	`string` or `null`	No	None
`start_at`	`string` or `null`	No	None
`end_at`	`string` or `null`	No	None
`parameters`	`object`	No	None
`environment`	`string` or `null`	No	None

ScheduleResponse

Field	Type	Required	Defaults and constraints
`schedule_id`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_version`	`string`	Yes	None
`deployment_name`	`string` or `null`	No	None
`environment`	`string` or `null`	No	None
`mode`	`cron`, `interval`, `one_time`, `manual`	Yes	None
`enabled`	`boolean`	Yes	None
`timezone`	`string`	Yes	None
`catchup_policy`	`none`, `all`	Yes	None
`cron_expression`	`string` or `null`	No	None
`interval_seconds`	`integer` or `null`	No	None
`one_time_at`	`string` or `null`	No	None
`start_at`	`string` or `null`	No	None
`end_at`	`string` or `null`	No	None
`parameters`	`object`	Yes	None
`next_run_epoch`	`integer` or `null`	No	None
`next_run_at`	`string` or `null`	No	None
`last_triggered_at`	`string` or `null`	No	None
`last_run_id`	`string` or `null`	No	None
`last_run_slug`	`string` or `null`	No	None
`last_error`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None

ScheduleTriggerRequest

Field	Type	Required	Defaults and constraints
`parameters`	`object`	No	None

ScopeSpec

Field	Type	Required	Defaults and constraints
`resources`	array of `string`	No	maxItems: `50`
`access`	`string`	No	default: `"read"`; pattern: `"^(read\|readwrite)$"`
`regions`	array of `string`	No	maxItems: `50`
`max_ttl_seconds`	`integer`	No	default: `3600`; minimum: `900.0`; maximum: `3600.0`
`kms_key_arns`	array of `string`	No	maxItems: `50`

SecretCopyRequest

Field	Type	Required	Defaults and constraints
`logical_name`	`string`	Yes	None
`source_environment`	`string`	Yes	None
`target_environment`	`string`	Yes	None

SecretCreateRequest

Field	Type	Required	Defaults and constraints
`secret_name`	`string`	Yes	None
`value`	`string`	Yes	None
`environment`	`string` or `null`	No	None

SecretListResponse

Field	Type	Required	Defaults and constraints
`items`	array of SecretResponse	Yes	None

SecretMetadataPatchRequest

Field	Type	Required	Defaults and constraints
`enabled`	`boolean` or `null`	No	None

SecretResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`secret_name`	`string`	Yes	None
`logical_name`	`string`	No	default: `""`
`created_by`	`string` or `null`	No	None
`environment`	`string` or `null`	No	None
`enabled`	`boolean`	No	default: `true`
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None

SecretUpdateRequest

Field	Type	Required	Defaults and constraints
`value`	`string`	Yes	None

SecretValueResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`secret_name`	`string`	Yes	None
`logical_name`	`string`	No	default: `""`
`created_by`	`string` or `null`	No	None
`environment`	`string` or `null`	No	None
`enabled`	`boolean`	No	default: `true`
`created_at`	`string` or `null`	No	None
`updated_at`	`string` or `null`	No	None
`decrypted_value`	`string` or `null`	No	None

SensorCreateRequest

Field	Type	Required	Defaults and constraints
`name`	`string`	Yes	None
`sensor_type`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_params_json`	`object` or `null`	No	None
`config_json`	`object` or `null`	No	None

SensorListResponse

Field	Type	Required	Defaults and constraints
`items`	array of SensorResponse	Yes	None

SensorResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`sensor_id`	`string`	Yes	None
`name`	`string`	Yes	None
`sensor_type`	`string`	Yes	None
`flow_name`	`string`	Yes	None
`flow_params_json`	`object` or `null`	No	None
`config_json`	`object` or `null`	No	None
`enabled`	`boolean`	No	default: `true`
`webhook_token`	`string` or `null`	No	None
`last_triggered_at`	`string` or `null`	No	None
`created_by`	`string` or `null`	No	None
`created_at`	`string` or `null`	No	None

SubscriptionResponse

Field	Type	Required	Defaults and constraints
`org_id`	`string`	Yes	None
`plan`	`string`	Yes	None
`status`	`string`	Yes	None
`stripe_customer_id`	`string` or `null`	No	None
`current_period_start`	`string` or `null`	No	None
`current_period_end`	`string` or `null`	No	None

UpdateDeploymentSettingsRequest

Field	Type	Required	Defaults and constraints
`execution_mode`	`string` or `null`	No	None
`default_executor`	`string` or `null`	No	None
`schedule`	`string` or `null`	No	None
`tags`	object of `string` or `null`	No	None
`dep_package_slugs`	array of `string` or `null`	No	None

UpdateMemberRoleRequest

Field	Type	Required	Defaults and constraints
`role`	`string`	Yes	None

UpdateNodeRequest

Field	Type	Required	Defaults and constraints
`label`	`string` or `null`	No	None
`category`	`string` or `null`	No	None
`icon`	`string` or `null`	No	None
`color`	`string` or `null`	No	None
`version`	`string` or `null`	No	None
`author`	`string` or `null`	No	None
`tags`	array of `string` or `null`	No	None
`connectors`	array of ConnectorDefSchema or `null`	No	None
`config_schema`	array of ConfigFieldSchema or `null`	No	None
`import_path`	`string` or `null`	No	None
`documentation_url`	`string` or `null`	No	None
`source_url`	`string` or `null`	No	None
`deprecated`	`boolean` or `null`	No	None
`deprecation_message`	`string` or `null`	No	None
`enabled`	`boolean` or `null`	No	None

UploadPartUrl

Field	Type	Required	Defaults and constraints
`part_number`	`integer`	Yes	None
`url`	`string`	Yes	None
`size`	`integer`	Yes	None

UsageDashboardResponse

Field	Type	Required	Defaults and constraints
`summary`	UsageSummaryResponse	Yes	None
`quota`	QuotaStatusResponse	Yes	None
`daily`	array of UsageSummaryResponse	Yes	None
`top_flows`	array of `object`	Yes	None

UsageSummaryResponse

Field	Type	Required	Defaults and constraints
`period`	`string`	Yes	None
`run_count`	`integer`	No	default: `0`
`task_count`	`integer`	No	default: `0`
`compute_seconds`	`number`	No	default: `0`
`api_call_count`	`integer`	No	default: `0`
`error_count`	`integer`	No	default: `0`
`estimated_cost_usd`	`number`	No	default: `0`

UsageTimeseriesResponse

Field	Type	Required	Defaults and constraints
`items`	array of UsageSummaryResponse	Yes	None

ValidateConnectionRequest

Field	Type	Required	Defaults and constraints
`source_node_type`	`string`	Yes	None
`source_connector_id`	`string`	Yes	None
`target_node_type`	`string`	Yes	None
`target_connector_id`	`string`	Yes	None
`existing_source_connections`	`integer`	No	default: `0`
`existing_target_connections`	`integer`	No	default: `0`

ValidateConnectionResponse

Field	Type	Required	Defaults and constraints
`valid`	`boolean`	Yes	None
`errors`	array of `string`	No	None

ValidationError

Field	Type	Required	Defaults and constraints
`loc`	array of `string` or `integer`	Yes	None
`msg`	`string`	Yes	None
`type`	`string`	Yes	None
`input`	`any`	No	None
`ctx`	`object`	No	None