{"openapi":"3.1.0","info":{"title":"Prefect Cloud API","description":"Prefect Cloud REST API documentation.","version":"0.8.4"},"paths":{"/api/workspace_scopes":{"get":{"tags":["Workspace Scopes"],"summary":"Get Workspace Scopes","operationId":"get_workspace_scopes_api_workspace_scopes_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WorkspaceScope"},"type":"array","title":"Response Get Workspace Scopes Api Workspace Scopes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/permissions":{"get":{"tags":["Accounts"],"summary":"List Permissions","description":"List account permissions","operationId":"list_permissions_api_accounts_permissions_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AccountPermission"},"type":"array","uniqueItems":true,"title":"Response List Permissions Api Accounts Permissions Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}":{"get":{"tags":["Accounts"],"summary":"Read Account","description":"Get an account by id.","operationId":"read_account_api_accounts__account_id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Accounts"],"summary":"Update Account","description":"Update an account by id.","operationId":"update_account_api_accounts__account_id__patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Accounts"],"summary":"Delete Account","operationId":"delete_account_api_accounts__account_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/settings":{"get":{"tags":["Accounts"],"summary":"Read Account Settings","operationId":"read_account_settings_api_accounts__account_id__settings_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Accounts"],"summary":"Update Account Settings","operationId":"update_account_settings_api_accounts__account_id__settings_patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSettingsUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/domains":{"get":{"tags":["Accounts"],"summary":"Read Account Domains","operationId":"read_account_domains_api_accounts__account_id__domains_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Accounts"],"summary":"Update Account Domains","description":"Update an account's associated domains.","operationId":"update_account_domains_api_accounts__account_id__domains_patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_account_domains_api_accounts__account_id__domains_patch"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/usage_limits":{"get":{"tags":["Accounts"],"summary":"Read Account Usage Limits","operationId":"read_account_usage_limits_api_accounts__account_id__usage_limits_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageLimitsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/usage":{"get":{"tags":["Accounts"],"summary":"Read Account Usage","operationId":"read_account_usage_api_accounts__account_id__usage_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceUsageResponse"},"title":"Response Read Account Usage Api Accounts  Account Id  Usage Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/image":{"get":{"tags":["Account Images"],"summary":"Get Account Image","operationId":"get_account_image_api_accounts__account_id__image_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Account Images"],"summary":"Upload Account Image","operationId":"upload_account_image_api_accounts__account_id__image_put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_account_image_api_accounts__account_id__image_put"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Account Images"],"summary":"Delete Account Image","operationId":"delete_account_image_api_accounts__account_id__image_delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/teams/":{"post":{"tags":["Teams"],"summary":"Create Team","description":"Create or update a team's metadata.\n\nRequired account permissions: `create:team`","operationId":"create_team_api_accounts__account_id__teams__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/teams/{id}":{"get":{"tags":["Teams"],"summary":"Read Team","description":"Get a team by id.\n\nRequired account permissions: `read:team`","operationId":"read_team_api_accounts__account_id__teams__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Teams"],"summary":"Update Team","description":"\n\nRequired account permissions: `update:team`","operationId":"update_team_api_accounts__account_id__teams__id__put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Teams"],"summary":"Delete Team","description":"Delete a team by id.\n\nRequired account permissions: `delete:team`","operationId":"delete_team_api_accounts__account_id__teams__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/teams/filter":{"post":{"tags":["Teams"],"summary":"Read Teams","description":"Query for teams.\n\nRequired account permissions: `read:team`","operationId":"read_teams_api_accounts__account_id__teams_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_teams_api_accounts__account_id__teams_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamResponse"},"title":"Response Read Teams Api Accounts  Account Id  Teams Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/teams/{id}/members":{"put":{"tags":["Teams"],"summary":"Upsert Team Members","description":"Upsert team memberships.\n\nRequired account permissions: `update:team`","operationId":"upsert_team_members_api_accounts__account_id__teams__id__members_put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_upsert_team_members_api_accounts__account_id__teams__id__members_put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/teams/{team_id}/members/{actor_id}":{"delete":{"tags":["Teams"],"summary":"Remove Team Member","description":"Remove a member from a team.\n\nRequired account permissions: `update:team`","operationId":"remove_team_member_api_accounts__account_id__teams__team_id__members__actor_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"team_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Team Id"}},{"name":"actor_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Actor Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/filter":{"post":{"tags":["Account Memberships"],"summary":"Read Account Memberships","description":"Query for account memberships.\n\nRequired account permissions: `read:account_membership`","operationId":"read_account_memberships_api_accounts__account_id__account_memberships_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_account_memberships_api_accounts__account_id__account_memberships_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountMembershipsResponse"},"title":"Response Read Account Memberships Api Accounts  Account Id  Account Memberships Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/download":{"get":{"tags":["Account Memberships"],"summary":"Download User Account Memberships Csv","description":"Stream all human users in the account as a CSV file.\n\nBot/service-account memberships are excluded. The export is streamed using\nserver-side cursors plus per-batch enrichment (teams + workspace access for\nonly the actors in the current chunk), so memory stays bounded by\n`_EXPORT_BATCH_SIZE` regardless of total account size.\n\nMulti-value columns (`workspace_ids`, `workspace_names`, `team_ids`,\n`team_names`) are encoded as JSON arrays so that names containing commas,\nsemicolons, or other delimiters round-trip unambiguously. The id columns\nalways contain only UUIDs; the name columns contain whatever the user has\ntyped for those resources.\n\nCaveat — audit truncation: the audit event is registered before the\nStreamingResponse begins. If the body iterator raises after the first\nyield, FastAPI may have already sent the partial 200 to the client; the\naudit log will record \"exported\" for a body that was actually cut short.\nSame behavior as the logs/flow_runs.py CSV download. Acceptable here\nbecause the audit captures intent; if the export is cut short the user\nwill retry.\n\nRequired account permissions: `read:account_membership`","operationId":"download_user_account_memberships_csv_api_accounts__account_id__account_memberships_download_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/count":{"post":{"tags":["Account Memberships"],"summary":"Count Account Memberships","description":"Query for account memberships count\n\nRequired account permissions: `read:account_membership`","operationId":"count_account_memberships_api_accounts__account_id__account_memberships_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_account_memberships_api_accounts__account_id__account_memberships_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Account Memberships Api Accounts  Account Id  Account Memberships Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/by-user/{user_id}":{"get":{"tags":["Account Memberships"],"summary":"Read Account Membership By User","description":"Get an Account Membership by user id.\n\nLooks up the membership for the given user within the account and returns\nenriched member details including timezone and team memberships.\n\nReturns 404 when the user is not a member of the account (e.g. they have\nsince been removed), allowing the frontend to show a \"deactivated user\"\nfallback.\n\nRequired account permissions: `read:account_membership`","operationId":"read_account_membership_by_user_api_accounts__account_id__account_memberships_by_user__user_id__get","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMemberSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/by-bot/{bot_id}":{"get":{"tags":["Account Memberships"],"summary":"Read Account Membership By Bot","description":"Get an Account Membership by bot id.\n\nLooks up the membership for the given bot within the account and returns\nenriched member details including team memberships.\n\nReturns 404 when the bot is not a member of the account.\n\nRequired account permissions: `read:account_membership`","operationId":"read_account_membership_by_bot_api_accounts__account_id__account_memberships_by_bot__bot_id__get","parameters":[{"name":"bot_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Bot Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMemberSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/{id}":{"get":{"tags":["Account Memberships"],"summary":"Read Account Membership","description":"Get an Account Membership by membership id.\n\nReturns enriched member details including timezone and team memberships.\nReturns 404 for bot memberships — use the bots endpoint for those.\n\nRequired account permissions: `read:account_membership`","operationId":"read_account_membership_api_accounts__account_id__account_memberships__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMemberSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Account Memberships"],"summary":"Update Account Membership","description":"Update an account membership by id.\n\nRequired account permissions: `update:account_membership`","operationId":"update_account_membership_api_accounts__account_id__account_memberships__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembershipUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Account Memberships"],"summary":"Delete Account Membership","description":"Delete an account membership by id.\nThis will also delete any workspace accesses that the membership's actor\nhas under the account.\n\nRequired account permissions: `delete:account_membership`","operationId":"delete_account_membership_api_accounts__account_id__account_memberships__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/{id}/active":{"patch":{"tags":["Account Memberships"],"summary":"Toggle Account Membership Active","description":"\n\nRequired account permissions: `update:account_membership`","operationId":"toggle_account_membership_active_api_accounts__account_id__account_memberships__id__active_patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembershipSetActive"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_memberships/set_active":{"post":{"tags":["Account Memberships"],"summary":"Bulk Set Account Membership Active","description":"\n\nRequired account permissions: `update:account_membership`","operationId":"bulk_set_account_membership_active_api_accounts__account_id__account_memberships_set_active_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembershipBulkSetActive"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_roles/{id}":{"get":{"tags":["Account Roles"],"summary":"Read Account Role","description":"Get an Account Role by id.\n\nRequired account permissions: `read:account_role`","operationId":"read_account_role_api_accounts__account_id__account_roles__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountRole"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Account Roles"],"summary":"Update Account Role","description":"Update an account role by id.\n\nRequired account permissions: `update:account_role`","operationId":"update_account_role_api_accounts__account_id__account_roles__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountRoleUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Account Roles"],"summary":"Delete Account Role","description":"Delete an account role by id.\n\nRequired account permissions: `delete:account_role`","operationId":"delete_account_role_api_accounts__account_id__account_roles__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/account_roles/filter":{"post":{"tags":["Account Roles"],"summary":"Read Account Roles","description":"Query for account roles.\n\nRequired account permissions: `read:account_role`","operationId":"read_account_roles_api_accounts__account_id__account_roles_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_account_roles_api_accounts__account_id__account_roles_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountRole"},"title":"Response Read Account Roles Api Accounts  Account Id  Account Roles Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/sso/setup_url":{"get":{"tags":["Account SSO"],"summary":"Read Sso Setup Url","description":"Get an SSO connection setup URL for a given account\n\nReturns a URL if the account doesn't already have SSO configured\n\nRequired account permissions: `administrate:sso`","operationId":"read_sso_setup_url_api_accounts__account_id__sso_setup_url_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Read Sso Setup Url Api Accounts  Account Id  Sso Setup Url Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/sso/dsync_setup_url":{"get":{"tags":["Account SSO"],"summary":"Read Dsync Setup Url","description":"Get an Directory Sync connection setup URL for a given account\n\nReturns a URL if the account doesn't already have Directory Sync configured\n\nRequired account permissions: `administrate:sso`","operationId":"read_dsync_setup_url_api_accounts__account_id__sso_dsync_setup_url_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Read Dsync Setup Url Api Accounts  Account Id  Sso Dsync Setup Url Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/sso/validate":{"post":{"tags":["Account SSO"],"summary":"Validate","description":"Validate that the current actor has recently authenticated with the\nAccount's authenticator.\n\nRequired account permissions: `read:account`","operationId":"validate_api_accounts__account_id__sso_validate_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_validate_api_accounts__account_id__sso_validate_post"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/sso/integrations":{"get":{"tags":["Account SSO"],"summary":"Integrations","description":"Return details about an Account's SSO / SCIM integrations.\n\nRequired account permissions: `administrate:sso`","operationId":"integrations_api_accounts__account_id__sso_integrations_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkOSIntegrationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/sso/integrations/{integration_id}":{"delete":{"tags":["Account SSO"],"summary":"Remove Integration","description":"Return details about an Account's SSO / SCIM integrations.\n\nRequired account permissions: `administrate:sso`","operationId":"remove_integration_api_accounts__account_id__sso_integrations__integration_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"integration_id","in":"path","required":true,"schema":{"type":"string","title":"Integration Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/":{"post":{"tags":["Bots"],"summary":"Create Bot","description":"Create a Bot\n\nRequired account permissions: `create:bot`","operationId":"create_bot_api_accounts__account_id__bots__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/{id}":{"get":{"tags":["Bots"],"summary":"Read Bot","description":"Get a bot by id.\n\nRequired account permissions: `read:bot`","operationId":"read_bot_api_accounts__account_id__bots__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotReadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Bots"],"summary":"Update Bot","description":"Update a bot by id.\n\nRequired account permissions: `update:bot`","operationId":"update_bot_api_accounts__account_id__bots__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Bots"],"summary":"Delete Bot","description":"Delete a bot by id.\n\nRequired account permissions: `delete:bot`","operationId":"delete_bot_api_accounts__account_id__bots__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/filter":{"post":{"tags":["Bots"],"summary":"Read Bots","description":"Query for bots.\n\nRequired account permissions: `read:bot`","operationId":"read_bots_api_accounts__account_id__bots_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_bots_api_accounts__account_id__bots_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BotReadResponse"},"title":"Response Read Bots Api Accounts  Account Id  Bots Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/paginate":{"post":{"tags":["Bots"],"summary":"Paginate Bots","description":"Pagination query for bots.\n\nRequired account permissions: `read:bot`","operationId":"paginate_bots_api_accounts__account_id__bots_paginate_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_bots_api_accounts__account_id__bots_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/{id}/rotate_api_key":{"post":{"tags":["Bots"],"summary":"Rotate Api Key","description":"Rotate the api key for a Bot.\n\nRequired account permissions: `update:bot`","operationId":"rotate_api_key_api_accounts__account_id__bots__id__rotate_api_key_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BotRotateAPIKey"},{"type":"null"}],"title":"Bot Rotate Key"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/{id}/read_bot_api_keys":{"get":{"tags":["Bots"],"summary":"Read Bot Api Keys","description":"Get a bot's api keys by id.\n\nRequired account permissions: `read:bot`","operationId":"read_bot_api_keys_api_accounts__account_id__bots__id__read_bot_api_keys_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotAPIKeyReadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/{id}/delete_bot_api_key/{api_key_id}":{"delete":{"tags":["Bots"],"summary":"Delete Bot Api Key","description":"Delete a bot's api key by id.\n\nRequired account permissions: `update:bot`","operationId":"delete_bot_api_key_api_accounts__account_id__bots__id__delete_bot_api_key__api_key_id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Api Key Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/{id}/rotate_mcp_oauth_client_credentials":{"post":{"tags":["Bots"],"summary":"Rotate Mcp Oauth Client Credentials","description":"Rotate MCP OAuth client credentials for a service account.\n\nRequired account permissions: `update:bot`","operationId":"rotate_mcp_oauth_client_credentials_api_accounts__account_id__bots__id__rotate_mcp_oauth_client_credentials_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotMCPOAuthClientCredentialsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/bots/{id}/mcp_oauth_client_credentials":{"get":{"tags":["Bots"],"summary":"Read Mcp Oauth Client Credentials","description":"Read metadata for a service account's active MCP OAuth credentials.\n\nRequired account permissions: `read:bot`","operationId":"read_mcp_oauth_client_credentials_api_accounts__account_id__bots__id__mcp_oauth_client_credentials_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotMCPOAuthClientCredentialsMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Bots"],"summary":"Revoke Mcp Oauth Client Credentials","description":"Revoke a service account's active MCP OAuth credentials.\n\nRequired account permissions: `update:bot`","operationId":"revoke_mcp_oauth_client_credentials_api_accounts__account_id__bots__id__mcp_oauth_client_credentials_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/invitations/":{"post":{"tags":["Invitations"],"summary":"Create Invitation","description":"Invite user(s) to an account.\nAny PENDING invitations for the same user to the account will be revoked.\n\nRequired account permissions: `create:invitation`","operationId":"create_invitation_api_accounts__account_id__invitations__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvitationCreate"},"title":"Invitations"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvitationReadResponse"},"title":"Response Create Invitation Api Accounts  Account Id  Invitations  Post"},"examples":{"created":{"summary":"Invite created","value":{"id":"666cfdd6-4a8f-4ace-bb90-afe01c708a7c","email":"user@test.io","account_id":"a78eef05-5763-4a1d-a22f-06ee22073893","account_role_id":"a35061bb-aec0-49d0-a574-0433d699ea4a","status":"PENDING","expiration":"2026-10-26T21:45:00.558867Z"}}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/invitations/{id}":{"get":{"tags":["Invitations"],"summary":"Read Invitation","description":"Get an invitation by id\n\nRequired account permissions: `read:invitation`","operationId":"read_invitation_api_accounts__account_id__invitations__id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationReadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/invitations/filter":{"post":{"tags":["Invitations"],"summary":"Read Invitations","description":"Query for invitations\n\nRequired account permissions: `read:invitation`","operationId":"read_invitations_api_accounts__account_id__invitations_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_invitations_api_accounts__account_id__invitations_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvitationReadResponse"},"title":"Response Read Invitations Api Accounts  Account Id  Invitations Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/invitations/count":{"post":{"tags":["Invitations"],"summary":"Count Invitations","description":"Query for invitations count\n\nRequired account permissions: `read:invitation`","operationId":"count_invitations_api_accounts__account_id__invitations_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_invitations_api_accounts__account_id__invitations_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Invitations Api Accounts  Account Id  Invitations Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/invitations/{id}/revoke":{"post":{"tags":["Invitations"],"summary":"Revoke Invitation","description":"Delete an invitation by id\n\nRequired account permissions: `update:invitation`","operationId":"revoke_invitation_api_accounts__account_id__invitations__id__revoke_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/":{"post":{"tags":["Workspaces"],"summary":"Create Workspace","description":"Create a Workspace\n\nRequired account permissions: `create:workspace`","operationId":"create_workspace_api_accounts__account_id__workspaces__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}":{"get":{"tags":["Workspaces"],"summary":"Read Workspace","description":"Get a workspace by id.\n\nRequired account permissions: `read:workspace`","operationId":"read_workspace_api_accounts__account_id__workspaces__workspace_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Workspaces"],"summary":"Update Workspace","description":"Update a workspace by id.\n\nRequired workspace scopes: `write_workspace_settings`","operationId":"update_workspace_api_accounts__account_id__workspaces__workspace_id__patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Workspaces"],"summary":"Delete Workspace","description":"Delete a workspace by id.\n\nRequired workspace scopes: `manage_workspace_settings`","operationId":"delete_workspace_api_accounts__account_id__workspaces__workspace_id__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/filter":{"post":{"tags":["Workspaces"],"summary":"Read Workspaces","description":"Query for workspaces.\n\nRequired account permissions: `read:workspace`","operationId":"read_workspaces_api_accounts__account_id__workspaces_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_workspaces_api_accounts__account_id__workspaces_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Workspace"},"title":"Response Read Workspaces Api Accounts  Account Id  Workspaces Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/transfer":{"post":{"tags":["Workspaces"],"summary":"Transfer Workspace","description":"Transfer a workspace to a new account\n\nRequired account permissions: `delete:workspace`","operationId":"transfer_workspace_api_accounts__account_id__workspaces__workspace_id__transfer_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__transfer_post"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/validate_transfer":{"post":{"tags":["Workspaces"],"summary":"Validate Transfer Workspace","description":"Validate transfer of a workspace to a new account, returning any validation errors\n\nRequired account permissions: `delete:workspace`","operationId":"validate_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__validate_transfer_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_validate_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__validate_transfer_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"title":"Response Validate Transfer Workspace Api Accounts  Account Id  Workspaces  Workspace Id  Validate Transfer Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/workspaces/{workspace_id}":{"get":{"tags":["Workspaces"],"summary":"Find Workspace Without Account Id","description":"Redirects to the full account-scoped URL of a workspace","operationId":"find_workspace_without_account_id_api_workspaces__workspace_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/settings":{"get":{"tags":["Workspaces"],"summary":"Read Workspace Settings","description":"Read a workspace's settings by id.\n\nRequired workspace scopes: `see_workspace_settings`","operationId":"read_workspace_settings_api_accounts__account_id__workspaces__workspace_id__settings_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSettings"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Workspaces"],"summary":"Update Workspace Settings","description":"Update a workspace's settings by id.\n\nRequired workspace scopes: `write_workspace_settings`","operationId":"update_workspace_settings_api_accounts__account_id__workspaces__workspace_id__settings_patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSettingsUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspace_roles/":{"post":{"tags":["Workspace Roles"],"summary":"Create Workspace Role","description":"Create a custom workspace role.\n\nRequired account permissions: `create:workspace_role`","operationId":"create_workspace_role_api_accounts__account_id__workspace_roles__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRole"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspace_roles/{id}":{"patch":{"tags":["Workspace Roles"],"summary":"Update Workspace Role","description":"Update a custom workspace role.\n\nRequired account permissions: `update:workspace_role`","operationId":"update_workspace_role_api_accounts__account_id__workspace_roles__id__patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRoleUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Workspace Roles"],"summary":"Delete Workspace Role","description":"Delete a custom workspace role.\n\nRequired account permissions: `delete:workspace_role`","operationId":"delete_workspace_role_api_accounts__account_id__workspace_roles__id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Workspace Roles"],"summary":"Read Workspace Role","description":"Read a workspace role.\n\nRequired account permissions: `read:workspace_role`","operationId":"read_workspace_role_api_accounts__account_id__workspace_roles__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRole"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspace_roles/filter":{"post":{"tags":["Workspace Roles"],"summary":"Read Workspace Roles","description":"Query for workspace roles.\n\nRequired account permissions: `read:workspace_role`","operationId":"read_workspace_roles_api_accounts__account_id__workspace_roles_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_workspace_roles_api_accounts__account_id__workspace_roles_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceRole"},"title":"Response Read Workspace Roles Api Accounts  Account Id  Workspace Roles Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limits/status":{"get":{"tags":["Rate Limits"],"summary":"Read Rate Limit Status","description":"Check whether the account is currently exceeding any rate limits.\n\nReturns a list of bucket names that are currently exceeded. The frontend\nuses this to display a warning banner. The exceeded status auto-clears\n~15 minutes after the last denied request.\n\nRequired account permissions: `read:account`","operationId":"read_rate_limit_status_api_accounts__account_id__rate_limits_status_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limits/usage":{"get":{"tags":["Rate Limits"],"summary":"Read Rate Limit Usage","description":"Read rate limit usage for a given account.\n\nRequired account permissions: `read:account`","operationId":"read_rate_limit_usage_api_accounts__account_id__rate_limits_usage_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The start date of the usage period","title":"Since"},"description":"The start date of the usage period"},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The end date of the usage period","title":"Until"},"description":"The end date of the usage period"},{"name":"keys","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"minItems":1,"description":"The keys to query usage for","title":"Keys"},"description":"The keys to query usage for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitUsageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limits/usage/download":{"get":{"tags":["Rate Limits"],"summary":"Download Rate Limit Usage","description":"Download rate limit usage for a given account as a CSV file.\n\nRequired account permissions: `read:account`","operationId":"download_rate_limit_usage_api_accounts__account_id__rate_limits_usage_download_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The start date of the usage period","title":"Since"},"description":"The start date of the usage period"},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The end date of the usage period","title":"Until"},"description":"The end date of the usage period"},{"name":"keys","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"minItems":1,"description":"The keys to query usage for","title":"Keys"},"description":"The keys to query usage for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limits/orchestration-api":{"get":{"tags":["Rate Limits"],"summary":"Read Orchestration Api Grouped Usage","description":"Read orchestration API rate limit usage grouped by a dimension over time.\n\nRequired account permissions: `read:account`","operationId":"read_orchestration_api_grouped_usage_api_accounts__account_id__rate_limits_orchestration_api_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"since","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"Start time of the usage period (inclusive)","title":"Since"},"description":"Start time of the usage period (inclusive)"},{"name":"until","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"End time of the usage period (inclusive)","title":"Until"},"description":"End time of the usage period (inclusive)"},{"name":"group_by","in":"query","required":true,"schema":{"type":"string","description":"The dimension to group usage by (e.g., workspace_id, api_key_name)","title":"Group By"},"description":"The dimension to group usage by (e.g., workspace_id, api_key_name)"},{"name":"workspace_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by workspace ID","title":"Workspace Id"},"description":"Filter by workspace ID"},{"name":"api_key_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by API key name","title":"Api Key Name"},"description":"Filter by API key name"},{"name":"actor_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by actor name","title":"Actor Name"},"description":"Filter by actor name"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitGroupedUsageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limits/events":{"get":{"tags":["Rate Limits"],"summary":"Read Events Grouped Usage","description":"Read events rate limit usage grouped by a dimension over time.\n\nRequired account permissions: `read:account`","operationId":"read_events_grouped_usage_api_accounts__account_id__rate_limits_events_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"since","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"Start time of the usage period (inclusive)","title":"Since"},"description":"Start time of the usage period (inclusive)"},{"name":"until","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"End time of the usage period (inclusive)","title":"Until"},"description":"End time of the usage period (inclusive)"},{"name":"group_by","in":"query","required":true,"schema":{"type":"string","description":"The dimension to group usage by (e.g., workspace_id, event_name)","title":"Group By"},"description":"The dimension to group usage by (e.g., workspace_id, event_name)"},{"name":"workspace_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by workspace ID","title":"Workspace Id"},"description":"Filter by workspace ID"},{"name":"api_key_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by API key name","title":"Api Key Name"},"description":"Filter by API key name"},{"name":"actor_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by actor name","title":"Actor Name"},"description":"Filter by actor name"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitGroupedUsageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limits/api-key-names":{"get":{"tags":["Rate Limits"],"summary":"List Api Key Names","description":"List distinct API key names from rate limit usage data.\n\nReturns API key names ordered by most recently seen, with optional\nfuzzy search filtering.\n\nRequired account permissions: `read:account`","operationId":"list_api_key_names_api_accounts__account_id__rate_limits_api_key_names_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"since","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"Start time of the search period (inclusive)","title":"Since"},"description":"Start time of the search period (inclusive)"},{"name":"until","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"End time of the search period (inclusive)","title":"Until"},"description":"End time of the search period (inclusive)"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fuzzy search string (case-insensitive substring match)","title":"Search"},"description":"Fuzzy search string (case-insensitive substring match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"description":"Maximum number of results to return","default":50,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"keys","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter to specific rate limit keys (e.g., orchestration-api, logs-and-events)","title":"Keys"},"description":"Filter to specific rate limit keys (e.g., orchestration-api, logs-and-events)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistinctValuesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limits/actor-names":{"get":{"tags":["Rate Limits"],"summary":"List Actor Names","description":"List distinct actor names from rate limit usage data.\n\nReturns actor names (users and service accounts) ordered by most recently\nseen, with optional fuzzy search filtering.\n\nRequired account permissions: `read:account`","operationId":"list_actor_names_api_accounts__account_id__rate_limits_actor_names_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"since","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"Start time of the search period (inclusive)","title":"Since"},"description":"Start time of the search period (inclusive)"},{"name":"until","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"End time of the search period (inclusive)","title":"Until"},"description":"End time of the search period (inclusive)"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fuzzy search string (case-insensitive substring match)","title":"Search"},"description":"Fuzzy search string (case-insensitive substring match)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"description":"Maximum number of results to return","default":50,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"keys","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter to specific rate limit keys (e.g., orchestration-api, logs-and-events)","title":"Keys"},"description":"Filter to specific rate limit keys (e.g., orchestration-api, logs-and-events)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistinctValuesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/managed_execution/details":{"get":{"tags":["Prefect Serverless"],"summary":"Read Managed Execution Details","description":"Compute usage so far this period plus the workspace's MEX limits and next reset.\n\nRequired workspace scopes: `see_workspace_settings`","operationId":"read_managed_execution_details_api_accounts__account_id__workspaces__workspace_id__managed_execution_details_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceLimitsUsageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/managed_execution/usage":{"get":{"tags":["Prefect Serverless"],"summary":"Read Managed Execution Usage","description":"Compute usage buckets plus the current limit snapshot.\n\nRequired workspace scopes: `see_workspace_settings`","operationId":"read_managed_execution_usage_api_accounts__account_id__workspaces__workspace_id__managed_execution_usage_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Start of the window, on or after 2020-01-01, at most 366 days after now.","title":"Since"},"description":"Start of the window, on or after 2020-01-01, at most 366 days after now."},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"End of the window, on or after 2020-01-01, at most 366 days after now.","title":"Until"},"description":"End of the window, on or after 2020-01-01, at most 366 days after now."},{"name":"group_by","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ManagedExecutionUsageGroupBy"},{"type":"null"}],"title":"Group By"}},{"name":"max_groups","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of resource groups to return separately before __other__.","default":10,"title":"Max Groups"},"description":"Maximum number of resource groups to return separately before __other__."},{"name":"resolution","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Bucket width in minutes: 1, 5, 15, 60, 360, or 1440 (the default). With group_by set, a defaulted window holds at most 367 buckets.","title":"Resolution"},"description":"Bucket width in minutes: 1, 5, 15, 60, 360, or 1440 (the default). With group_by set, a defaulted window holds at most 367 buckets."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedExecutionUsageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/rate-limit-allocations/":{"get":{"tags":["Workspace Rate Limit Allocations"],"summary":"Read Workspace Rate Limit Allocations","description":"Get all rate limit allocations for the account.\n\nRequired account permissions: `read:account`","operationId":"read_workspace_rate_limit_allocations_api_accounts__account_id__rate_limit_allocations__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceRateLimitAllocation"},"title":"Response Read Workspace Rate Limit Allocations Api Accounts  Account Id  Rate Limit Allocations  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Workspace Rate Limit Allocations"],"summary":"Upsert Workspace Rate Limit Allocations","description":"Upsert all workspace rate limit allocations for the account.\n\nAll workspaces in the account must be included in the allocations list,\nor an empty list to clear all allocations.\n\nRequired account permissions: `update:account`","operationId":"upsert_workspace_rate_limit_allocations_api_accounts__account_id__rate_limit_allocations__put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceRateLimitAllocationsUpsert"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceRateLimitAllocation"},"title":"Response Upsert Workspace Rate Limit Allocations Api Accounts  Account Id  Rate Limit Allocations  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/user_access/":{"post":{"tags":["Workspace User Access"],"summary":"Upsert Workspace User Access","description":"Upsert a workspace user access\n\nRequired workspace scopes: `manage_workspace_users`","operationId":"upsert_workspace_user_access_api_accounts__account_id__workspaces__workspace_id__user_access__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceUserAccessCreate"},{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceUserAccessCreate"}}],"title":"Workspace User Accesses"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceUserAccessResponse"},{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceUserAccessResponse"}}],"title":"Response Upsert Workspace User Access Api Accounts  Account Id  Workspaces  Workspace Id  User Access  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/user_access/filter":{"post":{"tags":["Workspace User Access"],"summary":"Read Workspace User Accesses","description":"Query for workspace user accesses\n\nRequired workspace scopes: `see_workspace_users`","operationId":"read_workspace_user_accesses_api_accounts__account_id__workspaces__workspace_id__user_access_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_workspace_user_accesses_api_accounts__account_id__workspaces__workspace_id__user_access_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceUserAccessResponse"},"title":"Response Read Workspace User Accesses Api Accounts  Account Id  Workspaces  Workspace Id  User Access Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/user_access/{id}":{"get":{"tags":["Workspace User Access"],"summary":"Read Workspace User Access","description":"Read a workspace user access\n\nRequired workspace scopes: `see_workspace_users`","operationId":"read_workspace_user_access_api_accounts__account_id__workspaces__workspace_id__user_access__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUserAccessResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Workspace User Access"],"summary":"Delete Workspace User Access","description":"Delete a workspace user access by id.\n\nThis route will also conditionally delete the user's account membership if:\n- account membership of the actor has `Collaborator` role\n- the actor has no more workspace accesses under the account\n\nRequired workspace scopes: `manage_workspace_users`","operationId":"delete_workspace_user_access_api_accounts__account_id__workspaces__workspace_id__user_access__id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/bot_access/":{"post":{"tags":["Workspace Bot Access"],"summary":"Upsert Workspace Bot Access","description":"Grant one or more bots access to a workspace\n\nRequired workspace scopes: `manage_workspace_service_accounts`","operationId":"upsert_workspace_bot_access_api_accounts__account_id__workspaces__workspace_id__bot_access__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceBotAccessCreate"},{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceBotAccessCreate"}}],"title":"Workspace Bot Accesses"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceBotAccessResponse"},{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceBotAccessResponse"}}],"title":"Response Upsert Workspace Bot Access Api Accounts  Account Id  Workspaces  Workspace Id  Bot Access  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/bot_access/filter":{"post":{"tags":["Workspace Bot Access"],"summary":"Read Workspace Bot Accesses","description":"Query for workspace bot accesses\n\nRequired workspace scopes: `see_workspace_service_accounts`","operationId":"read_workspace_bot_accesses_api_accounts__account_id__workspaces__workspace_id__bot_access_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_workspace_bot_accesses_api_accounts__account_id__workspaces__workspace_id__bot_access_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceBotAccessResponse"},"title":"Response Read Workspace Bot Accesses Api Accounts  Account Id  Workspaces  Workspace Id  Bot Access Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/bot_access/{id}":{"get":{"tags":["Workspace Bot Access"],"summary":"Read Workspace Bot Access","description":"Read a workspace bot access\n\nRequired workspace scopes: `see_workspace_service_accounts`","operationId":"read_workspace_bot_access_api_accounts__account_id__workspaces__workspace_id__bot_access__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceBotAccessResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Workspace Bot Access"],"summary":"Delete Workspace Bot Access","description":"Delete a workspace bot access by id.\n\nRequired workspace scopes: `manage_workspace_service_accounts`","operationId":"delete_workspace_bot_access_api_accounts__account_id__workspaces__workspace_id__bot_access__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/team_access/":{"put":{"tags":["Workspace Team Access"],"summary":"Upsert Workspace Team Access","description":"Grant one or more teams access to a workspace\n\nRequired workspace scopes: `manage_workspace_teams`","operationId":"upsert_workspace_team_access_api_accounts__account_id__workspaces__workspace_id__team_access__put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceTeamAccessCreate"},"title":"Workspace Team Accesses"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceTeamAccess"},"title":"Response Upsert Workspace Team Access Api Accounts  Account Id  Workspaces  Workspace Id  Team Access  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/team_access/filter":{"post":{"tags":["Workspace Team Access"],"summary":"Read Workspace Team Accesses","description":"List teams with access to a workspaces\n\nRequired workspace scopes: `manage_workspace_teams`","operationId":"read_workspace_team_accesses_api_accounts__account_id__workspaces__workspace_id__team_access_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_workspace_team_accesses_api_accounts__account_id__workspaces__workspace_id__team_access_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceTeamAccessResponse"},"title":"Response Read Workspace Team Accesses Api Accounts  Account Id  Workspaces  Workspace Id  Team Access Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/team_access/{team_id}":{"delete":{"tags":["Workspace Team Access"],"summary":"Remove Workspace Team Access","description":"Remove a team's access to a workspace\n\nRequired workspace scopes: `manage_workspace_teams`","operationId":"remove_workspace_team_access_api_accounts__account_id__workspaces__workspace_id__team_access__team_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"team_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Team Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/access/":{"get":{"tags":["Workspace Access"],"summary":"Read Actor Access","description":"Return a list of all actors with access to the workspace, including\nactors granted access via team membership.\n\nRequired workspace scopes: `see_workspace_users`,`see_workspace_service_accounts`","operationId":"read_actor_access_api_accounts__account_id__workspaces__workspace_id__access__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObjectActorAccess"},"title":"Response Read Actor Access Api Accounts  Account Id  Workspaces  Workspace Id  Access  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/":{"get":{"tags":["Me"],"summary":"Read My Profile","description":"List the current actor's user profile","operationId":"read_my_profile_api_me__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeReadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/sessions":{"get":{"tags":["Me"],"summary":"Read My Sessions","description":"List the current actor's user sessions","operationId":"read_my_sessions_api_me_sessions_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserSessionResponse"},"type":"array","title":"Response Read My Sessions Api Me Sessions Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/sessions/filter":{"post":{"tags":["Me"],"summary":"Filter My Sessions","description":"Filter the current actor's user sessions","operationId":"filter_my_sessions_api_me_sessions_filter_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_filter_my_sessions_api_me_sessions_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserSessionResponse"},"type":"array","title":"Response Filter My Sessions Api Me Sessions Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/sessions/{session_id}/terminate":{"post":{"tags":["Me"],"summary":"Terminate My Session","description":"Terminate the current actor's user session","operationId":"terminate_my_session_api_me_sessions__session_id__terminate_post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Session Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/api_keys":{"get":{"tags":["Me"],"summary":"Read My Api Keys","description":"List the current actor's api keys","operationId":"read_my_api_keys_api_me_api_keys_get","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIKeyReadResponse"},"title":"Response Read My Api Keys Api Me Api Keys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/api_keys/filter":{"post":{"tags":["Me"],"summary":"Filter My Api Keys","operationId":"filter_my_api_keys_api_me_api_keys_filter_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_filter_my_api_keys_api_me_api_keys_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/accounts":{"get":{"tags":["Me"],"summary":"Read My Accounts","description":"List the current actor's accounts","operationId":"read_my_accounts_api_me_accounts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserAccountResponse"},"type":"array","title":"Response Read My Accounts Api Me Accounts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/organizations":{"get":{"tags":["Me"],"summary":"Read My Organizations","description":"List the current actor's accounts that have plans that\nare schemas.plans.AccountPlanType.ORGANIZATION","operationId":"read_my_organizations_api_me_organizations_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserOrganizationResponse"},"type":"array","title":"Response Read My Organizations Api Me Organizations Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/accounts/{account_id}/permissions":{"get":{"tags":["Me"],"summary":"Read My Account Permissions","description":"List the current actor's permissions for the given account","operationId":"read_my_account_permissions_api_me_accounts__account_id__permissions_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/AccountPermission"},"title":"Response Read My Account Permissions Api Me Accounts  Account Id  Permissions Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/accounts/has_permission":{"get":{"tags":["Me"],"summary":"Read My Accounts With Permission","description":"Return the account ids the current actor has access to\nfor which they have the given permission","operationId":"read_my_accounts_with_permission_api_me_accounts_has_permission_get","parameters":[{"name":"permission","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AccountPermission"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Read My Accounts With Permission Api Me Accounts Has Permission Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/accounts/{account_id}/has_permission":{"get":{"tags":["Me"],"summary":"Check My Account Permissions","description":"Return if current actor has specific permission for account","operationId":"check_my_account_permissions_api_me_accounts__account_id__has_permission_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"permission","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AccountPermission"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Check My Account Permissions Api Me Accounts  Account Id  Has Permission Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/accounts/{account_id}":{"delete":{"tags":["Me"],"summary":"Leave Account","description":"Removes the user from an account. Will also remove any access the user\nhas to any workspaces under that account.","operationId":"leave_account_api_me_accounts__account_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/workspaces":{"get":{"tags":["Me"],"summary":"Read My Workspaces","description":"List the current actor's workspaces","operationId":"read_my_workspaces_api_me_workspaces_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserWorkspaceResponse"},"type":"array","title":"Response Read My Workspaces Api Me Workspaces Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/workspaces/{workspace_id}/scopes":{"get":{"tags":["Me"],"summary":"Read My Workspace Scopes","description":"List the current actor's scopes for the given workspace","operationId":"read_my_workspace_scopes_api_me_workspaces__workspace_id__scopes_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Read My Workspace Scopes Api Me Workspaces  Workspace Id  Scopes Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/workspaces/{workspace_id}/has_scope":{"get":{"tags":["Me"],"summary":"Check My Workspace Scopes","description":"Return if current actor has specific scope for workspace.","operationId":"check_my_workspace_scopes_api_me_workspaces__workspace_id__has_scope_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"scope","in":"query","required":true,"schema":{"$ref":"#/components/schemas/WorkspaceScopeName"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Check My Workspace Scopes Api Me Workspaces  Workspace Id  Has Scope Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/workspaces/{workspace_id}":{"delete":{"tags":["Me"],"summary":"Leave Workspace","description":"Removes the user from a workspace.\n\nThis route will also conditionally delete the user's account membership if:\n    - account membership of the actor has `Collaborator` role\n    - the actor has no more workspace accesses under the account","operationId":"leave_workspace_api_me_workspaces__workspace_id__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/profile-image":{"put":{"tags":["Me"],"summary":"Upload My Profile Image","operationId":"upload_my_profile_image_api_me_profile_image_put","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_my_profile_image_api_me_profile_image_put"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Me"],"summary":"Delete My Profile Image","operationId":"delete_my_profile_image_api_me_profile_image_delete","responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/me/profile-image/reset":{"post":{"tags":["Me"],"summary":"Reset My Profile Image","operationId":"reset_my_profile_image_api_me_profile_image_reset_post","responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{id}":{"get":{"tags":["Users"],"summary":"Read User","description":"Get a user by id.","operationId":"read_user_api_users__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Users"],"summary":"Update User","description":"Update a user by id.","operationId":"update_user_api_users__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users"],"summary":"Delete User","description":"Delete a user by id.","operationId":"delete_user_api_users__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{id}/api_keys":{"post":{"tags":["Users"],"summary":"Create User Api Key","description":"Create an APIKey for a user","operationId":"create_user_api_key_api_users__id__api_keys_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Users"],"summary":"Read User Api Keys","description":"List all APIKeys for a user","operationId":"read_user_api_keys_api_users__id__api_keys_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APIKeyReadResponse"},"title":"Response Read User Api Keys Api Users  Id  Api Keys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/users/{id}/api_keys/{api_key_id}":{"get":{"tags":["Users"],"summary":"Read User Api Key","description":"Read an APIKey for a user","operationId":"read_user_api_key_api_users__id__api_keys__api_key_id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Api Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIKeyReadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users"],"summary":"Delete User Api Key","description":"Delete an APIKey for a user","operationId":"delete_user_api_key_api_users__id__api_keys__api_key_id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"api_key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Api Key Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/details":{"get":{"tags":["Account Billing"],"summary":"Get Billing Details","description":"Returns the billing details for an account.\n\nRequired account permissions: `read:billing`","operationId":"get_billing_details_api_billing__account_id__details_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingDetailsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/subscription_restrictions":{"get":{"tags":["Account Billing"],"summary":"Get Subscription Restrictions","description":"Returns billing restrictions for an account based on current usage.\n\nRequired account permissions: `read:billing`","operationId":"get_subscription_restrictions_api_billing__account_id__subscription_restrictions_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingRestrictionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/cancel_org_subscription":{"post":{"tags":["Account Billing"],"summary":"Cancel Org Subscription At Period End","description":"\n\nRequired account permissions: `update:billing`","operationId":"cancel_org_subscription_at_period_end_api_billing__account_id__cancel_org_subscription_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/update_slots":{"post":{"tags":["Account Billing"],"summary":"Update Slots","description":"\n\nRequired account permissions: `update:billing`","operationId":"update_slots_api_billing__account_id__update_slots_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_update_slots_api_billing__account_id__update_slots_post"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/create_billing_portal_session":{"post":{"tags":["Account Billing"],"summary":"Create Billing Portal Session","description":"Creates a billing portal session for an account.\n\nRequired account permissions: `update:billing`","operationId":"create_billing_portal_session_api_billing__account_id__create_billing_portal_session_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_billing_portal_session_api_billing__account_id__create_billing_portal_session_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/validate_subscription_status":{"post":{"tags":["Account Billing"],"summary":"Validate Subscription Status","description":"Validate an account's subscription has been updated to reflect the latest stripe\nsession.\n\nRequired account permissions: `update:billing`","operationId":"validate_subscription_status_api_billing__account_id__validate_subscription_status_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_validate_subscription_status_api_billing__account_id__validate_subscription_status_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Validate Subscription Status Api Billing  Account Id  Validate Subscription Status Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/subscribe":{"post":{"tags":["Account Billing"],"summary":"Get Checkout Link","description":"\n\nRequired account permissions: `update:billing`","operationId":"get_checkout_link_api_billing__account_id__subscribe_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_checkout_link_api_billing__account_id__subscribe_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Get Checkout Link Api Billing  Account Id  Subscribe Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/manage_subscription":{"post":{"tags":["Account Billing"],"summary":"Manage Subscription","description":"Creates a Stripe customer portal session for managing an existing subscription.\n\nThis endpoint allows users to update, cancel, or otherwise manage their subscription\nthrough Stripe's customer portal with specific configuration options.\n\nRequired account permissions: `update:billing`","operationId":"manage_subscription_api_billing__account_id__manage_subscription_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_manage_subscription_api_billing__account_id__manage_subscription_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/alert_thresholds":{"get":{"tags":["Account Billing"],"summary":"Get Balance Alert Thresholds","description":"Return an account's alert thresholds for the requested kind, read live from Orb.\n\nRequired account permissions: `read:billing`","operationId":"get_balance_alert_thresholds_api_billing__account_id__alert_thresholds_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"alert_kind","in":"query","required":false,"schema":{"enum":["credit_balance","subscription_cost"],"type":"string","description":"Which alert's thresholds to read.","default":"credit_balance","title":"Alert Kind"},"description":"Which alert's thresholds to read."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceAlertThresholdsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Account Billing"],"summary":"Update Balance Alert Thresholds","description":"Replace an account's alert thresholds for the requested kind.\n\nThe desired set is recorded and converges into Orb asynchronously (latest save wins), so\nthis returns 202 rather than the applied state. If the desired state cannot be recorded\nor enqueued, the save has not landed and the request fails with a 503 rather than a\nmisleading 202.\n\nRequired account permissions: `update:billing`","operationId":"update_balance_alert_thresholds_api_billing__account_id__alert_thresholds_put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceAlertThresholdsUpdate"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/billing/{account_id}/usage-portal":{"get":{"tags":["Account Billing"],"summary":"Get Usage Portal","description":"Return a freshly minted, short-lived Orb usage-portal URL as ``{\"url\": ...}``.\n\nRaises 404 when the account is not enrolled in Orb usage billing.\n\nRequired account permissions: `read:billing`","operationId":"get_usage_portal_api_billing__account_id__usage_portal_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsagePortalResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/collections/views/{view}":{"get":{"tags":["Collections"],"summary":"Read View Content","description":"Reads the content of a view from the prefect-collection-registry.","operationId":"read_view_content_api_collections_views__view__get","parameters":[{"name":"view","in":"path","required":true,"schema":{"enum":["aggregate-block-metadata","aggregate-collection-metadata","aggregate-flow-metadata","aggregate-worker-metadata","demo-flows"],"type":"string","title":"View"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Read View Content Api Collections Views  View  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/invitations/{id}/accept":{"post":{"tags":["Invitations"],"summary":"Accept Invitation","description":"Accept an invitation","operationId":"accept_invitation_api_invitations__id__accept_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"invite_code","in":"query","required":true,"schema":{"type":"string","title":"Invite Code"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/invitations/{id}/reject":{"post":{"tags":["Invitations"],"summary":"Reject Invitation","description":"Reject an invitation","operationId":"reject_invitation_api_invitations__id__reject_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"invite_code","in":"query","required":true,"schema":{"type":"string","title":"Invite Code"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/events":{"post":{"tags":["Events","Events"],"summary":"Create Account Events","description":"Record a batch of Events for an Account","operationId":"create_account_events_api_accounts__account_id__events_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"title":"Events"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/events/filter":{"post":{"tags":["Events"],"summary":"Read Account Events","description":"Queries for Events matching the given filter criteria in the given Account.  Returns\nthe first page of results, and the URL to request the next page (if there are more\nresults).","operationId":"read_account_events_api_accounts__account_id__events_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_account_events_api_accounts__account_id__events_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/events/filter/next":{"get":{"tags":["Events"],"summary":"Read Account Events Page","description":"Returns the next page of Events for a previous query against the given Account, and\nthe URL to request the next page (if there are more results).","operationId":"read_account_events_page_api_accounts__account_id__events_filter_next_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"page-token","in":"query","required":true,"schema":{"type":"string","title":"Page-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/events/count-by/{countable}":{"post":{"tags":["Events"],"summary":"Count Account Events","description":"Returns distinct objects and the count of events associated with them.  Objects\nthat can be counted include the day the event occurred, the type of event, the\nworkspace, or the IDs of the resources associated with the event.","operationId":"count_account_events_api_accounts__account_id__events_count_by__countable__post","parameters":[{"name":"countable","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Countable"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_account_events_api_accounts__account_id__events_count_by__countable__post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventCount"},"title":"Response Count Account Events Api Accounts  Account Id  Events Count By  Countable  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/events":{"post":{"tags":["Events"],"summary":"Create Workspace Events","description":"Record a batch of Events for one Workspace within an Account","operationId":"create_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"title":"Events"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/events/filter":{"post":{"tags":["Events"],"summary":"Read Workspace Events","description":"Queries for Events matching the given filter criteria in the given Account and\nWorkspace.  Returns the first page of results, and the URL to request the next\npage (if there are more results).","operationId":"read_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/events/filter/next":{"get":{"tags":["Events"],"summary":"Read Workspace Events Page","description":"Returns the next page of Events for a previous query against the given Account and\nWorkspace, and the URL to request the next page (if there are more results).","operationId":"read_workspace_events_page_api_accounts__account_id__workspaces__workspace_id__events_filter_next_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"page-token","in":"query","required":true,"schema":{"type":"string","title":"Page-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/events/count-by/{countable}":{"post":{"tags":["Events"],"summary":"Count Workspace Events","description":"Returns distinct objects and the count of events associated with them.  Objects\nthat can be counted include the day the event occurred, the type of event, the\nworkspace, or the IDs of the resources associated with the event.","operationId":"count_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_count_by__countable__post","parameters":[{"name":"countable","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Countable"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_count_by__countable__post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EventCount"},"title":"Response Count Workspace Events Api Accounts  Account Id  Workspaces  Workspace Id  Events Count By  Countable  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{flow_run_id}/events":{"get":{"tags":["Events"],"summary":"Get Events For Flow Run","description":"Returns the first page of Events for a flow run against the given Account and Workspace.\n\nIf the `if-none-match` header is provided with the value of the current event count,\nthe server will return a 304 Not Modified response since the client already has the\nlatest events.","operationId":"get_events_for_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__flow_run_id__events_get","parameters":[{"name":"flow_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flow Run Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":5000,"minimum":0,"default":0,"title":"Offset"}},{"name":"order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EventOrder","default":"DESC"}},{"name":"with_task_runs","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"With Task Runs"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided.","title":"Limit"},"description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."},{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/hierarchy/filter":{"post":{"tags":["Resources"],"summary":"Read Resources Hierarchy","operationId":"read_resources_hierarchy_api_accounts__account_id__workspaces__workspace_id__resources_hierarchy_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_resources_hierarchy_api_accounts__account_id__workspaces__workspace_id__resources_hierarchy_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/filter":{"post":{"tags":["Resources"],"summary":"Filter Workspace Resources","description":"Returns resources matching the filter referenced in events during\nthe specified time period.","operationId":"filter_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_filter_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/filter/next":{"get":{"tags":["Resources"],"summary":"Read Resources Page","description":"Returns the next page of Resources for a previous query against the given Account and\nWorkspace, and the URL to request the next page (if there are more results).","operationId":"read_resources_page_api_accounts__account_id__workspaces__workspace_id__resources_filter_next_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"page-token","in":"query","required":true,"schema":{"type":"string","title":"Page-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourcePage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/filter/count":{"post":{"tags":["Resources"],"summary":"Get Filtered Resources Count","operationId":"get_filtered_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_filter_count_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_filtered_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_filter_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/related":{"post":{"tags":["Resources"],"summary":"Filter Related Workspace Resources","description":"Returns resources that interacted with resources matching the filter during\nthe specified time period.","operationId":"filter_related_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_related_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_filter_related_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_related_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResourcePage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/related/next":{"get":{"tags":["Resources"],"summary":"Read Related Resources Page","description":"Returns the next page of Resources for a previous query against the given Account and\nWorkspace, and the URL to request the next page (if there are more results).","operationId":"read_related_resources_page_api_accounts__account_id__workspaces__workspace_id__resources_related_next_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"page-token","in":"query","required":true,"schema":{"type":"string","title":"Page-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResourcePage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/related/count":{"post":{"tags":["Resources"],"summary":"Get Related Resources Count","operationId":"get_related_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_related_count_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_related_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_related_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/hidden-resources":{"get":{"tags":["Resources"],"summary":"Get Hidden Resources","operationId":"get_hidden_resources_api_accounts__account_id__workspaces__workspace_id__resources_hidden_resources_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExclusions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/hidden-resources/add":{"post":{"tags":["Resources"],"summary":"Hide Resource Path","operationId":"hide_resource_path_api_accounts__account_id__workspaces__workspace_id__resources_hidden_resources_add_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExclusionList"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Hide Resource Path Api Accounts  Account Id  Workspaces  Workspace Id  Resources Hidden Resources Add Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/resources/hidden-resources/delete":{"post":{"tags":["Resources"],"summary":"Remove Resource Exclusion","operationId":"remove_resource_exclusion_api_accounts__account_id__workspaces__workspace_id__resources_hidden_resources_delete_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExclusionList"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Remove Resource Exclusion Api Accounts  Account Id  Workspaces  Workspace Id  Resources Hidden Resources Delete Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/":{"post":{"tags":["Automations"],"summary":"Create Automation","operationId":"create_automation_api_accounts__account_id__workspaces__workspace_id__automations__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/{id}":{"put":{"tags":["Automations"],"summary":"Update Automation","operationId":"update_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Automations"],"summary":"Patch Automation","operationId":"patch_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationPartialUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Automations"],"summary":"Delete Automation","operationId":"delete_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Automations"],"summary":"Read Automation","operationId":"read_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/filter":{"post":{"tags":["Automations"],"summary":"Read Automations","operationId":"read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"},"title":"Response Read Automations Api Accounts  Account Id  Workspaces  Workspace Id  Automations Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/count":{"post":{"tags":["Automations"],"summary":"Count Automations","operationId":"count_automations_api_accounts__account_id__workspaces__workspace_id__automations_count_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_automations_api_accounts__account_id__workspaces__workspace_id__automations_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Automations Api Accounts  Account Id  Workspaces  Workspace Id  Automations Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/related-to/{resource_id}":{"get":{"tags":["Automations"],"summary":"Read Automations Related To Resource","operationId":"read_automations_related_to_resource_api_accounts__account_id__workspaces__workspace_id__automations_related_to__resource_id__get","parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"},"title":"Response Read Automations Related To Resource Api Accounts  Account Id  Workspaces  Workspace Id  Automations Related To  Resource Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/owned-by/{resource_id}":{"delete":{"tags":["Automations"],"summary":"Delete Automations Owned By Resource","operationId":"delete_automations_owned_by_resource_api_accounts__account_id__workspaces__workspace_id__automations_owned_by__resource_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/managed/":{"get":{"tags":["Managed Automations"],"summary":"List Managed Automations","operationId":"list_managed_automations_api_accounts__account_id__workspaces__workspace_id__automations_managed__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ManagedAutomationResponse"},"title":"Response List Managed Automations Api Accounts  Account Id  Workspaces  Workspace Id  Automations Managed  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/managed/{automation_type}":{"put":{"tags":["Managed Automations"],"summary":"Create Or Update Managed Automation","operationId":"create_or_update_managed_automation_api_accounts__account_id__workspaces__workspace_id__automations_managed__automation_type__put","parameters":[{"name":"automation_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ManagedAutomationType"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_or_update_managed_automation_api_accounts__account_id__workspaces__workspace_id__automations_managed__automation_type__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedAutomationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Managed Automations"],"summary":"Delete Managed Automation","operationId":"delete_managed_automation_api_accounts__account_id__workspaces__workspace_id__automations_managed__automation_type__delete","parameters":[{"name":"automation_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ManagedAutomationType"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/managed/types":{"get":{"tags":["Managed Automations"],"summary":"List Managed Automation Types","operationId":"list_managed_automation_types_api_accounts__account_id__workspaces__workspace_id__automations_managed_types_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ManagedAutomationTypeResponse"},"title":"Response List Managed Automation Types Api Accounts  Account Id  Workspaces  Workspace Id  Automations Managed Types Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/managed-automations/":{"get":{"tags":["Managed Automations"],"summary":"List Managed Automations By Workspace","operationId":"list_managed_automations_by_workspace_api_accounts__account_id__managed_automations__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceManagedAutomationsResponse"},"title":"Response List Managed Automations By Workspace Api Accounts  Account Id  Managed Automations  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/managed-automations":{"delete":{"tags":["Managed Automations"],"summary":"Delete All Managed Automations","operationId":"delete_all_managed_automations_api_accounts__account_id__managed_automations_delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/managed-automations/quick-enable":{"post":{"tags":["Managed Automations"],"summary":"Quick Enable Managed Automations","description":"Enable all managed automations across every workspace in the account.\n\nCurrently enables zombie-cleanup and stuck-cancelling with their default\nsettings. Enqueues a fan-out docket task; individual workspaces are\nprocessed asynchronously.","operationId":"quick_enable_managed_automations_api_accounts__account_id__managed_automations_quick_enable_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/":{"post":{"tags":["SLAs"],"summary":"Create Sla","operationId":"create_sla_api_accounts__account_id__workspaces__workspace_id__slas__post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/TimeToCompletionSla"},{"$ref":"#/components/schemas/FrequencySla"},{"$ref":"#/components/schemas/FreshnessSla"},{"$ref":"#/components/schemas/LatenessSla"}],"title":"Sla"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceLevelAgreement"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/apply-resource-slas/{resource_id}":{"post":{"tags":["SLAs"],"summary":"Apply Slas","operationId":"apply_slas_api_accounts__account_id__workspaces__workspace_id__slas_apply_resource_slas__resource_id__post","parameters":[{"name":"resource_id","in":"path","required":true,"schema":{"type":"string","title":"Resource Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/TimeToCompletionSla"},{"$ref":"#/components/schemas/FrequencySla"},{"$ref":"#/components/schemas/FreshnessSla"},{"$ref":"#/components/schemas/LatenessSla"}]},"title":"Slas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ServiceLevelAgreement"}},"title":"Response Apply Slas Api Accounts  Account Id  Workspaces  Workspace Id  Slas Apply Resource Slas  Resource Id  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/filter":{"post":{"tags":["SLAs"],"summary":"Read Slas","operationId":"read_slas_api_accounts__account_id__workspaces__workspace_id__slas_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SlaSort","default":"NAME_ASC"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_slas_api_accounts__account_id__workspaces__workspace_id__slas_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceLevelAgreement"},"title":"Response Read Slas Api Accounts  Account Id  Workspaces  Workspace Id  Slas Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/by-owner/{owner_resource}":{"post":{"tags":["SLAs"],"summary":"Read Slas By Owner Resource","operationId":"read_slas_by_owner_resource_api_accounts__account_id__workspaces__workspace_id__slas_by_owner__owner_resource__post","parameters":[{"name":"owner_resource","in":"path","required":true,"schema":{"type":"string","title":"Owner Resource"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SlaSort","default":"NAME_ASC"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_slas_by_owner_resource_api_accounts__account_id__workspaces__workspace_id__slas_by_owner__owner_resource__post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ServiceLevelAgreement"},"title":"Response Read Slas By Owner Resource Api Accounts  Account Id  Workspaces  Workspace Id  Slas By Owner  Owner Resource  Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/{sla_id}":{"get":{"tags":["SLAs"],"summary":"Read Sla","operationId":"read_sla_api_accounts__account_id__workspaces__workspace_id__slas__sla_id__get","parameters":[{"name":"sla_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Sla Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceLevelAgreement"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["SLAs"],"summary":"Update Sla","operationId":"update_sla_api_accounts__account_id__workspaces__workspace_id__slas__sla_id__patch","parameters":[{"name":"sla_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Sla Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceLevelAgreementPartialUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Update Sla Api Accounts  Account Id  Workspaces  Workspace Id  Slas  Sla Id  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["SLAs"],"summary":"Delete Sla","operationId":"delete_sla_api_accounts__account_id__workspaces__workspace_id__slas__sla_id__delete","parameters":[{"name":"sla_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Sla Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Delete Sla Api Accounts  Account Id  Workspaces  Workspace Id  Slas  Sla Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/flow-runs":{"post":{"tags":["SLAs"],"summary":"Read Flow Runs","description":"Read all flow runs that have an SLA violation event within the given horizon.\n\nArgs:\n    sla_ids (list[UUID]): The IDs of the SLAs to read flow runs for.\n    since (datetime): The date to read flow runs since.\n    workspace_id (UUID, optional): The ID of the workspace to read flow runs for. Defaults to Path(...).\n    account_id (UUID, optional): The ID of the account to read flow runs for. Defaults to Path(...).\n    client (AsyncClient, optional): The ClickHouse client to use. Defaults to Depends(clickhouse_client).\n\nReturns:\n    Sequence[str]: _description_","operationId":"read_flow_runs_api_accounts__account_id__workspaces__workspace_id__slas_flow_runs_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_flow_runs_api_accounts__account_id__workspaces__workspace_id__slas_flow_runs_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Read Flow Runs Api Accounts  Account Id  Workspaces  Workspace Id  Slas Flow Runs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/default":{"post":{"tags":["SLAs"],"summary":"Create Default Sla","operationId":"create_default_sla_api_accounts__account_id__workspaces__workspace_id__slas_default_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_default_sla_api_accounts__account_id__workspaces__workspace_id__slas_default_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"},"title":"Response Create Default Sla Api Accounts  Account Id  Workspaces  Workspace Id  Slas Default Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/default/list":{"get":{"tags":["SLAs"],"summary":"Read Default Sla List","operationId":"read_default_sla_list_api_accounts__account_id__workspaces__workspace_id__slas_default_list_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation"},"title":"Response Read Default Sla List Api Accounts  Account Id  Workspaces  Workspace Id  Slas Default List Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/slas/default/{sla_severity}":{"get":{"tags":["SLAs"],"summary":"Read Default Sla","operationId":"read_default_sla_api_accounts__account_id__workspaces__workspace_id__slas_default__sla_severity__get","parameters":[{"name":"sla_severity","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SlaSeverity"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["SLAs"],"summary":"Delete Default Sla","operationId":"delete_default_sla_api_accounts__account_id__workspaces__workspace_id__slas_default__sla_severity__delete","parameters":[{"name":"sla_severity","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SlaSeverity"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/webhooks/":{"post":{"tags":["Webhooks"],"summary":"Create Webhook","operationId":"create_webhook_api_accounts__account_id__workspaces__workspace_id__webhooks__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/webhooks/{webhook_id}":{"put":{"tags":["Webhooks"],"summary":"Update Webhook","operationId":"update_webhook_api_accounts__account_id__workspaces__workspace_id__webhooks__webhook_id__put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Webhooks"],"summary":"Partial Update Webhook","operationId":"partial_update_webhook_api_accounts__account_id__workspaces__workspace_id__webhooks__webhook_id__patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPartialUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Delete Webhook","operationId":"delete_webhook_api_accounts__account_id__workspaces__workspace_id__webhooks__webhook_id__delete","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Webhooks"],"summary":"Read Webhook","operationId":"read_webhook_api_accounts__account_id__workspaces__workspace_id__webhooks__webhook_id__get","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/webhooks/filter":{"post":{"tags":["Webhooks"],"summary":"Query Webhooks","operationId":"query_webhooks_api_accounts__account_id__workspaces__workspace_id__webhooks_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_query_webhooks_api_accounts__account_id__workspaces__workspace_id__webhooks_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookRead"},"title":"Response Query Webhooks Api Accounts  Account Id  Workspaces  Workspace Id  Webhooks Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/webhooks/{webhook_id}/rotate":{"post":{"tags":["Webhooks"],"summary":"Rotate Webhook Slug","operationId":"rotate_webhook_slug_api_accounts__account_id__workspaces__workspace_id__webhooks__webhook_id__rotate_post","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Webhook Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/templates/validate":{"post":{"summary":"Validate Template","operationId":"validate_template_api_accounts__account_id__workspaces__workspace_id__templates_validate_post","requestBody":{"content":{"application/json":{"schema":{"type":"string","title":"Template","default":""}}}},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/automations/templates/validate":{"post":{"tags":["Automations"],"summary":"Validate Template","operationId":"validate_template_api_accounts__account_id__workspaces__workspace_id__automations_templates_validate_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","default":"","title":"Template"}}}},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/metrics/prefect/{metric}/timeseries":{"post":{"tags":["Metrics"],"summary":"Read Prefect Metric Timeseries","operationId":"read_prefect_metric_timeseries_api_accounts__account_id__workspaces__workspace_id__ui_metrics_prefect__metric__timeseries_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"metric","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PrefectMetric"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeseriesMetricQuery"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeseriesMetricResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/metrics/prefect/{metric}":{"post":{"tags":["Metrics"],"summary":"Read Prefect Metric Timeseries","operationId":"read_prefect_metric_timeseries_api_accounts__account_id__workspaces__workspace_id__ui_metrics_prefect__metric__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"metric","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PrefectMetric"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeseriesMetricQuery"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeseriesMetricResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/metrics/prefect/{metric}/grouped":{"post":{"tags":["Metrics"],"summary":"Read Prefect Metric Grouped","operationId":"read_prefect_metric_grouped_api_accounts__account_id__workspaces__workspace_id__ui_metrics_prefect__metric__grouped_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"metric","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PrefectMetric"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedMetricQuery"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupedMetricResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/tags":{"get":{"tags":["Events"],"summary":"List Tags","description":"Page through tags in a workspace.","operationId":"list_tags_api_accounts__account_id__workspaces__workspace_id__tags_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"A string to search for in the tag names","title":"Search"},"description":"A string to search for in the tag names"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number of tags to return.","default":1,"title":"Page"},"description":"The page number of tags to return."},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/TagSort","description":"Sort tags by name (A→Z or Z→A) or recency (most/least recently seen first)","default":"LAST_SEEN_DESC"},"description":"Sort tags by name (A→Z or Z→A) or recency (most/least recently seen first)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided.","title":"Limit"},"description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Events"],"summary":"Delete Workspace Tag","description":"Delete a tag from the workspace tags index.","operationId":"delete_workspace_tag_api_accounts__account_id__workspaces__workspace_id__tags_delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"tag","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"The tag name","title":"Tag"},"description":"The tag name"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/":{"get":{"tags":["Assets"],"summary":"List Assets","operationId":"list_assets_api_accounts__account_id__workspaces__workspace_id__assets__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"prefix","in":"query","required":false,"schema":{"type":"string","description":"Prefix to search assets keys for","title":"Prefix"},"description":"Prefix to search assets keys for"},{"name":"search","in":"query","required":false,"schema":{"type":"string","description":"Substring to search assets keys for","title":"Search"},"description":"Substring to search assets keys for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetCatalogItem"},"title":"Response List Assets Api Accounts  Account Id  Workspaces  Workspace Id  Assets  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/key":{"get":{"tags":["Assets"],"summary":"Read Asset","operationId":"read_asset_api_accounts__account_id__workspaces__workspace_id__assets_key_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"key","in":"query","required":true,"schema":{"type":"string","title":"Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetCatalogItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Assets"],"summary":"Delete Asset","operationId":"delete_asset_api_accounts__account_id__workspaces__workspace_id__assets_key_delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"key","in":"query","required":true,"schema":{"type":"string","title":"Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/latest-dependencies":{"get":{"tags":["Assets"],"summary":"Latest Dependencies","operationId":"latest_dependencies_api_accounts__account_id__workspaces__workspace_id__assets_latest_dependencies_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetDependency"},"title":"Response Latest Dependencies Api Accounts  Account Id  Workspaces  Workspace Id  Assets Latest Dependencies Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/neighbors":{"get":{"tags":["Assets"],"summary":"Get Asset Neighbors","description":"Get the direct (1-hop) neighbors of a specific asset.\n\nReturns the asset, its immediate upstream and downstream dependencies,\nand the dependency edges between them. Does not traverse transitive\ndependencies.","operationId":"get_asset_neighbors_api_accounts__account_id__workspaces__workspace_id__assets_neighbors_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"key","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"The asset key to get neighbors for","title":"Key"},"description":"The asset key to get neighbors for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetGraph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/filter":{"post":{"tags":["Assets"],"summary":"Filter Assets","operationId":"filter_assets_api_accounts__account_id__workspaces__workspace_id__assets_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_filter_assets_api_accounts__account_id__workspaces__workspace_id__assets_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetGraphPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/filter/next":{"get":{"tags":["Assets"],"summary":"Filter Assets Page","operationId":"filter_assets_page_api_accounts__account_id__workspaces__workspace_id__assets_filter_next_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"page-token","in":"query","required":true,"schema":{"type":"string","title":"Page-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetGraphPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/materializations":{"get":{"tags":["Assets"],"summary":"List Asset Materializations","description":"Get historical materializations for a specific asset.\n\nReturns one materialization per run (deduplicated by run_id, latest occurred wins).","operationId":"list_asset_materializations_api_accounts__account_id__workspaces__workspace_id__assets_materializations_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"The asset key to get materializations for","title":"Key"},"description":"The asset key to get materializations for"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return materializations on or after this timestamp","title":"Since"},"description":"Only return materializations on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return materializations on or before this timestamp","title":"Until"},"description":"Only return materializations on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order: 'asc' or 'desc'","default":"desc","title":"Sort"},"description":"Sort order: 'asc' or 'desc'"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MaterializationEvent"},"title":"Response List Asset Materializations Api Accounts  Account Id  Workspaces  Workspace Id  Assets Materializations Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/references":{"get":{"tags":["Assets"],"summary":"List Asset References","description":"Get downstream assets that reference (consume) a specific asset.\n\nReturns materializations of assets that have the queried asset in their\nupstream dependencies. Deduplicated by run_id (latest occurred wins).","operationId":"list_asset_references_api_accounts__account_id__workspaces__workspace_id__assets_references_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"The asset key to get references for","title":"Key"},"description":"The asset key to get references for"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return references on or after this timestamp","title":"Since"},"description":"Only return references on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return references on or before this timestamp","title":"Until"},"description":"Only return references on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order: 'asc' or 'desc'","default":"desc","title":"Sort"},"description":"Sort order: 'asc' or 'desc'"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MaterializationEvent"},"title":"Response List Asset References Api Accounts  Account Id  Workspaces  Workspace Id  Assets References Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/materializations/{event_id}":{"get":{"tags":["Assets"],"summary":"Read Asset Materialization","description":"Get a specific materialization event by its event ID.\n\nThe asset key must be provided and match the event's asset key.","operationId":"read_asset_materialization_api_accounts__account_id__workspaces__workspace_id__assets_materializations__event_id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"event_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The event ID of the materialization","title":"Event Id"},"description":"The event ID of the materialization"},{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"The asset key for validation","title":"Key"},"description":"The asset key for validation"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaterializationEvent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/materializations/{event_id}/upstream":{"get":{"tags":["Assets"],"summary":"Get Upstream Materializations","description":"Get the latest materialization of each upstream asset that occurred\nbefore a specific materialization event.","operationId":"get_upstream_materializations_api_accounts__account_id__workspaces__workspace_id__assets_materializations__event_id__upstream_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"event_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The event ID of the focal materialization","title":"Event Id"},"description":"The event ID of the focal materialization"},{"name":"key","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"The asset key of the focal materialization","title":"Key"},"description":"The asset key of the focal materialization"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MaterializationEvent"},"title":"Response Get Upstream Materializations Api Accounts  Account Id  Workspaces  Workspace Id  Assets Materializations  Event Id  Upstream Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/assets/references/{event_id}":{"get":{"tags":["Assets"],"summary":"Read Asset Reference","description":"Get a specific downstream consumer by its event ID.\n\nReturns the materialization event for an asset that consumes the queried upstream\nasset. The upstream asset key must be provided and must appear in the\nmaterialization's upstream dependencies.","operationId":"read_asset_reference_api_accounts__account_id__workspaces__workspace_id__assets_references__event_id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"event_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The event ID of the downstream consumer","title":"Event Id"},"description":"The event ID of the downstream consumer"},{"name":"key","in":"query","required":true,"schema":{"type":"string","description":"The upstream asset key being referenced","title":"Key"},"description":"The upstream asset key being referenced"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaterializationEvent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/available-assets/":{"get":{"tags":["Available Assets"],"summary":"List Available Assets Endpoint","operationId":"list_available_assets_endpoint_api_accounts__account_id__workspaces__workspace_id__available_assets__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableAssetsPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/event-publications/":{"post":{"tags":["Event Publications"],"summary":"Create Publication","operationId":"create_publication_api_accounts__account_id__workspaces__workspace_id__event_publications__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Event Publications"],"summary":"List Publications","operationId":"list_publications_api_accounts__account_id__workspaces__workspace_id__event_publications__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"resource_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":200,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/event-publications/{publication_id}":{"get":{"tags":["Event Publications"],"summary":"Read Publication","operationId":"read_publication_api_accounts__account_id__workspaces__workspace_id__event_publications__publication_id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"publication_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Publication Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Event Publications"],"summary":"Update Publication","operationId":"update_publication_api_accounts__account_id__workspaces__workspace_id__event_publications__publication_id__patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"publication_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Publication Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Event Publications"],"summary":"Delete Publication","operationId":"delete_publication_api_accounts__account_id__workspaces__workspace_id__event_publications__publication_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"publication_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Publication Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/event-publications/{publication_id}/subscriptions":{"get":{"tags":["Event Publications"],"summary":"List Publication Subscribers","operationId":"list_publication_subscribers_api_accounts__account_id__workspaces__workspace_id__event_publications__publication_id__subscriptions_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"publication_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Publication Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":200,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationSubscriberPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/event-subscriptions/":{"post":{"tags":["Event Subscriptions"],"summary":"Create Subscription","operationId":"create_subscription_api_accounts__account_id__workspaces__workspace_id__event_subscriptions__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Event Subscriptions"],"summary":"List Subscriptions","operationId":"list_subscriptions_api_accounts__account_id__workspaces__workspace_id__event_subscriptions__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"resource_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":200,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/event-subscriptions/{subscription_id}":{"get":{"tags":["Event Subscriptions"],"summary":"Read Subscription","operationId":"read_subscription_api_accounts__account_id__workspaces__workspace_id__event_subscriptions__subscription_id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Subscription Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Event Subscriptions"],"summary":"Update Subscription","operationId":"update_subscription_api_accounts__account_id__workspaces__workspace_id__event_subscriptions__subscription_id__patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Subscription Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Event Subscriptions"],"summary":"Delete Subscription","operationId":"delete_subscription_api_accounts__account_id__workspaces__workspace_id__event_subscriptions__subscription_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Subscription Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/asset-publications/":{"post":{"tags":["Asset Publications"],"summary":"Create Asset Publication","operationId":"create_asset_publication_api_accounts__account_id__workspaces__workspace_id__asset_publications__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetPublicationCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/asset-subscriptions/":{"post":{"tags":["Asset Subscriptions"],"summary":"Create Asset Subscription","operationId":"create_asset_subscription_api_accounts__account_id__workspaces__workspace_id__asset_subscriptions__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetSubscriptionCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/logs/":{"post":{"tags":["Logs"],"summary":"Create Logs","description":"Create new logs from the provided schema.\n\nRequired workspace scopes: `run_flows`","operationId":"create_logs_api_accounts__account_id__workspaces__workspace_id__logs__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LogCreate"},"title":"Logs"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/logs/filter":{"post":{"tags":["Logs"],"summary":"Read Logs","description":"Query for logs.\n\nRequired workspace scopes: `see_flows`","operationId":"read_logs_api_accounts__account_id__workspaces__workspace_id__logs_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_logs_api_accounts__account_id__workspaces__workspace_id__logs_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Log"},"title":"Response Read Logs Api Accounts  Account Id  Workspaces  Workspace Id  Logs Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/logs/ai/flow_run_logs/{flow_run_id}":{"get":{"tags":["AI"],"summary":"Summarize Flow Run Logs","description":"Summarize error logs for a flow run.\n\nIf the `flow_run_id` is not found, or if there are no error logs for the\nflow run, the `result` will be `None`.\n\nRequires the account's `ai_log_summaries` setting: responds with a 403 when\nthe account has not opted in, and a 503 when the setting could not be\nverified.\n\nRequired workspace scopes: `see_flows`","operationId":"summarize_flow_run_logs_api_accounts__account_id__workspaces__workspace_id__logs_ai_flow_run_logs__flow_run_id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"flow_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flow Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarvinResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/logs":{"get":{"tags":["Logs","Download"],"summary":"Get Flow Run Logs","description":"Returns a page of logs for a flow run\n\nRequired workspace scopes: `see_flows`","operationId":"get_flow_run_logs_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__logs_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"level_ge","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Level Ge"}},{"name":"level_le","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Level Le"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/LogSort","default":"TIMESTAMP_ASC"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only include logs with a timestamp at or after this time","title":"Since"},"description":"Only include logs with a timestamp at or after this time"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only include logs with a timestamp at or before this time","title":"Until"},"description":"Only include logs with a timestamp at or before this time"},{"name":"task_runs","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated list of task run IDs to filter by","title":"Task Runs"},"description":"Comma-separated list of task run IDs to filter by"},{"name":"task_runs_is_null","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"If true, only include logs without a task run ID","title":"Task Runs Is Null"},"description":"If true, only include logs without a task run ID"},{"name":"loggers","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated list of logger names to filter by","title":"Loggers"},"description":"Comma-separated list of logger names to filter by"},{"name":"text_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Text search query string","title":"Text Query"},"description":"Text search query string"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided.","title":"Limit"},"description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."},{"name":"if-none-match","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"If-None-Match"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/download-logs-csv":{"get":{"tags":["Logs","Download"],"summary":"Download Flow Run Logs","description":"Download all flow run logs as a CSV file, collecting all logs until there are no more logs to retrieve.\n\nRequired workspace scopes: `see_flows`","operationId":"download_flow_run_logs_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__download_logs_csv_get","deprecated":true,"parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/logs/download":{"get":{"tags":["Logs","Download"],"summary":"Download Flow Run Logs","description":"Download all flow run logs as a CSV file, collecting all logs until there are no more logs to retrieve.\n\nRequired workspace scopes: `see_flows`","operationId":"download_flow_run_logs_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__logs_download_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/traces/{trace_id}/observed-loggers":{"get":{"tags":["Logs"],"summary":"Read Trace Observed Loggers","description":"Get observed logger names used in a specific trace.\n\nReturns distinct logger names used in the trace with their usage counts\nand first/last seen timestamps. Useful for showing what loggers were\nactive in a flow run and providing autocomplete/filtering options.\n\nArgs:\n    workspace_id: The workspace ID\n    trace_id: The trace (flow run) ID to analyze\n    query: Optional prefix search on logger name\n    order_by: Order by name (alphabetically) or recency (most recent first)\n    limit: Maximum number of results\n\nReturns:\n    List of ObservedLogger objects\n\nRequired workspace scopes: `see_flows`","operationId":"read_trace_observed_loggers_api_accounts__account_id__workspaces__workspace_id__traces__trace_id__observed_loggers_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The trace ID to query observed loggers for","title":"Trace Id"},"description":"The trace ID to query observed loggers for"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Prefix search query for logger names","title":"Query"},"description":"Prefix search query for logger names"},{"name":"order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ObservedLoggerSort","description":"Order results by name (alphabetically) or recency (most recently seen first)","default":"LAST_SEEN_DESC"},"description":"Order results by name (alphabetically) or recency (most recently seen first)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObservedLogger"},"title":"Response Read Trace Observed Loggers Api Accounts  Account Id  Workspaces  Workspace Id  Traces  Trace Id  Observed Loggers Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/observed-loggers":{"get":{"tags":["Logs"],"summary":"Read Workspace Observed Loggers","description":"Get observed logger names for a workspace.\n\nReturns distinct logger names across all traces in the workspace.\nResults are filtered by workspace retention policy.\nUseful for providing autocomplete/filtering options in the UI.\n\nArgs:\n    account_id: The account ID\n    workspace_id: The workspace ID\n    query: Optional prefix search on logger name\n    order_by: Order by name (alphabetically) or recency (most recent first)\n    limit: Maximum number of results\n\nReturns:\n    List of ObservedLogger objects\n\nRequired workspace scopes: `see_flows`","operationId":"read_workspace_observed_loggers_api_accounts__account_id__workspaces__workspace_id__observed_loggers_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Prefix search query for logger names","title":"Query"},"description":"Prefix search query for logger names"},{"name":"order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ObservedLoggerSort","description":"Order results by name (alphabetically) or recency (most recently seen first)","default":"LAST_SEEN_DESC"},"description":"Order results by name (alphabetically) or recency (most recently seen first)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Maximum number of results to return","default":200,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObservedLogger"},"title":"Response Read Workspace Observed Loggers Api Accounts  Account Id  Workspaces  Workspace Id  Observed Loggers Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/":{"post":{"tags":["Artifacts"],"summary":"Create Artifact","description":"\n\nRequired workspace scopes: `write_artifacts`","operationId":"create_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/{id}":{"get":{"tags":["Artifacts"],"summary":"Read Artifact","description":"Retrieve an artifact from the database.\n\nRequired workspace scopes: `see_artifacts`","operationId":"read_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the artifact to retrieve.","title":"Id"},"description":"The ID of the artifact to retrieve."},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Artifacts"],"summary":"Update Artifact","description":"Update an artifact in the database.\n\nRequired workspace scopes: `write_artifacts`","operationId":"update_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the artifact to update.","title":"Id"},"description":"The ID of the artifact to update."},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Artifacts"],"summary":"Delete Artifact","description":"Delete an artifact from the database.\n\nRequired workspace scopes: `manage_artifacts`","operationId":"delete_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the artifact to delete.","title":"Id"},"description":"The ID of the artifact to delete."},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/{key}/latest":{"get":{"tags":["Artifacts"],"summary":"Read Latest Artifact","description":"Retrieve the latest artifact from the database.\n\nRequired workspace scopes: `see_artifacts`","operationId":"read_latest_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__key__latest_get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The key of the artifact to retrieve.","title":"Key"},"description":"The key of the artifact to retrieve."},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArtifactCollection"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/filter":{"post":{"tags":["Artifacts"],"summary":"Read Artifacts","description":"Retrieve artifacts from the database.\n\nRequired workspace scopes: `see_artifacts`","operationId":"read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Artifact"},"title":"Response Read Artifacts Api Accounts  Account Id  Workspaces  Workspace Id  Artifacts Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/latest/filter":{"post":{"tags":["Artifacts"],"summary":"Read Latest Artifacts","description":"Retrieve artifacts from the database.\n\nRequired workspace scopes: `see_artifacts`","operationId":"read_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ArtifactCollection"},"title":"Response Read Latest Artifacts Api Accounts  Account Id  Workspaces  Workspace Id  Artifacts Latest Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/count":{"post":{"tags":["Artifacts"],"summary":"Count Artifacts","description":"Count artifacts in the database.\n\nRequired workspace scopes: `see_artifacts`","operationId":"count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Artifacts Api Accounts  Account Id  Workspaces  Workspace Id  Artifacts Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/latest/count":{"post":{"tags":["Artifacts"],"summary":"Count Latest Artifacts","description":"Count artifacts from the database.\n\nRequired workspace scopes: `see_artifacts`","operationId":"count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Latest Artifacts Api Accounts  Account Id  Workspaces  Workspace Id  Artifacts Latest Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/collections/work_pool_types":{"get":{"tags":["Collections"],"summary":"Read Available Work Pool Types","description":"Reads the content of a view from the prefect-collection-registry.\n\nRequired workspace scopes: `see_work_pools`","operationId":"read_available_work_pool_types_api_accounts__account_id__workspaces__workspace_id__collections_work_pool_types_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Read Available Work Pool Types Api Accounts  Account Id  Workspaces  Workspace Id  Collections Work Pool Types Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/":{"post":{"tags":["Flows"],"summary":"Create Flow","description":"Gracefully creates a new flow from the provided schema. If a flow with the\nsame name already exists, the existing flow is returned.\n\nRequired workspace scopes: `run_flows`","operationId":"create_flow_api_accounts__account_id__workspaces__workspace_id__flows__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/{id}":{"patch":{"tags":["Flows"],"summary":"Update Flow","description":"Updates a flow.\n\nRequired workspace scopes: `run_flows`","operationId":"update_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow id","title":"Id"},"description":"The flow id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Flows"],"summary":"Read Flow","description":"Get a flow by id.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow id","title":"Id"},"description":"The flow id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Flows"],"summary":"Delete Flow","description":"Delete a flow by id.\n\nRequired workspace scopes: `manage_flows`","operationId":"delete_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow id","title":"Id"},"description":"The flow id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/{id}/archive":{"post":{"tags":["Flows"],"summary":"Archive Flow","description":"Archive a flow, hiding it from views that filter out archived flows. Archived\nflows produce no scheduled runs, so a flow with deployments that are unpaused\nand have an active schedule cannot be archived (409) until those schedules are\npaused. Archiving leaves the flow's runs and deployments unchanged. Archiving\nan archived flow does nothing.\n\nRequired workspace scopes: `manage_flows`","operationId":"archive_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__archive_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow id","title":"Id"},"description":"The flow id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/{id}/unarchive":{"post":{"tags":["Flows"],"summary":"Unarchive Flow","description":"Unarchive a flow. Unarchiving a flow that is not archived does nothing.\n\nRequired workspace scopes: `manage_flows`","operationId":"unarchive_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__unarchive_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow id","title":"Id"},"description":"The flow id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/count":{"post":{"tags":["Flows"],"summary":"Count Flows","description":"Count flows.\n\nRequired workspace scopes: `see_flows`","operationId":"count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Flows Api Accounts  Account Id  Workspaces  Workspace Id  Flows Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/name/{name}":{"get":{"tags":["Flows"],"summary":"Read Flow By Name","description":"Get a flow by name.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_by_name_api_accounts__account_id__workspaces__workspace_id__flows_name__name__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The name of the flow","title":"Name"},"description":"The name of the flow"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/filter":{"post":{"tags":["Flows"],"summary":"Read Flows","description":"Query for flows.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Flow"},"title":"Response Read Flows Api Accounts  Account Id  Workspaces  Workspace Id  Flows Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/bulk_delete":{"post":{"tags":["Flows"],"summary":"Bulk Delete Flows","description":"Bulk delete flows using a filter.\n\nThis endpoint soft-deletes flows matching the provided filter criteria,\nthen hard-deletes their associated deployments.\nFlow runs are soft-deleted asynchronously in the background.\nAssociated automations are cleaned up asynchronously in the background.\n\nIf ANY deployment for a flow is unauthorized, the entire request fails\nand nothing is deleted.\n\nRequired workspace scopes: `manage_flows`","operationId":"bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/bulk_archive":{"post":{"tags":["Flows"],"summary":"Bulk Archive Flows","description":"Archive up to `limit` flows matching a filter, skipping flows that are already\narchived. A flow whose deployments have active schedules is not archived and is\nreported as BLOCKED with those deployments' names; the rest of the batch still\nproceeds. Blocked flows are selected only after every archivable match, so\nrepeating a request keeps making progress.\n\nRequired workspace scopes: `manage_flows`","operationId":"bulk_archive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_archive_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_archive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_archive_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowBulkArchiveResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/bulk_unarchive":{"post":{"tags":["Flows"],"summary":"Bulk Unarchive Flows","description":"Unarchive up to `limit` flows matching a filter, skipping flows that are not\narchived.\n\nRequired workspace scopes: `manage_flows`","operationId":"bulk_unarchive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_unarchive_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_unarchive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_unarchive_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowBulkArchiveResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flows/paginate":{"post":{"tags":["Flows"],"summary":"Paginate Flows","description":"Pagination query for flows.\n\nRequired workspace scopes: `see_flows`","operationId":"paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/execution-plans/schema":{"get":{"tags":["Execution Plans"],"summary":"Read execution plan schema","operationId":"read_execution_plan_schema_api_accounts__account_id__workspaces__workspace_id__execution_plans_schema_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"version","in":"query","required":false,"schema":{"type":"string","description":"The authored execution plan schema version to retrieve.","default":"0.1","title":"Version"},"description":"The authored execution plan schema version to retrieve."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionPlanSchemaResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/":{"post":{"tags":["Flow Runs"],"summary":"Create Flow Run","description":"Create a flow run. If a flow run with the same flow_id and\nidempotency key already exists, the existing flow run will be returned.\n\nIf no state is provided, the flow run will be created in a PENDING state.\n\nRequired workspace scopes: `run_flows`","operationId":"create_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/filter":{"post":{"tags":["Flow Runs"],"summary":"Read Flow Runs","description":"Query for flow runs.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FlowRunResponse"},"title":"Response Read Flow Runs Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/filter-minimal":{"post":{"tags":["Flow Runs"],"summary":"Read Flow Runs Minimal","description":"A flow runs filter that excludes full state data -- and possibly other\ndata in the future -- for improved performance.\n\nNote that the state name, state type, and state ID are all still available.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_runs_minimal_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_minimal_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_flow_runs_minimal_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_minimal_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MinimalFlowRun"},"title":"Response Read Flow Runs Minimal Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs Filter Minimal Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}":{"patch":{"tags":["Flow Runs"],"summary":"Update Flow Run","description":"Updates a flow run.\n\nRequired workspace scopes: `run_flows`","operationId":"update_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Flow Runs"],"summary":"Read Flow Run","description":"Get a flow run by id.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Flow Runs"],"summary":"Delete Flow Run","description":"Delete a flow run by id.\n\nRequired workspace scopes: `manage_flows`","operationId":"delete_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/count":{"post":{"tags":["Flow Runs"],"summary":"Count Flow Runs","description":"Query for flow runs.\n\nRequired workspace scopes: `see_flows`","operationId":"count_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Flow Runs Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/lateness":{"post":{"tags":["Flow Runs"],"summary":"Average Flow Run Lateness","description":"Query for average flow-run lateness in seconds.\n\nRequired workspace scopes: `see_flows`","operationId":"average_flow_run_lateness_api_accounts__account_id__workspaces__workspace_id__flow_runs_lateness_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_average_flow_run_lateness_api_accounts__account_id__workspaces__workspace_id__flow_runs_lateness_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Response Average Flow Run Lateness Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs Lateness Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/history":{"post":{"tags":["Flow Runs"],"summary":"Flow Run History","description":"Query for flow run history data across a given range and interval.\n\nRequired workspace scopes: `see_flows`","operationId":"flow_run_history_api_accounts__account_id__workspaces__workspace_id__flow_runs_history_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_flow_run_history_api_accounts__account_id__workspaces__workspace_id__flow_runs_history_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoryResponse"},"title":"Response Flow Run History Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs History Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/graph":{"get":{"tags":["Flow Runs"],"summary":"Read Flow Run Graph V1","description":"Get a task run dependency map for a given flow run.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_graph_v1_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__graph_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DependencyResult"},"title":"Response Read Flow Run Graph V1 Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs  Id  Graph Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/graph-v2":{"get":{"tags":["Flow Runs"],"summary":"Read Flow Run Graph V2","description":"Get a graph of the tasks and subflow runs for the given flow run\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_graph_v2_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__graph_v2_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Only include runs that start or end after this time.","default":"0001-01-01T00:00:00Z","title":"Since"},"description":"Only include runs that start or end after this time."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Graph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/artifacts":{"get":{"tags":["Flow Runs"],"summary":"Get Flow Run Artifacts","description":"Get all artifacts created within a flow run, including artifacts from\ntask runs and subflow runs (recursively).\n\nRequired workspace scopes: `see_flows`","operationId":"get_flow_run_artifacts_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__artifacts_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"depth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Optional depth limit for recursion (0 = flow run only)","title":"Depth"},"description":"Optional depth limit for recursion (0 = flow run only)"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return artifacts created on or after this timestamp","title":"Since"},"description":"Only return artifacts created on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return artifacts created on or before this timestamp","title":"Until"},"description":"Only return artifacts created on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order by creation time (asc or desc)","default":"desc","title":"Sort"},"description":"Sort order by creation time (asc or desc)"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Artifact"},"title":"Response Get Flow Run Artifacts Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs  Id  Artifacts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/resume":{"post":{"tags":["Flow Runs"],"summary":"Resume Flow Run","description":"Resume a paused flow run.\n\nRequired workspace scopes: `run_flows`","operationId":"resume_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__resume_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_resume_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__resume_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/bulk_delete":{"post":{"tags":["Flow Runs"],"summary":"Bulk Delete Flow Runs","description":"Bulk delete flow runs using a filter.\n\nThis endpoint soft-deletes flow runs matching the provided filter criteria.\nFor small numbers of flow runs (5 or fewer), cleanup is performed synchronously.\nFor larger batches, cleanup is queued as a background job.\n\nRequired workspace scopes: `manage_flows`","operationId":"bulk_delete_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_delete_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_delete_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_delete_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/bulk_set_state":{"post":{"tags":["Flow Runs"],"summary":"Bulk Set Flow Run State","description":"Bulk set state on flow runs matching a filter.\n\nThis endpoint attempts to set the specified state on all flow runs\nmatching the filter criteria. Each flow run is processed through\norchestration rules (unless force=True), so individual transitions\nmay be accepted, rejected, aborted, or waited.\n\nThe response body contains detailed per-run results indicating\nthe outcome for each flow run.\n\nRequired workspace scopes: `run_flows`","operationId":"bulk_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_set_state_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_set_state_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunBulkSetStateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/set_state":{"post":{"tags":["Flow Runs"],"summary":"Set Flow Run State","description":"Set a flow run state, invoking any orchestration rules.\n\nRequired workspace scopes: `run_flows`","operationId":"set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__set_state_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__set_state_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunSetStateResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/input":{"post":{"tags":["Flow Runs"],"summary":"Create Flow Run Input","description":"Create a key/value input for a flow run.\n\nRequired workspace scopes: `run_flows`","operationId":"create_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_create_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/input/filter":{"post":{"tags":["Flow Runs"],"summary":"Filter Flow Run Input","description":"Filter flow run inputs by key prefix\n\nRequired workspace scopes: `see_flows`","operationId":"filter_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_filter_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_filter_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FlowRunInput"},"title":"Response Filter Flow Run Input Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs  Id  Input Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/input/{key}":{"get":{"tags":["Flow Runs"],"summary":"Read Flow Run Input","description":"Create a value from a flow run input\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input__key__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The input key","title":"Key"},"description":"The input key"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Flow Runs"],"summary":"Delete Flow Run Input","description":"Delete a flow run input\n\nRequired workspace scopes: `manage_flows`","operationId":"delete_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input__key__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"key","in":"path","required":true,"schema":{"type":"string","description":"The input key","title":"Key"},"description":"The input key"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/paginate":{"post":{"tags":["Flow Runs"],"summary":"Paginate Flow Runs","description":"Pagination query for flow runs.\n\nRequired workspace scopes: `see_flows`","operationId":"paginate_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_paginate_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/labels":{"patch":{"tags":["Flow Runs"],"summary":"Update Flow Run Labels","description":"\n\nRequired workspace scopes: `run_flows`","operationId":"update_flow_run_labels_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__labels_patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"title":"Flow Run Labels"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/assets/materializations":{"get":{"tags":["Flow Runs"],"summary":"Get Flow Run Materializations","description":"Get all asset materializations within a flow run, including materializations\nfrom descendant task runs and subflow runs.\n\nReturns a historical snapshot of materializations as they occurred, with asset\nproperties captured at materialization time (not current state).\n\nRequired workspace scopes: `see_assets`","operationId":"get_flow_run_materializations_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__assets_materializations_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"depth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default).","title":"Depth"},"description":"Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default)."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return materializations on or after this timestamp","title":"Since"},"description":"Only return materializations on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return materializations on or before this timestamp","title":"Until"},"description":"Only return materializations on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order by occurred time (asc or desc)","default":"desc","title":"Sort"},"description":"Sort order by occurred time (asc or desc)"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MaterializationEvent"},"title":"Response Get Flow Run Materializations Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs  Id  Assets Materializations Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/assets/references":{"get":{"tags":["Flow Runs"],"summary":"Get Flow Run References","description":"Get all asset references within a flow run, including references from\ndescendant task runs and subflow runs.\n\nReturns a historical snapshot of asset references as they occurred, with asset\nproperties captured at reference time (not current state).\n\nRequired workspace scopes: `see_assets`","operationId":"get_flow_run_references_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__assets_references_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run id","title":"Id"},"description":"The flow run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"depth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default).","title":"Depth"},"description":"Optional depth limit based on execution hierarchy. depth=0: only the root flow run. depth=1: root + direct children (tasks and subflows). None: unlimited depth (default)."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return references on or after this timestamp","title":"Since"},"description":"Only return references on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return references on or before this timestamp","title":"Until"},"description":"Only return references on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order by occurred time (asc or desc)","default":"desc","title":"Sort"},"description":"Sort order by occurred time (asc or desc)"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceEvent"},"title":"Response Get Flow Run References Api Accounts  Account Id  Workspaces  Workspace Id  Flow Runs  Id  Assets References Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/filter":{"post":{"tags":["Task Runs"],"summary":"Read Task Runs","description":"Query for task runs.\n\nRequired workspace scopes: `see_flows`","operationId":"read_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskRun"},"title":"Response Read Task Runs Api Accounts  Account Id  Workspaces  Workspace Id  Task Runs Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}":{"delete":{"tags":["Task Runs"],"summary":"Delete Task Run","description":"Delete a task run by id.\n\nRequired workspace scopes: `manage_flows`","operationId":"delete_task_run_api_accounts__account_id__workspaces__workspace_id__task_runs__id__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run id","title":"Id"},"description":"The task run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Task Runs"],"summary":"Update Task Run","description":"Updates a task run.\n\nRequired workspace scopes: `run_flows`","operationId":"update_task_run_api_accounts__account_id__workspaces__workspace_id__task_runs__id__patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run id","title":"Id"},"description":"The task run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRunUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Task Runs"],"summary":"Read Task Run","description":"Get a task run by id.\n\nRequired workspace scopes: `see_flows`","operationId":"read_task_run_api_accounts__account_id__workspaces__workspace_id__task_runs__id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run id","title":"Id"},"description":"The task run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/":{"post":{"tags":["Task Runs"],"summary":"Create Task Run","description":"Create a task run. If a task run with the same flow_run_id,\ntask_key, and dynamic_key already exists, the existing task\nrun will be returned.\nIf no state is provided, the task run will be created in a PENDING state.\n\nRequired workspace scopes: `run_flows`","operationId":"create_task_run_api_accounts__account_id__workspaces__workspace_id__task_runs__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRunCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/count":{"post":{"tags":["Task Runs"],"summary":"Count Task Runs","description":"Count task runs.\n\nRequired workspace scopes: `see_flows`","operationId":"count_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Task Runs Api Accounts  Account Id  Workspaces  Workspace Id  Task Runs Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/history":{"post":{"tags":["Task Runs"],"summary":"Task Run History","description":"Query for task run history data across a given range and interval.\n\nRequired workspace scopes: `see_flows`","operationId":"task_run_history_api_accounts__account_id__workspaces__workspace_id__task_runs_history_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_task_run_history_api_accounts__account_id__workspaces__workspace_id__task_runs_history_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HistoryResponse"},"title":"Response Task Run History Api Accounts  Account Id  Workspaces  Workspace Id  Task Runs History Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/artifacts":{"get":{"tags":["Task Runs"],"summary":"Get Task Run Artifacts","description":"Get all artifacts created within a task run, including artifacts from\nsubflow runs spawned by this task (recursively).\n\nRequired workspace scopes: `see_flows`","operationId":"get_task_run_artifacts_api_accounts__account_id__workspaces__workspace_id__task_runs__id__artifacts_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run id","title":"Id"},"description":"The task run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"depth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Optional depth limit for recursion (0 = task run only)","title":"Depth"},"description":"Optional depth limit for recursion (0 = task run only)"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return artifacts created on or after this timestamp","title":"Since"},"description":"Only return artifacts created on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return artifacts created on or before this timestamp","title":"Until"},"description":"Only return artifacts created on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order by creation time (asc or desc)","default":"desc","title":"Sort"},"description":"Sort order by creation time (asc or desc)"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Artifact"},"title":"Response Get Task Run Artifacts Api Accounts  Account Id  Workspaces  Workspace Id  Task Runs  Id  Artifacts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/assets/materializations":{"get":{"tags":["Task Runs"],"summary":"Get Task Run Materializations","description":"Get all asset materializations from a task run, including materializations\nfrom descendant runs.\n\nReturns a historical snapshot of materializations as they occurred, with asset\nproperties captured at materialization time (not current state).\n\nRequired workspace scopes: `see_assets`","operationId":"get_task_run_materializations_api_accounts__account_id__workspaces__workspace_id__task_runs__id__assets_materializations_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run id","title":"Id"},"description":"The task run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"depth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Optional depth limit based on execution hierarchy. depth=0: only the task run. depth=1: task run + its descendants. None: unlimited depth (default).","title":"Depth"},"description":"Optional depth limit based on execution hierarchy. depth=0: only the task run. depth=1: task run + its descendants. None: unlimited depth (default)."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return materializations on or after this timestamp","title":"Since"},"description":"Only return materializations on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return materializations on or before this timestamp","title":"Until"},"description":"Only return materializations on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order by occurred time (asc or desc)","default":"desc","title":"Sort"},"description":"Sort order by occurred time (asc or desc)"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MaterializationEvent"},"title":"Response Get Task Run Materializations Api Accounts  Account Id  Workspaces  Workspace Id  Task Runs  Id  Assets Materializations Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/assets/references":{"get":{"tags":["Task Runs"],"summary":"Get Task Run References","description":"Get all asset references from a task run, including references from\ndescendant runs.\n\nReturns a historical snapshot of asset references as they occurred, with asset\nproperties captured at reference time (not current state).\n\nRequired workspace scopes: `see_assets`","operationId":"get_task_run_references_api_accounts__account_id__workspaces__workspace_id__task_runs__id__assets_references_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run id","title":"Id"},"description":"The task run id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"depth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Optional depth limit based on execution hierarchy. depth=0: only the task run. depth=1: task run + its descendants. None: unlimited depth (default).","title":"Depth"},"description":"Optional depth limit based on execution hierarchy. depth=0: only the task run. depth=1: task run + its descendants. None: unlimited depth (default)."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return references on or after this timestamp","title":"Since"},"description":"Only return references on or after this timestamp"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return references on or before this timestamp","title":"Until"},"description":"Only return references on or before this timestamp"},{"name":"sort","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Sort order by occurred time (asc or desc)","default":"desc","title":"Sort"},"description":"Sort order by occurred time (asc or desc)"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceEvent"},"title":"Response Get Task Run References Api Accounts  Account Id  Workspaces  Workspace Id  Task Runs  Id  Assets References Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/set_state":{"post":{"tags":["Task Runs"],"summary":"Set Task Run State","description":"Set a task run state, invoking any orchestration rules.\n\nRequired workspace scopes: `run_flows`","operationId":"set_task_run_state_api_accounts__account_id__workspaces__workspace_id__task_runs__id__set_state_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run id","title":"Id"},"description":"The task run id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_set_task_run_state_api_accounts__account_id__workspaces__workspace_id__task_runs__id__set_state_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrchestrationResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/paginate":{"post":{"tags":["Task Runs"],"summary":"Paginate Task Runs","description":"Pagination query for task runs.\n\nRequired workspace scopes: `see_flows`","operationId":"paginate_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_paginate_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRunPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_workers/filter":{"post":{"tags":["Task Workers"],"summary":"Read Task Workers","description":"Read task workers for a workspace. Optionally filter by task keys.\n\nRequired workspace scopes: `see_workers`","operationId":"read_task_workers_api_accounts__account_id__workspaces__workspace_id__task_workers_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_task_workers_api_accounts__account_id__workspaces__workspace_id__task_workers_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskWorkerResponse"},"title":"Response Read Task Workers Api Accounts  Account Id  Workspaces  Workspace Id  Task Workers Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_run_states/{id}":{"get":{"tags":["Flow Run States"],"summary":"Read Flow Run State","description":"Get a flow run state by id.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_run_states__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run state id","title":"Id"},"description":"The flow run state id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/State"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/flow_run_states/":{"get":{"tags":["Flow Run States"],"summary":"Read Flow Run States","description":"Get states associated with a flow run.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_states_api_accounts__account_id__workspaces__workspace_id__flow_run_states__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"flow_run_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Flow Run Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/State"},"title":"Response Read Flow Run States Api Accounts  Account Id  Workspaces  Workspace Id  Flow Run States  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_run_states/{id}":{"get":{"tags":["Task Run States"],"summary":"Read Task Run State","description":"Get a task run state by id.\n\nRequired workspace scopes: `see_flows`","operationId":"read_task_run_state_api_accounts__account_id__workspaces__workspace_id__task_run_states__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The task run state id","title":"Id"},"description":"The task run state id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/task_run_states/":{"get":{"tags":["Task Run States"],"summary":"Read Task Run States","description":"Get states associated with a task run.\n\nRequired workspace scopes: `see_flows`","operationId":"read_task_run_states_api_accounts__account_id__workspaces__workspace_id__task_run_states__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"task_run_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Task Run Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/":{"post":{"tags":["Deployments"],"summary":"Create Deployment","description":"\n\nRequired workspace scopes: `write_deployments`","operationId":"create_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/branch":{"post":{"tags":["Deployments"],"summary":"Branch From Deployment","description":"\n\nRequired workspace scopes: `write_deployments`","operationId":"branch_from_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__branch_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentBranch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}":{"patch":{"tags":["Deployments"],"summary":"Update Deployment","description":"\n\nRequired workspace scopes: `write_deployments`","operationId":"update_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Deployments"],"summary":"Read Deployment","description":"Get a deployment by id.\n\nRequired workspace scopes: `see_deployments`","operationId":"read_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Deployments"],"summary":"Delete Deployment","description":"Delete a deployment by id.\n\nRequired workspace scopes: `manage_deployments`","operationId":"delete_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/name/{flow_name}/{deployment_name}":{"get":{"tags":["Deployments"],"summary":"Read Deployment By Name","description":"Get a deployment using the name of the flow and the deployment.\n\nRequired workspace scopes: `see_deployments`","operationId":"read_deployment_by_name_api_accounts__account_id__workspaces__workspace_id__deployments_name__flow_name___deployment_name__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"flow_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the flow","title":"Flow Name"},"description":"The name of the flow"},{"name":"deployment_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the deployment","title":"Deployment Name"},"description":"The name of the deployment"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/filter":{"post":{"tags":["Deployments"],"summary":"Read Deployments","description":"\n\nRequired workspace scopes: `see_deployments`","operationId":"read_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentResponse"},"title":"Response Read Deployments Api Accounts  Account Id  Workspaces  Workspace Id  Deployments Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/paginate":{"post":{"tags":["Deployments"],"summary":"Paginate Deployments","description":"Pagination query for deployments.\n\nRequired workspace scopes: `see_deployments`","operationId":"paginate_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_paginate_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/get_scheduled_flow_runs":{"post":{"tags":["Deployments"],"summary":"Get Scheduled Flow Runs For Deployments","description":"Get scheduled runs for a set of deployments. Used by a runner to poll for work.\n\nRequired workspace scopes: `see_deployments`","operationId":"get_scheduled_flow_runs_for_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_get_scheduled_flow_runs_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_scheduled_flow_runs_for_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_get_scheduled_flow_runs_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FlowRunResponse"},"title":"Response Get Scheduled Flow Runs For Deployments Api Accounts  Account Id  Workspaces  Workspace Id  Deployments Get Scheduled Flow Runs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/count":{"post":{"tags":["Deployments"],"summary":"Count Deployments","description":"Count deployments.\n\nRequired workspace scopes: `see_deployments`","operationId":"count_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Deployments Api Accounts  Account Id  Workspaces  Workspace Id  Deployments Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/bulk_delete":{"post":{"tags":["Deployments"],"summary":"Bulk Delete Deployments","description":"Bulk delete deployments using a filter.\n\nThis endpoint deletes deployments matching the provided filter criteria.\nDeployments are deleted immediately so they disappear from the UI.\nAssociated automations are cleaned up asynchronously in the background.\n\nIf ANY deployment in the filter is unauthorized, the entire request fails\nand nothing is deleted.\n\nRequired workspace scopes: `manage_deployments`","operationId":"bulk_delete_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_bulk_delete_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_delete_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_bulk_delete_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedule":{"post":{"tags":["Deployments"],"summary":"Schedule Deployment","description":"Schedule runs for a deployment. For backfills, provide start/end times in the past.\n\nThis function will generate the minimum number of runs that satisfy the min\nand max times, and the min and max counts. Specifically, the following order\nwill be respected.\n\n    - Runs will be generated starting on or after the `start_time`\n    - No more than `max_runs` runs will be generated\n    - No runs will be generated after `end_time` is reached\n    - At least `min_runs` runs will be generated\n    - Runs will be generated until at least `start_time + min_time` is reached\n\nRequired workspace scopes: `write_deployments`","operationId":"schedule_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedule_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_schedule_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedule_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/resume_deployment":{"post":{"tags":["Deployments"],"summary":"Resume Deployment","description":"Resume the deployment. Runs will be scheduled immediately.\n\nRequired workspace scopes: `write_deployments`","operationId":"resume_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__resume_deployment_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/set_schedule_active":{"post":{"tags":["Deployments"],"summary":"Resume Deployment","description":"Resume the deployment. Runs will be scheduled immediately.\n\nRequired workspace scopes: `write_deployments`","operationId":"resume_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__set_schedule_active_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/pause_deployment":{"post":{"tags":["Deployments"],"summary":"Pause Deployment","description":"Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled\nstate will be deleted.\n\nRequired workspace scopes: `write_deployments`","operationId":"pause_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__pause_deployment_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/set_schedule_inactive":{"post":{"tags":["Deployments"],"summary":"Pause Deployment","description":"Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled\nstate will be deleted.\n\nRequired workspace scopes: `write_deployments`","operationId":"pause_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__set_schedule_inactive_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/create_flow_run":{"post":{"tags":["Deployments"],"summary":"Create Flow Run From Deployment","description":"Create a flow run from a deployment.\n\nAny parameters not provided will be inferred from the deployment's parameters.\nIf tags are not provided, the deployment's tags will be used.\n\nIf no state is provided, the flow run will be created in a SCHEDULED state with\na scheduled start time of NOW.\n\nRequired workspace scopes: `run_deployments`","operationId":"create_flow_run_from_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__create_flow_run_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentFlowRunCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/create_flow_run/bulk":{"post":{"tags":["Deployments"],"summary":"Bulk Create Flow Runs From Deployment","description":"Create multiple flow runs from a deployment in a single request.\n\nEach item in the list uses the same schema as the single create endpoint.\nResults are returned in the same order as the input list.\n\nRequired workspace scopes: `run_deployments`","operationId":"bulk_create_flow_runs_from_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__create_flow_run_bulk_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentFlowRunCreate"},"maxItems":250,"description":"List of flow runs to create","title":"Flow Runs"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunBulkCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/access":{"get":{"tags":["Deployments"],"summary":"Read Deployment Access","description":"Read access controls for a deployment.\n\nRequired workspace scopes: `see_deployments`","operationId":"read_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentAccessControl"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Deployments"],"summary":"Set Deployment Access","description":"Set access controls for a deployment.\nThe given access controls will replace any existing access controls.\n\nRequired workspace scopes: `manage_deployments`","operationId":"set_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_put","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_set_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_put"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/my-access":{"post":{"tags":["Deployments"],"summary":"Read Actors Deployment Access","description":"Read access controls for a set of deployments and return the resolved\naccess levels for the current actor.\n\nRequired workspace scopes: `see_deployments`","operationId":"read_actors_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments_my_access_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_actors_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments_my_access_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Response Read Actors Deployment Access Api Accounts  Account Id  Workspaces  Workspace Id  Deployments My Access Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/work_queue_check":{"get":{"tags":["Deployments"],"summary":"Work Queue Check For Deployment","description":"Get list of work-queues that are able to pick up the specified deployment.\n\nThis endpoint is intended to be used by the UI to provide users warnings\nabout deployments that are unable to be executed because there are no work\nqueues that will pick up their runs, based on existing filter criteria. It\nmay be deprecated in the future because there is not a strict relationship\nbetween work queues and deployments.","operationId":"work_queue_check_for_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__work_queue_check_get","deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkQueue"},"title":"Response Work Queue Check For Deployment Api Accounts  Account Id  Workspaces  Workspace Id  Deployments  Id  Work Queue Check Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules":{"get":{"tags":["Deployments"],"summary":"Read Deployment Schedules","description":"\n\nRequired workspace scopes: `see_deployments`","operationId":"read_deployment_schedules_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentScheduleResponse"},"title":"Response Read Deployment Schedules Api Accounts  Account Id  Workspaces  Workspace Id  Deployments  Id  Schedules Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Deployments"],"summary":"Create Deployment Schedules","description":"\n\nRequired workspace scopes: `write_deployments`","operationId":"create_deployment_schedules_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentScheduleCreate"},"description":"The schedules to create","title":"Schedules"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentScheduleResponse"},"title":"Response Create Deployment Schedules Api Accounts  Account Id  Workspaces  Workspace Id  Deployments  Id  Schedules Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/schedules/{schedule_id}":{"patch":{"tags":["Deployments"],"summary":"Update Deployment Schedule","description":"\n\nRequired workspace scopes: `write_deployments`","operationId":"update_deployment_schedule_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules__schedule_id__patch","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The schedule id","title":"Schedule Id"},"description":"The schedule id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentScheduleUpdate","description":"The updated schedule"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Deployments"],"summary":"Delete Deployment Schedule","description":"\n\nRequired workspace scopes: `write_deployments`","operationId":"delete_deployment_schedule_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedules__schedule_id__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"schedule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The schedule id","title":"Schedule Id"},"description":"The schedule id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/disable":{"post":{"tags":["Deployments"],"summary":"Disable Deployment","description":"Set a deployment to disabled. Any auto-scheduled runs still in a Scheduled state will be deleted. No new flow runs can be created until the deployment is enabled.\n\nRequired workspace scopes: `write_deployments`","operationId":"disable_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__disable_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/enable":{"post":{"tags":["Deployments"],"summary":"Enable Deployment","description":"Resume the deployment. Runs will be scheduled immediately.\n\nRequired workspace scopes: `write_deployments`","operationId":"enable_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__enable_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/paginate":{"post":{"tags":["Deployments"],"summary":"Paginate Deployment Versions","description":"\n\nRequired workspace scopes: `see_deployments`","operationId":"paginate_deployment_versions_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions_paginate_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_deployment_versions_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentVersionPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id}":{"get":{"tags":["Deployments"],"summary":"Read Deployment Version","description":"\n\nRequired workspace scopes: `see_deployments`","operationId":"read_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"version_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The version id","title":"Version Id"},"description":"The version id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentVersionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Deployments"],"summary":"Delete Deployment Version","description":"\n\nRequired workspace scopes: `manage_deployments`","operationId":"delete_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"version_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The version id","title":"Version Id"},"description":"The version id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/deployments/{id}/versions/{version_id}/promote":{"post":{"tags":["Deployments"],"summary":"Promote Deployment Version","description":"\n\nRequired workspace scopes: `manage_deployments`","operationId":"promote_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__promote_post","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment id","title":"Id"},"description":"The deployment id"},{"name":"version_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The version id","title":"Version Id"},"description":"The version id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_promote_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__promote_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Promote Deployment Version Api Accounts  Account Id  Workspaces  Workspace Id  Deployments  Id  Versions  Version Id  Promote Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/saved_searches/":{"put":{"tags":["SavedSearches"],"summary":"Create Saved Search","description":"Gracefully creates a new saved search from the provided schema.\n\nIf a saved search with the same name already exists, the saved search's fields are\nreplaced.\n\nRequired workspace scopes: `manage_saved_search`","operationId":"create_saved_search_api_accounts__account_id__workspaces__workspace_id__saved_searches__put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/saved_searches/{id}":{"get":{"tags":["SavedSearches"],"summary":"Read Saved Search","description":"Get a saved search by id.\n\nRequired workspace scopes: `see_flows`","operationId":"read_saved_search_api_accounts__account_id__workspaces__workspace_id__saved_searches__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The saved search id","title":"Id"},"description":"The saved search id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["SavedSearches"],"summary":"Delete Saved Search","description":"Delete a saved search by id.\n\nRequired workspace scopes: `manage_saved_search`","operationId":"delete_saved_search_api_accounts__account_id__workspaces__workspace_id__saved_searches__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The saved search id","title":"Id"},"description":"The saved search id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/saved_searches/filter":{"post":{"tags":["SavedSearches"],"summary":"Read Saved Searches","description":"Query for saved searches.\n\nRequired workspace scopes: `see_flows`","operationId":"read_saved_searches_api_accounts__account_id__workspaces__workspace_id__saved_searches_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_saved_searches_api_accounts__account_id__workspaces__workspace_id__saved_searches_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SavedSearch"},"title":"Response Read Saved Searches Api Accounts  Account Id  Workspaces  Workspace Id  Saved Searches Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/pins/":{"post":{"tags":["Pins"],"summary":"Create User Pin","description":"Pin a resource for the current user.\n\nRequired workspace scopes: `see_flows`","operationId":"create_user_pin_api_accounts__account_id__workspaces__workspace_id__pins__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPinCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPin"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/pins/filter":{"post":{"tags":["Pins"],"summary":"Read User Pins","description":"List pins for the current user, optionally filtered by resource type.\n\nRequired workspace scopes: `see_flows`","operationId":"read_user_pins_api_accounts__account_id__workspaces__workspace_id__pins_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_user_pins_api_accounts__account_id__workspaces__workspace_id__pins_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserPin"},"title":"Response Read User Pins Api Accounts  Account Id  Workspaces  Workspace Id  Pins Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/pins/{id}":{"delete":{"tags":["Pins"],"summary":"Delete User Pin","description":"Remove a pin for the current user.\n\nRequired workspace scopes: `see_flows`","operationId":"delete_user_pin_api_accounts__account_id__workspaces__workspace_id__pins__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The pin id","title":"Id"},"description":"The pin id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/concurrency_limits/":{"post":{"tags":["Concurrency Limits"],"summary":"Create Concurrency Limit","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"create_concurrency_limit_api_accounts__account_id__workspaces__workspace_id__concurrency_limits__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimitCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/concurrency_limits/{id}":{"get":{"tags":["Concurrency Limits"],"summary":"Read Concurrency Limit","description":"Get a concurrency limit by id.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.\n\nRequired workspace scopes: `see_concurrency_limits`","operationId":"read_concurrency_limit_api_accounts__account_id__workspaces__workspace_id__concurrency_limits__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The concurrency limit id","title":"Id"},"description":"The concurrency limit id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Concurrency Limits"],"summary":"Delete Concurrency Limit","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"delete_concurrency_limit_api_accounts__account_id__workspaces__workspace_id__concurrency_limits__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The concurrency limit id","title":"Id"},"description":"The concurrency limit id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/concurrency_limits/tag/{tag}":{"get":{"tags":["Concurrency Limits"],"summary":"Read Concurrency Limit By Tag","description":"Get a concurrency limit by tag.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.\n\nRequired workspace scopes: `see_concurrency_limits`","operationId":"read_concurrency_limit_by_tag_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_tag__tag__get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","description":"The tag name","title":"Tag"},"description":"The tag name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Concurrency Limits"],"summary":"Delete Concurrency Limit By Tag","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"delete_concurrency_limit_by_tag_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_tag__tag__delete","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","description":"The tag name","title":"Tag"},"description":"The tag name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/concurrency_limits/filter":{"post":{"tags":["Concurrency Limits"],"summary":"Read Concurrency Limits","description":"Query for concurrency limits.\n\nFor each concurrency limit the `active slots` field contains a list of TaskRun IDs\ncurrently using a concurrency slot for the specified tag.\n\nRequired workspace scopes: `see_concurrency_limits`","operationId":"read_concurrency_limits_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_concurrency_limits_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConcurrencyLimit"},"title":"Response Read Concurrency Limits Api Accounts  Account Id  Workspaces  Workspace Id  Concurrency Limits Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/concurrency_limits/tag/{tag}/reset":{"post":{"tags":["Concurrency Limits"],"summary":"Reset Concurrency Limit By Tag","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"reset_concurrency_limit_by_tag_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_tag__tag__reset_post","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","description":"The tag name","title":"Tag"},"description":"The tag name"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_reset_concurrency_limit_by_tag_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_tag__tag__reset_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/concurrency_limits/increment":{"post":{"tags":["Concurrency Limits"],"summary":"Increment Concurrency Limits V1","description":"\n\nRequired workspace scopes: `run_flows`","operationId":"increment_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_increment_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_increment_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_increment_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MinimalConcurrencyLimitResponse"},"title":"Response Increment Concurrency Limits V1 Api Accounts  Account Id  Workspaces  Workspace Id  Concurrency Limits Increment Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/concurrency_limits/decrement":{"post":{"tags":["Concurrency Limits"],"summary":"Decrement Concurrency Limits V1","description":"\n\nRequired workspace scopes: `run_flows`","operationId":"decrement_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_decrement_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_decrement_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_decrement_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MinimalConcurrencyLimitResponse"},"title":"Response Decrement Concurrency Limits V1 Api Accounts  Account Id  Workspaces  Workspace Id  Concurrency Limits Decrement Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/":{"post":{"tags":["Concurrency Limits V2"],"summary":"Create Concurrency Limit V2","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"create_concurrency_limit_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimitV2Create"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimitV2"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/{id_or_name}":{"get":{"tags":["Concurrency Limits V2"],"summary":"Read Concurrency Limit V2","description":"\n\nRequired workspace scopes: `see_concurrency_limits`","operationId":"read_concurrency_limit_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits__id_or_name__get","parameters":[{"name":"id_or_name","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"description":"The ID or name of the concurrency limit","title":"Id Or Name"},"description":"The ID or name of the concurrency limit"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalConcurrencyLimitResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Concurrency Limits V2"],"summary":"Update Concurrency Limit V2","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"update_concurrency_limit_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits__id_or_name__patch","parameters":[{"name":"id_or_name","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"description":"The ID or name of the concurrency limit","title":"Id Or Name"},"description":"The ID or name of the concurrency limit"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimitV2Update"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Concurrency Limits V2"],"summary":"Delete Concurrency Limit V2","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"delete_concurrency_limit_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits__id_or_name__delete","parameters":[{"name":"id_or_name","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"}],"description":"The ID or name of the concurrency limit","title":"Id Or Name"},"description":"The ID or name of the concurrency limit"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/filter":{"post":{"tags":["Concurrency Limits V2"],"summary":"Read All Concurrency Limits V2","description":"\n\nRequired workspace scopes: `see_concurrency_limits`","operationId":"read_all_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_all_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GlobalConcurrencyLimitResponse"},"title":"Response Read All Concurrency Limits V2 Api Accounts  Account Id  Workspaces  Workspace Id  V2 Concurrency Limits Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/paginate":{"post":{"tags":["Concurrency Limits V2"],"summary":"Paginate Concurrency Limits V2","description":"Pagination query for concurrency limits.\n\nRequired workspace scopes: `see_concurrency_limits`","operationId":"paginate_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_paginate_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimitV2PaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/increment":{"post":{"tags":["Concurrency Limits V2"],"summary":"Bulk Increment Active Slots","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"bulk_increment_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_increment_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MinimalConcurrencyLimitResponse"},"title":"Response Bulk Increment Active Slots Api Accounts  Account Id  Workspaces  Workspace Id  V2 Concurrency Limits Increment Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/increment-with-lease":{"post":{"tags":["Concurrency Limits V2"],"summary":"Bulk Increment Active Slots With Lease","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"bulk_increment_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_with_lease_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_increment_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_with_lease_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConcurrencyLimitWithLeaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/decrement":{"post":{"tags":["Concurrency Limits V2"],"summary":"Bulk Decrement Active Slots","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"bulk_decrement_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_decrement_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MinimalConcurrencyLimitResponse"},"title":"Response Bulk Decrement Active Slots Api Accounts  Account Id  Workspaces  Workspace Id  V2 Concurrency Limits Decrement Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/decrement-with-lease":{"post":{"tags":["Concurrency Limits V2"],"summary":"Bulk Decrement Active Slots With Lease","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"bulk_decrement_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_with_lease_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_bulk_decrement_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_with_lease_post"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/v2/concurrency_limits/leases/{lease_id}/renew":{"post":{"tags":["Concurrency Limits V2"],"summary":"Renew Concurrency Lease","description":"\n\nRequired workspace scopes: `manage_concurrency_limits`","operationId":"renew_concurrency_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_leases__lease_id__renew_post","parameters":[{"name":"lease_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The ID of the lease to renew","title":"Lease Id"},"description":"The ID of the lease to renew"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_renew_concurrency_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_leases__lease_id__renew_post"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/":{"post":{"tags":["Block types"],"summary":"Create Block Type","description":"Create a new block type\n\nRequired workspace scopes: `manage_blocks`","operationId":"create_block_type_api_accounts__account_id__workspaces__workspace_id__block_types__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockTypeCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockType"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/{id}":{"get":{"tags":["Block types"],"summary":"Read Block Type By Id","description":"Get a block type by ID.\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_type_by_id_api_accounts__account_id__workspaces__workspace_id__block_types__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block type ID","title":"Id"},"description":"The block type ID"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockType"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Block types"],"summary":"Update Block Type","description":"Update a block type.\n\nRequired workspace scopes: `manage_blocks`","operationId":"update_block_type_api_accounts__account_id__workspaces__workspace_id__block_types__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block type ID","title":"Id"},"description":"The block type ID"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockTypeUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Block types"],"summary":"Delete Block Type","description":"\n\nRequired workspace scopes: `manage_blocks`","operationId":"delete_block_type_api_accounts__account_id__workspaces__workspace_id__block_types__id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block type ID","title":"Id"},"description":"The block type ID"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}":{"get":{"tags":["Block types"],"summary":"Read Block Type By Slug","description":"Get a block type by name.\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_type_by_slug_api_accounts__account_id__workspaces__workspace_id__block_types_slug__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"The block type name","title":"Slug"},"description":"The block type name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockType"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/filter":{"post":{"tags":["Block types"],"summary":"Read Block Types","description":"Gets all block types. Optionally limit return with limit and offset.\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_types_api_accounts__account_id__workspaces__workspace_id__block_types_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_block_types_api_accounts__account_id__workspaces__workspace_id__block_types_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockType"},"title":"Response Read Block Types Api Accounts  Account Id  Workspaces  Workspace Id  Block Types Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}/block_documents":{"get":{"tags":["Block types","Block types","Block documents"],"summary":"Read Block Documents For Block Type","description":"\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_documents_for_block_type_api_accounts__account_id__workspaces__workspace_id__block_types_slug__slug__block_documents_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"The block type name","title":"Slug"},"description":"The block type name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"include_secrets","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include sensitive values in the block document.","default":false,"title":"Include Secrets"},"description":"Whether to include sensitive values in the block document."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockDocument"},"title":"Response Read Block Documents For Block Type Api Accounts  Account Id  Workspaces  Workspace Id  Block Types Slug  Slug  Block Documents Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}/block_documents/name/{block_document_name}":{"get":{"tags":["Block types","Block types","Block documents"],"summary":"Read Block Document By Name For Block Type","description":"\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_document_by_name_for_block_type_api_accounts__account_id__workspaces__workspace_id__block_types_slug__slug__block_documents_name__block_document_name__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"slug","in":"path","required":true,"schema":{"type":"string","description":"The block type name","title":"Slug"},"description":"The block type name"},{"name":"block_document_name","in":"path","required":true,"schema":{"type":"string","description":"The block type name","title":"Block Document Name"},"description":"The block type name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"include_secrets","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include sensitive values in the block document.","default":false,"title":"Include Secrets"},"description":"Whether to include sensitive values in the block document."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/install_system_block_types":{"post":{"tags":["Block types"],"summary":"Install System Block Types","description":"\n\nRequired workspace scopes: `manage_blocks`","operationId":"install_system_block_types_api_accounts__account_id__workspaces__workspace_id__block_types_install_system_block_types_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/":{"post":{"tags":["Block documents"],"summary":"Create Block Document","description":"Create a new block document.\n\nRequired workspace scopes: `manage_blocks`","operationId":"create_block_document_api_accounts__account_id__workspaces__workspace_id__block_documents__post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocumentCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Block documents"],"summary":"Create Or Update Block Document","description":"\n\nRequired workspace scopes: `manage_blocks`","operationId":"create_or_update_block_document_api_accounts__account_id__workspaces__workspace_id__block_documents__put","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocumentCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/filter":{"post":{"tags":["Block documents"],"summary":"Read Block Documents","description":"Query for block documents.\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockDocument"},"title":"Response Read Block Documents Api Accounts  Account Id  Workspaces  Workspace Id  Block Documents Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/count":{"post":{"tags":["Block documents"],"summary":"Count Block Documents","description":"Count block documents.\n\nRequired workspace scopes: `see_blocks`","operationId":"count_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Block Documents Api Accounts  Account Id  Workspaces  Workspace Id  Block Documents Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/{id}":{"get":{"tags":["Block documents"],"summary":"Read Block Document By Id","description":"\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_document_by_id_api_accounts__account_id__workspaces__workspace_id__block_documents__id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block document id","title":"Id"},"description":"The block document id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"include_secrets","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include sensitive values in the block document.","default":false,"title":"Include Secrets"},"description":"Whether to include sensitive values in the block document."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Block documents"],"summary":"Delete Block Document","description":"\n\nRequired workspace scopes: `manage_blocks`","operationId":"delete_block_document_api_accounts__account_id__workspaces__workspace_id__block_documents__id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block document id","title":"Id"},"description":"The block document id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Block documents"],"summary":"Update Block Document Data","description":"\n\nRequired workspace scopes: `manage_blocks`","operationId":"update_block_document_data_api_accounts__account_id__workspaces__workspace_id__block_documents__id__patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block document id","title":"Id"},"description":"The block document id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocumentUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/{id}/access":{"get":{"tags":["Block documents"],"summary":"Read Block Document Access","description":"Read access controls for a block_document.\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block_document id","title":"Id"},"description":"The block_document id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockDocumentAccessControl"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Block documents"],"summary":"Set Block Document Access","description":"Set access controls for a block document.\nThe given access controls will replace any existing access controls.\n\nRequired workspace scopes: `manage_blocks`","operationId":"set_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_put","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block_document id","title":"Id"},"description":"The block_document id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_set_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_put"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/my-access":{"post":{"tags":["Block documents"],"summary":"Read Actors Block Document Access","description":"Read access controls for a set of block documents and return the resolved\naccess levels for the current actor.\n\nRequired workspace scopes: `see_blocks`","operationId":"read_actors_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents_my_access_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_actors_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents_my_access_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Response Read Actors Block Document Access Api Accounts  Account Id  Workspaces  Workspace Id  Block Documents My Access Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/variables/":{"post":{"tags":["Variables"],"summary":"Create Variable","description":"\n\nRequired workspace scopes: `write_variables`","operationId":"create_variable_api_accounts__account_id__workspaces__workspace_id__variables__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/variables/{id}":{"get":{"tags":["Variables"],"summary":"Read Variable","description":"\n\nRequired workspace scopes: `see_variables`","operationId":"read_variable_api_accounts__account_id__workspaces__workspace_id__variables__id__get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Variables"],"summary":"Update Variable","description":"\n\nRequired workspace scopes: `write_variables`","operationId":"update_variable_api_accounts__account_id__workspaces__workspace_id__variables__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Variables"],"summary":"Delete Variable","description":"\n\nRequired workspace scopes: `manage_variables`","operationId":"delete_variable_api_accounts__account_id__workspaces__workspace_id__variables__id__delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/variables/name/{name}":{"get":{"tags":["Variables"],"summary":"Read Variable By Name","description":"\n\nRequired workspace scopes: `see_variables`","operationId":"read_variable_by_name_api_accounts__account_id__workspaces__workspace_id__variables_name__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Variables"],"summary":"Update Variable By Name","description":"\n\nRequired workspace scopes: `write_variables`","operationId":"update_variable_by_name_api_accounts__account_id__workspaces__workspace_id__variables_name__name__patch","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Variables"],"summary":"Delete Variable By Name","description":"\n\nRequired workspace scopes: `manage_variables`","operationId":"delete_variable_by_name_api_accounts__account_id__workspaces__workspace_id__variables_name__name__delete","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/variables/filter":{"post":{"tags":["Variables"],"summary":"Read Variables","description":"\n\nRequired workspace scopes: `see_variables`","operationId":"read_variables_api_accounts__account_id__workspaces__workspace_id__variables_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_variables_api_accounts__account_id__workspaces__workspace_id__variables_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Variable"},"title":"Response Read Variables Api Accounts  Account Id  Workspaces  Workspace Id  Variables Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/variables/count":{"post":{"tags":["Variables"],"summary":"Count Variables","description":"\n\nRequired workspace scopes: `see_variables`","operationId":"count_variables_api_accounts__account_id__workspaces__workspace_id__variables_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_variables_api_accounts__account_id__workspaces__workspace_id__variables_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Variables Api Accounts  Account Id  Workspaces  Workspace Id  Variables Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/configuration/preview":{"post":{"tags":["Work Pools","Work Pools"],"summary":"Preview Work Pool Configuration","operationId":"preview_work_pool_configuration_api_accounts__account_id__workspaces__workspace_id__work_pools_configuration_preview_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_preview_work_pool_configuration_api_accounts__account_id__workspaces__workspace_id__work_pools_configuration_preview_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/":{"post":{"tags":["Work Pools"],"summary":"Create Work Pool","description":"Creates a new work pool. If a work pool with the same\nname already exists, an error will be raised.\n\nRequired workspace scopes: `write_work_pools`","operationId":"create_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPoolCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPoolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}":{"get":{"tags":["Work Pools"],"summary":"Read Work Pool","description":"Read a work pool by name\n\nRequired workspace scopes: `see_work_pools`","operationId":"read_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPoolResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Work Pools"],"summary":"Update Work Pool","description":"Update a work pool\n\nRequired workspace scopes: `write_work_pools`","operationId":"update_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__name__patch","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Name"},"description":"The work pool name"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPoolUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Work Pools"],"summary":"Delete Work Pool","description":"Delete a work pool\n\nRequired workspace scopes: `manage_work_pools`","operationId":"delete_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__name__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Name"},"description":"The work pool name"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/filter":{"post":{"tags":["Work Pools"],"summary":"Read Work Pools","description":"Read multiple work pools\n\nRequired workspace scopes: `see_work_pools`","operationId":"read_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_filter_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkPoolResponse"},"title":"Response Read Work Pools Api Accounts  Account Id  Workspaces  Workspace Id  Work Pools Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/paginate":{"post":{"tags":["Work Pools"],"summary":"Paginate Work Pools","description":"Paginated query for work pools.\n\nRequired workspace scopes: `see_work_pools`","operationId":"paginate_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_paginate_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPoolPaginationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/count":{"post":{"tags":["Work Pools"],"summary":"Count Work Pools","description":"Count work pools\n\nRequired workspace scopes: `see_work_pools`","operationId":"count_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Count Work Pools Api Accounts  Account Id  Workspaces  Workspace Id  Work Pools Count Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}/get_scheduled_flow_runs":{"post":{"tags":["Work Pools"],"summary":"Get Scheduled Flow Runs","description":"Load scheduled runs for a worker\n\nRequired workspace scopes: `see_work_queues`","operationId":"get_scheduled_flow_runs_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get_scheduled_flow_runs_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Name"},"description":"The work pool name"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_get_scheduled_flow_runs_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get_scheduled_flow_runs_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkerFlowRunResponse"},"title":"Response Get Scheduled Flow Runs Api Accounts  Account Id  Workspaces  Workspace Id  Work Pools  Name  Get Scheduled Flow Runs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}/access":{"get":{"tags":["Work Pools"],"summary":"Read Work Pool Access","description":"Read access controls for a work_pool.\n\nRequired workspace scopes: `see_work_pools`","operationId":"read_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPoolAccessControl"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Work Pools"],"summary":"Set Work Pool Access","description":"Set access controls for a work_pool.\nThe given access controls will replace any existing access controls.\n\nRequired workspace scopes: `manage_work_pools`","operationId":"set_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_put","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Name"},"description":"The work pool name"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_set_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_put"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/my-access":{"post":{"tags":["Work Pools"],"summary":"Read Actors Work Pool Access","description":"Read access controls for a set of work pools and return the resolved\naccess levels for the current actor.\n\nRequired workspace scopes: `see_work_pools`","operationId":"read_actors_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools_my_access_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_actors_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools_my_access_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Response Read Actors Work Pool Access Api Accounts  Account Id  Workspaces  Workspace Id  Work Pools My Access Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues":{"post":{"tags":["Work Pools"],"summary":"Create Work Queue","description":"Creates a new work pool queue. If a work pool queue with the same\nname already exists, an error will be raised.\n\nRequired workspace scopes: `write_work_queues`","operationId":"create_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/{name}":{"get":{"tags":["Work Pools"],"summary":"Read Work Queue","description":"Read a work pool queue\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues__name__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool queue name","title":"Name"},"description":"The work pool queue name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Work Pools"],"summary":"Update Work Queue","description":"Update a work pool queue\n\nRequired workspace scopes: `write_work_queues`","operationId":"update_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues__name__patch","parameters":[{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool queue name","title":"Name"},"description":"The work pool queue name"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Work Pools"],"summary":"Delete Work Queue","description":"Delete a work pool queue\n\nRequired workspace scopes: `manage_work_queues`","operationId":"delete_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues__name__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool queue name","title":"Name"},"description":"The work pool queue name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/filter":{"post":{"tags":["Work Pools"],"summary":"Read Work Queues","description":"Read all work pool queues\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkQueueResponse"},"title":"Response Read Work Queues Api Accounts  Account Id  Workspaces  Workspace Id  Work Pools  Work Pool Name  Queues Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/paginate":{"post":{"tags":["Work Pools"],"summary":"Paginate Work Queues","description":"Pagination query for work pool queues\n\nRequired workspace scopes: `see_work_queues`","operationId":"paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_paginate_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueuePaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/heartbeat":{"post":{"tags":["Work Pools"],"summary":"Worker Heartbeat","description":"\n\nRequired workspace scopes: `write_workers`","operationId":"worker_heartbeat_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_heartbeat_post","parameters":[{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_worker_heartbeat_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_heartbeat_post"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/filter":{"post":{"tags":["Work Pools"],"summary":"Read Workers","description":"Read all worker processes\n\nRequired workspace scopes: `see_workers`","operationId":"read_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Worker"},"title":"Response Read Workers Api Accounts  Account Id  Workspaces  Workspace Id  Work Pools  Work Pool Name  Workers Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/paginate":{"post":{"tags":["Work Pools"],"summary":"Paginate Workers","description":"Read all worker processes\n\nRequired workspace scopes: `see_workers`","operationId":"paginate_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_paginate_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkerPaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/{worker_id}":{"get":{"tags":["Work Pools"],"summary":"Read Worker","description":"Read a single worker process\n\nRequired workspace scopes: `see_workers`","operationId":"read_worker_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers__worker_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"worker_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The worker process id","title":"Worker Id"},"description":"The worker process id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worker"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/{name}":{"delete":{"tags":["Work Pools"],"summary":"Delete Worker","description":"Delete a work pool's worker\n\nRequired workspace scopes: `manage_workers`","operationId":"delete_worker_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers__name__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"work_pool_name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Work Pool Name"},"description":"The work pool name"},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool's worker name","title":"Name"},"description":"The work pool's worker name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}/concurrency_status":{"post":{"tags":["Work Pools"],"summary":"Read Work Pool Concurrency Status","description":"Get the concurrency status of a work pool, including per-queue breakdown\nand flow run details for each slot holder.\n\nRequired workspace scopes: `see_work_pools`,`see_work_queues`","operationId":"read_work_pool_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_pools__name__concurrency_status_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work pool name","title":"Name"},"description":"The work pool name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_work_pool_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_pools__name__concurrency_status_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkPoolConcurrencyStatusPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/":{"post":{"tags":["Work Queues"],"summary":"Create Work Queue","description":"Creates a new work queue for the default agent work pool.\n\nIf a work queue with the same name already exists, an error\nwill be raised.\n\nRequired workspace scopes: `write_work_queues`","operationId":"create_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}":{"patch":{"tags":["Work Queues"],"summary":"Update Work Queue","description":"Updates an existing work queue.\n\nRequired workspace scopes: `write_work_queues`","operationId":"update_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__id__patch","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The work queue id","title":"Id"},"description":"The work queue id"},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Work Queues"],"summary":"Read Work Queue","description":"Get a work queue by id.\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The work queue id","title":"Id"},"description":"The work queue id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Work Queues"],"summary":"Delete Work Queue","description":"Delete a work queue by id.\n\nRequired workspace scopes: `manage_work_queues`","operationId":"delete_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__id__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The work queue id","title":"Id"},"description":"The work queue id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/name/{name}":{"get":{"tags":["Work Queues"],"summary":"Read Work Queue By Name","description":"Get a work queue by id.\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queue_by_name_api_accounts__account_id__workspaces__workspace_id__work_queues_name__name__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"The work queue name","title":"Name"},"description":"The work queue name"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}/get_runs":{"post":{"tags":["Work Queues"],"summary":"Read Work Queue Runs","description":"Get flow runs from the work queue.\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queue_runs_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get_runs_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The work queue id","title":"Id"},"description":"The work queue id"},{"name":"x-prefect-ui","in":"header","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"A header to indicate this request came from the Prefect UI.","default":false,"title":"X-Prefect-Ui"},"description":"A header to indicate this request came from the Prefect UI."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_work_queue_runs_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get_runs_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FlowRunResponse"},"title":"Response Read Work Queue Runs Api Accounts  Account Id  Workspaces  Workspace Id  Work Queues  Id  Get Runs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/filter":{"post":{"tags":["Work Queues"],"summary":"Read Work Queues","description":"Query for work queues.\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkQueueResponse"},"title":"Response Read Work Queues Api Accounts  Account Id  Workspaces  Workspace Id  Work Queues Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/paginate":{"post":{"tags":["Work Queues"],"summary":"Paginate Work Queues","description":"Pagination query for work queues.\n\nRequired workspace scopes: `see_work_queues`","operationId":"paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_paginate_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_paginate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueuePaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}/status":{"get":{"tags":["Work Queues"],"summary":"Read Work Queue Status","description":"Get the status of a work queue.\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queue_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__status_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The work queue id","title":"Id"},"description":"The work queue id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueStatusDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}/concurrency_status":{"post":{"tags":["Work Queues"],"summary":"Read Work Queue Concurrency Status","description":"Get the concurrency status of a work queue, including flow run details\nfor each slot holder.\n\nRequired workspace scopes: `see_work_queues`","operationId":"read_work_queue_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__concurrency_status_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The work queue id","title":"Id"},"description":"The work queue id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_work_queue_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__concurrency_status_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkQueueConcurrencyStatusPage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/":{"post":{"tags":["Block schemas"],"summary":"Create Block Schema","description":"\n\nRequired workspace scopes: `manage_blocks`","operationId":"create_block_schema_api_accounts__account_id__workspaces__workspace_id__block_schemas__post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockSchemaCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/{id}":{"delete":{"tags":["Block schemas"],"summary":"Delete Block Schema","description":"Delete a block schema by id.\n\nRequired workspace scopes: `manage_blocks`","operationId":"delete_block_schema_api_accounts__account_id__workspaces__workspace_id__block_schemas__id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block schema id","title":"Id"},"description":"The block schema id"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Block schemas"],"summary":"Read Block Schema By Id","description":"Get a block schema by id.\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_schema_by_id_api_accounts__account_id__workspaces__workspace_id__block_schemas__id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The block schema id","title":"Id"},"description":"The block schema id"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/filter":{"post":{"tags":["Block schemas"],"summary":"Read Block Schemas","description":"Read all block schemas, optionally filtered by type\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_schemas_api_accounts__account_id__workspaces__workspace_id__block_schemas_filter_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_block_schemas_api_accounts__account_id__workspaces__workspace_id__block_schemas_filter_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockSchema"},"title":"Response Read Block Schemas Api Accounts  Account Id  Workspaces  Workspace Id  Block Schemas Filter Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/checksum/{checksum}":{"get":{"tags":["Block schemas"],"summary":"Read Block Schema By Checksum","description":"\n\nRequired workspace scopes: `see_blocks`","operationId":"read_block_schema_by_checksum_api_accounts__account_id__workspaces__workspace_id__block_schemas_checksum__checksum__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"checksum","in":"path","required":true,"schema":{"type":"string","description":"The block schema checksum","title":"Checksum"},"description":"The block schema checksum"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"version","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned.","title":"Version"},"description":"Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/block_capabilities/":{"get":{"tags":["Block capabilities"],"summary":"Read Available Block Capabilities","description":"\n\nRequired workspace scopes: `see_blocks`","operationId":"read_available_block_capabilities_api_accounts__account_id__workspaces__workspace_id__block_capabilities__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Read Available Block Capabilities Api Accounts  Account Id  Workspaces  Workspace Id  Block Capabilities  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/metrics/flow-runs/{flow_run_id}":{"get":{"tags":["Metrics"],"summary":"Read Flow Run Resource Metrics","description":"Get resource metrics (CPU, memory, etc.) for a specific flow run.\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_resource_metrics_api_accounts__account_id__workspaces__workspace_id__metrics_flow_runs__flow_run_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"flow_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run ID","title":"Flow Run Id"},"description":"The flow run ID"},{"name":"metric_names","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter to specific metric names","title":"Metric Names"},"description":"Filter to specific metric names"},{"name":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Start of time range filter","title":"Start Time"},"description":"Start of time range filter"},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"End of time range filter","title":"End Time"},"description":"End of time range filter"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Read Flow Run Resource Metrics Api Accounts  Account Id  Workspaces  Workspace Id  Metrics Flow Runs  Flow Run Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/metrics/deployments/{deployment_id}/resource-peaks":{"get":{"tags":["Metrics"],"summary":"Read Deployment Resource Peaks Endpoint","description":"Get peak resource metrics across all flow runs for a deployment.\n\nRequired workspace scopes: `see_deployments`","operationId":"read_deployment_resource_peaks_endpoint_api_accounts__account_id__workspaces__workspace_id__metrics_deployments__deployment_id__resource_peaks_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"deployment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The deployment ID","title":"Deployment Id"},"description":"The deployment ID"},{"name":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Start of time range filter","title":"Start Time"},"description":"Start of time range filter"},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"End of time range filter","title":"End Time"},"description":"End of time range filter"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResourcePeaksResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/metrics/flow-runs/{flow_run_id}/names":{"get":{"tags":["Metrics"],"summary":"List Available Flow Run Metrics","description":"List the distinct metric names available for a flow run.\n\nRequired workspace scopes: `see_flows`","operationId":"list_available_flow_run_metrics_api_accounts__account_id__workspaces__workspace_id__metrics_flow_runs__flow_run_id__names_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"flow_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The flow run ID","title":"Flow Run Id"},"description":"The flow run ID"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Available Flow Run Metrics Api Accounts  Account Id  Workspaces  Workspace Id  Metrics Flow Runs  Flow Run Id  Names Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/traces/{trace_id}":{"get":{"tags":["Spans"],"summary":"Read Spans","description":"Get spans with cursor-based pagination for efficient browsing.\n\nUse cases:\n- Initial page load (depth=0 for root spans)\n- Expand a node (parent_span_id=X for children)\n- Browse all spans at specific depth\n- Filter by state types/names\n- Paginate through large result sets (both directions)\n\nRequired workspace scopes: `see_flows`","operationId":"read_spans_api_accounts__account_id__workspaces__workspace_id__traces__trace_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The trace ID to query spans for","title":"Trace Id"},"description":"The trace ID to query spans for"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"parent_span_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by parent span ID (None = all spans)","title":"Parent Span Id"},"description":"Filter by parent span ID (None = all spans)"},{"name":"depth","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Filter by depth level (None = all depths)","title":"Depth"},"description":"Filter by depth level (None = all depths)"},{"name":"entities","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by entity types (e.g., 'flow-run', 'task-run', 'artifact')","title":"Entities"},"description":"Filter by entity types (e.g., 'flow-run', 'task-run', 'artifact')"},{"name":"state_types","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by state types (e.g., 'COMPLETED', 'RUNNING', 'FAILED')","title":"State Types"},"description":"Filter by state types (e.g., 'COMPLETED', 'RUNNING', 'FAILED')"},{"name":"state_names","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by state names (e.g., 'Completed', 'Running', 'Failed')","title":"State Names"},"description":"Filter by state names (e.g., 'Completed', 'Running', 'Failed')"},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by tags (OR logic - span matches if it has ANY of the specified tags)","title":"Tags"},"description":"Filter by tags (OR logic - span matches if it has ANY of the specified tags)"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Text search query across span content (space=OR, -/!=NOT, quotes=phrases)","title":"Query"},"description":"Text search query across span content (space=OR, -/!=NOT, quotes=phrases)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Number of results to return","default":100,"title":"Limit"},"description":"Number of results to return"},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pagination cursor from previous response","title":"Cursor"},"description":"Pagination cursor from previous response"},{"name":"direction","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","description":"Pagination direction","default":"asc","title":"Direction"},"description":"Pagination direction"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpansResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/traces/{trace_id}/context/{span_id}":{"get":{"tags":["Spans"],"summary":"Read Span Context","description":"Get full context window for detailed span view.\n\nReturns:\n- spans: All ancestors + siblings in context window\n- target_span_id: The requested span ID\n- has_more_before/after: Pagination indicators\n\nUse case: When user clicks on a span or loads a deep link URL\n\nThe frontend receives a flat list of spans and can:\n- Build the tree structure from parent relationships\n- Highlight the target span\n- Show pagination controls based on has_more flags\n\nRequired workspace scopes: `see_flows`","operationId":"read_span_context_api_accounts__account_id__workspaces__workspace_id__traces__trace_id__context__span_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The trace containing the span","title":"Trace Id"},"description":"The trace containing the span"},{"name":"span_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The target span to get context for","title":"Span Id"},"description":"The target span to get context for"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"context_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of siblings before/after to include","default":10,"title":"Context Size"},"description":"Number of siblings before/after to include"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpansResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/traces/{trace_id}/observed-states":{"get":{"tags":["Spans"],"summary":"Read Trace Observed States","description":"Get observed state type/name combinations used in a specific trace.\n\nReturns distinct state combinations used in the trace.\nUseful for showing what states were actually used in a flow run and\nproviding autocomplete/filtering options.\n\nArgs:\n    workspace_id: The workspace ID\n    trace_id: The trace (flow run) ID to analyze\n    query: Optional prefix search on state_type or state_name\n    order_by: Order by name (alphabetically) or recency (most recent first)\n    limit: Maximum number of results\n\nReturns:\n    List of ObservedState objects\n\nRequired workspace scopes: `see_flows`","operationId":"read_trace_observed_states_api_accounts__account_id__workspaces__workspace_id__traces__trace_id__observed_states_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The trace ID to query observed states for","title":"Trace Id"},"description":"The trace ID to query observed states for"},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Prefix search query for state type or name","title":"Query"},"description":"Prefix search query for state type or name"},{"name":"order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ObservedStateSort","description":"Order results by name (alphabetically) or recency (most recently seen first)","default":"LAST_SEEN_DESC"},"description":"Order results by name (alphabetically) or recency (most recently seen first)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObservedState"},"title":"Response Read Trace Observed States Api Accounts  Account Id  Workspaces  Workspace Id  Traces  Trace Id  Observed States Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/traces/{trace_id}/observed-tags":{"get":{"tags":["Spans"],"summary":"Read Trace Observed Tags","description":"Get all observed tags and their counts for a specific trace.\n\nReturns all tags used in spans within the trace with their occurrence counts.\nUseful for showing what tags were used in a flow run and their frequency.\n\nArgs:\n    workspace_id: The workspace ID\n    trace_id: The trace (flow run) ID to analyze\n\nReturns:\n    List of ObservedTag objects with tag names and counts\n\nRequired workspace scopes: `see_flows`","operationId":"read_trace_observed_tags_api_accounts__account_id__workspaces__workspace_id__traces__trace_id__observed_tags_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The trace ID to query observed tags for","title":"Trace Id"},"description":"The trace ID to query observed tags for"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Prefix search query for tag names","title":"Query"},"description":"Prefix search query for tag names"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObservedTag"},"title":"Response Read Trace Observed Tags Api Accounts  Account Id  Workspaces  Workspace Id  Traces  Trace Id  Observed Tags Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/traces/{trace_id}/spans/{span_id}":{"get":{"tags":["Spans"],"summary":"Read Single Span","description":"Get a single span by ID within a specific trace.\n\nArgs:\n    workspace_id: The workspace ID\n    trace_id: The trace (flow run) ID containing the span\n    span_id: The span ID to retrieve\n\nReturns:\n    SpanResponse with has_children and child_count computed\n\nRaises:\n    HTTPException: 404 if span not found or doesn't belong to trace\n\nRequired workspace scopes: `see_flows`","operationId":"read_single_span_api_accounts__account_id__workspaces__workspace_id__traces__trace_id__spans__span_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The trace containing the span","title":"Trace Id"},"description":"The trace containing the span"},{"name":"span_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The span ID to retrieve","title":"Span Id"},"description":"The span ID to retrieve"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpanResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/traces/{trace_id}/spans":{"get":{"tags":["Spans"],"summary":"Read Spans By Ids","description":"Get multiple spans by IDs within a specific trace.\n\nReturns only spans that exist and belong to the specified trace.\nEmpty IDs list or no matches returns empty list.\n\nArgs:\n    workspace_id: The workspace ID\n    trace_id: The trace (flow run) ID containing the spans\n    ids: List of span IDs to retrieve\n\nReturns:\n    List of SpanResponse objects with has_children and child_count computed\n\nRaises:\n    HTTPException: 404 if trace doesn't exist\n\nRequired workspace scopes: `see_flows`","operationId":"read_spans_by_ids_api_accounts__account_id__workspaces__workspace_id__traces__trace_id__spans_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"trace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The trace containing the spans","title":"Trace Id"},"description":"The trace containing the spans"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of span IDs to retrieve. Only returns spans that exist and belong to the specified trace.","default":[],"title":"Ids"},"description":"List of span IDs to retrieve. Only returns spans that exist and belong to the specified trace."},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SpanResponse"},"title":"Response Read Spans By Ids Api Accounts  Account Id  Workspaces  Workspace Id  Traces  Trace Id  Spans Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/spans/lookup/{run_id}":{"get":{"tags":["Spans"],"summary":"Lookup Span By Run Id","description":"Look up trace and span information for a given run ID.\n\nTreats the run_id as a span_id and returns the trace_id and span_id\nof the found span. This is useful for navigating from a child run ID\nto its trace view.\n\nArgs:\n    workspace_id: The workspace ID\n    run_id: The run ID to look up (treated as span_id)\n\nReturns:\n    SpanIdentifierResponse containing trace_id and span_id\n\nRaises:\n    HTTPException: 404 if span not found\n\nRequired workspace scopes: `see_flows`","operationId":"lookup_span_by_run_id_api_accounts__account_id__workspaces__workspace_id__spans_lookup__run_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The run ID to lookup span information for","title":"Run Id"},"description":"The run ID to lookup span information for"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpanIdentifierResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/spans/{span_id}/observed-tags":{"get":{"tags":["Spans"],"summary":"Read Span Observed Tags","description":"Get all observed tags and their counts for a specific span and all its descendants.\n\nUses a recursive query to find all descendant spans, then aggregates tags\nfrom the target span and all its children recursively.\n\nArgs:\n    workspace_id: The workspace ID\n    span_id: The span ID to analyze (includes this span + all descendants)\n\nReturns:\n    List of ObservedTag objects with tag names and occurrence counts\n\nRequired workspace scopes: `see_flows`","operationId":"read_span_observed_tags_api_accounts__account_id__workspaces__workspace_id__spans__span_id__observed_tags_get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"span_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"The span ID to query observed tags for","title":"Span Id"},"description":"The span ID to query observed tags for"},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Prefix search query for tag names","title":"Query"},"description":"Prefix search query for tag names"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObservedTag"},"title":"Response Read Span Observed Tags Api Accounts  Account Id  Workspaces  Workspace Id  Spans  Span Id  Observed Tags Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/observed-states":{"get":{"tags":["Spans"],"summary":"Read Workspace Observed States","description":"Get observed state type/name combinations for a workspace.\n\nReturns distinct state combinations across all traces in the workspace.\nResults are filtered by workspace retention policy.\nUseful for providing autocomplete/filtering options in the UI.\n\nArgs:\n    account_id: The account ID\n    workspace_id: The workspace ID\n    query: Optional prefix search on state_type or state_name\n    order_by: Order by name (alphabetically) or recency (most recent first)\n    limit: Maximum number of results\n\nReturns:\n    List of ObservedState objects\n\nRequired workspace scopes: `see_flows`","operationId":"read_workspace_observed_states_api_accounts__account_id__workspaces__workspace_id__observed_states_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Prefix search query for state type or name","title":"Query"},"description":"Prefix search query for state type or name"},{"name":"order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ObservedStateSort","description":"Order results by name (alphabetically) or recency (most recently seen first)","default":"LAST_SEEN_DESC"},"description":"Order results by name (alphabetically) or recency (most recently seen first)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Maximum number of results to return","default":200,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ObservedState"},"title":"Response Read Workspace Observed States Api Accounts  Account Id  Workspaces  Workspace Id  Observed States Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/count-deployments":{"post":{"tags":["Flows","UI"],"summary":"Count Deployments By Flow","description":"Get deployment counts by flow id.\n\nRequired workspace scopes: `see_flows`","operationId":"count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer"},"propertyNames":{"format":"uuid"},"title":"Response Count Deployments By Flow Api Accounts  Account Id  Workspaces  Workspace Id  Ui Flows Count Deployments Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/next-runs":{"post":{"tags":["Flows","UI"],"summary":"Next Runs By Flow","description":"Get the next flow run by flow id.\n\nRequired workspace scopes: `see_flows`","operationId":"next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/SimpleNextFlowRun"},{"type":"null"}]},"propertyNames":{"format":"uuid"},"title":"Response Next Runs By Flow Api Accounts  Account Id  Workspaces  Workspace Id  Ui Flows Next Runs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history":{"post":{"tags":["Flow Runs","UI"],"summary":"Read Flow Run History","description":"\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SimpleFlowRun"},"title":"Response Read Flow Run History Api Accounts  Account Id  Workspaces  Workspace Id  Ui Flow Runs History Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history-v2":{"post":{"tags":["Flow Runs","UI"],"summary":"Read Flow Run History V2","description":"\n\nRequired workspace scopes: `see_flows`","operationId":"read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowRunHistoryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/count-task-runs":{"post":{"tags":["Flow Runs","UI"],"summary":"Count Task Runs By Flow Run","description":"Get task run counts by flow run id.\n\nRequired workspace scopes: `see_flows`","operationId":"count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer"},"propertyNames":{"format":"uuid"},"title":"Response Count Task Runs By Flow Run Api Accounts  Account Id  Workspaces  Workspace Id  Ui Flow Runs Count Task Runs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/dashboard/counts":{"post":{"tags":["Task Runs","UI"],"summary":"Read Dashboard Task Run Counts","description":"\n\nRequired workspace scopes: `see_flows`","operationId":"read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DashboardTaskRunCount"},"title":"Response Read Dashboard Task Run Counts Api Accounts  Account Id  Workspaces  Workspace Id  Ui Task Runs Dashboard Counts Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/count":{"post":{"tags":["Task Runs","UI"],"summary":"Read Task Run Counts By State","description":"\n\nRequired workspace scopes: `see_flows`","operationId":"read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountByState"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/schemas/validate":{"post":{"tags":["UI","Schemas"],"summary":"Validate Obj","operationId":"validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/schemas/validate_schema":{"post":{"tags":["UI","Schemas"],"summary":"Validate Schema","operationId":"validate_schema_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_schema_post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Schema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/ui/work_pools/count-flow-runs":{"post":{"tags":["Work Pools","UI"],"summary":"Count Flow Runs By Work Pool","description":"Get flow run counts grouped by work pool id.\n\nReturns a mapping of work_pool_id to the number of flow runs matching the\noptional filter. Work pools with no matching runs are included with a count\nof zero.\n\nRequired workspace scopes: `see_flows`","operationId":"count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer"},"propertyNames":{"format":"uuid"},"title":"Response Count Flow Runs By Work Pool Api Accounts  Account Id  Workspaces  Workspace Id  Ui Work Pools Count Flow Runs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/hello":{"get":{"tags":["Root"],"summary":"Hello","description":"Say hello!","operationId":"hello_api_accounts__account_id__workspaces__workspace_id__hello_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Account Id"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"x-prefect-api-version","in":"header","required":false,"schema":{"type":"string","title":"X-Prefect-Api-Version"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/accounts/{account_id}/workspaces/{workspace_id}/health":{"get":{"summary":"Health Check","operationId":"health_check_api_accounts__account_id__workspaces__workspace_id__health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"APIKey":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"actor_id":{"type":"string","format":"uuid","title":"Actor Id"},"name":{"type":"string","title":"Name","description":"The name of the api key."},"expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiration","description":"The time at which the api key expires. If `None`, the api key will not expire."},"hash":{"type":"string","title":"Hash"},"masked_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Masked Key","description":"Masked API key showing prefix and last 4 characters (e.g., pnu_...a1b2)."}},"type":"object","required":["actor_id","name","hash"],"title":"APIKey","description":"An ORM representation of an APIKey"},"APIKeyCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the api key."},"expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiration","description":"The time at which the api key expires. If `None`, the api key will not expire."}},"additionalProperties":false,"type":"object","required":["name"],"title":"APIKeyCreate","description":"Data used by the api to create a new api_key"},"APIKeyCreateResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"name":{"type":"string","title":"Name","description":"The name of the api key."},"expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiration","description":"The time at which the api key expires. If `None`, the api key will not expire."},"key":{"type":"string","title":"Key","description":"The Prefect API Key."}},"additionalProperties":false,"type":"object","required":["name","key"],"title":"APIKeyCreateResponse","description":"Data returned by the api after creating a new api_key. This includes an un-hashed api key."},"APIKeyFilter":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/APIKeyNameFilter"},{"type":"null"}],"description":"Filter criteria for APIKey.name"}},"additionalProperties":false,"type":"object","title":"APIKeyFilter"},"APIKeyNameFilter":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include api keys matching these names"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin-ops', 'ceo-marvin', and 'marvin-engineering'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"APIKeyNameFilter"},"APIKeyReadResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"name":{"type":"string","title":"Name","description":"The name of the api key."},"expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expiration","description":"The time at which the api key expires. If `None`, the api key will not expire."},"masked_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Masked Key","description":"Masked API key showing prefix and last 4 characters (e.g., pnu_...a1b2)."}},"additionalProperties":false,"type":"object","required":["name"],"title":"APIKeyReadResponse","description":"Data returned by the api when reading api_keys"},"AccountDefaultResultStorage-Input":{"properties":{"block_type":{"$ref":"#/components/schemas/AccountDefaultResultStorageBlockType","description":"The block type to materialize into inheriting workspaces."},"block_schema":{"$ref":"#/components/schemas/AccountDefaultResultStorageBlockSchema","description":"The block schema to materialize into inheriting workspaces."},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The block data to materialize into inheriting workspaces."},"block_document_references":{"additionalProperties":{"$ref":"#/components/schemas/AccountDefaultResultStorage-Input"},"type":"object","title":"Block Document References","description":"Nested account-owned block templates keyed by the field they are referenced under."}},"type":"object","required":["block_type","block_schema"],"title":"AccountDefaultResultStorage"},"AccountDefaultResultStorage-Output":{"properties":{"block_type":{"$ref":"#/components/schemas/AccountDefaultResultStorageBlockType","description":"The block type to materialize into inheriting workspaces."},"block_schema":{"$ref":"#/components/schemas/AccountDefaultResultStorageBlockSchema","description":"The block schema to materialize into inheriting workspaces."},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The block data to materialize into inheriting workspaces."},"block_document_references":{"additionalProperties":{"$ref":"#/components/schemas/AccountDefaultResultStorage-Output"},"type":"object","title":"Block Document References","description":"Nested account-owned block templates keyed by the field they are referenced under."}},"type":"object","required":["block_type","block_schema"],"title":"AccountDefaultResultStorage"},"AccountDefaultResultStorageBlockSchema":{"properties":{"checksum":{"type":"string","title":"Checksum","description":"The block schema checksum."},"fields":{"additionalProperties":true,"type":"object","title":"Fields","description":"The block schema fields."},"capabilities":{"items":{"type":"string"},"type":"array","title":"Capabilities","description":"The block schema capabilities."},"version":{"type":"string","title":"Version","description":"The block schema version.","default":"non-versioned"}},"type":"object","required":["checksum"],"title":"AccountDefaultResultStorageBlockSchema"},"AccountDefaultResultStorageBlockType":{"properties":{"name":{"type":"string","title":"Name","description":"The block type name."},"slug":{"type":"string","title":"Slug","description":"The block type slug."},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"Web URL for the block type's logo."},"documentation_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Documentation Url","description":"Web URL for the block type's documentation."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A short description of the block type."},"code_example":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code Example","description":"A code example for the block type."}},"type":"object","required":["name","slug"],"title":"AccountDefaultResultStorageBlockType"},"AccountMemberSummaryResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The account membership id."},"created":{"type":"string","format":"date-time","title":"Created","description":"The time the membership was created."},"updated":{"type":"string","format":"date-time","title":"Updated","description":"The time the membership was last updated."},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The actor id of the member."},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The account id."},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id","description":"The id of the user. None for bots."},"handle":{"type":"string","title":"Handle","description":"The member's unique handle."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The user's first name."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The user's last name."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The user's email."},"account_role_id":{"type":"string","format":"uuid","title":"Account Role Id","description":"The id of the account role."},"account_role_name":{"type":"string","title":"Account Role Name","description":"The name of the account role."},"directory_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Directory Id","description":"The id of the WorkOS directory that created this membership."},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","description":"The user's configured timezone."},"teams":{"items":{"$ref":"#/components/schemas/TeamSummary"},"type":"array","title":"Teams","description":"The teams this member belongs to in the account."},"active":{"type":"boolean","title":"Active","description":"Whether the membership is active."}},"additionalProperties":false,"type":"object","required":["id","created","updated","actor_id","account_id","handle","account_role_id","account_role_name","active"],"title":"AccountMemberSummaryResponse","description":"Enriched account membership response for single-member lookups.\n\nWorks for both user and bot memberships. User-specific fields (user_id,\nfirst_name, last_name, email, timezone) are None for bots.\nManually constructed (not via model_validate), so extra=\"forbid\" is safe.\n\nIncludes all fields from the previous AccountMembership response\n(account_id, directory_id, created, updated) for backward compatibility."},"AccountMembershipBulkSetActive":{"properties":{"membership_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":200,"minItems":1,"title":"Membership Ids"},"active":{"type":"boolean","title":"Active"}},"additionalProperties":false,"type":"object","required":["membership_ids","active"],"title":"AccountMembershipBulkSetActive","description":"Data used by the api to bulk set account memberships' active status"},"AccountMembershipFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"account_role_id":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilterAccountRoleId"},{"type":"null"}],"description":"Filter criteria for AccountMembership.account_role_id"},"user_id":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilterUserId"},{"type":"null"}],"description":"Filter criteria for AccountMembership.actor.user_id"},"email":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilterEmail"},{"type":"null"}],"description":"Filter criteria for UserEmail.email"},"handle":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilterHandle"},{"type":"null"}],"description":"Filter criteria for User.handle"},"name":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilterName"},{"type":"null"}],"description":"Filter criteria for User.first_name or User.last_name"},"actor_id":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilterActorId"},{"type":"null"}],"description":"Filter criteria for AccountMembership.actor_id"},"last_login":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilterLastLogin"},{"type":"null"}],"description":"Filter criteria for User.last_login. Always narrows the result, regardless of `operator`, so it composes with an OR'd search."}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilter"},"AccountMembershipFilterAccountRoleId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include account memberships matching one of these account role id"}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilterAccountRoleId"},"AccountMembershipFilterActorId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of actor ids to include"}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilterActorId","description":"Filter by `AccountMembership.actor_id`."},"AccountMembershipFilterEmail":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of membership emails to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin-ops', 'ceo-marvin', and 'marvin-engineering'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilterEmail"},"AccountMembershipFilterHandle":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of user handles to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin-ops', 'ceo-marvin', and 'marvin-engineering'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilterHandle","description":"Filter by `User.handle` for account memberships."},"AccountMembershipFilterLastLogin":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include members whose last login is at or before this time. Members who never logged in are included unless `is_null_` is False."},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include members whose last login is at or after this time"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If True, only include members who never logged in. If False, only include members who logged in at least once."}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilterLastLogin","description":"Filter by `User.last_login`.\n\nA user who never logged in sorts as the minimum for `LAST_LOGIN_ASC`, and\nthis filter treats them the same way: `before_` includes them unless\n`is_null_` is False."},"AccountMembershipFilterName":{"properties":{"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match on first_name or last_name. For example, passing 'marvin' will match users with 'marvin' in their first or last name.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilterName","description":"Filter by user first_name/last_name for account memberships."},"AccountMembershipFilterUserId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of user ids to include"},"not_any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of user ids to exclude"}},"additionalProperties":false,"type":"object","title":"AccountMembershipFilterUserId"},"AccountMembershipSetActive":{"properties":{"active":{"type":"boolean","title":"Active"}},"additionalProperties":false,"type":"object","required":["active"],"title":"AccountMembershipSetActive","description":"Data used by the api to toggle an account membership's active status"},"AccountMembershipSort":{"type":"string","enum":["CREATED_ASC","CREATED_DESC","LAST_LOGIN_ASC","LAST_LOGIN_DESC","NAME_ASC","NAME_DESC","HANDLE_ASC","HANDLE_DESC","EMAIL_ASC","EMAIL_DESC","ACCOUNT_ROLE_NAME_ASC","ACCOUNT_ROLE_NAME_DESC"],"title":"AccountMembershipSort","description":"Sort options for account memberships"},"AccountMembershipUpdate":{"properties":{"account_role_id":{"type":"string","format":"uuid","title":"Account Role Id","description":"The account role id. The account role defines permissions for the actor in this account."}},"additionalProperties":false,"type":"object","required":["account_role_id"],"title":"AccountMembershipUpdate","description":"Data used by the api to update an account membership"},"AccountMembershipsResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The account membership id."},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The actor id of the member."},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id","description":"The id of the user. None for bots."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The first name of the user. None for bots."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The last name of the user. None for bots."},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle","description":"The user's unique handle. None for bots."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The user's email. None for bots."},"account_role_name":{"type":"string","title":"Account Role Name","description":"The name of the account role associated with the membership."},"account_role_id":{"type":"string","format":"uuid","title":"Account Role Id","description":"The id of the account role associated with the membership."},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login","description":"The last time the user logged in."},"active":{"type":"boolean","title":"Active","description":"Whether the membership is active."}},"additionalProperties":false,"type":"object","required":["id","actor_id","account_role_name","account_role_id","active"],"title":"AccountMembershipsResponse"},"AccountPermission":{"type":"string","enum":["read:account","update:account","delete:account","read:account_membership","update:account_membership","delete:account_membership","create:account_role","read:account_role","update:account_role","delete:account_role","add:account_member","read:sso","administrate:sso","bypass:sso","read:billing","update:billing","create:bot","read:bot","update:bot","delete:bot","create:team","read:team","update:team","delete:team","create:invitation","read:invitation","update:invitation","create:workspace_invitation","read:workspace_invitation","update:workspace_invitation","administrate:workspace","create:workspace","read:workspace","delete:workspace","create:workspace_role","read:workspace_role","update:workspace_role","delete:workspace_role","create:audit_event","read:audit_event","update:ip_allowlist","read:ip_allowlist","read:mex-storage","update:mex-storage","delete:mex-storage","read:integrations","update:integrations"],"title":"AccountPermission","description":"Enumerates possible permissions over an account"},"AccountPlanTier":{"type":"string","enum":["FREE_2025_04","PRO","ENTERPRISE","PRO_2024_04","STARTER","TEAM"],"title":"AccountPlanTier"},"AccountPlanType":{"type":"string","enum":["ORGANIZATION","PERSONAL","ENTERPRISE"],"title":"AccountPlanType"},"AccountResponse":{"properties":{"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"An optional physical location for the account, e.g. Washington, D.C."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"An optional for an external url associated with the account, e.g. https://prefect.io/."},"image_location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Location","description":"A url linking to an image for the account."},"stripe_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stripe Customer Id","description":"Stripe customer id associated with the account."},"salesforce_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Salesforce Account Id","description":"Salesforce account id associated with the account."},"auth_expiration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Auth Expiration Seconds","description":"The number of seconds a user should be considered to be authenticated against this Account."},"status_last_updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Status Last Updated","description":"Timestamp indicating the last time the account status was updated."},"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","description":"The account name."},"handle":{"type":"string","title":"Handle","description":"A unique identifier for the account containing only lowercase letters, numbers, and dashes."},"settings":{"$ref":"#/components/schemas/AccountSettings","description":"The account settings."},"status":{"$ref":"#/components/schemas/AccountStatus","description":"The account status. Indicates whether the account is in good standing, delinquent, or frozen. Frozen accounts have severely limited functionality.","default":"ACTIVE"},"workos_connection_ids":{"items":{"type":"string"},"type":"array","title":"Workos Connection Ids","description":"WorkOS connection_ids that can be used to authenticate against this account."},"workos_directory_ids":{"items":{"type":"string"},"type":"array","title":"Workos Directory Ids","description":"WorkOS directory_ids that are connected for Directory Sync / SCIM."},"workos_organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workos Organization Id","description":"The organization_id for this account in WorkOS."},"plan_type":{"$ref":"#/components/schemas/AccountPlanType","description":"The type of plan this account has.  Useful for making decisions abouthow to display this account, but not for authorization or feature enablement."},"plan_tier":{"anyOf":[{"$ref":"#/components/schemas/AccountPlanTier"},{"type":"null"}],"description":"The tier of the account plan."},"self_serve":{"type":"boolean","title":"Self Serve","description":"Whether billing is self-serve on the plan. When a plan is self serve, users manage their own billable resources and make payments through a credit card they have setup with Stripe.","default":false},"scim_state":{"$ref":"#/components/schemas/AccountSCIMState","description":"The SCIM configuration state of the account."},"sso_state":{"$ref":"#/components/schemas/AccountSSOState","description":"The SSO configuration state of the account."},"billing_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Email","description":"Billing email of the account. None if there if cccount has no stripe customer."},"features":{"items":{"type":"string"},"type":"array","uniqueItems":true,"title":"Features","description":"Set of features that the account has access to."},"max_deployments_per_workspace":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Deployments Per Workspace","description":"The maximum number of deployments that can be created in a workspace."},"work_pool_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Work Pool Limit","description":"The maximum number of work pools that can be created in a workspace."},"non_mex_work_pool_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Non Mex Work Pool Limit","description":"The maximum number of non-managed work pools that can be created in a workspace."},"mex_work_pool_limit":{"type":"integer","title":"Mex Work Pool Limit","description":"The maximum number of `prefect:managed` work pools that can be created in a workspace."},"run_retention_days":{"type":"integer","title":"Run Retention Days","description":"How many days flow run data and associated objects should be retained for."},"audit_log_retention_days":{"type":"integer","title":"Audit Log Retention Days","description":"How many days of audit log events are available to the customer."},"automations_limit":{"type":"integer","title":"Automations Limit","description":"\n        The number of automations available to (1) each workspace in the account\n        and (2) the account itself (i.e. Automations not associated with a specific workspace).\n        "}},"additionalProperties":false,"type":"object","required":["name","handle","plan_type","scim_state","sso_state","work_pool_limit","mex_work_pool_limit","run_retention_days","audit_log_retention_days","automations_limit"],"title":"AccountResponse"},"AccountRole":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Account Id","description":"The account id associated with the role. If `None`, the role is a globally available default not associated with a specific account."},"name":{"type":"string","title":"Name","description":"The name of the account role."},"permissions":{"items":{"$ref":"#/components/schemas/AccountPermission"},"type":"array","title":"Permissions","description":"The list of account permissions held by this role. Defines the actions account members assigned this role are allowed to take."},"is_system_role":{"type":"boolean","title":"Is System Role","description":"Whether the role is a system role.","default":false}},"type":"object","required":["name","permissions"],"title":"AccountRole"},"AccountRoleFilter":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/AccountRoleFilterName"},{"type":"null"}],"description":"Filter criteria for AccountRole.name"}},"additionalProperties":false,"type":"object","title":"AccountRoleFilter"},"AccountRoleFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include account roles matching these names"}},"additionalProperties":false,"type":"object","title":"AccountRoleFilterName"},"AccountRoleUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name","description":"The name of the account role."},"permissions":{"anyOf":[{"items":{"$ref":"#/components/schemas/AccountPermission"},"type":"array"},{"type":"null"}],"title":"Permissions","description":"The list of account permissions held by this role. Defines the actions account members assigned this role are allowed to take."}},"additionalProperties":false,"type":"object","title":"AccountRoleUpdate","description":"Data used by API to update an account role"},"AccountSCIMState":{"type":"string","enum":["DISABLED","NEEDS_ORGANIZATION_ID","NEEDS_CONFIGURATION","ENABLED"],"title":"AccountSCIMState"},"AccountSSOState":{"type":"string","enum":["DISABLED","NEEDS_CONFIGURATION","ENABLED"],"title":"AccountSSOState"},"AccountSettings":{"properties":{"allow_public_workspaces":{"type":"boolean","title":"Allow Public Workspaces","description":"Whether or not this account allows public workspaces.","default":false},"ai_log_summaries":{"type":"boolean","title":"Ai Log Summaries","description":"Whether to use AI to generate log summaries.","default":false},"managed_execution":{"type":"boolean","title":"Managed Execution","description":"Whether to enable the use of managed work pools","default":true},"enforce_ip_allowlist":{"type":"boolean","title":"Enforce Ip Allowlist","description":"Whether to enforce account's IP allowlist.","default":false},"enforce_webhook_authentication":{"type":"boolean","title":"Enforce Webhook Authentication","description":"Whether to enforce webhook authentication.","default":false},"enforce_vpce_binding":{"type":"boolean","title":"Enforce Vpce Binding","description":"Whether to enforce that requests over PrivateLink present a vpce-id in the account's trusted_vpce_ids.","default":false},"trusted_vpce_ids":{"items":{"type":"string"},"type":"array","title":"Trusted Vpce Ids","description":"AWS VPC endpoint IDs trusted to authenticate as this account over PrivateLink."},"self_healing_enabled":{"type":"boolean","title":"Self Healing Enabled","description":"Whether to automatically create managed automations for new workspaces.","default":true},"scim_role_sync_enabled":{"type":"boolean","title":"Scim Role Sync Enabled","description":"Whether SCIM directory sync may set and update members' account roles from the identity provider's role assignments.","default":false},"enabled_feature_flags":{"items":{"type":"string"},"type":"array","title":"Enabled Feature Flags","description":"Feature flags enabled for the account."},"default_result_storage":{"anyOf":[{"$ref":"#/components/schemas/AccountDefaultResultStorage-Output"},{"type":"null"}],"description":"The account-owned template to use when materializing the account's default result storage into inheriting workspaces."}},"type":"object","title":"AccountSettings"},"AccountSettingsUpdate":{"properties":{"allow_public_workspaces":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allow Public Workspaces","description":"Whether or not this account allows public workspaces."},"ai_log_summaries":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ai Log Summaries","description":"Whether to use AI to generate log summaries."},"managed_execution":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Managed Execution","description":"Whether to enable the use of managed work pools"},"enforce_ip_allowlist":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enforce Ip Allowlist","description":"Whether to enforce account's IP allowlist."},"enforce_webhook_authentication":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enforce Webhook Authentication","description":"Whether to enforce webhook authentication."},"enforce_vpce_binding":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enforce Vpce Binding","description":"Whether to enforce that requests over PrivateLink present a vpce-id in the account's trusted_vpce_ids."},"trusted_vpce_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","uniqueItems":true},{"type":"null"}],"title":"Trusted Vpce Ids","description":"AWS VPC endpoint IDs trusted to authenticate as this account over PrivateLink. Replaces the existing set when provided."},"self_healing_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Self Healing Enabled","description":"Whether to automatically create managed automations for new workspaces."},"scim_role_sync_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Scim Role Sync Enabled","description":"Whether SCIM directory sync may set and update members' account roles from the identity provider's role assignments."},"default_result_storage":{"anyOf":[{"$ref":"#/components/schemas/AccountDefaultResultStorage-Input"},{"type":"null"}],"description":"The account-owned template to use when materializing the account's default result storage into inheriting workspaces."}},"additionalProperties":false,"type":"object","title":"AccountSettingsUpdate","description":"Data used by API to update an account settings"},"AccountStatus":{"type":"string","enum":["ACTIVE","DELINQUENT","FROZEN"],"title":"AccountStatus"},"AccountUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name","description":"The account name."},"handle":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Handle","description":"A unique identifier for the account containing only lowercase letters, numbers, and dashes."},"location":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Location","description":"An optional physical location for the account, e.g. Washington, D.C."},"link":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Link","description":"An optional for an external url associated with the account, e.g. https://prefect.io/."},"auth_expiration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Auth Expiration Seconds","description":"The number of seconds a user should be considered to be authenticated against this Account."},"billing_email":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Billing Email","description":"Billing email to apply to the account's stripe customer."}},"additionalProperties":false,"type":"object","title":"AccountUpdate","description":"Data used by API to update an account"},"ActorReference":{"properties":{"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The ID of the Actor"},"handle":{"type":"string","maxLength":5000,"title":"Handle","description":"The handle of the Actor"},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id","description":"The user's ID, if the actor is a user"},"bot_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Bot Id","description":"The service account's ID, if the actor is a service_account"}},"type":"object","required":["actor_id","handle"],"title":"ActorReference"},"Artifact":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key","description":"An optional unique reference key for this artifact."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A markdown-enabled description of the artifact."},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{},{"type":"null"}],"title":"Data","description":"Data associated with the artifact, e.g. a result.; structure depends on the artifact type.Content must be storable as JSON."},"metadata_":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"User-defined artifact metadata. Content must be string key and value pairs."},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run associated with the artifact."},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id","description":"The task run associated with the artifact."}},"type":"object","title":"Artifact"},"ArtifactCollection":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"key":{"type":"string","title":"Key","description":"A unique reference key for this artifact."},"latest_id":{"type":"string","format":"uuid","title":"Latest Id","description":"The latest artifact ID associated with the key."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A markdown-enabled description of the artifact."},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{},{"type":"null"}],"title":"Data","description":"Data associated with the artifact, e.g. a result.; structure depends on the artifact type."},"metadata_":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"User-defined artifact metadata. Content must be string key and value pairs."},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run associated with the artifact."},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id","description":"The task run associated with the artifact."}},"type":"object","required":["key","latest_id"],"title":"ArtifactCollection"},"ArtifactCollectionFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"latest_id":{"anyOf":[{"$ref":"#/components/schemas/ArtifactCollectionFilterLatestId"},{"type":"null"}],"description":"Filter criteria for `Artifact.id`"},"key":{"anyOf":[{"$ref":"#/components/schemas/ArtifactCollectionFilterKey"},{"type":"null"}],"description":"Filter criteria for `Artifact.key`"},"flow_run_id":{"anyOf":[{"$ref":"#/components/schemas/ArtifactCollectionFilterFlowRunId"},{"type":"null"}],"description":"Filter criteria for `Artifact.flow_run_id`"},"task_run_id":{"anyOf":[{"$ref":"#/components/schemas/ArtifactCollectionFilterTaskRunId"},{"type":"null"}],"description":"Filter criteria for `Artifact.task_run_id`"},"type":{"anyOf":[{"$ref":"#/components/schemas/ArtifactCollectionFilterType"},{"type":"null"}],"description":"Filter criteria for `Artifact.type`"}},"additionalProperties":false,"type":"object","title":"ArtifactCollectionFilter","description":"Filter artifact collections. Only artifact collections matching all criteria will be returned"},"ArtifactCollectionFilterFlowRunId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run IDs to include"}},"additionalProperties":false,"type":"object","title":"ArtifactCollectionFilterFlowRunId","description":"Filter by `ArtifactCollection.flow_run_id`."},"ArtifactCollectionFilterKey":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of artifact keys to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.","examples":["my-artifact-%"]},"exists_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exists","description":"If `true`, only include artifacts with a non-null key. If `false`, only include artifacts with a null key. Should return all rows in the ArtifactCollection table if specified."}},"additionalProperties":false,"type":"object","title":"ArtifactCollectionFilterKey","description":"Filter by `ArtifactCollection.key`."},"ArtifactCollectionFilterLatestId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of artifact ids to include"}},"additionalProperties":false,"type":"object","title":"ArtifactCollectionFilterLatestId","description":"Filter by `ArtifactCollection.latest_id`."},"ArtifactCollectionFilterTaskRunId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run IDs to include"}},"additionalProperties":false,"type":"object","title":"ArtifactCollectionFilterTaskRunId","description":"Filter by `ArtifactCollection.task_run_id`."},"ArtifactCollectionFilterType":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of artifact types to include"},"not_any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of artifact types to exclude"}},"additionalProperties":false,"type":"object","title":"ArtifactCollectionFilterType","description":"Filter by `ArtifactCollection.type`."},"ArtifactCollectionSort":{"type":"string","enum":["CREATED_DESC","UPDATED_DESC","ID_DESC","KEY_DESC","KEY_ASC"],"title":"ArtifactCollectionSort","description":"Defines artifact collection sorting options."},"ArtifactCreate":{"properties":{"key":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Key","description":"An optional unique reference key for this artifact."},"type":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Type","description":"An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"A markdown-enabled description of the artifact."},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{},{"type":"null"}],"title":"Data","description":"Data associated with the artifact, e.g. a result.; structure depends on the artifact type."},"metadata_":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"User-defined artifact metadata. Content must be string key and value pairs."},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run associated with the artifact."},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id","description":"The task run associated with the artifact."}},"additionalProperties":false,"type":"object","title":"ArtifactCreate","description":"Data used by the Prefect REST API to create an artifact."},"ArtifactFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/ArtifactFilterId"},{"type":"null"}],"description":"Filter criteria for `Artifact.id`"},"key":{"anyOf":[{"$ref":"#/components/schemas/ArtifactFilterKey"},{"type":"null"}],"description":"Filter criteria for `Artifact.key`"},"flow_run_id":{"anyOf":[{"$ref":"#/components/schemas/ArtifactFilterFlowRunId"},{"type":"null"}],"description":"Filter criteria for `Artifact.flow_run_id`"},"task_run_id":{"anyOf":[{"$ref":"#/components/schemas/ArtifactFilterTaskRunId"},{"type":"null"}],"description":"Filter criteria for `Artifact.task_run_id`"},"type":{"anyOf":[{"$ref":"#/components/schemas/ArtifactFilterType"},{"type":"null"}],"description":"Filter criteria for `Artifact.type`"}},"additionalProperties":false,"type":"object","title":"ArtifactFilter","description":"Filter artifacts. Only artifacts matching all criteria will be returned"},"ArtifactFilterFlowRunId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run IDs to include"}},"additionalProperties":false,"type":"object","title":"ArtifactFilterFlowRunId","description":"Filter by `Artifact.flow_run_id`."},"ArtifactFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of artifact ids to include"}},"additionalProperties":false,"type":"object","title":"ArtifactFilterId","description":"Filter by `Artifact.id`."},"ArtifactFilterKey":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of artifact keys to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.","examples":["my-artifact-%"]},"exists_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exists","description":"If true, only include artifacts with a non-null key"}},"additionalProperties":false,"type":"object","title":"ArtifactFilterKey","description":"Filter by `Artifact.key`."},"ArtifactFilterTaskRunId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run IDs to include"}},"additionalProperties":false,"type":"object","title":"ArtifactFilterTaskRunId","description":"Filter by `Artifact.task_run_id`."},"ArtifactFilterType":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of artifact types to include"},"not_any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of artifact types to exclude"}},"additionalProperties":false,"type":"object","title":"ArtifactFilterType","description":"Filter by `Artifact.type`."},"ArtifactSort":{"type":"string","enum":["CREATED_DESC","UPDATED_DESC","ID_DESC","KEY_DESC","KEY_ASC"],"title":"ArtifactSort","description":"Defines artifact sorting options."},"ArtifactUpdate":{"properties":{"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{},{"type":"null"}],"title":"Data"},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description"},"metadata_":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"}},"additionalProperties":false,"type":"object","title":"ArtifactUpdate","description":"Data used by the Prefect REST API to update an artifact."},"AssetCatalogItem":{"properties":{"key":{"type":"string","title":"Key"},"properties":{"$ref":"#/components/schemas/AssetProperties"},"last_seen":{"type":"string","format":"date-time","title":"Last Seen"},"latest_reference":{"$ref":"#/components/schemas/LatestReference"},"latest_materialization":{"$ref":"#/components/schemas/LatestMaterialization"}},"type":"object","required":["key","last_seen"],"title":"AssetCatalogItem"},"AssetDependency":{"properties":{"upstream":{"type":"string","title":"Upstream"},"downstream":{"type":"string","title":"Downstream"},"occurred":{"type":"string","format":"date-time","title":"Occurred"},"status":{"type":"string","enum":["succeeded","failed"],"title":"Status"}},"type":"object","required":["upstream","downstream","occurred","status"],"title":"AssetDependency"},"AssetFilter":{"properties":{"key":{"anyOf":[{"$ref":"#/components/schemas/AssetKeyFilter"},{"type":"null"}],"description":"Filter criteria for asset keys"},"occurred":{"anyOf":[{"$ref":"#/components/schemas/AssetOccurredFilter"},{"type":"null"}],"description":"Filter criteria for asset activity timestamps"},"related":{"anyOf":[{"$ref":"#/components/schemas/AssetRelatedFilter"},{"type":"null"}],"description":"Filter criteria for related resources from asset events"}},"type":"object","title":"AssetFilter"},"AssetGraph":{"properties":{"assets":{"additionalProperties":{"$ref":"#/components/schemas/AssetCatalogItem"},"type":"object","title":"Assets"},"dependencies":{"items":{"$ref":"#/components/schemas/AssetGraphDependency"},"type":"array","title":"Dependencies"},"root_asset_key":{"type":"string","title":"Root Asset Key"}},"type":"object","required":["root_asset_key"],"title":"AssetGraph","description":"Graph of assets with normalized structure."},"AssetGraphDependency":{"properties":{"upstream_asset_key":{"type":"string","title":"Upstream Asset Key"},"downstream_asset_key":{"type":"string","title":"Downstream Asset Key"}},"type":"object","required":["upstream_asset_key","downstream_asset_key"],"title":"AssetGraphDependency","description":"A dependency edge between two assets."},"AssetGraphPage":{"properties":{"assets":{"items":{"$ref":"#/components/schemas/AssetCatalogItem"},"type":"array","title":"Assets"},"dependencies":{"items":{"$ref":"#/components/schemas/AssetDependency"},"type":"array","title":"Dependencies"},"total":{"type":"integer","title":"Total"},"next_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Page"}},"type":"object","required":["assets","dependencies","total"],"title":"AssetGraphPage"},"AssetKeyFilter":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include assets with these exact keys"},"prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Prefix","description":"Only include assets with keys starting with these prefixes"},"search":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Search","description":"Only include assets with keys containing these substrings"}},"type":"object","title":"AssetKeyFilter"},"AssetOccurredFilter":{"properties":{"since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since","description":"Only include assets seen after this time (inclusive)"},"until":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Until","description":"Only include assets seen before this time (inclusive)"}},"type":"object","title":"AssetOccurredFilter"},"AssetProperties":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","default":""},"url":{"type":"string","maxLength":5000,"title":"Url","default":""},"description":{"type":"string","title":"Description","default":""},"owners":{"items":{"type":"string"},"type":"array","title":"Owners"}},"type":"object","title":"AssetProperties"},"AssetPublicationCreate":{"properties":{"resource_ids":{"items":{"type":"string"},"type":"array","title":"Resource Ids"}},"type":"object","required":["resource_ids"],"title":"AssetPublicationCreate","description":"POST body for creating an asset publication.\n\nThe caller provides literal asset keys; the server constructs the underlying\nPublicationCreate with the correct event patterns and resource spec so the\npublication is visible to the Available Assets browse experience."},"AssetRelatedFilter":{"properties":{"id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id","description":"Only include assets with related resources matching these IDs"},"role":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Role","description":"Only include assets with related resources in these roles"},"resources_in_roles":{"anyOf":[{"items":{"prefixItems":[{"type":"string"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},"type":"array"},{"type":"null"}],"title":"Resources In Roles","description":"Only include assets with specific related resources in specific roles"},"labels":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"type":"null"}],"description":"Only include assets with related resources matching these labels"}},"type":"object","title":"AssetRelatedFilter"},"AssetSubscriptionCreate":{"properties":{"publication_id":{"type":"string","format":"uuid","title":"Publication Id"}},"type":"object","required":["publication_id"],"title":"AssetSubscriptionCreate","description":"POST body for creating an asset subscription.\n\nThe caller provides a publication_id; the server constructs the underlying\nSubscriptionCreate with the correct event patterns."},"Automation":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this automation"},"description":{"type":"string","maxLength":5000,"title":"Description","description":"A longer description of this automation","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether this automation will be evaluated","default":true},"trigger":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Output"},{"$ref":"#/components/schemas/SequenceTrigger-Output"}],"title":"Trigger","description":"The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"},"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions","description":"The actions to perform when this Automation triggers"},"actions_on_trigger":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Trigger","description":"The actions to perform when an Automation goes into a triggered state"},"actions_on_resolve":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Resolve","description":"The actions to perform when an Automation goes into a resolving state"},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"Labels to apply to this automation"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the automation","examples":[["tag-1","tag-2"]]},"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account":{"type":"string","format":"uuid","title":"Account","description":"The Account to which this automation belongs"},"workspace":{"type":"string","format":"uuid","title":"Workspace","description":"The Workspace to which this automation belongs"},"actor":{"anyOf":[{"$ref":"#/components/schemas/ActorReference"},{"type":"null"}],"description":"The Prefect Actor to use when running actions, defaulting to the Actor who created the Automation"}},"type":"object","required":["name","trigger","actions","account","workspace"],"title":"Automation"},"AutomationCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this automation"},"description":{"type":"string","maxLength":5000,"title":"Description","description":"A longer description of this automation","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether this automation will be evaluated","default":true},"trigger":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Input"},{"$ref":"#/components/schemas/SequenceTrigger-Input"}],"title":"Trigger","description":"The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"},"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions","description":"The actions to perform when this Automation triggers"},"actions_on_trigger":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Trigger","description":"The actions to perform when an Automation goes into a triggered state"},"actions_on_resolve":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Resolve","description":"The actions to perform when an Automation goes into a resolving state"},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"Labels to apply to this automation"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the automation","examples":[["tag-1","tag-2"]]},"owner_resource":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Owner Resource","description":"The resource to which this automation belongs"}},"additionalProperties":false,"type":"object","required":["name","trigger","actions"],"title":"AutomationCreate"},"AutomationFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterId"},{"type":"null"}],"description":"Filter criteria for `Automation.id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterName"},{"type":"null"}],"description":"Filter criteria for `Automation.name`"},"created":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterCreated"},{"type":"null"}],"description":"Filter criteria for `Automation.created`"},"tags":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterTags"},{"type":"null"}],"description":"Filter criteria for `Automation.tags`"},"managed":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterManaged"},{"type":"null"}],"description":"Filter criteria for whether an automation is Prefect-managed"}},"additionalProperties":false,"type":"object","title":"AutomationFilter","description":"Filter automations. Only automations that match all of the criteria will be\nreturned."},"AutomationFilterCreated":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include automations created before this datetime"}},"additionalProperties":false,"type":"object","title":"AutomationFilterCreated","description":"Filter by `Automatio.created`."},"AutomationFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of automation ids to include"}},"additionalProperties":false,"type":"object","title":"AutomationFilterId","description":"Filter by `Automation.id`."},"AutomationFilterManaged":{"properties":{"eq_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Eq","description":"If true, only include Prefect-managed automations; if false, only include automations that are not Prefect-managed"}},"additionalProperties":false,"type":"object","title":"AutomationFilterManaged","description":"Filter by whether an automation is Prefect-managed."},"AutomationFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of names to match","examples":[["foo"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example, passing 'hello' will match 'hello', 'say-Hello', and 'hello-world'.","examples":["hello"]}},"additionalProperties":false,"type":"object","title":"AutomationFilterName","description":"Filter by `Automation.name`."},"AutomationFilterTags":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"all_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"All","description":"A list of tags. Automations will be returned only if their tags are a superset of the list","examples":[["tag-1","tag-2"]]},"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of tags. Automations will be returned if their tags contain any of the tags in the list","examples":[["tag-1","tag-2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include automations without tags"}},"additionalProperties":false,"type":"object","title":"AutomationFilterTags","description":"Filter by `Automation.tags`."},"AutomationPartialUpdate":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether this automation will be evaluated","default":true}},"additionalProperties":false,"type":"object","title":"AutomationPartialUpdate"},"AutomationSort":{"type":"string","enum":["CREATED_DESC","UPDATED_DESC","NAME_ASC","NAME_DESC"],"title":"AutomationSort","description":"Defines automations sorting options."},"AutomationUpdate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this automation"},"description":{"type":"string","maxLength":5000,"title":"Description","description":"A longer description of this automation","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether this automation will be evaluated","default":true},"trigger":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Input"},{"$ref":"#/components/schemas/SequenceTrigger-Input"}],"title":"Trigger","description":"The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"},"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions","description":"The actions to perform when this Automation triggers"},"actions_on_trigger":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Trigger","description":"The actions to perform when an Automation goes into a triggered state"},"actions_on_resolve":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Resolve","description":"The actions to perform when an Automation goes into a resolving state"},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"Labels to apply to this automation"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the automation","examples":[["tag-1","tag-2"]]}},"additionalProperties":false,"type":"object","required":["name","trigger","actions"],"title":"AutomationUpdate"},"AvailableAsset":{"properties":{"key":{"type":"string","title":"Key"},"publication_id":{"type":"string","format":"uuid","title":"Publication Id"},"publishing_workspace_id":{"type":"string","format":"uuid","title":"Publishing Workspace Id"},"publication_event":{"items":{"type":"string"},"type":"array","title":"Publication Event"},"publication_enabled":{"type":"boolean","title":"Publication Enabled"},"asset":{"anyOf":[{"$ref":"#/components/schemas/AssetCatalogItem"},{"type":"null"}]}},"type":"object","required":["key","publication_id","publishing_workspace_id","publication_event","publication_enabled"],"title":"AvailableAsset","description":"A single asset key from a cross-workspace publication, optionally\nenriched with ClickHouse metadata."},"AvailableAssetsPage":{"properties":{"results":{"items":{"$ref":"#/components/schemas/AvailableAsset"},"type":"array","title":"Results"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["results"],"title":"AvailableAssetsPage","description":"Paginated list of available assets with an opaque cursor for the next page."},"BalanceAlertThresholdsResponse":{"properties":{"alert_kind":{"type":"string","enum":["credit_balance","subscription_cost"],"title":"Alert Kind","description":"Which alert these thresholds drive.","default":"credit_balance"},"thresholds":{"items":{"type":"number"},"type":"array","title":"Thresholds","description":"Amounts, ascending, that each trigger an alert of the requested kind."}},"type":"object","title":"BalanceAlertThresholdsResponse","description":"An account's alert thresholds for one alert kind, as a flat list of amounts.\n\nFor `credit_balance` each amount fires when the balance drops to or below it; for\n`subscription_cost` each fires when the cycle's amount due crosses it. Empty when the\naccount has no thresholds set for the requested kind."},"BalanceAlertThresholdsUpdate":{"properties":{"alert_kind":{"type":"string","enum":["credit_balance","subscription_cost"],"title":"Alert Kind","description":"Which alert these thresholds drive. `credit_balance` amounts are credits; `subscription_cost` amounts are USD. Defaults to `credit_balance` when omitted.","default":"credit_balance"},"thresholds":{"items":{"type":"number","maximum":1000000000.0,"exclusiveMinimum":0.0},"type":"array","title":"Thresholds","description":"Amounts that each trigger an alert. Each must be a positive, finite number, distinct, and at most 10 in all. An empty list clears every threshold."}},"additionalProperties":false,"type":"object","required":["thresholds"],"title":"BalanceAlertThresholdsUpdate","description":"The full desired set of an account's credit-balance alert thresholds.\n\nReplace-the-set: the thresholds Orb ends up holding become exactly this list. An empty\nlist is the explicit clear; the field is required, so an omitted body is rejected rather\nthan silently wiping every threshold."},"BillingDetailsResponse":{"properties":{"stripe_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stripe Customer Id","description":"Stripe customer id associated with the account."},"self_serve":{"type":"boolean","title":"Self Serve","description":"Whether billing is self-serve on the plan. When a plan is self serve, users manage their own billable resources and make payments through a credit card they have setup with Stripe.","default":false},"has_payment_method":{"type":"boolean","title":"Has Payment Method","description":"Whether the account has a payment method the seat-add charge can use (subscription or customer default payment method, or a legacy default source). When false, the UI must send the customer to add a card before they can self-serve adjust slots.","default":false},"plan_type":{"$ref":"#/components/schemas/AccountPlanType","description":"The type of plan this account has.  Useful for making decisions abouthow to display this account, but not for authorization or feature enablement."},"plan_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Tier","description":"The tier of the account plan."},"users":{"$ref":"#/components/schemas/BillingObjectDetailsResponse","description":"User related billing information."},"workspaces":{"$ref":"#/components/schemas/BillingObjectDetailsResponse","description":"Workspace related billing information."},"annual_billing":{"type":"boolean","title":"Annual Billing","description":"Whether this account is on a yearly plan or not.","default":true},"cancel_at_period_end":{"type":"boolean","title":"Cancel At Period End","description":"Whether this account is going to be cancelling at their end of term. If truethe account won't be able to update workspace nor user slots.","default":false},"trial_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Trial Start","description":"Deprecated: always returns null."},"trial_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Trial End","description":"Deprecated: always returns null."},"billing_enabled":{"type":"boolean","title":"Billing Enabled","description":"Whether billing is enabled on the plan. When billing is disabled, users may add up to the free workspace/user slots specified in their account's terms. When billing is enabled, if implicit_slots=True we will automatically reconcile their current slots as users/workspaces are added and removed. If implicit_slots=True users/workspaces slots can purchased and filled.","default":false}},"additionalProperties":false,"type":"object","required":["plan_type","users","workspaces"],"title":"BillingDetailsResponse","description":"Data returned by the api for details about an account's billing"},"BillingObjectDetailsResponse":{"properties":{"free_slots":{"type":"integer","title":"Free Slots","description":"Number of free slots for object."},"minimum_slots":{"type":"integer","title":"Minimum Slots","description":"Minimum number of slots for object plan needs to maintain."},"used_slots":{"type":"integer","title":"Used Slots","description":"Number of slots currently in use for object."},"slots":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Slots","description":"Total number of slots for object. If `None` there is no limit."},"price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price","description":"Per unit cost of the object. None if there is no subscription."}},"additionalProperties":false,"type":"object","required":["free_slots","minimum_slots","used_slots","slots","price"],"title":"BillingObjectDetailsResponse","description":"Data returned by the api for details about a billable object"},"BillingRestrictionsResponse":{"properties":{"can_upgrade":{"type":"boolean","title":"Can Upgrade","description":"Whether the account can upgrade to a higher tier based on current usage.","default":false},"can_cancel":{"type":"boolean","title":"Can Cancel","description":"Whether the account can cancel their subscription based on current usage.","default":false},"available_tiers":{"items":{"type":"string"},"type":"array","title":"Available Tiers","description":"List of account plan tiers that are available based on current usage."}},"additionalProperties":false,"type":"object","title":"BillingRestrictionsResponse","description":"Data returned by the API about billing restrictions for an account."},"BlockDocument":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"anyOf":[{"type":"string","pattern":"^[^/%&><]+$"},{"type":"null"}],"title":"Name","description":"The block document's name. Not required for anonymous block documents."},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The block document's data"},"block_schema_id":{"type":"string","format":"uuid","title":"Block Schema Id","description":"A block schema ID"},"block_schema":{"anyOf":[{"$ref":"#/components/schemas/BlockSchema"},{"type":"null"}],"description":"The associated block schema"},"block_type_id":{"type":"string","format":"uuid","title":"Block Type Id","description":"A block type ID"},"block_type_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Block Type Name","description":"A block type name"},"block_type":{"anyOf":[{"$ref":"#/components/schemas/BlockType"},{"type":"null"}],"description":"The associated block type"},"block_document_references":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Block Document References","description":"Record of the block document's references"},"is_anonymous":{"type":"boolean","title":"Is Anonymous","description":"Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)","default":false}},"type":"object","required":["block_schema_id","block_type_id"],"title":"BlockDocument","description":"An ORM representation of a block document."},"BlockDocumentAccessControl":{"properties":{"manage_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"Manage Actors","description":"A list of actors with access to manage the block document."},"view_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"View Actors","description":"A list of actors with access to view the block document."}},"type":"object","title":"BlockDocumentAccessControl","description":"A representation of the access control for a block document."},"BlockDocumentCreate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name","description":"The block document's name. Not required for anonymous block documents."},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The block document's data"},"block_schema_id":{"type":"string","format":"uuid","title":"Block Schema Id","description":"A block schema ID"},"block_type_id":{"type":"string","format":"uuid","title":"Block Type Id","description":"A block type ID"},"is_anonymous":{"type":"boolean","title":"Is Anonymous","description":"Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)","default":false}},"additionalProperties":false,"type":"object","required":["block_schema_id","block_type_id"],"title":"BlockDocumentCreate","description":"Data used by the Prefect REST API to create a block document."},"BlockDocumentFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/BlockDocumentFilterId"},{"type":"null"}],"description":"Filter criteria for `BlockDocument.id`"},"is_anonymous":{"anyOf":[{"$ref":"#/components/schemas/BlockDocumentFilterIsAnonymous"},{"type":"null"}],"description":"Filter criteria for `BlockDocument.is_anonymous`. Defaults to excluding anonymous blocks.","default":{"eq_":false}},"block_type_id":{"anyOf":[{"$ref":"#/components/schemas/BlockDocumentFilterBlockTypeId"},{"type":"null"}],"description":"Filter criteria for `BlockDocument.block_type_id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/BlockDocumentFilterName"},{"type":"null"}],"description":"Filter criteria for `BlockDocument.name`"}},"additionalProperties":false,"type":"object","title":"BlockDocumentFilter","description":"Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned"},"BlockDocumentFilterBlockTypeId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of block type ids to include"}},"additionalProperties":false,"type":"object","title":"BlockDocumentFilterBlockTypeId","description":"Filter by `BlockDocument.block_type_id`."},"BlockDocumentFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of block ids to include"}},"additionalProperties":false,"type":"object","title":"BlockDocumentFilterId","description":"Filter by `BlockDocument.id`."},"BlockDocumentFilterIsAnonymous":{"properties":{"eq_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Eq","description":"Filter block documents for only those that are or are not anonymous."}},"additionalProperties":false,"type":"object","title":"BlockDocumentFilterIsAnonymous","description":"Filter by `BlockDocument.is_anonymous`."},"BlockDocumentFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of block names to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A string to match block names against. This can include SQL wildcard characters like `%` and `_`.","examples":["my-block%"]}},"additionalProperties":false,"type":"object","title":"BlockDocumentFilterName","description":"Filter by `BlockDocument.name`."},"BlockDocumentSort":{"type":"string","enum":["NAME_DESC","NAME_ASC","BLOCK_TYPE_AND_NAME_ASC"],"title":"BlockDocumentSort","description":"Defines block document sorting options."},"BlockDocumentUpdate":{"properties":{"block_schema_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Block Schema Id","description":"A block schema ID"},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The block document's data"},"merge_existing_data":{"type":"boolean","title":"Merge Existing Data","default":true}},"additionalProperties":false,"type":"object","title":"BlockDocumentUpdate","description":"Data used by the Prefect REST API to update a block document."},"BlockSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"checksum":{"type":"string","title":"Checksum","description":"The block schema's unique checksum"},"fields":{"additionalProperties":true,"type":"object","title":"Fields","description":"The block schema's field schema"},"block_type_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Block Type Id","description":"A block type ID"},"block_type":{"anyOf":[{"$ref":"#/components/schemas/BlockType"},{"type":"null"}],"description":"The associated block type"},"capabilities":{"items":{"type":"string"},"type":"array","title":"Capabilities","description":"A list of Block capabilities"},"version":{"type":"string","title":"Version","description":"Human readable identifier for the block schema","default":"non-versioned"}},"type":"object","required":["checksum","block_type_id"],"title":"BlockSchema","description":"An ORM representation of a block schema."},"BlockSchemaCreate":{"properties":{"fields":{"additionalProperties":true,"type":"object","title":"Fields","description":"The block schema's field schema"},"block_type_id":{"type":"string","format":"uuid","title":"Block Type Id","description":"A block type ID"},"capabilities":{"items":{"type":"string"},"type":"array","title":"Capabilities","description":"A list of Block capabilities"},"version":{"type":"string","maxLength":5000,"title":"Version","description":"Human readable identifier for the block schema","default":"non-versioned"}},"additionalProperties":false,"type":"object","required":["block_type_id"],"title":"BlockSchemaCreate","description":"Data used by the Prefect REST API to create a block schema."},"BlockSchemaFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"block_type_id":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilterBlockTypeId"},{"type":"null"}],"description":"Filter criteria for `BlockSchema.block_type_id`"},"block_capabilities":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilterCapabilities"},{"type":"null"}],"description":"Filter criteria for `BlockSchema.capabilities`"},"id":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilterId"},{"type":"null"}],"description":"Filter criteria for `BlockSchema.id`"},"version":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilterVersion"},{"type":"null"}],"description":"Filter criteria for `BlockSchema.version`"}},"additionalProperties":false,"type":"object","title":"BlockSchemaFilter","description":"Filter BlockSchemas"},"BlockSchemaFilterBlockTypeId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of block type ids to include"}},"additionalProperties":false,"type":"object","title":"BlockSchemaFilterBlockTypeId","description":"Filter by `BlockSchema.block_type_id`."},"BlockSchemaFilterCapabilities":{"properties":{"all_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"All","description":"A list of block capabilities. Block entities will be returned only if an associated block schema has a superset of the defined capabilities.","examples":[["write-storage","read-storage"]]}},"additionalProperties":false,"type":"object","title":"BlockSchemaFilterCapabilities","description":"Filter by `BlockSchema.capabilities`"},"BlockSchemaFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of IDs to include"}},"additionalProperties":false,"type":"object","title":"BlockSchemaFilterId","description":"Filter by BlockSchema.id"},"BlockSchemaFilterVersion":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of block schema versions.","examples":[["2.0.0","2.1.0"]]}},"additionalProperties":false,"type":"object","title":"BlockSchemaFilterVersion","description":"Filter by `BlockSchema.capabilities`"},"BlockType":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","pattern":"^[^/%&><]+$","title":"Name","description":"A block type's name"},"slug":{"type":"string","title":"Slug","description":"A block type's slug"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"Web URL for the block type's logo"},"documentation_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Documentation Url","description":"Web URL for the block type's documentation"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A short blurb about the corresponding block's intended use"},"code_example":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code Example","description":"A code snippet demonstrating use of the corresponding block"},"is_protected":{"type":"boolean","title":"Is Protected","description":"Protected block types cannot be modified via API.","default":false}},"type":"object","required":["name","slug"],"title":"BlockType","description":"An ORM representation of a block type"},"BlockTypeCreate":{"properties":{"name":{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$","title":"Name","description":"A block type's name"},"slug":{"type":"string","maxLength":5000,"title":"Slug","description":"A block type's slug"},"logo_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Logo Url","description":"Web URL for the block type's logo"},"documentation_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Documentation Url","description":"Web URL for the block type's documentation"},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"A short blurb about the corresponding block's intended use"},"code_example":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Code Example","description":"A code snippet demonstrating use of the corresponding block"}},"additionalProperties":false,"type":"object","required":["name","slug"],"title":"BlockTypeCreate","description":"Data used by the Prefect REST API to create a block type."},"BlockTypeFilter":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/BlockTypeFilterName"},{"type":"null"}],"description":"Filter criteria for `BlockType.name`"},"slug":{"anyOf":[{"$ref":"#/components/schemas/BlockTypeFilterSlug"},{"type":"null"}],"description":"Filter criteria for `BlockType.slug`"}},"additionalProperties":false,"type":"object","title":"BlockTypeFilter","description":"Filter BlockTypes"},"BlockTypeFilterName":{"properties":{"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"BlockTypeFilterName","description":"Filter by `BlockType.name`"},"BlockTypeFilterSlug":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of slugs to match"}},"additionalProperties":false,"type":"object","title":"BlockTypeFilterSlug","description":"Filter by `BlockType.slug`"},"BlockTypeUpdate":{"properties":{"logo_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Logo Url"},"documentation_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Documentation Url"},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description"},"code_example":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Code Example"}},"additionalProperties":false,"type":"object","title":"BlockTypeUpdate","description":"Data used by the Prefect REST API to update a block type."},"Body_average_flow_run_lateness_api_accounts__account_id__workspaces__workspace_id__flow_runs_lateness_post":{"properties":{"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]}},"type":"object","title":"Body_average_flow_run_lateness_api_accounts__account_id__workspaces__workspace_id__flow_runs_lateness_post"},"Body_bulk_archive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_archive_post":{"properties":{"flows":{"$ref":"#/components/schemas/FlowFilter","description":"Filter to identify flows to archive"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of flows to archive","default":50}},"type":"object","required":["flows"],"title":"Body_bulk_archive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_archive_post"},"Body_bulk_decrement_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_post":{"properties":{"slots":{"type":"integer","exclusiveMinimum":0.0,"title":"Slots"},"names":{"items":{"type":"string","pattern":"^[^/%&><]+$"},"type":"array","maxItems":100,"minItems":1,"title":"Names","description":"The names of the concurrency limits. One call can act on at most 100 limits."},"occupancy_seconds":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Occupancy Seconds"},"create_if_missing":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Create If Missing","deprecated":true}},"type":"object","required":["slots","names"],"title":"Body_bulk_decrement_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_post"},"Body_bulk_decrement_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_with_lease_post":{"properties":{"lease_id":{"type":"string","format":"uuid","title":"Lease Id","description":"The ID of the lease to use for decrementing active slots."}},"type":"object","required":["lease_id"],"title":"Body_bulk_decrement_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_decrement_with_lease_post"},"Body_bulk_delete_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_bulk_delete_post":{"properties":{"deployments":{"$ref":"#/components/schemas/DeploymentFilter","description":"Filter to identify deployments to delete"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of deployments to delete","default":50}},"type":"object","required":["deployments"],"title":"Body_bulk_delete_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_bulk_delete_post"},"Body_bulk_delete_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_delete_post":{"properties":{"flow_runs":{"$ref":"#/components/schemas/FlowRunFilter","description":"Filter to identify flow runs to delete"},"limit":{"type":"integer","maximum":250.0,"minimum":1.0,"title":"Limit","description":"Maximum number of flow runs to delete. Defaults to 50.","default":50}},"type":"object","required":["flow_runs"],"title":"Body_bulk_delete_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_delete_post"},"Body_bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post":{"properties":{"flows":{"$ref":"#/components/schemas/FlowFilter","description":"Filter to identify flows to delete"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of flows to delete","default":50}},"type":"object","required":["flows"],"title":"Body_bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post"},"Body_bulk_increment_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_post":{"properties":{"slots":{"type":"integer","exclusiveMinimum":0.0,"title":"Slots"},"names":{"items":{"type":"string","pattern":"^[^/%&><]+$"},"type":"array","maxItems":100,"minItems":1,"title":"Names","description":"The names of the concurrency limits. One call can act on at most 100 limits."},"mode":{"type":"string","enum":["concurrency","rate_limit"],"title":"Mode","default":"concurrency"},"create_if_missing":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Create If Missing","deprecated":true}},"type":"object","required":["slots","names"],"title":"Body_bulk_increment_active_slots_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_post"},"Body_bulk_increment_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_with_lease_post":{"properties":{"slots":{"type":"integer","exclusiveMinimum":0.0,"title":"Slots"},"names":{"items":{"type":"string","pattern":"^[^/%&><]+$"},"type":"array","maxItems":100,"minItems":1,"title":"Names","description":"The names of the concurrency limits. One call can act on at most 100 limits."},"mode":{"type":"string","enum":["concurrency","rate_limit"],"title":"Mode","default":"concurrency"},"lease_duration":{"type":"number","maximum":86400.0,"minimum":60.0,"title":"Lease Duration","description":"The duration of the lease in seconds.","default":300},"holder":{"anyOf":[{"$ref":"#/components/schemas/ConcurrencyLeaseHolder"},{"type":"null"}],"description":"The holder of the lease with type (flow_run, task_run, or deployment) and id."}},"type":"object","required":["slots","names"],"title":"Body_bulk_increment_active_slots_with_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_increment_with_lease_post"},"Body_bulk_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_set_state_post":{"properties":{"flow_runs":{"$ref":"#/components/schemas/FlowRunFilter","description":"Filter to identify flow runs to update"},"state":{"$ref":"#/components/schemas/StateCreate","description":"The intended state"},"force":{"type":"boolean","title":"Force","description":"If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.","default":false},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of flow runs to update","default":50},"emit_event":{"type":"boolean","title":"Emit Event","description":"If False, state changes will not be emitted as events server side, which may disable automations that fire when state changes occur.","default":true}},"type":"object","required":["flow_runs","state"],"title":"Body_bulk_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_set_state_post"},"Body_bulk_unarchive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_unarchive_post":{"properties":{"flows":{"$ref":"#/components/schemas/FlowFilter","description":"Filter to identify flows to unarchive"},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of flows to unarchive","default":50}},"type":"object","required":["flows"],"title":"Body_bulk_unarchive_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_unarchive_post"},"Body_count_account_events_api_accounts__account_id__events_count_by__countable__post":{"properties":{"time_unit":{"$ref":"#/components/schemas/TimeUnit","default":"day"},"time_interval":{"type":"number","minimum":0.01,"title":"Time Interval","default":1.0},"filter":{"anyOf":[{"$ref":"#/components/schemas/EventFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down the set of Events"}},"type":"object","title":"Body_count_account_events_api_accounts__account_id__events_count_by__countable__post"},"Body_count_account_memberships_api_accounts__account_id__account_memberships_count_post":{"properties":{"account_memberships":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilter"},{"type":"null"}]},"filter":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilter"},{"type":"null"}]},"only_users":{"type":"boolean","title":"Only Users","default":false},"only_bots":{"type":"boolean","title":"Only Bots","default":false},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},"type":"object","title":"Body_count_account_memberships_api_accounts__account_id__account_memberships_count_post"},"Body_count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_post":{"properties":{"artifacts":{"anyOf":[{"$ref":"#/components/schemas/ArtifactFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_post"},"Body_count_automations_api_accounts__account_id__workspaces__workspace_id__automations_count_post":{"properties":{"automations":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_automations_api_accounts__account_id__workspaces__workspace_id__automations_count_post"},"Body_count_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_count_post":{"properties":{"block_documents":{"anyOf":[{"$ref":"#/components/schemas/BlockDocumentFilter"},{"type":"null"}]},"block_types":{"anyOf":[{"$ref":"#/components/schemas/BlockTypeFilter"},{"type":"null"}]},"block_schemas":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_count_post"},"Body_count_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_count_post":{"properties":{"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_count_post"},"Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post":{"properties":{"flow_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Flow Ids","max_items":200}},"type":"object","required":["flow_ids"],"title":"Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post"},"Body_count_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_count_post":{"properties":{"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_count_post"},"Body_count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post":{"properties":{"work_pool_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Work Pool Ids","max_items":200},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]}},"type":"object","required":["work_pool_ids"],"title":"Body_count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post"},"Body_count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post":{"properties":{"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post"},"Body_count_invitations_api_accounts__account_id__invitations_count_post":{"properties":{"invitations":{"anyOf":[{"$ref":"#/components/schemas/InvitationFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_invitations_api_accounts__account_id__invitations_count_post"},"Body_count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post":{"properties":{"artifacts":{"anyOf":[{"$ref":"#/components/schemas/ArtifactCollectionFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post"},"Body_count_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_count_post":{"properties":{"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_count_post"},"Body_count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post":{"properties":{"flow_run_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Flow Run Ids","max_items":200}},"type":"object","required":["flow_run_ids"],"title":"Body_count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post"},"Body_count_variables_api_accounts__account_id__workspaces__workspace_id__variables_count_post":{"properties":{"variables":{"anyOf":[{"$ref":"#/components/schemas/VariableFilter"},{"type":"null"}]}},"type":"object","title":"Body_count_variables_api_accounts__account_id__workspaces__workspace_id__variables_count_post"},"Body_count_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_count_post":{"properties":{"work_pools":{"$ref":"#/components/schemas/WorkPoolFilter"}},"type":"object","title":"Body_count_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_count_post"},"Body_count_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_count_by__countable__post":{"properties":{"time_unit":{"$ref":"#/components/schemas/TimeUnit","default":"day"},"time_interval":{"type":"number","minimum":0.01,"title":"Time Interval","default":1.0},"filter":{"anyOf":[{"$ref":"#/components/schemas/EventFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down the set of Events"}},"type":"object","title":"Body_count_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_count_by__countable__post"},"Body_create_billing_portal_session_api_billing__account_id__create_billing_portal_session_post":{"properties":{"return_url":{"type":"string","title":"Return Url","description":"The url to return to after leaving the billing portal."}},"type":"object","required":["return_url"],"title":"Body_create_billing_portal_session_api_billing__account_id__create_billing_portal_session_post"},"Body_create_default_sla_api_accounts__account_id__workspaces__workspace_id__slas_default_post":{"properties":{"sla_severities":{"items":{"$ref":"#/components/schemas/SlaSeverity"},"type":"array","title":"Sla Severities"},"block_id":{"type":"string","format":"uuid","title":"Block Id"}},"type":"object","required":["sla_severities","block_id"],"title":"Body_create_default_sla_api_accounts__account_id__workspaces__workspace_id__slas_default_post"},"Body_create_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_post":{"properties":{"key":{"type":"string","title":"Key","description":"The input key"},"value":{"type":"string","maxLength":500000,"contentMediaType":"application/octet-stream","title":"Value","description":"The value of the input"},"sender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender","description":"The sender of the input"}},"type":"object","required":["key","value"],"title":"Body_create_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_post"},"Body_create_or_update_managed_automation_api_accounts__account_id__workspaces__workspace_id__automations_managed__automation_type__put":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"settings":{"additionalProperties":true,"type":"object","title":"Settings"}},"type":"object","title":"Body_create_or_update_managed_automation_api_accounts__account_id__workspaces__workspace_id__automations_managed__automation_type__put"},"Body_decrement_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_decrement_post":{"properties":{"names":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Names","description":"The tags to release a slot for. One call can act on at most 100 tags."},"task_run_id":{"type":"string","format":"uuid","title":"Task Run Id","description":"The ID of the task run releasing the slot"}},"type":"object","required":["names","task_run_id"],"title":"Body_decrement_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_decrement_post"},"Body_filter_assets_api_accounts__account_id__workspaces__workspace_id__assets_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","description":"The number of assets to return with each page","default":50},"filter":{"anyOf":[{"$ref":"#/components/schemas/AssetFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down assets"}},"type":"object","title":"Body_filter_assets_api_accounts__account_id__workspaces__workspace_id__assets_filter_post"},"Body_filter_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_filter_post":{"properties":{"prefix":{"type":"string","title":"Prefix","description":"The input key prefix"},"limit":{"type":"integer","title":"Limit","description":"The maximum number of results to return","default":1},"exclude_keys":{"items":{"type":"string"},"type":"array","title":"Exclude Keys","description":"Exclude inputs with these keys","default":[]}},"type":"object","required":["prefix"],"title":"Body_filter_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_filter_post"},"Body_filter_my_api_keys_api_me_api_keys_filter_post":{"properties":{"api_keys":{"anyOf":[{"$ref":"#/components/schemas/APIKeyFilter"},{"type":"null"}]},"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0}},"type":"object","title":"Body_filter_my_api_keys_api_me_api_keys_filter_post"},"Body_filter_my_sessions_api_me_sessions_filter_post":{"properties":{"filter":{"anyOf":[{"$ref":"#/components/schemas/UserSessionFilter"},{"type":"null"}]},"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0}},"type":"object","title":"Body_filter_my_sessions_api_me_sessions_filter_post"},"Body_filter_related_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_related_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","description":"The number of events to return with each page","default":50},"filter":{"$ref":"#/components/schemas/EventLineageRelatedFilter","description":"Additional optional filter criteria to narrow down the set of Events"}},"type":"object","title":"Body_filter_related_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_related_post"},"Body_filter_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","description":"The number of events to return with each page","default":50},"filter":{"anyOf":[{"$ref":"#/components/schemas/EventLineageFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down the set of Resources"}},"type":"object","title":"Body_filter_workspace_resources_api_accounts__account_id__workspaces__workspace_id__resources_filter_post"},"Body_flow_run_history_api_accounts__account_id__workspaces__workspace_id__flow_runs_history_post":{"properties":{"history_start":{"type":"string","format":"date-time","title":"History Start","description":"The history's start time."},"history_end":{"type":"string","format":"date-time","title":"History End","description":"The history's end time."},"history_interval_seconds":{"type":"number","format":"time-delta","title":"History Interval Seconds","description":"The size of each history interval, in seconds. Must be at least 1 second."},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]}},"type":"object","required":["history_start","history_end","history_interval_seconds"],"title":"Body_flow_run_history_api_accounts__account_id__workspaces__workspace_id__flow_runs_history_post"},"Body_get_checkout_link_api_billing__account_id__subscribe_post":{"properties":{"tier":{"$ref":"#/components/schemas/AccountPlanTier","description":"The pricing tier to create a checkout session for."}},"type":"object","required":["tier"],"title":"Body_get_checkout_link_api_billing__account_id__subscribe_post"},"Body_get_filtered_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_filter_count_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","description":"The number of events to return with each page","default":50},"filter":{"anyOf":[{"$ref":"#/components/schemas/EventLineageFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down the set of Resources"}},"type":"object","title":"Body_get_filtered_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_filter_count_post"},"Body_get_related_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_related_count_post":{"properties":{"filter":{"$ref":"#/components/schemas/EventLineageRelatedFilter","description":"Additional optional filter criteria to narrow down the set of Events"}},"type":"object","title":"Body_get_related_resources_count_api_accounts__account_id__workspaces__workspace_id__resources_related_count_post"},"Body_get_scheduled_flow_runs_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get_scheduled_flow_runs_post":{"properties":{"work_queue_names":{"items":{"type":"string"},"type":"array","title":"Work Queue Names","description":"The names of work pool queues"},"scheduled_before":{"type":"string","format":"date-time","title":"Scheduled Before","description":"The maximum time to look for scheduled flow runs"},"scheduled_after":{"type":"string","format":"date-time","title":"Scheduled After","description":"The minimum time to look for scheduled flow runs"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_get_scheduled_flow_runs_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get_scheduled_flow_runs_post"},"Body_get_scheduled_flow_runs_for_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_get_scheduled_flow_runs_post":{"properties":{"deployment_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Deployment Ids","description":"The deployment IDs to get scheduled runs for"},"scheduled_before":{"type":"string","format":"date-time","title":"Scheduled Before","description":"The maximum time to look for scheduled flow runs"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","required":["deployment_ids"],"title":"Body_get_scheduled_flow_runs_for_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_get_scheduled_flow_runs_post"},"Body_increment_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_increment_post":{"properties":{"names":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"Names","description":"The tags to acquire a slot for. One call can act on at most 100 tags."},"task_run_id":{"type":"string","format":"uuid","title":"Task Run Id","description":"The ID of the task run acquiring the slot"}},"type":"object","required":["names","task_run_id"],"title":"Body_increment_concurrency_limits_v1_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_increment_post"},"Body_manage_subscription_api_billing__account_id__manage_subscription_post":{"properties":{"return_url":{"type":"string","title":"Return Url","description":"The URL to return to after managing the subscription."}},"type":"object","required":["return_url"],"title":"Body_manage_subscription_api_billing__account_id__manage_subscription_post"},"Body_next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post":{"properties":{"flow_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Flow Ids","max_items":200}},"type":"object","required":["flow_ids"],"title":"Body_next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post"},"Body_paginate_bots_api_accounts__account_id__bots_paginate_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"service_accounts":{"anyOf":[{"$ref":"#/components/schemas/BotFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/BotSort","default":"NAME_ASC"}},"type":"object","title":"Body_paginate_bots_api_accounts__account_id__bots_paginate_post"},"Body_paginate_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_paginate_post":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_paginate_post"},"Body_paginate_deployment_versions_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions_paginate_post":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_deployment_versions_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions_paginate_post"},"Body_paginate_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_paginate_post":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/DeploymentSort","default":"NAME_ASC"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_paginate_post"},"Body_paginate_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_paginate_post":{"properties":{"sort":{"$ref":"#/components/schemas/FlowRunSort","default":"ID_DESC"},"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_paginate_post"},"Body_paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/FlowSort","default":"NAME_ASC"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post"},"Body_paginate_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_paginate_post":{"properties":{"sort":{"$ref":"#/components/schemas/TaskRunSort","default":"ID_DESC"},"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_paginate_post"},"Body_paginate_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_paginate_post":{"properties":{"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"sort":{"$ref":"#/components/schemas/WorkPoolSort","default":"NAME_ASC"},"include_base_job_template":{"type":"boolean","title":"Include Base Job Template","description":"If True, include base_job_template in responses. Defaults to False to reduce payload size when the full template is not needed.","default":false},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_paginate_post"},"Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_paginate_post":{"properties":{"work_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_paginate_post"},"Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_paginate_post":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"work_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_paginate_post"},"Body_paginate_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_paginate_post":{"properties":{"workers":{"anyOf":[{"$ref":"#/components/schemas/WorkerFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/WorkerSort","default":"LAST_HEARTBEAT_DESC"},"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_paginate_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_paginate_post"},"Body_preview_work_pool_configuration_api_accounts__account_id__workspaces__workspace_id__work_pools_configuration_preview_post":{"properties":{"base_job_template":{"title":"Base Job Template"},"type":{"type":"string","title":"Type"}},"type":"object","required":["base_job_template","type"],"title":"Body_preview_work_pool_configuration_api_accounts__account_id__workspaces__workspace_id__work_pools_configuration_preview_post"},"Body_promote_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__promote_post":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"Body_promote_deployment_version_api_accounts__account_id__workspaces__workspace_id__deployments__id__versions__version_id__promote_post"},"Body_query_webhooks_api_accounts__account_id__workspaces__workspace_id__webhooks_filter_post":{"properties":{"sort":{"$ref":"#/components/schemas/WebhookSort","default":"NAME_ASC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_query_webhooks_api_accounts__account_id__workspaces__workspace_id__webhooks_filter_post"},"Body_read_account_events_api_accounts__account_id__events_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","description":"The number of events to return with each page","default":50},"filter":{"anyOf":[{"$ref":"#/components/schemas/EventFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down the set of Events"}},"type":"object","title":"Body_read_account_events_api_accounts__account_id__events_filter_post"},"Body_read_account_memberships_api_accounts__account_id__account_memberships_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"account_memberships":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipFilter"},{"type":"null"}]},"sort":{"anyOf":[{"$ref":"#/components/schemas/AccountMembershipSort"},{"type":"null"}]},"only_users":{"type":"boolean","title":"Only Users","default":false},"only_bots":{"type":"boolean","title":"Only Bots","default":false},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},"type":"object","title":"Body_read_account_memberships_api_accounts__account_id__account_memberships_filter_post"},"Body_read_account_roles_api_accounts__account_id__account_roles_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"account_roles":{"anyOf":[{"$ref":"#/components/schemas/AccountRoleFilter"},{"type":"null"}]}},"type":"object","title":"Body_read_account_roles_api_accounts__account_id__account_roles_filter_post"},"Body_read_actors_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents_my_access_post":{"properties":{"block_document_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Block Document Ids"}},"type":"object","required":["block_document_ids"],"title":"Body_read_actors_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents_my_access_post"},"Body_read_actors_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments_my_access_post":{"properties":{"deployment_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Deployment Ids"}},"type":"object","required":["deployment_ids"],"title":"Body_read_actors_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments_my_access_post"},"Body_read_actors_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools_my_access_post":{"properties":{"work_pool_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Work Pool Ids","default":[]},"work_pool_names":{"items":{"type":"string"},"type":"array","title":"Work Pool Names","default":[]}},"type":"object","title":"Body_read_actors_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools_my_access_post"},"Body_read_all_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_all_concurrency_limits_v2_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_filter_post"},"Body_read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post":{"properties":{"sort":{"$ref":"#/components/schemas/ArtifactSort","default":"ID_DESC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"artifacts":{"anyOf":[{"$ref":"#/components/schemas/ArtifactFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post"},"Body_read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post":{"properties":{"sort":{"$ref":"#/components/schemas/AutomationSort","default":"NAME_ASC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"automations":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post"},"Body_read_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_filter_post":{"properties":{"block_documents":{"anyOf":[{"$ref":"#/components/schemas/BlockDocumentFilter"},{"type":"null"}]},"block_types":{"anyOf":[{"$ref":"#/components/schemas/BlockTypeFilter"},{"type":"null"}]},"block_schemas":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilter"},{"type":"null"}]},"include_secrets":{"type":"boolean","title":"Include Secrets","description":"Whether to include sensitive values in the block document.","default":false},"sort":{"anyOf":[{"$ref":"#/components/schemas/BlockDocumentSort"},{"type":"null"}],"default":"NAME_ASC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_filter_post"},"Body_read_block_schemas_api_accounts__account_id__workspaces__workspace_id__block_schemas_filter_post":{"properties":{"block_schemas":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilter"},{"type":"null"}]},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_block_schemas_api_accounts__account_id__workspaces__workspace_id__block_schemas_filter_post"},"Body_read_block_types_api_accounts__account_id__workspaces__workspace_id__block_types_filter_post":{"properties":{"block_types":{"anyOf":[{"$ref":"#/components/schemas/BlockTypeFilter"},{"type":"null"}]},"block_schemas":{"anyOf":[{"$ref":"#/components/schemas/BlockSchemaFilter"},{"type":"null"}]},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_block_types_api_accounts__account_id__workspaces__workspace_id__block_types_filter_post"},"Body_read_bots_api_accounts__account_id__bots_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"service_accounts":{"anyOf":[{"$ref":"#/components/schemas/BotFilter"},{"type":"null"}]}},"type":"object","title":"Body_read_bots_api_accounts__account_id__bots_filter_post"},"Body_read_concurrency_limits_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_concurrency_limits_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_filter_post"},"Body_read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post":{"properties":{"task_runs":{"$ref":"#/components/schemas/TaskRunFilter"},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]}},"type":"object","required":["task_runs"],"title":"Body_read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post"},"Body_read_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/DeploymentSort","default":"NAME_ASC"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_deployments_api_accounts__account_id__workspaces__workspace_id__deployments_filter_post"},"Body_read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post":{"properties":{"sort":{"$ref":"#/components/schemas/FlowRunSort","default":"EXPECTED_START_TIME_DESC"},"limit":{"type":"integer","maximum":1000.0,"title":"Limit","default":1000},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]}},"type":"object","title":"Body_read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post"},"Body_read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post":{"properties":{"sort":{"$ref":"#/components/schemas/FlowRunSort","default":"EXPECTED_START_TIME_DESC"},"limit":{"type":"integer","maximum":5000.0,"title":"Limit","default":5000},"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]}},"type":"object","title":"Body_read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post"},"Body_read_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_post":{"properties":{"sort":{"$ref":"#/components/schemas/FlowRunSort","default":"ID_DESC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_post"},"Body_read_flow_runs_api_accounts__account_id__workspaces__workspace_id__slas_flow_runs_post":{"properties":{"sla_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Sla Ids"},"since":{"type":"string","format":"date-time","title":"Since"}},"type":"object","required":["sla_ids","since"],"title":"Body_read_flow_runs_api_accounts__account_id__workspaces__workspace_id__slas_flow_runs_post"},"Body_read_flow_runs_minimal_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_minimal_post":{"properties":{"sort":{"$ref":"#/components/schemas/FlowRunSort","default":"ID_DESC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"work_pool_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_flow_runs_minimal_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_minimal_post"},"Body_read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/FlowSort","default":"NAME_ASC"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post"},"Body_read_invitations_api_accounts__account_id__invitations_filter_post":{"properties":{"invitations":{"anyOf":[{"$ref":"#/components/schemas/InvitationFilter"},{"type":"null"}]},"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0}},"type":"object","title":"Body_read_invitations_api_accounts__account_id__invitations_filter_post"},"Body_read_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_filter_post":{"properties":{"sort":{"$ref":"#/components/schemas/ArtifactCollectionSort","default":"ID_DESC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"artifacts":{"anyOf":[{"$ref":"#/components/schemas/ArtifactCollectionFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_filter_post"},"Body_read_logs_api_accounts__account_id__workspaces__workspace_id__logs_filter_post":{"properties":{"offset":{"type":"integer","maximum":20000.0,"minimum":0.0,"title":"Offset","default":0},"logs":{"anyOf":[{"$ref":"#/components/schemas/LogFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/LogSort","default":"TIMESTAMP_ASC"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_logs_api_accounts__account_id__workspaces__workspace_id__logs_filter_post"},"Body_read_resources_hierarchy_api_accounts__account_id__workspaces__workspace_id__resources_hierarchy_filter_post":{"properties":{"depth":{"type":"integer","minimum":0.0,"title":"Depth","description":"The depth of the hierarchy to return"},"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","description":"The number of events to return with each page","default":50},"filter":{"anyOf":[{"$ref":"#/components/schemas/EventLineageFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down the set of Resources"}},"type":"object","required":["depth"],"title":"Body_read_resources_hierarchy_api_accounts__account_id__workspaces__workspace_id__resources_hierarchy_filter_post"},"Body_read_saved_searches_api_accounts__account_id__workspaces__workspace_id__saved_searches_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_saved_searches_api_accounts__account_id__workspaces__workspace_id__saved_searches_filter_post"},"Body_read_slas_api_accounts__account_id__workspaces__workspace_id__slas_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"filter":{"anyOf":[{"$ref":"#/components/schemas/SlaFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_slas_api_accounts__account_id__workspaces__workspace_id__slas_filter_post"},"Body_read_slas_by_owner_resource_api_accounts__account_id__workspaces__workspace_id__slas_by_owner__owner_resource__post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"filter":{"anyOf":[{"$ref":"#/components/schemas/SlaFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_slas_by_owner_resource_api_accounts__account_id__workspaces__workspace_id__slas_by_owner__owner_resource__post"},"Body_read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post":{"properties":{"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]}},"type":"object","title":"Body_read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post"},"Body_read_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_filter_post":{"properties":{"sort":{"$ref":"#/components/schemas/TaskRunSort","default":"ID_DESC"},"offset":{"type":"integer","maximum":10001.0,"minimum":0.0,"title":"Offset","default":0},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_filter_post"},"Body_read_task_workers_api_accounts__account_id__workspaces__workspace_id__task_workers_filter_post":{"properties":{"task_worker_filter":{"anyOf":[{"$ref":"#/components/schemas/TaskWorkerFilter"},{"type":"null"}],"description":"The task worker filter"}},"type":"object","title":"Body_read_task_workers_api_accounts__account_id__workspaces__workspace_id__task_workers_filter_post"},"Body_read_teams_api_accounts__account_id__teams_filter_post":{"properties":{"teams":{"$ref":"#/components/schemas/TeamFilter"},"users":{"$ref":"#/components/schemas/UserFilter"},"bots":{"$ref":"#/components/schemas/BotFilter"},"sort":{"anyOf":[{"$ref":"#/components/schemas/TeamSort"},{"type":"null"}]},"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0}},"type":"object","title":"Body_read_teams_api_accounts__account_id__teams_filter_post"},"Body_read_user_pins_api_accounts__account_id__workspaces__workspace_id__pins_filter_post":{"properties":{"resource_type":{"anyOf":[{"items":{"$ref":"#/components/schemas/PinnableResourceType"},"type":"array"},{"type":"null"}],"title":"Resource Type"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_user_pins_api_accounts__account_id__workspaces__workspace_id__pins_filter_post"},"Body_read_variables_api_accounts__account_id__workspaces__workspace_id__variables_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"variables":{"anyOf":[{"$ref":"#/components/schemas/VariableFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/VariableSort","default":"NAME_ASC"},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_variables_api_accounts__account_id__workspaces__workspace_id__variables_filter_post"},"Body_read_work_pool_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_pools__name__concurrency_status_post":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"flow_run_limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Flow Run Limit","default":10},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_work_pool_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_pools__name__concurrency_status_post"},"Body_read_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_filter_post":{"properties":{"work_pools":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilter"},{"type":"null"}]},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"sort":{"$ref":"#/components/schemas/WorkPoolSort","default":"NAME_ASC"},"exclude_base_job_template":{"type":"boolean","title":"Exclude Base Job Template","description":"If True, exclude base_job_template from responses to reduce payload size. Use when listing work pools and the full template is not needed.","default":false},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_filter_post"},"Body_read_work_queue_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__concurrency_status_post":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","default":1},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_work_queue_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__concurrency_status_post"},"Body_read_work_queue_runs_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get_runs_post":{"properties":{"scheduled_before":{"type":"string","format":"date-time","title":"Scheduled Before","description":"Only flow runs scheduled to start before this time will be returned."},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_work_queue_runs_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get_runs_post"},"Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_filter_post":{"properties":{"work_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_filter_post"},"Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_filter_post":{"properties":{"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"work_queues":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilter"},{"type":"null"}]},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_filter_post"},"Body_read_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_filter_post":{"properties":{"workers":{"anyOf":[{"$ref":"#/components/schemas/WorkerFilter"},{"type":"null"}]},"sort":{"$ref":"#/components/schemas/WorkerSort","default":"LAST_HEARTBEAT_DESC"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","description":"Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided."}},"type":"object","title":"Body_read_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_filter_post"},"Body_read_workspace_bot_accesses_api_accounts__account_id__workspaces__workspace_id__bot_access_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"workspace_accesses":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceActorAccessFilter"},{"type":"null"}]},"bots":{"anyOf":[{"$ref":"#/components/schemas/BotFilter"},{"type":"null"}]},"sort":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceBotAccessSort"},{"type":"null"}]}},"type":"object","title":"Body_read_workspace_bot_accesses_api_accounts__account_id__workspaces__workspace_id__bot_access_filter_post"},"Body_read_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","description":"The number of events to return with each page","default":50},"filter":{"anyOf":[{"$ref":"#/components/schemas/EventFilter"},{"type":"null"}],"description":"Additional optional filter criteria to narrow down the set of Events"}},"type":"object","title":"Body_read_workspace_events_api_accounts__account_id__workspaces__workspace_id__events_filter_post"},"Body_read_workspace_roles_api_accounts__account_id__workspace_roles_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"workspace_roles":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceRoleFilter"},{"type":"null"}]}},"type":"object","title":"Body_read_workspace_roles_api_accounts__account_id__workspace_roles_filter_post"},"Body_read_workspace_team_accesses_api_accounts__account_id__workspaces__workspace_id__team_access_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0}},"type":"object","title":"Body_read_workspace_team_accesses_api_accounts__account_id__workspaces__workspace_id__team_access_filter_post"},"Body_read_workspace_user_accesses_api_accounts__account_id__workspaces__workspace_id__user_access_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"workspace_accesses":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceActorAccessFilter"},{"type":"null"}]},"users":{"anyOf":[{"$ref":"#/components/schemas/UserFilter"},{"type":"null"}]},"sort":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceUserAccessSort"},{"type":"null"}]}},"type":"object","title":"Body_read_workspace_user_accesses_api_accounts__account_id__workspaces__workspace_id__user_access_filter_post"},"Body_read_workspaces_api_accounts__account_id__workspaces_filter_post":{"properties":{"limit":{"type":"integer","maximum":200.0,"minimum":0.0,"title":"Limit","default":200},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"workspaces":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceFilter"},{"type":"null"}]}},"type":"object","title":"Body_read_workspaces_api_accounts__account_id__workspaces_filter_post"},"Body_renew_concurrency_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_leases__lease_id__renew_post":{"properties":{"lease_duration":{"type":"number","maximum":86400.0,"minimum":60.0,"title":"Lease Duration","description":"The duration of the lease in seconds.","default":300}},"type":"object","title":"Body_renew_concurrency_lease_api_accounts__account_id__workspaces__workspace_id__v2_concurrency_limits_leases__lease_id__renew_post"},"Body_reset_concurrency_limit_by_tag_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_tag__tag__reset_post":{"properties":{"slot_override":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Slot Override","description":"Manual override for active concurrency limit slots."}},"type":"object","title":"Body_reset_concurrency_limit_by_tag_api_accounts__account_id__workspaces__workspace_id__concurrency_limits_tag__tag__reset_post"},"Body_resume_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__resume_post":{"properties":{"run_input":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Run Input"}},"type":"object","title":"Body_resume_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__resume_post"},"Body_schedule_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedule_post":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"The earliest date to schedule"},"end_time":{"type":"string","format":"date-time","title":"End Time","description":"The latest date to schedule"},"min_time":{"type":"number","format":"time-delta","title":"Min Time","description":"Runs will be scheduled until at least this long after the `start_time`"},"min_runs":{"type":"integer","title":"Min Runs","description":"The minimum number of runs to schedule"},"max_runs":{"type":"integer","title":"Max Runs","description":"The maximum number of runs to schedule"}},"type":"object","title":"Body_schedule_deployment_api_accounts__account_id__workspaces__workspace_id__deployments__id__schedule_post"},"Body_set_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_put":{"properties":{"access_control":{"$ref":"#/components/schemas/ReplaceBlockDocumentAccess"}},"type":"object","required":["access_control"],"title":"Body_set_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_put"},"Body_set_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_put":{"properties":{"access_control":{"$ref":"#/components/schemas/ReplaceDeploymentAccess"}},"type":"object","required":["access_control"],"title":"Body_set_deployment_access_api_accounts__account_id__workspaces__workspace_id__deployments__id__access_put"},"Body_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__set_state_post":{"properties":{"state":{"$ref":"#/components/schemas/FlowRunStateCreate","description":"The intended state."},"force":{"type":"boolean","title":"Force","description":"If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.","default":false},"emit_event":{"type":"boolean","title":"Emit Event","description":"If False, the state change will not be emitted as an event server side, expecting the client to do so instead. If True, the state change will be emitted as an event.","default":true}},"type":"object","required":["state"],"title":"Body_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__set_state_post"},"Body_set_task_run_state_api_accounts__account_id__workspaces__workspace_id__task_runs__id__set_state_post":{"properties":{"state":{"$ref":"#/components/schemas/StateCreate","description":"The intended state."},"force":{"type":"boolean","title":"Force","description":"If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.","default":false},"emit_event":{"type":"boolean","title":"Emit Event","description":"If True, the state change is emitted as an event server side. Clients emit their own task run events, so the default is False. Set it when no client will report the state change, such as a state set by a user.","default":false}},"type":"object","required":["state"],"title":"Body_set_task_run_state_api_accounts__account_id__workspaces__workspace_id__task_runs__id__set_state_post"},"Body_set_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_put":{"properties":{"access_control":{"$ref":"#/components/schemas/ReplaceWorkPoolAccess"}},"type":"object","required":["access_control"],"title":"Body_set_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_put"},"Body_task_run_history_api_accounts__account_id__workspaces__workspace_id__task_runs_history_post":{"properties":{"history_start":{"type":"string","format":"date-time","title":"History Start","description":"The history's start time."},"history_end":{"type":"string","format":"date-time","title":"History End","description":"The history's end time."},"history_interval_seconds":{"type":"number","format":"time-delta","title":"History Interval Seconds","description":"The size of each history interval, in seconds. Must be at least 1 second."},"flows":{"anyOf":[{"$ref":"#/components/schemas/FlowFilter"},{"type":"null"}]},"flow_runs":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilter"},{"type":"null"}]},"task_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilter"},{"type":"null"}]},"deployments":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilter"},{"type":"null"}]}},"type":"object","required":["history_start","history_end","history_interval_seconds"],"title":"Body_task_run_history_api_accounts__account_id__workspaces__workspace_id__task_runs_history_post"},"Body_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__transfer_post":{"properties":{"to_account_id":{"type":"string","format":"uuid","title":"To Account Id"},"new_handle":{"type":"string","title":"New Handle"}},"type":"object","required":["to_account_id"],"title":"Body_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__transfer_post"},"Body_update_account_domains_api_accounts__account_id__domains_patch":{"properties":{"domain_names":{"items":{"type":"string"},"type":"array","title":"Domain Names"}},"type":"object","required":["domain_names"],"title":"Body_update_account_domains_api_accounts__account_id__domains_patch"},"Body_update_slots_api_billing__account_id__update_slots_post":{"properties":{"additional_workspace_slots":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Additional Workspace Slots","description":"The number of additional workspace slots to update to."},"additional_user_slots":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Additional User Slots","description":"The number of additional user slots to update to."}},"type":"object","title":"Body_update_slots_api_billing__account_id__update_slots_post"},"Body_upload_account_image_api_accounts__account_id__image_put":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_account_image_api_accounts__account_id__image_put"},"Body_upload_my_profile_image_api_me_profile_image_put":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_my_profile_image_api_me_profile_image_put"},"Body_upsert_team_members_api_accounts__account_id__teams__id__members_put":{"properties":{"members":{"items":{"$ref":"#/components/schemas/TeamMembershipCreate"},"type":"array","title":"Members"}},"type":"object","required":["members"],"title":"Body_upsert_team_members_api_accounts__account_id__teams__id__members_put"},"Body_validate_api_accounts__account_id__sso_validate_post":{"properties":{"redirect_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Redirect Uri"}},"type":"object","title":"Body_validate_api_accounts__account_id__sso_validate_post"},"Body_validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post":{"properties":{"schema":{"additionalProperties":true,"type":"object","title":"Schema"},"values":{"additionalProperties":true,"type":"object","title":"Values"}},"type":"object","required":["schema","values"],"title":"Body_validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post"},"Body_validate_subscription_status_api_billing__account_id__validate_subscription_status_post":{"properties":{"stripe_session_id":{"type":"string","title":"Stripe Session Id","description":"The id of the stripe session to validate."}},"type":"object","required":["stripe_session_id"],"title":"Body_validate_subscription_status_api_billing__account_id__validate_subscription_status_post"},"Body_validate_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__validate_transfer_post":{"properties":{"to_account_id":{"type":"string","format":"uuid","title":"To Account Id"},"new_handle":{"type":"string","title":"New Handle"}},"type":"object","required":["to_account_id"],"title":"Body_validate_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__validate_transfer_post"},"Body_worker_heartbeat_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_heartbeat_post":{"properties":{"name":{"type":"string","title":"Name","description":"The worker process name"},"heartbeat_interval_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Heartbeat Interval Seconds","description":"The worker's heartbeat interval in seconds"},"return_id":{"type":"boolean","title":"Return Id","description":"Whether to return the worker ID. If False, returns 204.","default":false},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"The worker's metadata"}},"type":"object","required":["name"],"title":"Body_worker_heartbeat_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_heartbeat_post"},"BotAPIKeyReadResponse":{"properties":{"active_key":{"$ref":"#/components/schemas/APIKeyReadResponse","description":"The key currently in use by the bot."},"rotating_keys":{"items":{"$ref":"#/components/schemas/APIKeyReadResponse"},"type":"array","title":"Rotating Keys","description":"The bot's rotating keys. These keys will expire in 48 hours or less. They can be deleted at any time."}},"type":"object","required":["active_key","rotating_keys"],"title":"BotAPIKeyReadResponse","description":"Data returned by the API when listing a bot's api keys."},"BotCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the bot."},"api_key_expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Api Key Expiration","description":"The time at which bot's api key expires. If `None`, the api key will not expire."},"account_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Account Role Id","description":"The account role id to assign the bot. If `None` the bot will be assignedthe MEMBER role by `models.bots.create_bot`"}},"additionalProperties":false,"type":"object","required":["name"],"title":"BotCreate","description":"Data used by the api to create a bot"},"BotCreateResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The actor id associated with this bot."},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The bot's account id. Bots can only belong to one account."},"name":{"type":"string","title":"Name","description":"The name of the bot."},"account_role_name":{"type":"string","title":"Account Role Name","description":"The name of the role of the bot's account membership."},"api_key":{"$ref":"#/components/schemas/APIKeyCreateResponse","description":"API Key associated with the bot."}},"additionalProperties":false,"type":"object","required":["actor_id","account_id","name","account_role_name","api_key"],"title":"BotCreateResponse"},"BotFilter":{"properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/BotFilterId"},{"type":"null"}],"description":"Filter criteria for Bot.id"},"name":{"anyOf":[{"$ref":"#/components/schemas/BotFilterName"},{"type":"null"}],"description":"Filter criteria for Bot.name"}},"additionalProperties":false,"type":"object","title":"BotFilter"},"BotFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of bot ids to include"}},"additionalProperties":false,"type":"object","title":"BotFilterId"},"BotFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of bot names to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin-ops', 'ceo-marvin', and 'marvin-engineering'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"BotFilterName"},"BotMCPOAuthClientCredentialsMetadataResponse":{"properties":{"client_id":{"type":"string","format":"uuid","title":"Client Id","description":"OAuth client id for MCP machine access."},"scope":{"type":"string","const":"prefect-cloud:workspaces","title":"Scope","description":"OAuth scopes granted to the client."},"grant_types":{"items":{"type":"string","const":"client_credentials"},"type":"array","title":"Grant Types","description":"OAuth grant types supported by the client."},"token_endpoint_auth_method":{"type":"string","const":"client_secret_basic","title":"Token Endpoint Auth Method","description":"OAuth client authentication method.","default":"client_secret_basic"},"token_endpoint_path":{"type":"string","const":"/auth/mcp/oauth/token","title":"Token Endpoint Path","description":"Cloud OAuth token endpoint path for client credentials exchange.","default":"/auth/mcp/oauth/token"},"authorization_server_metadata_path":{"type":"string","const":"/.well-known/oauth-authorization-server","title":"Authorization Server Metadata Path","description":"OAuth authorization-server metadata endpoint path.","default":"/.well-known/oauth-authorization-server"}},"additionalProperties":false,"type":"object","required":["client_id","scope"],"title":"BotMCPOAuthClientCredentialsMetadataResponse","description":"Metadata for a service account's active MCP OAuth credentials."},"BotMCPOAuthClientCredentialsResponse":{"properties":{"client_id":{"type":"string","format":"uuid","title":"Client Id","description":"OAuth client id for MCP machine access."},"scope":{"type":"string","const":"prefect-cloud:workspaces","title":"Scope","description":"OAuth scopes granted to the client."},"grant_types":{"items":{"type":"string","const":"client_credentials"},"type":"array","title":"Grant Types","description":"OAuth grant types supported by the client."},"token_endpoint_auth_method":{"type":"string","const":"client_secret_basic","title":"Token Endpoint Auth Method","description":"OAuth client authentication method.","default":"client_secret_basic"},"token_endpoint_path":{"type":"string","const":"/auth/mcp/oauth/token","title":"Token Endpoint Path","description":"Cloud OAuth token endpoint path for client credentials exchange.","default":"/auth/mcp/oauth/token"},"authorization_server_metadata_path":{"type":"string","const":"/.well-known/oauth-authorization-server","title":"Authorization Server Metadata Path","description":"OAuth authorization-server metadata endpoint path.","default":"/.well-known/oauth-authorization-server"},"client_secret":{"type":"string","title":"Client Secret","description":"OAuth client secret. This is only returned when rotated."}},"additionalProperties":false,"type":"object","required":["client_id","scope","client_secret"],"title":"BotMCPOAuthClientCredentialsResponse","description":"Data returned after rotating a service account's MCP OAuth credentials."},"BotPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BotReadResponse"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"BotPaginationResponse"},"BotPartial":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The actor id associated with this bot."},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The bot's account id. Bots can only belong to one account."},"name":{"type":"string","title":"Name","description":"The name of the bot."},"api_key":{"$ref":"#/components/schemas/APIKey","description":"The API Key the bot owns."}},"type":"object","required":["actor_id","account_id","name","api_key"],"title":"BotPartial","description":"An ORM representation of a Bot"},"BotReadResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The actor id associated with this bot."},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The bot's account id. Bots can only belong to one account."},"name":{"type":"string","title":"Name","description":"The name of the bot."},"account_role_name":{"type":"string","title":"Account Role Name","description":"The name of the role of the bot's account membership."},"api_key":{"$ref":"#/components/schemas/APIKeyReadResponse","description":"API Key associated with the bot"}},"additionalProperties":false,"type":"object","required":["actor_id","account_id","name","account_role_name","api_key"],"title":"BotReadResponse"},"BotRotateAPIKey":{"properties":{"api_key_expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Api Key Expiration","description":"The time at which the bot's new api key (the one created by calling this endpoint) will expire. If `None`, the api key will not expire."},"old_key_expires_in_seconds":{"anyOf":[{"type":"integer","maximum":172800.0,"minimum":0.0},{"type":"null"}],"title":"Old Key Expires In Seconds","description":"Provide this field to set an expiration for the currently active api key. If not provided or provided Null, the current key will be deleted. If provided, it cannot be more than 48 hours (172800 seconds) in the future."}},"additionalProperties":false,"type":"object","title":"BotRotateAPIKey","description":"Data used by the api to rotate a bot's api key"},"BotSort":{"type":"string","enum":["NAME_ASC","NAME_DESC","CREATED_ASC","CREATED_DESC","UPDATED_ASC","UPDATED_DESC"],"title":"BotSort","description":"Sort options for bots"},"BotUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name","description":"The name of the bot."},"account_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Account Role Id","description":"The account role id to assign the bot."}},"additionalProperties":false,"type":"object","title":"BotUpdate","description":"Data used by the api to update a bot"},"BranchingScheduleHandling":{"type":"string","enum":["keep","remove","inactive"],"title":"BranchingScheduleHandling"},"BulkDeleteResponse":{"properties":{"deleted":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Deleted","description":"List of IDs that were successfully deleted"}},"type":"object","title":"BulkDeleteResponse","description":"Response from a bulk deletion operation."},"CallWebhook":{"properties":{"type":{"type":"string","const":"call-webhook","title":"Type","default":"call-webhook"},"block_document_id":{"type":"string","format":"uuid","title":"Block Document Id","description":"The identifier of the webhook block to use"},"payload":{"type":"string","title":"Payload","description":"An optional templatable payload to send when calling the webhook.","default":""}},"type":"object","required":["block_document_id"],"title":"CallWebhook","description":"Call a webhook when an Automation is triggered."},"CancelFlowRun":{"properties":{"type":{"type":"string","const":"cancel-flow-run","title":"Type","default":"cancel-flow-run"},"force":{"type":"boolean","title":"Force","description":"Force the state change, bypassing orchestration rules","default":false}},"type":"object","title":"CancelFlowRun","description":"Cancels a flow run associated with the trigger"},"CancelledBy":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"The id of the actor that cancelled the object."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"The type of the actor that cancelled the object."},"display_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Value","description":"The display value for the actor that cancelled."}},"type":"object","title":"CancelledBy"},"ChangeFlowRunState":{"properties":{"type":{"type":"string","const":"change-flow-run-state","title":"Type","default":"change-flow-run-state"},"force":{"type":"boolean","title":"Force","description":"Force the state change, bypassing orchestration rules","default":false},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the state to change the flow run to"},"state":{"$ref":"#/components/schemas/StateType","description":"The type of the state to change the flow run to"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"An optional message to associate with the state change"}},"type":"object","required":["state"],"title":"ChangeFlowRunState","description":"Changes the state of a flow run associated with the trigger"},"CompoundTrigger-Input":{"properties":{"type":{"type":"string","const":"compound","title":"Type","default":"compound"},"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID of this trigger"},"triggers":{"items":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Input"},{"$ref":"#/components/schemas/SequenceTrigger-Input"}]},"type":"array","title":"Triggers"},"within":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Within"},"require":{"anyOf":[{"type":"integer"},{"type":"string","enum":["any","all"]}],"title":"Require"}},"type":"object","required":["triggers","within","require"],"title":"CompoundTrigger","description":"A composite trigger that requires some number of triggers to have\nfired within the given time period"},"CompoundTrigger-Output":{"properties":{"type":{"type":"string","const":"compound","title":"Type","default":"compound"},"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID of this trigger"},"triggers":{"items":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Output"},{"$ref":"#/components/schemas/SequenceTrigger-Output"}]},"type":"array","title":"Triggers"},"within":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Within"},"require":{"anyOf":[{"type":"integer"},{"type":"string","enum":["any","all"]}],"title":"Require"}},"type":"object","required":["triggers","within","require"],"title":"CompoundTrigger","description":"A composite trigger that requires some number of triggers to have\nfired within the given time period"},"ConcurrencyLeaseHolder":{"properties":{"type":{"type":"string","enum":["flow_run","task_run","deployment"],"title":"Type"},"id":{"type":"string","format":"uuid","title":"Id"}},"additionalProperties":false,"type":"object","required":["type","id"],"title":"ConcurrencyLeaseHolder","description":"Model for validating concurrency lease holder information."},"ConcurrencyLimit":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"tag":{"type":"string","title":"Tag","description":"A tag the concurrency limit is applied to."},"concurrency_limit":{"type":"integer","title":"Concurrency Limit","description":"The concurrency limit."},"active_slots":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Active Slots","description":"A list of active run ids using a concurrency slot"}},"type":"object","required":["tag","concurrency_limit"],"title":"ConcurrencyLimit","description":"An ORM representation of a concurrency limit."},"ConcurrencyLimitCreate":{"properties":{"tag":{"type":"string","maxLength":5000,"title":"Tag","description":"A tag the concurrency limit is applied to."},"concurrency_limit":{"type":"integer","minimum":0.0,"title":"Concurrency Limit","description":"The concurrency limit."}},"additionalProperties":false,"type":"object","required":["tag","concurrency_limit"],"title":"ConcurrencyLimitCreate","description":"Data used by the Orion API to create a concurrency limit."},"ConcurrencyLimitStrategy":{"type":"string","enum":["ENQUEUE","CANCEL_NEW"],"title":"ConcurrencyLimitStrategy","description":"Enumeration of concurrency collision strategies."},"ConcurrencyLimitV2":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"active":{"type":"boolean","title":"Active","description":"Whether the concurrency limit is active.","default":true},"name":{"type":"string","title":"Name","description":"The name of the concurrency limit."},"limit":{"type":"integer","minimum":0.0,"title":"Limit","description":"The concurrency limit."},"active_slots":{"type":"integer","title":"Active Slots","description":"The number of active slots.","default":0},"denied_slots":{"type":"integer","title":"Denied Slots","description":"The number of denied slots.","default":0},"slot_decay_per_second":{"type":"number","title":"Slot Decay Per Second","description":"The decay rate for active slots when used as a rate limit.","default":0},"avg_slot_occupancy_seconds":{"type":"number","title":"Avg Slot Occupancy Seconds","description":"The average amount of time a slot is occupied.","default":2.0}},"type":"object","required":["name","limit"],"title":"ConcurrencyLimitV2","description":"An ORM representation of a v2 concurrency limit."},"ConcurrencyLimitV2Create":{"properties":{"active":{"type":"boolean","title":"Active","description":"Whether the concurrency limit is active.","default":true},"name":{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$","title":"Name","description":"The name of the concurrency limit."},"limit":{"type":"integer","minimum":0.0,"title":"Limit","description":"The concurrency limit."},"active_slots":{"type":"integer","minimum":0.0,"title":"Active Slots","description":"The number of active slots.","default":0},"denied_slots":{"type":"integer","minimum":0.0,"title":"Denied Slots","description":"The number of denied slots.","default":0},"slot_decay_per_second":{"type":"number","maximum":1000000.0,"minimum":0.0,"title":"Slot Decay Per Second","description":"The decay rate for active slots when used as a rate limit.","default":0}},"additionalProperties":false,"type":"object","required":["name","limit"],"title":"ConcurrencyLimitV2Create","description":"Data used by the Orion API to create a v2 concurrency limit."},"ConcurrencyLimitV2PaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/GlobalConcurrencyLimitResponse"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"ConcurrencyLimitV2PaginationResponse"},"ConcurrencyLimitV2Update":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"name":{"anyOf":[{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$"},{"type":"null"}],"title":"Name"},"limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Limit"},"active_slots":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Active Slots"},"denied_slots":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Denied Slots"},"slot_decay_per_second":{"anyOf":[{"type":"number","maximum":1000000.0,"minimum":0.0},{"type":"null"}],"title":"Slot Decay Per Second"}},"additionalProperties":false,"type":"object","title":"ConcurrencyLimitV2Update","description":"Data used by the Orion API to update a v2 concurrency limit."},"ConcurrencyLimitWithLeaseResponse":{"properties":{"lease_id":{"type":"string","format":"uuid","title":"Lease Id"},"limits":{"items":{"$ref":"#/components/schemas/MinimalConcurrencyLimitResponse"},"type":"array","title":"Limits"}},"type":"object","required":["lease_id","limits"],"title":"ConcurrencyLimitWithLeaseResponse"},"ConcurrencyOptions":{"properties":{"collision_strategy":{"$ref":"#/components/schemas/ConcurrencyLimitStrategy"},"grace_period_seconds":{"type":"integer","maximum":86400.0,"minimum":60.0,"title":"Grace Period Seconds","description":"Grace period in seconds for infrastructure to start before concurrency slots are revoked","default":600}},"type":"object","required":["collision_strategy"],"title":"ConcurrencyOptions","description":"Class for storing the concurrency config in database."},"Constant":{"properties":{"input_type":{"type":"string","const":"constant","title":"Input Type","default":"constant"},"type":{"type":"string","title":"Type"}},"type":"object","required":["type"],"title":"Constant","description":"Represents constant input value to a task run."},"Count":{"properties":{"function":{"type":"string","const":"COUNT","title":"Function","default":"COUNT"}},"type":"object","title":"Count"},"CountByState":{"properties":{"COMPLETED":{"type":"integer","title":"Completed","default":0},"PENDING":{"type":"integer","title":"Pending","default":0},"RUNNING":{"type":"integer","title":"Running","default":0},"FAILED":{"type":"integer","title":"Failed","default":0},"CANCELLED":{"type":"integer","title":"Cancelled","default":0},"CRASHED":{"type":"integer","title":"Crashed","default":0},"PAUSED":{"type":"integer","title":"Paused","default":0},"CANCELLING":{"type":"integer","title":"Cancelling","default":0},"SCHEDULED":{"type":"integer","title":"Scheduled","default":0}},"type":"object","title":"CountByState"},"CountIf":{"properties":{"function":{"type":"string","const":"COUNT_IF","title":"Function","default":"COUNT_IF"},"operator":{"type":"string","enum":["==","!=",">",">=","<","<="],"title":"Operator","description":"The operator to use for the condition","default":"=="},"value":{"anyOf":[{"type":"number"},{"type":"integer"}],"title":"Value","description":"The value to compare the column to"}},"type":"object","required":["value"],"title":"CountIf"},"Countable":{"type":"string","enum":["day","time","event","resource","workspace","actor"],"title":"Countable"},"CreatedBy":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"The id of the creator of the object."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"The type of the creator of the object."},"display_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Value","description":"The display value for the creator."}},"type":"object","title":"CreatedBy"},"CronSchedule":{"properties":{"cron":{"type":"string","title":"Cron","examples":["0 0 * * *"]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","examples":["America/New_York"]},"day_or":{"type":"boolean","title":"Day Or","description":"Control croniter behavior for handling day and day_of_week entries.","default":true}},"additionalProperties":false,"type":"object","required":["cron"],"title":"CronSchedule","description":"Cron schedule\n\nNOTE: If the timezone is a DST-observing one, then the schedule will adjust\nitself appropriately. Cron's rules for DST are based on schedule times, not\nintervals. This means that an hourly cron schedule will fire on every new\nschedule hour, not every elapsed hour; for example, when clocks are set back\nthis will result in a two-hour pause as the schedule will fire *the first\ntime* 1am is reached and *the first time* 2am is reached, 120 minutes later.\nLonger schedules, such as one that fires at 9am every morning, will\nautomatically adjust for DST.\n\nArgs:\n    cron (str): a valid cron string\n    timezone (str): a valid timezone string\n    day_or (bool, optional): Control how croniter handles `day` and `day_of_week`\n        entries. Defaults to True, matching cron which connects those values using\n        OR. If the switch is set to False, the values are connected using AND. This\n        behaves like fcron and enables you to e.g. define a job that executes each\n        2nd friday of a month by setting the days of month and the weekday."},"DashboardTaskRunCount":{"properties":{"completed":{"type":"integer","title":"Completed","description":"The number of completed task runs."},"failed":{"type":"integer","title":"Failed","description":"The number of failed task runs."}},"type":"object","required":["completed","failed"],"title":"DashboardTaskRunCount"},"DeclareIncident":{"properties":{"type":{"type":"string","const":"declare-incident","title":"Type","default":"declare-incident"}},"type":"object","title":"DeclareIncident","description":"Declares an incident for the triggering event"},"DeleteFlowRun":{"properties":{"type":{"type":"string","const":"delete-flow-run","title":"Type","default":"delete-flow-run"}},"type":"object","title":"DeleteFlowRun","description":"Deletes a flow run associated with the trigger"},"DependencyResult":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"upstream_dependencies":{"items":{"$ref":"#/components/schemas/TaskRunResult"},"type":"array","title":"Upstream Dependencies"},"state":{"$ref":"#/components/schemas/State"},"expected_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expected Start Time"},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"},"total_run_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Run Time"},"estimated_run_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Estimated Run Time"},"untrackable_result":{"type":"boolean","title":"Untrackable Result"}},"type":"object","required":["id","name","upstream_dependencies","state","expected_start_time","start_time","end_time","total_run_time","estimated_run_time","untrackable_result"],"title":"DependencyResult"},"DeploymentAccessControl":{"properties":{"manage_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"Manage Actors","description":"A list of actors with access to manage the deployment."},"run_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"Run Actors","description":"A list of actors with access to run the deployment."},"view_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"View Actors","description":"A list of actors with access to view the deployment."}},"type":"object","title":"DeploymentAccessControl","description":"A representation of the access control for a deployment."},"DeploymentBranch":{"properties":{"branch":{"type":"string","maxLength":5000,"title":"Branch","description":"Name of the branch to create"},"options":{"$ref":"#/components/schemas/DeploymentBranchingOptions","description":"Configuration options for how the deployment should be branched"},"overrides":{"anyOf":[{"$ref":"#/components/schemas/DeploymentUpdate"},{"type":"null"}],"description":"Optional values to override in the branched deployment"}},"additionalProperties":false,"type":"object","required":["branch"],"title":"DeploymentBranch"},"DeploymentBranchingOptions":{"properties":{"schedule_handling":{"$ref":"#/components/schemas/BranchingScheduleHandling","description":"Whether to keep, remove, or set inactive the existing schedules when branching","default":"remove"}},"type":"object","title":"DeploymentBranchingOptions"},"DeploymentCreate":{"properties":{"infra_overrides":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Infra Overrides","description":"Deprecated field. Use `job_variables` instead."},"name":{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$","title":"Name","description":"The name of the deployment.","examples":["my-deployment"]},"branch":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Branch"},"base":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Base"},"root":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Root"},"version":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Version"},"version_info":{"anyOf":[{"$ref":"#/components/schemas/VersionInfo"},{"type":"null"}]},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The ID of the flow associated with the deployment."},"is_schedule_active":{"type":"boolean","title":"Is Schedule Active","description":"Whether the schedule is active.","default":true},"paused":{"type":"boolean","title":"Paused","description":"Whether or not the deployment is paused.","default":false},"disabled":{"type":"boolean","title":"Disabled","description":"Whether or not the deployment is disabled.","default":false},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimPolicyInput"},{"type":"null"}],"description":"Pending-claim policy overrides for this deployment."},"schedules":{"items":{"$ref":"#/components/schemas/DeploymentScheduleCreate"},"type":"array","title":"Schedules","description":"A list of schedules for the deployment."},"concurrency_limit":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"The deployment's concurrency limit."},"concurrency_options":{"anyOf":[{"$ref":"#/components/schemas/ConcurrencyOptions"},{"type":"null"}],"description":"Options for configuring deployment concurrency."},"global_concurrency_limit_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Global Concurrency Limit Id","description":"The ID of the global concurrency limit to apply to the deployment."},"enforce_parameter_schema":{"type":"boolean","title":"Enforce Parameter Schema","description":"Whether or not the deployment should enforce the parameter schema.","default":false},"parameter_openapi_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameter Openapi Schema","description":"The parameter schema of the flow, including defaults."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for flow runs scheduled by the deployment."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of deployment tags.","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"pull_steps":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Pull Steps"},"manifest_path":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Manifest Path"},"work_queue_name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Work Queue Name"},"work_pool_name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Work Pool Name","description":"The name of the deployment's work pool.","examples":["my-work-pool"]},"storage_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Storage Document Id"},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id"},"schedule":{"anyOf":[{"$ref":"#/components/schemas/IntervalSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/RRuleSchedule"},{"type":"null"}],"title":"Schedule","description":"The schedule for the deployment."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"path":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Path"},"entrypoint":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Entrypoint"},"job_variables":{"additionalProperties":true,"type":"object","title":"Job Variables","description":"Overrides for the flow's infrastructure configuration."}},"additionalProperties":false,"type":"object","required":["name","flow_id"],"title":"DeploymentCreate","description":"Data used by the Orion API to create a deployment."},"DeploymentFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterId"},{"type":"null"}],"description":"Filter criteria for `Deployment.id`"},"branch":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterBranch"},{"type":"null"}],"description":"Filter criteria for `Deployment.branch`"},"base":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterBase"},{"type":"null"}],"description":"Filter criteria for `Deployment.base`"},"root":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterRoot"},{"type":"null"}],"description":"Filter criteria for `Deployment.root`"},"name":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterName"},{"type":"null"}],"description":"Filter criteria for `Deployment.name`"},"is_schedule_active":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterIsScheduleActive"},{"type":"null"}],"description":"Filter criteria for `Deployment.is_schedule_active`"},"paused":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterPaused"},{"type":"null"}],"description":"Filter criteria for `Deployment.paused`"},"tags":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterTags"},{"type":"null"}],"description":"Filter criteria for `Deployment.tags`"},"work_queue_name":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterWorkQueueName"},{"type":"null"}],"description":"Filter criteria for `Deployment.work_queue_name`"},"concurrency_limit":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterConcurrencyLimit"},{"type":"null"}],"description":"DEPRECATED: Prefer `Deployment.concurrency_limit_id` over `Deployment.concurrency_limit`. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.","deprecated":true},"work_queue_id":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterWorkQueueId"},{"type":"null"}],"description":"Filter criteria for `Deployment.work_queue_id`"},"status":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterStatus"},{"type":"null"}],"description":"Filter criteria for `Deployment.status`"},"flow_or_deployment_name":{"anyOf":[{"$ref":"#/components/schemas/DeploymentOrFlowNameFilter"},{"type":"null"}],"description":"Filter criteria for `Deployment.name` or `Flow.name`"},"flow_id":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterFlowId"},{"type":"null"}],"description":"Filter criteria for `Deployment.flow_id`"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterCreatedBy"},{"type":"null"}],"description":"Filter criteria for `Deployment.created_by`"},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/DeploymentFilterUpdatedBy"},{"type":"null"}],"description":"Filter criteria for `Deployment.updated_by`"}},"additionalProperties":false,"type":"object","title":"DeploymentFilter","description":"Filter for deployments. Only deployments matching all criteria will be returned."},"DeploymentFilterBase":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of deployments that have a base to include","examples":[["deployment1","deployment2"]]}},"additionalProperties":false,"type":"object","title":"DeploymentFilterBase","description":"Filter by `Deployment.base`."},"DeploymentFilterBranch":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of branches to include","examples":[["tag-1","tag-2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include root deployments, those without branches"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterBranch","description":"Filter by `Deployment.branch`."},"DeploymentFilterConcurrencyLimit":{"properties":{"ge_":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ge","description":"Only include deployments with a concurrency limit greater than or equal to this value"},"le_":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Le","description":"Only include deployments with a concurrency limit less than or equal to this value"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include deployments without a concurrency limit"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterConcurrencyLimit","description":"DEPRECATED: Prefer `Deployment.concurrency_limit_id` over `Deployment.concurrency_limit`."},"DeploymentFilterCreatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of creator IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of creator types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include deployments without a creator"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterCreatedBy","description":"Filter by `Deployment.created_by`."},"DeploymentFilterFlowId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow ids to include"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterFlowId","description":"Filter by `Deployment.flow_id`."},"DeploymentFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of deployment ids to include"},"not_any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of deployment ids to exclude"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterId","description":"Filter by `Deployment.id`."},"DeploymentFilterIsScheduleActive":{"properties":{"eq_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Eq","description":"Only returns where deployment schedule is/is not active"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterIsScheduleActive","description":"Legacy filter to filter by `Deployment.is_schedule_active` which\nis always the opposite of `Deployment.paused`."},"DeploymentFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of deployment names to include","examples":[["my-deployment-1","my-deployment-2"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"DeploymentFilterName","description":"Filter by `Deployment.name`."},"DeploymentFilterPaused":{"properties":{"eq_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Eq","description":"Only returns where deployment is/is not paused"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterPaused","description":"Filter by `Deployment.paused`."},"DeploymentFilterRoot":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of deployments that have a root to include","examples":[["deployment1","deployment2"]]}},"additionalProperties":false,"type":"object","title":"DeploymentFilterRoot","description":"Filter by `Deployment.root`."},"DeploymentFilterStatus":{"properties":{"any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/DeploymentStatus"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of deployment statuses to include"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterStatus","description":"Filter by `Deployment.status`."},"DeploymentFilterTags":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"all_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"All","description":"A list of tags. Deployments will be returned only if their tags are a superset of the list","examples":[["tag-1","tag-2"]]},"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of tags to include","examples":[["tag-1","tag-2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include deployments without tags"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterTags","description":"Filter by `Deployment.tags`."},"DeploymentFilterUpdatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of updater IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of updater types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include deployments without an updater"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterUpdatedBy","description":"Filter by `Deployment.updated_by`."},"DeploymentFilterWorkQueueId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work queue ids to include"}},"additionalProperties":false,"type":"object","title":"DeploymentFilterWorkQueueId","description":"Filter by `Deployment.work_queue_id`"},"DeploymentFilterWorkQueueName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work queue names to include","examples":[["work_queue_1","work_queue_2"]]}},"additionalProperties":false,"type":"object","title":"DeploymentFilterWorkQueueName","description":"Filter by `Deployment.work_queue_name`."},"DeploymentFlowRunCreate":{"properties":{"state":{"anyOf":[{"$ref":"#/components/schemas/StateCreate"},{"type":"null"}],"description":"The state of the flow run to create"},"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the flow run. Defaults to a random slug if not specified.","examples":["my-flow-run"]},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters"},"enforce_parameter_schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enforce Parameter Schema","description":"Whether or not to enforce the parameter schema on this run."},"context":{"additionalProperties":true,"type":"object","title":"Context"},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id"},"empirical_policy":{"$ref":"#/components/schemas/FlowRunPolicy","description":"The empirical policy for the flow run."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the flow run.","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"idempotency_key":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Idempotency Key","description":"An optional idempotency key. If a flow run with the same idempotency key has already been created, the existing flow run will be returned."},"parent_task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Run Id"},"work_queue_name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Work Queue Name"},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables"}},"additionalProperties":false,"type":"object","title":"DeploymentFlowRunCreate","description":"Data used by the Orion API to create a flow run from a deployment."},"DeploymentOrFlowNameFilter":{"properties":{"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.","examples":["example"]}},"additionalProperties":false,"type":"object","title":"DeploymentOrFlowNameFilter","description":"Filter by `Deployment.name` or `Flow.name` with a single input string for ilike filtering."},"DeploymentPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/DeploymentResponse"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"DeploymentPaginationResponse"},"DeploymentResourcePeaksResponse":{"properties":{"peaks":{"items":{"$ref":"#/components/schemas/ResourcePeak"},"type":"array","title":"Peaks"}},"type":"object","required":["peaks"],"title":"DeploymentResourcePeaksResponse"},"DeploymentResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"infra_overrides":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Infra Overrides","description":"Deprecated field. Use `job_variables` instead."},"name":{"type":"string","title":"Name","description":"The name of the deployment."},"version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Version Id","description":"The ID of the default version of this deployment"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version","description":"An optional version for the deployment."},"version_info":{"anyOf":[{"$ref":"#/components/schemas/VersionInfo"},{"type":"null"}],"description":"Information about the version of the deployment."},"branch":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Branch","description":"The branch that this deployment belongs to."},"root":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Root","description":"The deployment id of the root deployment when following the chain of deployments from base."},"base":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Base","description":"The id of the deployment that this deployment branched from"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description for the deployment."},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The flow id associated with the deployment."},"schedule":{"anyOf":[{"$ref":"#/components/schemas/IntervalSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/RRuleSchedule"},{"type":"null"}],"title":"Schedule","description":"A schedule for the deployment."},"is_schedule_active":{"type":"boolean","title":"Is Schedule Active","description":"Whether or not the deployment schedule is active.","default":true},"paused":{"type":"boolean","title":"Paused","description":"Whether or not the deployment is paused.","default":false},"disabled":{"type":"boolean","title":"Disabled","description":"Whether or not the deployment is disabled.","default":false},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimPolicy"},{"type":"null"}],"description":"Pending-claim policy overrides for this deployment."},"schedules":{"items":{"$ref":"#/components/schemas/DeploymentSchedule"},"type":"array","title":"Schedules","description":"A list of schedules for the deployment."},"concurrency_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Concurrency Limit","description":"DEPRECATED: Prefer `global_concurrency_limit`. Will always be None for backwards compatibility. Will be removed after December 2024.","deprecated":true},"global_concurrency_limit":{"anyOf":[{"$ref":"#/components/schemas/GlobalConcurrencyLimitResponse"},{"type":"null"}],"description":"The global concurrency limit object for enforcing the maximum number of flow runs that can be active at once."},"concurrency_options":{"anyOf":[{"$ref":"#/components/schemas/ConcurrencyOptions"},{"type":"null"}],"description":"Options for configuring deployment concurrency."},"job_variables":{"additionalProperties":true,"type":"object","title":"Job Variables","description":"Overrides to apply to the base infrastructure block at runtime."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for flow runs scheduled by the deployment."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the deployment","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"work_queue_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Queue Name","description":"The work queue for the deployment. If no work queue is set, work will not be scheduled."},"work_queue_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Queue Id","description":"The id of the work pool queue to which this deployment is assigned."},"last_polled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Polled","description":"The last time the deployment was polled for status updates."},"parameter_openapi_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameter Openapi Schema","description":"The parameter schema of the flow, including defaults."},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"The path to the working directory for the workflow, relative to remote storage or an absolute path."},"pull_steps":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Pull Steps","description":"Pull steps for cloning and running this deployment."},"entrypoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entrypoint","description":"The path to the entrypoint for the workflow, relative to the `path`."},"manifest_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manifest Path","description":"The path to the flow's manifest file, relative to the chosen storage."},"storage_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Storage Document Id","description":"The block document defining storage used for this flow."},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id","description":"The block document defining infrastructure to use for flow runs."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Optional information about the creator of this deployment."},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/UpdatedBy"},{"type":"null"}],"description":"Optional information about the updater of this deployment."},"work_pool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Pool Name","description":"The name of the deployment's work pool."},"status":{"anyOf":[{"$ref":"#/components/schemas/DeploymentStatus"},{"type":"null"}],"description":"Whether the deployment is ready to run flows.","default":"NOT_READY"},"enforce_parameter_schema":{"type":"boolean","title":"Enforce Parameter Schema","description":"Whether or not the deployment should enforce the parameter schema.","default":false}},"type":"object","required":["name","flow_id"],"title":"DeploymentResponse"},"DeploymentSchedule":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The deployment id associated with this schedule."},"schedule":{"anyOf":[{"$ref":"#/components/schemas/IntervalSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/RRuleSchedule"}],"title":"Schedule","description":"The schedule for the deployment."},"active":{"type":"boolean","title":"Active","description":"Whether or not the schedule is active.","default":true},"last_scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Scheduled At","description":"The last time the schedule was scheduled."},"soonest_scheduled_run":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Soonest Scheduled Run","description":"The soonest scheduled run time."},"latest_scheduled_run":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest Scheduled Run","description":"The latest scheduled run time."},"max_active_runs":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Active Runs","description":"The maximum number of active runs for the schedule."},"max_scheduled_runs":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Scheduled Runs","description":"The maximum number of scheduled runs for the schedule."},"catchup":{"type":"boolean","title":"Catchup","description":"Whether or not a worker should catch up on Late runs for the schedule.","default":false},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for the schedule."},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"A unique slug for the schedule."}},"type":"object","required":["schedule"],"title":"DeploymentSchedule"},"DeploymentScheduleCreate":{"properties":{"active":{"type":"boolean","title":"Active","description":"Whether or not the schedule is active.","default":true},"max_active_runs":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Active Runs","description":"The maximum number of active runs for the schedule."},"max_scheduled_runs":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Scheduled Runs","description":"The maximum number of scheduled runs for the schedule."},"catchup":{"type":"boolean","title":"Catchup","description":"Whether or not a worker should catch up on Late runs for the schedule.","default":false},"schedule":{"anyOf":[{"$ref":"#/components/schemas/IntervalSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/RRuleSchedule"}],"title":"Schedule","description":"The schedule for the deployment."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for the schedule."},"slug":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Slug","description":"A unique slug for the schedule."},"replaces":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replaces","description":"The slug of an existing schedule that this schedule replaces. Used for renaming slugs."}},"additionalProperties":false,"type":"object","required":["schedule"],"title":"DeploymentScheduleCreate"},"DeploymentScheduleResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The deployment id associated with this schedule."},"schedule":{"anyOf":[{"$ref":"#/components/schemas/IntervalSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/RRuleSchedule"}],"title":"Schedule","description":"The schedule for the deployment."},"active":{"type":"boolean","title":"Active","description":"Whether or not the schedule is active.","default":true},"max_active_runs":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Active Runs","description":"The maximum number of active runs for the schedule."},"catchup":{"type":"boolean","title":"Catchup","description":"Whether or not a worker should catch up on Late runs for the schedule.","default":false},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"A slug for the schedule. Must be unique within a deployment."}},"type":"object","required":["schedule"],"title":"DeploymentScheduleResponse"},"DeploymentScheduleUpdate":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Whether or not the schedule is active."},"schedule":{"anyOf":[{"$ref":"#/components/schemas/IntervalSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/RRuleSchedule"},{"type":"null"}],"title":"Schedule","description":"The schedule for the deployment."},"max_active_runs":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Active Runs","description":"The maximum number of active runs for the schedule."},"max_scheduled_runs":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Scheduled Runs","description":"The maximum number of scheduled runs for the schedule."},"catchup":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Catchup","description":"Whether or not a worker should catch up on Late runs for the schedule."},"parameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameters","description":"Parameters for the schedule."},"slug":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Slug","description":"A unique slug for the schedule."},"replaces":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replaces","description":"The slug of an existing schedule that this schedule replaces. Used for renaming slugs."}},"additionalProperties":false,"type":"object","title":"DeploymentScheduleUpdate"},"DeploymentSort":{"type":"string","enum":["CREATED_DESC","CREATED_ASC","UPDATED_DESC","UPDATED_ASC","NAME_ASC","NAME_DESC"],"title":"DeploymentSort","description":"Defines deployment sorting options."},"DeploymentStatus":{"type":"string","enum":["READY","NOT_READY","DISABLED"],"title":"DeploymentStatus","description":"Enumeration of deployment statuses."},"DeploymentUpdate":{"properties":{"infra_overrides":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Infra Overrides","description":"Deprecated field. Use `job_variables` instead."},"version":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Version"},"version_info":{"anyOf":[{"$ref":"#/components/schemas/VersionInfo"},{"type":"null"}]},"schedule":{"anyOf":[{"$ref":"#/components/schemas/IntervalSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/RRuleSchedule"},{"type":"null"}],"title":"Schedule","description":"The schedule for the deployment."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_schedule_active":{"type":"boolean","title":"Is Schedule Active","description":"Whether the schedule is active.","default":true},"paused":{"type":"boolean","title":"Paused","description":"Whether or not the deployment is paused.","default":false},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimPolicyInput"},{"type":"null"}],"description":"Pending-claim policy overrides for this deployment."},"schedules":{"items":{"$ref":"#/components/schemas/DeploymentScheduleUpdate"},"type":"array","title":"Schedules","description":"A list of schedule updates for the deployment."},"concurrency_limit":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"The deployment's concurrency limit."},"concurrency_options":{"anyOf":[{"$ref":"#/components/schemas/ConcurrencyOptions"},{"type":"null"}],"description":"Options for configuring deployment concurrency."},"global_concurrency_limit_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Global Concurrency Limit Id","description":"The ID of the global concurrency limit to apply to the deployment."},"parameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameters","description":"Parameters for flow runs scheduled by the deployment."},"parameter_openapi_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameter Openapi Schema","description":"The parameter schema of the flow, including defaults."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of deployment tags.","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"pull_steps":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Pull Steps"},"work_queue_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Queue Name"},"work_pool_name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Work Pool Name","description":"The name of the deployment's work pool.","examples":["my-work-pool"]},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path"},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables"},"entrypoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entrypoint"},"manifest_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manifest Path"},"storage_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Storage Document Id"},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id"},"enforce_parameter_schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enforce Parameter Schema","description":"Whether or not the deployment should enforce the parameter schema."}},"additionalProperties":false,"type":"object","title":"DeploymentUpdate","description":"Data used by the Orion API to update a deployment."},"DeploymentVersionPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/DeploymentVersionResponse"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"DeploymentVersionPaginationResponse"},"DeploymentVersionResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"infra_overrides":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Infra Overrides","description":"Deprecated field. Use `job_variables` instead."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description for the deployment."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the deployment."},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels."},"entrypoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entrypoint","description":"The path to the entrypoint for the workflow, relative to the `path`."},"pull_steps":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Pull Steps","description":"The steps required to pull this deployment's project to a remote location."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for flow runs scheduled by the deployment."},"parameter_openapi_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameter Openapi Schema","description":"The parameter schema of the flow, including defaults."},"enforce_parameter_schema":{"type":"boolean","title":"Enforce Parameter Schema","description":"Whether or not the deployment should enforce the parameter schema.","default":false},"work_queue_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Queue Id","description":"The id of the work pool queue to which this deployment is assigned."},"work_queue_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Queue Name","description":"The work queue for the deployment. If no work queue is set, work will not be scheduled."},"job_variables":{"additionalProperties":true,"type":"object","title":"Job Variables","description":"Overrides to apply to the base infrastructure block at runtime."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Optional information about the creator of this deployment."},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/UpdatedBy"},{"type":"null"}],"description":"Optional information about the updater of this deployment."},"deployment_id":{"type":"string","format":"uuid","title":"Deployment Id","description":"The deployment ID."},"version_info":{"$ref":"#/components/schemas/VersionInfo","description":"Information about the version of the deployment."},"last_active":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Active","description":"The timestamp of the last time the deployment version was live or run. Is updated when the version moves from live to non-live, none-live to live, or when a run occurs."},"work_pool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Pool Name","description":"The name of the work pool the work pool resides within."}},"type":"object","required":["deployment_id","version_info"],"title":"DeploymentVersionResponse"},"DistinctValuesResponse":{"properties":{"values":{"items":{"type":"string"},"type":"array","title":"Values","description":"List of distinct values"}},"type":"object","required":["values"],"title":"DistinctValuesResponse","description":"Response model for distinct values endpoints."},"DoNothing":{"properties":{"type":{"type":"string","const":"do-nothing","title":"Type","default":"do-nothing"}},"type":"object","title":"DoNothing","description":"Do nothing when an Automation is triggered"},"Edge":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"Edge"},"Event":{"properties":{"occurred":{"type":"string","format":"date-time","title":"Occurred","description":"When the event happened from the sender's perspective"},"event":{"type":"string","maxLength":1024,"title":"Event","description":"The name of the event that happened"},"resource":{"$ref":"#/components/schemas/Resource","description":"The primary Resource this event concerns"},"related":{"items":{"$ref":"#/components/schemas/RelatedResource"},"type":"array","title":"Related","description":"A list of additional Resources involved in this event"},"payload":{"additionalProperties":true,"type":"object","title":"Payload","description":"An open-ended set of data describing what happened"},"id":{"type":"string","format":"uuid","title":"Id","description":"The client-provided identifier of this event"},"follows":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Follows","description":"The ID of an event that is known to have occurred prior to this one. If set, this may be used to establish a more precise ordering of causally-related events when they occur close enough together in time that the system may receive them out-of-order."}},"type":"object","required":["occurred","event","resource","id"],"title":"Event","description":"The client-side view of an event that has happened to a Resource"},"EventAnyResourceFilter":{"properties":{"id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id","description":"Only include events for resources with these IDs"},"id_prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id Prefix","description":"Only include events for resources with IDs starting with these prefixes"},"labels":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"type":"null"}],"description":"Only include events for related resources with these labels"}},"additionalProperties":false,"type":"object","title":"EventAnyResourceFilter"},"EventCount":{"properties":{"value":{"type":"string","title":"Value","description":"The value to use for filtering"},"label":{"type":"string","title":"Label","description":"The value to display for this count"},"count":{"type":"integer","title":"Count","description":"The count of matching events"},"start_time":{"type":"string","format":"date-time","title":"Start Time","description":"The start time of this group of events"},"end_time":{"type":"string","format":"date-time","title":"End Time","description":"The end time of this group of events"}},"type":"object","required":["value","label","count","start_time","end_time"],"title":"EventCount","description":"The count of events with the given filter value"},"EventDirection":{"type":"string","enum":["downstream","upstream"],"title":"EventDirection"},"EventFilter":{"properties":{"occurred":{"$ref":"#/components/schemas/EventOccurredFilter","description":"Filter criteria for when the events occurred"},"event":{"anyOf":[{"$ref":"#/components/schemas/EventNameFilter"},{"type":"null"}],"description":"Filter criteria for the event name"},"resource":{"anyOf":[{"$ref":"#/components/schemas/EventResourceFilter"},{"type":"null"}],"description":"Filter criteria for the resource of the event"},"related":{"anyOf":[{"$ref":"#/components/schemas/EventRelatedFilter"},{"items":{"$ref":"#/components/schemas/EventRelatedFilter"},"type":"array"},{"type":"null"}],"title":"Related","description":"Filter criteria for the related resources of the event"},"any_resource":{"anyOf":[{"$ref":"#/components/schemas/EventAnyResourceFilter"},{"items":{"$ref":"#/components/schemas/EventAnyResourceFilter"},"type":"array"},{"type":"null"}],"title":"Any Resource","description":"Filter criteria for any resource involved in the event"},"scope":{"$ref":"#/components/schemas/EventScopeFilter","description":"Filter criteria for the events' workspace"},"id":{"$ref":"#/components/schemas/EventIDFilter","description":"Filter criteria for the events' ID"},"text":{"anyOf":[{"$ref":"#/components/schemas/EventTextFilter"},{"type":"null"}],"description":"Filter criteria for text search across event content"},"order":{"$ref":"#/components/schemas/EventOrder","description":"The order to return filtered events","default":"DESC"},"limit":{"anyOf":[{"type":"integer","maximum":200.0,"minimum":0.0},{"type":"null"}],"title":"Limit","description":"The maximum number of events to return"},"offset":{"anyOf":[{"type":"integer","maximum":5000.0,"minimum":0.0},{"type":"null"}],"title":"Offset","description":"The number of events to skip"}},"additionalProperties":false,"type":"object","title":"EventFilter"},"EventIDFilter":{"properties":{"id":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"Only include events with one of these IDs"}},"additionalProperties":false,"type":"object","title":"EventIDFilter"},"EventLineageFilter":{"properties":{"id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id","description":"Only include events for resources with these IDs"},"id_prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id Prefix","description":"Only include events for resources with IDs starting with these prefixes"},"labels":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"type":"null"}],"description":"Only include events for related resources with these labels"},"exclude_id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Id","description":"Exclude events for resources with these IDs"},"exclude_id_prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Id Prefix","description":"Exclude events for resources with IDs starting with these prefixes"},"occurred":{"$ref":"#/components/schemas/LineageResourceOccurredFilter","description":"Filter criteria for when events related to matching resources occurred"},"limit":{"anyOf":[{"type":"integer","maximum":200.0,"minimum":0.0},{"type":"null"}],"title":"Limit","description":"The maximum number of events to return"},"offset":{"anyOf":[{"type":"integer","maximum":5000.0,"minimum":0.0},{"type":"null"}],"title":"Offset","description":"The number of events to skip"},"order":{"$ref":"#/components/schemas/EventOrder","description":"The order to return filtered resources","default":"DESC"},"scope":{"$ref":"#/components/schemas/EventScopeFilter","description":"Filter criteria for the events' workspace"},"group_level":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Group Level","description":"The number of levels to group by"}},"additionalProperties":false,"type":"object","title":"EventLineageFilter"},"EventLineageRelatedFilter":{"properties":{"id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id","description":"Only include events for resources with these IDs"},"id_prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id Prefix","description":"Only include events for resources with IDs starting with these prefixes"},"labels":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"type":"null"}],"description":"Only include events for related resources with these labels"},"exclude_id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Id","description":"Exclude events for resources with these IDs"},"exclude_id_prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Id Prefix","description":"Exclude events for resources with IDs starting with these prefixes"},"occurred":{"$ref":"#/components/schemas/LineageResourceOccurredFilter","description":"Filter criteria for when events related to matching resources occurred"},"limit":{"anyOf":[{"type":"integer","maximum":200.0,"minimum":0.0},{"type":"null"}],"title":"Limit","description":"The maximum number of events to return"},"offset":{"anyOf":[{"type":"integer","maximum":5000.0,"minimum":0.0},{"type":"null"}],"title":"Offset","description":"The number of events to skip"},"order":{"$ref":"#/components/schemas/EventOrder","description":"The order to return filtered resources","default":"DESC"},"scope":{"$ref":"#/components/schemas/EventScopeFilter","description":"Filter criteria for the events' workspace"},"group_level":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Group Level","description":"The number of levels to group by"},"direction":{"$ref":"#/components/schemas/EventDirection","description":"The direction of the relationship to filter on","default":"downstream"},"related_role":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Related Role","description":"Include only related resources with these roles"},"exclude_related_role":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Related Role","description":"Exclude related resources with these roles"}},"additionalProperties":false,"type":"object","title":"EventLineageRelatedFilter"},"EventNameFilter":{"properties":{"prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Prefix","description":"Only include events matching one of these prefixes"},"exclude_prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Prefix","description":"Exclude events matching one of these prefixes"},"name":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Name","description":"Only include events matching one of these names exactly"},"exclude_name":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Name","description":"Exclude events matching one of these names exactly"}},"additionalProperties":false,"type":"object","title":"EventNameFilter"},"EventOccurredFilter":{"properties":{"since":{"type":"string","format":"date-time","title":"Since","description":"Only include events after this time (inclusive)"},"until":{"type":"string","format":"date-time","title":"Until","description":"Only include events prior to this time (inclusive)"}},"additionalProperties":false,"type":"object","title":"EventOccurredFilter"},"EventOrder":{"type":"string","enum":["ASC","DESC"],"title":"EventOrder"},"EventPage":{"properties":{"events":{"items":{"$ref":"#/components/schemas/ReceivedEvent"},"type":"array","title":"Events","description":"The Events matching the query"},"total":{"type":"integer","title":"Total","description":"The total number of matching Events"},"next_page":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Next Page","description":"The URL for the next page of results, if there are more"}},"type":"object","required":["events","total","next_page"],"title":"EventPage","description":"A single page of events returned from the API, with an optional link to the\nnext page of results"},"EventRelatedFilter":{"properties":{"id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id","description":"Only include events for related resources with these IDs"},"role":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Role","description":"Only include events for related resources in these roles"},"resources_in_roles":{"anyOf":[{"items":{"prefixItems":[{"type":"string"},{"type":"string"}],"type":"array","maxItems":2,"minItems":2},"type":"array"},{"type":"null"}],"title":"Resources In Roles","description":"Only include events with specific related resources in specific roles"},"labels":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"type":"null"}],"description":"Only include events for related resources with these labels"}},"additionalProperties":false,"type":"object","title":"EventRelatedFilter"},"EventResourceFilter":{"properties":{"id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id","description":"Only include events for resources with these IDs"},"id_prefix":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Id Prefix","description":"Only include events for resources with IDs starting with these prefixes."},"labels":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"type":"null"}],"description":"Only include events for resources with these labels"},"distinct":{"type":"boolean","title":"Distinct","description":"Only include events for distinct resources","default":false}},"additionalProperties":false,"type":"object","title":"EventResourceFilter"},"EventScopeFilter":{"properties":{"account":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Account","description":"Only include events for this account"},"workspace":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Workspace","description":"Only include events for these workspaces"}},"additionalProperties":false,"type":"object","title":"EventScopeFilter"},"EventTextFilter":{"properties":{"query":{"type":"string","maxLength":200,"title":"Query","description":"Text search query string","examples":["error","error -debug","\"connection timeout\"","+required -excluded"]}},"additionalProperties":false,"type":"object","required":["query"],"title":"EventTextFilter","description":"Filter by text search across event content."},"EventTrigger":{"properties":{"type":{"type":"string","const":"event","title":"Type","default":"event"},"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID of this trigger"},"match":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object"}],"title":"Match","description":"Labels for resources which this trigger will match."},"match_related":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object"},{"items":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object"}]},"type":"array"}],"title":"Match Related","description":"Labels for related resources which this trigger will match."},"after":{"items":{"type":"string"},"type":"array","uniqueItems":true,"title":"After","description":"The event(s) which must first been seen to fire this trigger.  If empty, then fire this trigger immediately.  Events may include trailing wildcards, like `prefect.flow-run.*`"},"expect":{"items":{"type":"string"},"type":"array","uniqueItems":true,"title":"Expect","description":"The event(s) this trigger is expecting to see.  If empty, this trigger will match any event.  Events may include trailing wildcards, like `prefect.flow-run.*`"},"for_each":{"items":{"type":"string"},"type":"array","uniqueItems":true,"title":"For Each","description":"Evaluate the trigger separately for each distinct value of these labels on the resource.  By default, labels refer to the primary resource of the triggering event.  You may also refer to labels from related resources by specifying `related:<role>:<label>`.  This will use the value of that label for the first related resource in that role.  For example, `\"for_each\": [\"related:flow:prefect.resource.id\"]` would evaluate the trigger for each flow."},"posture":{"type":"string","enum":["Reactive","Proactive"],"title":"Posture","description":"The posture of this trigger, either Reactive or Proactive.  Reactive triggers respond to the _presence_ of the expected events, while Proactive triggers respond to the _absence_ of those expected events."},"threshold":{"type":"integer","title":"Threshold","description":"The number of events required for this trigger to fire (for Reactive triggers), or the number of events expected (for Proactive triggers)","default":1},"within":{"type":"number","title":"Within","description":"The time period over which the events must occur.  For Reactive triggers, this may be as low as 0 seconds, but must be at least 10 seconds for Proactive triggers","default":0.0}},"type":"object","required":["posture"],"title":"EventTrigger","description":"A trigger that fires based on the presence or absence of events within a given\nperiod of time."},"ExecutionPlanSchemaResponse":{"properties":{"schema_version":{"type":"string","title":"Schema Version","description":"The authored execution plan schema version returned."},"schema":{"additionalProperties":true,"type":"object","title":"Schema","description":"The JSON Schema for the authored execution plan document shape."},"supported_schema_versions":{"items":{"type":"string"},"type":"array","title":"Supported Schema Versions","description":"All authored execution plan schema versions this API can return."},"current_schema_version":{"type":"string","title":"Current Schema Version","description":"The current authored execution plan schema version."},"is_current":{"type":"boolean","title":"Is Current","description":"Whether the returned schema version is the current version."},"is_deprecated":{"type":"boolean","title":"Is Deprecated","description":"Whether the returned schema version is deprecated."},"document_shape_only":{"type":"boolean","const":true,"title":"Document Shape Only","description":"Whether the returned JSON Schema covers only document shape and not semantic graph validation.","default":true},"validation_guidance":{"type":"string","title":"Validation Guidance","description":"Human-readable guidance explaining when callers should use validation before publishing."}},"type":"object","required":["schema_version","schema","supported_schema_versions","current_schema_version","is_current","is_deprecated","validation_guidance"],"title":"ExecutionPlanSchemaResponse"},"Flow":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","pattern":"^[^/%&><]+$","title":"Name","description":"The name of the flow","examples":["1"]},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of flow tags","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Information about the creator of this flow."},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/UpdatedBy"},{"type":"null"}],"description":"Information about the updater of this flow."},"archived":{"type":"boolean","title":"Archived","description":"Whether the flow is archived. Archived flows are hidden from views that filter them out.","default":false},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At","description":"When the flow was archived, if it is archived."}},"type":"object","required":["name"],"title":"Flow","description":"An ORM representation of flow data."},"FlowBulkArchiveResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/FlowBulkArchiveResult"},"type":"array","title":"Results","description":"One result per flow that was changed or blocked. Changed flows come first; each group is ordered by flow name."}},"type":"object","title":"FlowBulkArchiveResponse","description":"Response from a bulk flow archive or unarchive operation."},"FlowBulkArchiveResult":{"properties":{"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The flow ID"},"status":{"type":"string","enum":["ARCHIVED","UNARCHIVED","BLOCKED"],"title":"Status","description":"ARCHIVED or UNARCHIVED when the flow's state changed. BLOCKED when the flow was not archived because its deployments have active schedules."},"scheduled_deployments":{"items":{"type":"string"},"type":"array","title":"Scheduled Deployments","description":"For BLOCKED flows, the names of the deployments with active schedules to pause before the flow can be archived."}},"type":"object","required":["flow_id","status"],"title":"FlowBulkArchiveResult","description":"Result for a single flow in a bulk archive or unarchive operation."},"FlowCreate":{"properties":{"name":{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$","title":"Name","description":"The name of the flow","examples":["my-flow"]},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of flow tags","examples":[["tag-1","tag-2","tag-3"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]}},"additionalProperties":false,"type":"object","required":["name"],"title":"FlowCreate","description":"Data used by the Orion API to create a flow."},"FlowFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/FlowFilterId"},{"type":"null"}],"description":"Filter criteria for `Flow.id`"},"deployment":{"anyOf":[{"$ref":"#/components/schemas/FlowFilterDeployment"},{"type":"null"}],"description":"Filter criteria for Flow deployments"},"name":{"anyOf":[{"$ref":"#/components/schemas/FlowFilterName"},{"type":"null"}],"description":"Filter criteria for `Flow.name`"},"tags":{"anyOf":[{"$ref":"#/components/schemas/FlowFilterTags"},{"type":"null"}],"description":"Filter criteria for `Flow.tags`"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/FlowFilterCreatedBy"},{"type":"null"}],"description":"Filter criteria for `Flow.created_by`"},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/FlowFilterUpdatedBy"},{"type":"null"}],"description":"Filter criteria for `Flow.updated_by`"},"archived":{"anyOf":[{"$ref":"#/components/schemas/FlowFilterArchived"},{"type":"null"}],"description":"Filter criteria for `Flow.archived`"}},"additionalProperties":false,"type":"object","title":"FlowFilter","description":"Filter for flows. Only flows matching all criteria will be returned."},"FlowFilterArchived":{"properties":{"eq_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Eq","description":"Only returns flows that are/are not archived"}},"additionalProperties":false,"type":"object","title":"FlowFilterArchived","description":"Filter by `Flow.archived`."},"FlowFilterCreatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of creator IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of creator types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flows without a creator"}},"additionalProperties":false,"type":"object","title":"FlowFilterCreatedBy","description":"Filter by `Flow.created_by`."},"FlowFilterDeployment":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flows without deployments"}},"additionalProperties":false,"type":"object","title":"FlowFilterDeployment","description":"Filter by flows by deployment"},"FlowFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow ids to include"},"not_any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of flow ids to exclude"}},"additionalProperties":false,"type":"object","title":"FlowFilterId","description":"Filter by `Flow.id`."},"FlowFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow names to include","examples":[["my-flow-1","my-flow-2"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"FlowFilterName","description":"Filter by `Flow.name`."},"FlowFilterTags":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"all_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"All","description":"A list of tags. Flows will be returned only if their tags are a superset of the list","examples":[["tag-1","tag-2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flows without tags"}},"additionalProperties":false,"type":"object","title":"FlowFilterTags","description":"Filter by `Flow.tags`."},"FlowFilterUpdatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of updater IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of updater types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flows without an updater"}},"additionalProperties":false,"type":"object","title":"FlowFilterUpdatedBy","description":"Filter by `Flow.updated_by`."},"FlowPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/Flow"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"FlowPaginationResponse"},"FlowRunBulkCreateResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/FlowRunCreateResult"},"type":"array","title":"Results","description":"Results for each flow run in the bulk operation, in the same order as the request"}},"type":"object","title":"FlowRunBulkCreateResponse","description":"Response from bulk flow run creation."},"FlowRunBulkSetStateResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/FlowRunOrchestrationResult"},"type":"array","title":"Results","description":"Results for each flow run in the bulk operation"}},"type":"object","title":"FlowRunBulkSetStateResponse","description":"Response from bulk flow run state change operation."},"FlowRunCreate":{"properties":{"state":{"anyOf":[{"$ref":"#/components/schemas/StateCreate"},{"type":"null"}],"description":"The state of the flow run to create"},"name":{"type":"string","title":"Name","description":"The name of the flow run. Defaults to a random slug if not specified.","examples":["my-flow-run"]},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The id of the flow being run."},"flow_version":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Flow Version","description":"The version of the flow being run."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters"},"context":{"additionalProperties":true,"type":"object","title":"Context","description":"The context of the flow run."},"parent_task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Run Id"},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id"},"empirical_policy":{"$ref":"#/components/schemas/FlowRunPolicy","description":"The empirical policy for the flow run."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the flow run.","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"idempotency_key":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Idempotency Key","description":"An optional idempotency key. If a flow run with the same idempotency key has already been created, the existing flow run will be returned."},"work_pool_name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Work Pool Name","description":"The name of the work pool to run the flow run in."},"work_queue_name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Work Queue Name","description":"The name of the work queue to place the flow run in."},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables","description":"The job variables to use when setting up flow run infrastructure."},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"DEPRECATED: The id of the deployment associated with this flow run, if available.","deprecated":true}},"additionalProperties":false,"type":"object","required":["flow_id"],"title":"FlowRunCreate","description":"Data used by the Orion API to create a flow run."},"FlowRunCreateResult":{"properties":{"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The ID of the created flow run, if successful"},"status":{"type":"string","enum":["CREATED","FAILED"],"title":"Status","description":"Whether the flow run was created or failed"},"flow_run":{"anyOf":[{"$ref":"#/components/schemas/FlowRunResponse"},{"type":"null"}],"description":"The created flow run, if successful"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Error message, if failed"}},"type":"object","required":["status"],"title":"FlowRunCreateResult","description":"Result for a single flow run in bulk create operation."},"FlowRunFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterId"},{"type":"null"}],"description":"Filter criteria for `FlowRun.id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterName"},{"type":"null"}],"description":"Filter criteria for `FlowRun.name`"},"tags":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterTags"},{"type":"null"}],"description":"Filter criteria for `FlowRun.tags`"},"flow_id":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterFlowId"},{"type":"null"}],"description":"Filter criteria for `FlowRun.flow_id`"},"deployment_id":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterDeploymentId"},{"type":"null"}],"description":"Filter criteria for `FlowRun.deployment_id`"},"deployment_version_id":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterDeploymentVersionId"},{"type":"null"}],"description":"Filter criteria for the deployment version of flow runs"},"deployment_version_info":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterDeploymentVersionInfo"},{"type":"null"}],"description":"Filter criteria for the deployment version info of flow runs"},"work_queue_id":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterWorkQueueId"},{"type":"null"}],"description":"Filter criteria for `FlowRun.work_queue_id`"},"work_queue_name":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterWorkQueueName"},{"type":"null"}],"description":"Filter criteria for `FlowRun.work_queue_name"},"state":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterState"},{"type":"null"}],"description":"Filter criteria for `FlowRun.state`"},"flow_version":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterFlowVersion"},{"type":"null"}],"description":"Filter criteria for `FlowRun.flow_version`"},"start_time":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterStartTime"},{"type":"null"}],"description":"Filter criteria for `FlowRun.start_time`"},"expected_start_time":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterExpectedStartTime"},{"type":"null"}],"description":"Filter criteria for `FlowRun.expected_start_time`"},"next_scheduled_start_time":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterNextScheduledStartTime"},{"type":"null"}],"description":"Filter criteria for `FlowRun.next_scheduled_start_time`"},"end_time":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterEndTime"},{"type":"null"}],"description":"Filter criteria for `FlowRun.end_time`"},"parent_flow_run_id":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterParentFlowRunId"},{"type":"null"}],"description":"Filter criteria for subflows of the given flow runs"},"parent_task_run_id":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterParentTaskRunId"},{"type":"null"}],"description":"Filter criteria for `FlowRun.parent_task_run_id`"},"idempotency_key":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterIdempotencyKey"},{"type":"null"}],"description":"Filter criteria for `FlowRun.idempotency_key`"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterCreatedBy"},{"type":"null"}],"description":"Filter criteria for `FlowRun.created_by`"}},"additionalProperties":false,"type":"object","title":"FlowRunFilter","description":"Filter flow runs. Only flow runs matching all criteria will be returned"},"FlowRunFilterCreatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of creator IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of creator types to include. For example, 'DEPLOYMENT' for scheduled runs or 'AUTOMATION' for runs triggered by automations.","examples":[["DEPLOYMENT","AUTOMATION"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flow runs without a creator"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterCreatedBy","description":"Filter by `FlowRun.created_by`."},"FlowRunFilterDeploymentId":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run deployment ids to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flow runs without deployment ids"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterDeploymentId","description":"Filter by `FlowRun.deployment_id`."},"FlowRunFilterDeploymentVersionId":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"deployment_id":{"type":"string","format":"uuid","title":"Deployment Id","description":"The deployment id to filter by"},"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run deployment version ids to include"}},"additionalProperties":false,"type":"object","required":["deployment_id"],"title":"FlowRunFilterDeploymentVersionId","description":"Filter by `FlowRun.deployment_version_id`."},"FlowRunFilterDeploymentVersionInfo":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"deployment_id":{"type":"string","format":"uuid","title":"Deployment Id","description":"The deployment id to filter by"},"any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/VersionInfo"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run deployment version infos to include"}},"additionalProperties":false,"type":"object","required":["deployment_id"],"title":"FlowRunFilterDeploymentVersionInfo","description":"Filter by `FlowRun.deployment_version_info`."},"FlowRunFilterEndTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include flow runs ending at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include flow runs ending at or after this time"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only return flow runs without an end time"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterEndTime","description":"Filter by `FlowRun.end_time`."},"FlowRunFilterExpectedStartTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include flow runs scheduled to start at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include flow runs scheduled to start at or after this time"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterExpectedStartTime","description":"Filter by `FlowRun.expected_start_time`."},"FlowRunFilterFlowId":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run flow ids to include"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterFlowId","description":"Filter by `FlowRun.flow_id`."},"FlowRunFilterFlowVersion":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run flow_versions to include"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterFlowVersion","description":"Filter by `FlowRun.flow_version`."},"FlowRunFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run ids to include"},"not_any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of flow run ids to exclude"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterId","description":"Filter by FlowRun.id."},"FlowRunFilterIdempotencyKey":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run idempotency keys to include"},"not_any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of flow run idempotency keys to exclude"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterIdempotencyKey","description":"Filter by FlowRun.idempotency_key."},"FlowRunFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run names to include","examples":[["my-flow-run-1","my-flow-run-2"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"FlowRunFilterName","description":"Filter by `FlowRun.name`."},"FlowRunFilterNextScheduledStartTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include flow runs with a next_scheduled_start_time or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include flow runs with a next_scheduled_start_time at or after this time"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterNextScheduledStartTime","description":"Filter by `FlowRun.next_scheduled_start_time`."},"FlowRunFilterParentFlowRunId":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of parent flow run ids to include"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterParentFlowRunId"},"FlowRunFilterParentTaskRunId":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run parent_task_run_ids to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flow runs without parent_task_run_id"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterParentTaskRunId","description":"Filter by `FlowRun.parent_task_run_id`."},"FlowRunFilterStartTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include flow runs starting at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include flow runs starting at or after this time"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only return flow runs without a start time"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterStartTime","description":"Filter by `FlowRun.start_time`."},"FlowRunFilterState":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"type":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterStateType"},{"type":"null"}],"description":"Filter criteria for `FlowRun.state_type`"},"name":{"anyOf":[{"$ref":"#/components/schemas/FlowRunFilterStateName"},{"type":"null"}],"description":"Filter criteria for `FlowRun.state_name`"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterState"},"FlowRunFilterStateName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run state names to include"},"not_any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of flow run state names to exclude"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterStateName"},"FlowRunFilterStateType":{"properties":{"any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/StateType"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run state types to include"},"not_any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/StateType"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of flow run state types to exclude"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterStateType","description":"Filter by `FlowRun.state_type`."},"FlowRunFilterTags":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"all_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"All","description":"A list of tags. Flow runs will be returned only if their tags are a superset of the list","examples":[["tag-1","tag-2"]]},"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of tags. Flow runs will be returned if their tags contain any of the tags in the list","examples":[["tag-1","tag-2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flow runs without tags"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterTags","description":"Filter by `FlowRun.tags`."},"FlowRunFilterWorkQueueId":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run work queue ids to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flow runs without work queue ids"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterWorkQueueId","description":"Filter by `FlowRun.work_queue_id`."},"FlowRunFilterWorkQueueName":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work queue names to include","examples":[["work_queue_1","work_queue_2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include flow runs without work queue names"}},"additionalProperties":false,"type":"object","title":"FlowRunFilterWorkQueueName","description":"Filter by `FlowRun.work_queue_name`."},"FlowRunHistoryItem":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The flow run id."},"state":{"$ref":"#/components/schemas/StateType","description":"The state type."},"timestamp":{"type":"integer","title":"Timestamp","description":"The start time of the run as Unix timestamp (seconds since epoch)"},"duration":{"type":"number","title":"Duration","description":"The total run time of the run."},"deployment":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment","description":"The deployment id for the run."}},"type":"object","required":["id","state","timestamp","duration"],"title":"FlowRunHistoryItem"},"FlowRunHistoryResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/FlowRunHistoryItem"},"type":"array","title":"Results","description":"The flow run history items."},"count":{"type":"integer","title":"Count","description":"The total number of flow run history items."},"limit":{"type":"integer","title":"Limit","description":"The limit of the response."},"pages":{"type":"integer","title":"Pages","description":"The number of pages in the response."},"page":{"type":"integer","title":"Page","description":"The current page in the response."}},"type":"object","required":["results","count","limit","pages","page"],"title":"FlowRunHistoryResponse"},"FlowRunInput":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"flow_run_id":{"type":"string","format":"uuid","title":"Flow Run Id","description":"The flow run ID associated with the input."},"key":{"type":"string","title":"Key","description":"The key of the input."},"value":{"type":"string","title":"Value","description":"The value of the input."},"sender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender","description":"The sender of the input."}},"type":"object","required":["flow_run_id","key","value"],"title":"FlowRunInput"},"FlowRunOrchestrationResult":{"properties":{"flow_run_id":{"type":"string","format":"uuid","title":"Flow Run Id","description":"The flow run ID"},"status":{"$ref":"#/components/schemas/SetStateStatus","description":"The orchestration result status"},"state":{"anyOf":[{"$ref":"#/components/schemas/State"},{"type":"null"}],"description":"The resulting state, if the transition was accepted"},"details":{"anyOf":[{"$ref":"#/components/schemas/StateAcceptDetails"},{"$ref":"#/components/schemas/StateWaitDetails"},{"$ref":"#/components/schemas/StateRejectDetails"},{"$ref":"#/components/schemas/StateAbortDetails"}],"title":"Details","description":"Details about the state transition result"}},"type":"object","required":["flow_run_id","status","details"],"title":"FlowRunOrchestrationResult","description":"Result for a single flow run in a bulk state operation."},"FlowRunPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/FlowRunResponse"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"FlowRunPaginationResponse"},"FlowRunPolicy":{"properties":{"max_retries":{"type":"integer","title":"Max Retries","description":"The maximum number of retries. Field is not used. Please use `retries` instead.","default":0,"deprecated":true},"retry_delay_seconds":{"type":"number","title":"Retry Delay Seconds","description":"The delay between retries. Field is not used. Please use `retry_delay` instead.","default":0,"deprecated":true},"retries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retries","description":"The number of retries."},"retry_delay":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retry Delay","description":"The delay time between retries, in seconds."},"pause_keys":{"anyOf":[{"items":{},"type":"array","uniqueItems":true},{"type":"null"}],"title":"Pause Keys","description":"Tracks pauses this run has observed."},"resuming":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resuming","description":"Indicates if this run is resuming from a pause.","default":false},"retry_type":{"anyOf":[{"type":"string","enum":["in_process","reschedule"]},{"type":"null"}],"title":"Retry Type","description":"The type of retry this run is undergoing."}},"type":"object","title":"FlowRunPolicy","description":"Defines of how a flow run should retry."},"FlowRunResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","description":"The name of the flow run. Defaults to a random slug if not specified.","examples":["my-flow-run"]},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The id of the flow being run."},"flow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Name","description":"The name of the flow being run."},"flow_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Version","description":"The version of the flow executed in this flow run.","examples":["1.0"]},"state_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"State Id","description":"The id of the flow run's current state."},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The deployment associated with this flow run"},"deployment_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Version Id","description":"The deployment version associated with this flow run."},"deployment_version_info":{"anyOf":[{"$ref":"#/components/schemas/VersionInfo"},{"type":"null"}],"description":"The version info of the deployment associated with this flow run."},"deployment_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deployment Version","description":"The version of the deployment associated with this flow run.","examples":["1.0"]},"work_queue_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Queue Id","description":"The id of the run's work pool queue."},"work_queue_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Queue Name","description":"The work queue that handled this flow run."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for the flow run."},"idempotency_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency Key","description":"An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times."},"context":{"additionalProperties":true,"type":"object","title":"Context","description":"Additional context for the flow run.","examples":[{"my_var":"my_val"}]},"empirical_policy":{"$ref":"#/components/schemas/FlowRunPolicy"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags on the flow run","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"parent_task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Run Id","description":"If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state."},"state_type":{"anyOf":[{"$ref":"#/components/schemas/StateType"},{"type":"null"}],"description":"The type of the current flow run state."},"state_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Name","description":"The name of the current flow run state."},"run_count":{"type":"integer","title":"Run Count","description":"The number of times the flow run was executed.","default":0},"expected_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expected Start Time","description":"The flow run's expected start time."},"next_scheduled_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Scheduled Start Time","description":"The next time the flow run is scheduled to start."},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time","description":"The actual start time."},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"The actual end time."},"total_run_time":{"type":"number","title":"Total Run Time","description":"Total run time. If the flow run was executed multiple times, the time of each run will be summed.","default":0.0},"estimated_run_time":{"type":"number","title":"Estimated Run Time","description":"A real-time estimate of the total run time.","default":0.0},"estimated_start_time_delta":{"type":"number","title":"Estimated Start Time Delta","description":"The difference between actual and expected start time.","default":0.0},"auto_scheduled":{"type":"boolean","title":"Auto Scheduled","description":"Whether or not the flow run was automatically scheduled.","default":false},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id","description":"The block document defining infrastructure to use this flow run."},"infrastructure_pid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Infrastructure Pid","description":"The id of the flow run as returned by an infrastructure block."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Optional information about the creator of this flow run."},"work_pool_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Pool Id","description":"The id of the flow run's work pool."},"work_pool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Pool Name","description":"The name of the flow run's work pool.","examples":["my-work-pool"]},"state":{"anyOf":[{"$ref":"#/components/schemas/State"},{"type":"null"}],"description":"The current state of the flow run."},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables","description":"Variables used as overrides in the base job template"}},"type":"object","required":["flow_id"],"title":"FlowRunResponse"},"FlowRunResult":{"properties":{"input_type":{"type":"string","const":"flow_run","title":"Input Type","default":"flow_run"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"FlowRunResult"},"FlowRunSetStateResult":{"properties":{"state":{"anyOf":[{"$ref":"#/components/schemas/FlowRunState"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/SetStateStatus"},"details":{"anyOf":[{"$ref":"#/components/schemas/StateAcceptDetails"},{"$ref":"#/components/schemas/StateWaitDetails"},{"$ref":"#/components/schemas/StateRejectDetails"},{"$ref":"#/components/schemas/StateAbortDetails"}],"title":"Details"}},"type":"object","required":["state","status","details"],"title":"FlowRunSetStateResult","description":"The result of setting one flow run's state."},"FlowRunSlotSummary":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"state_type":{"anyOf":[{"$ref":"#/components/schemas/StateType"},{"type":"null"}]},"state_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Name"},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"},"state_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"State Timestamp"},"time_in_current_state":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Time In Current State"}},"type":"object","required":["id","name","state_type","state_name","start_time","state_timestamp","time_in_current_state"],"title":"FlowRunSlotSummary","description":"Summary of a flow run holding a concurrency slot."},"FlowRunSort":{"type":"string","enum":["ID_DESC","START_TIME_ASC","START_TIME_DESC","EXPECTED_START_TIME_ASC","EXPECTED_START_TIME_DESC","NAME_ASC","NAME_DESC","NEXT_SCHEDULED_START_TIME_ASC","END_TIME_DESC","DURATION_DESC","LATENESS_DESC"],"title":"FlowRunSort","description":"Defines flow run sorting options."},"FlowRunState":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"$ref":"#/components/schemas/StateType"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","examples":["Run started"]},"data":{"anyOf":[{},{"type":"null"}],"title":"Data","description":"Data associated with the state, e.g. a result. Content must be storable as JSON."},"state_details":{"$ref":"#/components/schemas/FlowRunStateDetails"}},"type":"object","required":["type"],"title":"FlowRunState","description":"A flow-run state with flow-specific orchestration metadata."},"FlowRunStateCreate":{"properties":{"type":{"$ref":"#/components/schemas/StateType"},"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","examples":["Run started"]},"data":{"anyOf":[{},{"type":"null"}],"title":"Data","description":"Data associated with the state, e.g. a result. Content must be storable as JSON."},"state_details":{"$ref":"#/components/schemas/StateDetails"},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimCreate"},{"type":"null"}],"description":"Client-authored pending claim identity for acquisition and subsequent claim-owned PENDING transitions. The server resolves and persists the canonical claim metadata."}},"additionalProperties":false,"type":"object","required":["type"],"title":"FlowRunStateCreate","description":"Data used by the Orion API to propose a flow run state."},"FlowRunStateDetails":{"properties":{"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaim"},{"type":"null"}]},"pending_timeout_count":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pending Timeout Count"},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id"},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id"},"child_flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Child Flow Run Id"},"scheduled_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled Time"},"cache_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cache Key"},"cache_expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cache Expiration"},"deferred":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Deferred"},"untrackable_result":{"type":"boolean","title":"Untrackable Result","default":false},"pause_timeout":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pause Timeout"},"pause_reschedule":{"type":"boolean","title":"Pause Reschedule","default":false},"pause_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pause Key"},"run_input_keyset":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Run Input Keyset"},"refresh_cache":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Refresh Cache"},"retriable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Retriable"},"transition_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transition Id"},"task_parameters_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Parameters Id"},"traceparent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Traceparent"},"deployment_concurrency_lease_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Concurrency Lease Id"}},"type":"object","title":"FlowRunStateDetails","description":"State metadata stored for flow runs."},"FlowRunUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name"},"flow_version":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Flow Version"},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters"},"empirical_policy":{"$ref":"#/components/schemas/FlowRunPolicy"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"infrastructure_pid":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Infrastructure Pid"},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables"}},"additionalProperties":false,"type":"object","title":"FlowRunUpdate","description":"Data used by the Orion API to update a flow run."},"FlowRunWithRunTimeField":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","description":"The name of the flow run. Defaults to a random slug if not specified.","examples":["my-flow-run"]},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The id of the flow being run."},"flow_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Version","description":"The version of the flow executed in this flow run.","examples":["1.0"]},"state_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"State Id","description":"The id of the flow run's current state."},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The deployment associated with this flow run"},"deployment_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Version Id","description":"The deployment version associated with this flow run."},"deployment_version_info":{"anyOf":[{"$ref":"#/components/schemas/VersionInfo"},{"type":"null"}],"description":"The version info of the deployment associated with this flow run."},"deployment_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deployment Version","description":"The version of the deployment associated with this flow run.","examples":["1.0"]},"work_queue_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Queue Name","description":"The work queue that handled this flow run."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for the flow run."},"idempotency_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency Key","description":"An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times."},"context":{"additionalProperties":true,"type":"object","title":"Context","description":"Additional context for the flow run.","examples":[{"my_var":"my_val"}]},"empirical_policy":{"$ref":"#/components/schemas/FlowRunPolicy"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags on the flow run","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"parent_task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Run Id","description":"If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state."},"state_type":{"anyOf":[{"$ref":"#/components/schemas/StateType"},{"type":"null"}],"description":"The type of the current flow run state."},"state_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Name","description":"The name of the current flow run state."},"state_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"State Timestamp","description":"The timestamp of the current flow run state."},"run_count":{"type":"integer","title":"Run Count","description":"The number of times the flow run was executed.","default":0},"expected_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expected Start Time","description":"The flow run's expected start time."},"next_scheduled_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Scheduled Start Time","description":"The next time the flow run is scheduled to start."},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time","description":"The actual start time."},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"The actual end time."},"total_run_time":{"type":"number","title":"Total Run Time","description":"Total run time. If the flow run was executed multiple times, the time of each run will be summed.","default":0.0},"estimated_start_time_delta":{"type":"number","title":"Estimated Start Time Delta","description":"The difference between actual and expected start time.","default":0.0},"auto_scheduled":{"type":"boolean","title":"Auto Scheduled","description":"Whether or not the flow run was automatically scheduled.","default":false},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id","description":"The block document defining infrastructure to use this flow run."},"infrastructure_pid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Infrastructure Pid","description":"The id of the flow run as returned by an infrastructure block."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Optional information about the creator of this flow run."},"cancelled_by":{"anyOf":[{"$ref":"#/components/schemas/CancelledBy"},{"type":"null"}],"description":"Optional information about the actor that cancelled this flow run."},"work_queue_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Queue Id","description":"The id of the run's work pool queue."},"work_queue":{"anyOf":[{"$ref":"#/components/schemas/WorkQueue"},{"type":"null"}],"description":"The work queue that handled this flow run."},"flow":{"anyOf":[{"$ref":"#/components/schemas/Flow"},{"type":"null"}],"description":"The flow queue that handled this flow run."},"state":{"anyOf":[{"$ref":"#/components/schemas/State"},{"type":"null"}],"description":"The current state of the flow run."},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables","description":"Variables used as overrides in the base job template."},"estimated_run_time":{"type":"number","title":"Estimated Run Time","description":"A real-time estimate of the total run time.","default":0.0}},"type":"object","required":["flow_id"],"title":"FlowRunWithRunTimeField"},"FlowSort":{"type":"string","enum":["CREATED_DESC","CREATED_ASC","UPDATED_DESC","UPDATED_ASC","NAME_ASC","NAME_DESC"],"title":"FlowSort","description":"Defines flow sorting options."},"FlowUpdate":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of flow tags","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]}},"additionalProperties":false,"type":"object","title":"FlowUpdate","description":"Data used by the Prefect REST API to update a flow."},"FrequencySla":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this SLA"},"severity":{"$ref":"#/components/schemas/SlaSeverity","description":"The severity of the SLA","default":"high"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"Whether this SLA will be evaluated"},"owner_resource":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Owner Resource","description":"The resource that owns this SLA"},"stale_after":{"type":"number","title":"Stale After","description":"The amount of time after a flow run is considered stale."}},"additionalProperties":false,"type":"object","required":["name","stale_after"],"title":"FrequencySla","description":"An SLA that triggers when a flow run is stale."},"FreshnessSla":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this SLA"},"severity":{"$ref":"#/components/schemas/SlaSeverity","description":"The severity of the SLA","default":"high"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"Whether this SLA will be evaluated"},"owner_resource":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Owner Resource","description":"The resource that owns this SLA"},"within":{"type":"number","title":"Within","description":"The amount of time after a flow run is considered stale."},"resource_match":{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object","title":"Resource Match","description":"The resource to match for this SLA"},"expected_event":{"type":"string","maxLength":5000,"title":"Expected Event","description":"The event that is expected to occur within the specified time window."}},"additionalProperties":false,"type":"object","required":["name","within","resource_match","expected_event"],"title":"FreshnessSla","description":"An SLA that triggers when a flow run is stale."},"GlobalConcurrencyLimitResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"active":{"type":"boolean","title":"Active","description":"Whether the global concurrency limit is active.","default":true},"name":{"type":"string","title":"Name","description":"The name of the global concurrency limit."},"limit":{"type":"integer","title":"Limit","description":"The concurrency limit."},"active_slots":{"type":"integer","title":"Active Slots","description":"The number of active slots.","default":0},"slot_decay_per_second":{"type":"number","title":"Slot Decay Per Second","description":"The decay rate for active slots when used as a rate limit.","default":0.0}},"type":"object","required":["name","limit"],"title":"GlobalConcurrencyLimitResponse","description":"A response object for global concurrency limits."},"Graph":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"},"root_node_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Root Node Ids"},"nodes":{"items":{"prefixItems":[{"type":"string","format":"uuid"},{"$ref":"#/components/schemas/Node"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Nodes"},"artifacts":{"items":{"$ref":"#/components/schemas/GraphArtifact"},"type":"array","title":"Artifacts"},"states":{"items":{"$ref":"#/components/schemas/GraphState"},"type":"array","title":"States"}},"type":"object","required":["start_time","end_time","root_node_ids","nodes","artifacts","states"],"title":"Graph"},"GraphArtifact":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"type":"string","format":"date-time","title":"Created"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"},"type":{"type":"string","title":"Type"},"is_latest":{"type":"boolean","title":"Is Latest"},"data":{"anyOf":[{},{"type":"null"}],"title":"Data"}},"type":"object","required":["id","created","type","is_latest"],"title":"GraphArtifact"},"GraphState":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"type":{"$ref":"#/components/schemas/StateType"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","timestamp","type","name"],"title":"GraphState"},"GroupedMetricQuery":{"properties":{"after":{"type":"string","format":"date-time","title":"After","description":"The start of the time series"},"before":{"type":"string","format":"date-time","title":"Before","description":"The end of the time series, defaulting to now"},"timezone":{"type":"string","title":"Timezone","description":"The timezone to use for the time series","default":"Etc/UTC"},"resource":{"$ref":"#/components/schemas/ResourceSpecification","description":"Filter to only flow runs matching these labels"},"related":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"}],"title":"Related","description":"Filter to only flow runs with a related resource matching these labels"},"aggregates":{"items":{"anyOf":[{"$ref":"#/components/schemas/Count"},{"$ref":"#/components/schemas/CountIf"},{"$ref":"#/components/schemas/Sum"},{"$ref":"#/components/schemas/Mean"},{"$ref":"#/components/schemas/Minimum"},{"$ref":"#/components/schemas/Maximum"},{"$ref":"#/components/schemas/StandardDeviation"},{"$ref":"#/components/schemas/Quantile"},{"$ref":"#/components/schemas/Ratio"},{"$ref":"#/components/schemas/MapAggregate"}]},"type":"array","maxItems":10,"minItems":1,"title":"Aggregates","description":"The aggregate functions to apply.  The order they are specified here will determine the order of the returned data columns."},"group_by":{"type":"string","enum":["flow","deployment","work-pool","tag"],"title":"Group By","description":"The role of the related resource to group by.  There will be one result for each distinct related resource with that role in the time period, and optionally another null result for those that do not have the requested related resource."},"order_by":{"items":{"$ref":"#/components/schemas/Ordering"},"type":"array","title":"Order By","description":"The order to sort the groups by"},"limit":{"anyOf":[{"type":"integer","maximum":200.0,"minimum":1.0},{"type":"null"}],"title":"Limit","description":"The maximum number of groups to return, applied after `order_by`.  Omit it to return every group."}},"type":"object","required":["after","aggregates","group_by"],"title":"GroupedMetricQuery"},"GroupedMetricResponse":{"properties":{"metric":{"$ref":"#/components/schemas/PrefectMetric","description":"The metric that was queried"},"query":{"$ref":"#/components/schemas/GroupedMetricQuery","description":"The metric query that was executed"},"results":{"items":{"prefixItems":[{"anyOf":[{"$ref":"#/components/schemas/RelatedResource"},{"type":"null"}]},{"items":{},"type":"array"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Results","description":"The results of the query, with each item being a tuple of the Resource and the row of values of metrics in the same order as `query.aggregates`."}},"type":"object","required":["metric","query","results"],"title":"GroupedMetricResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HistoryResponse":{"properties":{"interval_start":{"type":"string","format":"date-time","title":"Interval Start","description":"The start date of the interval."},"interval_end":{"type":"string","format":"date-time","title":"Interval End","description":"The end date of the interval."},"states":{"items":{"$ref":"#/components/schemas/HistoryResponseState"},"type":"array","title":"States","description":"A list of state histories during the interval."}},"type":"object","required":["interval_start","interval_end","states"],"title":"HistoryResponse","description":"Represents a history of aggregation states over an interval"},"HistoryResponseState":{"properties":{"state_type":{"$ref":"#/components/schemas/StateType","description":"The state type."},"state_name":{"type":"string","title":"State Name","description":"The state name."},"count_runs":{"type":"integer","title":"Count Runs","description":"The number of runs in the specified state during the interval."},"sum_estimated_run_time":{"type":"number","title":"Sum Estimated Run Time","description":"The total estimated run time of all runs during the interval."},"sum_estimated_lateness":{"type":"number","title":"Sum Estimated Lateness","description":"The sum of differences between actual and expected start time during the interval."}},"type":"object","required":["state_type","state_name","count_runs","sum_estimated_run_time","sum_estimated_lateness"],"title":"HistoryResponseState","description":"Represents a single state's history over an interval."},"IntervalSchedule":{"properties":{"interval":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Interval"},"anchor_date":{"type":"string","format":"date-time","title":"Anchor Date","examples":["2020-01-01T00:00:00Z"]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","examples":["America/New_York"]}},"additionalProperties":false,"type":"object","required":["interval"],"title":"IntervalSchedule","description":"A schedule formed by adding `interval` increments to an `anchor_date`. If no\n`anchor_date` is supplied, the current UTC time is used.  If a\ntimezone-naive datetime is provided for `anchor_date`, it is assumed to be\nin the schedule's timezone (or UTC). Even if supplied with an IANA timezone,\nanchor dates are always stored as UTC offsets, so a `timezone` can be\nprovided to determine localization behaviors like DST boundary handling. If\nnone is provided it will be inferred from the anchor date.\n\nNOTE: If the `IntervalSchedule` `anchor_date` or `timezone` is provided in a\nDST-observing timezone, then the schedule will adjust itself appropriately.\nIntervals greater than 24 hours will follow DST conventions, while intervals\nof less than 24 hours will follow UTC intervals. For example, an hourly\nschedule will fire every UTC hour, even across DST boundaries. When clocks\nare set back, this will result in two runs that *appear* to both be\nscheduled for 1am local time, even though they are an hour apart in UTC\ntime. For longer intervals, like a daily schedule, the interval schedule\nwill adjust for DST boundaries so that the clock-hour remains constant. This\nmeans that a daily schedule that always fires at 9am will observe DST and\ncontinue to fire at 9am in the local time zone.\n\nArgs:\n    interval (timedelta): an interval to schedule on.\n    anchor_date (datetime, optional): an anchor date to schedule increments against;\n        if not provided, the current timestamp will be used.\n    timezone (str, optional): a valid timezone string."},"InvitationCreate":{"properties":{"email":{"type":"string","format":"email","title":"Email","description":"The email of the user to invite"},"account_role_id":{"type":"string","format":"uuid","title":"Account Role Id","description":"The role id to assign the user"}},"additionalProperties":false,"type":"object","required":["email","account_role_id"],"title":"InvitationCreate","description":"Data used by the api to create an invitation"},"InvitationFilter":{"properties":{"status":{"anyOf":[{"$ref":"#/components/schemas/InvitationFilterStatus"},{"type":"null"}],"description":"Filter criteria for Invitation.status"},"expiration":{"anyOf":[{"$ref":"#/components/schemas/InvitationFilterExpiration"},{"type":"null"}],"description":"Filter criteria for Invitation.expiration"},"email":{"anyOf":[{"$ref":"#/components/schemas/InvitationFilterEmail"},{"type":"null"}],"description":"Filter criteria for Invitation.email"}},"additionalProperties":false,"type":"object","title":"InvitationFilter"},"InvitationFilterEmail":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of invitation emails to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin-ops', 'ceo-marvin', and 'marvin-engineering'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"InvitationFilterEmail"},"InvitationFilterExpiration":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include invitations expiring at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include invitations expiring at or after this time"}},"additionalProperties":false,"type":"object","title":"InvitationFilterExpiration"},"InvitationFilterStatus":{"properties":{"any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvitationStatus"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of invitation statuses to include"}},"additionalProperties":false,"type":"object","title":"InvitationFilterStatus"},"InvitationReadResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"email":{"type":"string","format":"email","title":"Email","description":"The email of the user to invite"},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The account id"},"account_role_id":{"type":"string","format":"uuid","title":"Account Role Id","description":"The role id to assign the user"},"status":{"$ref":"#/components/schemas/InvitationStatus","description":"The invitation status"},"expiration":{"type":"string","format":"date-time","title":"Expiration","description":"The expiration time of the invite"}},"additionalProperties":false,"type":"object","required":["email","account_id","account_role_id","status","expiration"],"title":"InvitationReadResponse","description":"Data returned by the api when reading an invitation"},"InvitationStatus":{"type":"string","enum":["ACCEPTED","PENDING","REJECTED","REVOKED"],"title":"InvitationStatus","description":"Enumeration of Invitation status"},"LatenessSla":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this SLA"},"severity":{"$ref":"#/components/schemas/SlaSeverity","description":"The severity of the SLA","default":"high"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"Whether this SLA will be evaluated"},"owner_resource":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Owner Resource","description":"The resource that owns this SLA"},"within":{"type":"number","title":"Within","description":"The amount of time after a flow run is considered late."}},"additionalProperties":false,"type":"object","required":["name","within"],"title":"LatenessSla","description":"An SLA that triggers when a flow run is late."},"LatestMaterialization":{"properties":{"event_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Event Id"},"occurred":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Occurred"},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id"},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id"},"originating_workspace_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Originating Workspace Id"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"by_tools":{"items":{"type":"string"},"type":"array","title":"By Tools"},"status":{"anyOf":[{"type":"string","enum":["succeeded","failed"]},{"type":"null"}],"title":"Status"}},"type":"object","title":"LatestMaterialization"},"LatestReference":{"properties":{"event_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Event Id"},"occurred":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Occurred"},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id"},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id"},"originating_workspace_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Originating Workspace Id"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"}},"type":"object","title":"LatestReference"},"LineageResourceOccurredFilter":{"properties":{"since":{"type":"string","format":"date-time","title":"Since"},"until":{"type":"string","format":"date-time","title":"Until","description":"Only include events prior to this time (inclusive)"}},"additionalProperties":false,"type":"object","title":"LineageResourceOccurredFilter"},"Log":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","description":"The logger name."},"level":{"type":"integer","title":"Level","description":"The log level."},"message":{"type":"string","title":"Message","description":"The log message."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The log timestamp."},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run ID associated with the log."},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id","description":"The task run ID associated with the log."},"worker_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Worker Id","description":"The worker ID associated with the log."}},"type":"object","required":["name","level","message","timestamp"],"title":"Log","description":"An ORM representation of log data."},"LogCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The logger name."},"level":{"type":"integer","title":"Level","description":"The log level."},"message":{"type":"string","maxLength":25000,"title":"Message","description":"The log message."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The log timestamp."},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id"},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id"},"worker_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Worker Id"}},"additionalProperties":false,"type":"object","required":["name","level","message","timestamp"],"title":"LogCreate","description":"Data used by the Prefect REST API to create a log."},"LogFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"level":{"anyOf":[{"$ref":"#/components/schemas/LogFilterLevel"},{"type":"null"}],"description":"Filter criteria for `Log.level`"},"timestamp":{"anyOf":[{"$ref":"#/components/schemas/LogFilterTimestamp"},{"type":"null"}],"description":"Filter criteria for `Log.timestamp`"},"flow_run_id":{"anyOf":[{"$ref":"#/components/schemas/LogFilterFlowRunId"},{"type":"null"}],"description":"Filter criteria for `Log.flow_run_id`"},"task_run_id":{"anyOf":[{"$ref":"#/components/schemas/LogFilterTaskRunId"},{"type":"null"}],"description":"Filter criteria for `Log.task_run_id`"},"worker_id":{"anyOf":[{"$ref":"#/components/schemas/LogFilterWorkerId"},{"type":"null"}],"description":"Filter criteria for `Log.worker_id`"},"loggers":{"anyOf":[{"$ref":"#/components/schemas/LogFilterLoggers"},{"type":"null"}],"description":"Filter criteria for `Log.name` (logger name)"},"text":{"anyOf":[{"$ref":"#/components/schemas/LogFilterTextSearch"},{"type":"null"}],"description":"Filter criteria for text search across log content"}},"additionalProperties":false,"type":"object","title":"LogFilter","description":"Filter logs. Only logs matching all criteria will be returned"},"LogFilterFlowRunId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of flow run IDs to include"}},"additionalProperties":false,"type":"object","title":"LogFilterFlowRunId","description":"Filter by `Log.flow_run_id`."},"LogFilterLevel":{"properties":{"ge_":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ge","description":"Include logs with a level greater than or equal to this level","examples":[20]},"le_":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Le","description":"Include logs with a level less than or equal to this level","examples":[50]}},"additionalProperties":false,"type":"object","title":"LogFilterLevel","description":"Filter by `Log.level`."},"LogFilterLoggers":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of logger names to include","examples":[["prefect.flow_runs","prefect.task_runs"]]}},"additionalProperties":false,"type":"object","title":"LogFilterLoggers","description":"Filter by `Log.name` (logger name)."},"LogFilterTaskRunId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run IDs to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include logs without a task run id"}},"additionalProperties":false,"type":"object","title":"LogFilterTaskRunId","description":"Filter by `Log.task_run_id`."},"LogFilterTextSearch":{"properties":{"query":{"type":"string","maxLength":200,"title":"Query","description":"Text search query string","examples":["error","error -debug","\"connection timeout\"","+required -excluded"]}},"additionalProperties":false,"type":"object","required":["query"],"title":"LogFilterTextSearch","description":"Filter by text search across log content."},"LogFilterTimestamp":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include logs with a timestamp at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include logs with a timestamp at or after this time"}},"additionalProperties":false,"type":"object","title":"LogFilterTimestamp","description":"Filter by `Log.timestamp`."},"LogFilterWorkerId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of worker IDs to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include logs without a worker id"},"not_any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of worker IDs to exclude"}},"additionalProperties":false,"type":"object","title":"LogFilterWorkerId","description":"Filter by `Log.worker_id`."},"LogSort":{"type":"string","enum":["TIMESTAMP_ASC","TIMESTAMP_DESC"],"title":"LogSort","description":"Defines log sorting options."},"ManagedAutomationResponse":{"properties":{"type":{"$ref":"#/components/schemas/ManagedAutomationType"},"settings":{"additionalProperties":true,"type":"object","title":"Settings"},"enabled":{"type":"boolean","title":"Enabled"},"automation":{"$ref":"#/components/schemas/Automation"}},"type":"object","required":["type","settings","enabled","automation"],"title":"ManagedAutomationResponse"},"ManagedAutomationType":{"type":"string","enum":["zombie-cleanup","stuck-cancelling"],"title":"ManagedAutomationType"},"ManagedAutomationTypeResponse":{"properties":{"type":{"$ref":"#/components/schemas/ManagedAutomationType"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"defaults":{"additionalProperties":true,"type":"object","title":"Defaults"},"settings_schema":{"additionalProperties":true,"type":"object","title":"Settings Schema"}},"type":"object","required":["type","name","description","defaults","settings_schema"],"title":"ManagedAutomationTypeResponse"},"ManagedExecutionUsageGroupBy":{"type":"string","enum":["deployment","flow","work_pool","compute_profile"],"title":"ManagedExecutionUsageGroupBy"},"ManagedExecutionUsageResponse":{"properties":{"account":{"type":"string","format":"uuid","title":"Account"},"workspace":{"type":"string","format":"uuid","title":"Workspace"},"since":{"type":"string","format":"date-time","title":"Since"},"until":{"type":"string","format":"date-time","title":"Until"},"current":{"$ref":"#/components/schemas/UsageCurrent"},"total_used_seconds":{"type":"number","title":"Total Used Seconds"},"total_run_count":{"type":"integer","title":"Total Run Count"},"group_by":{"anyOf":[{"$ref":"#/components/schemas/ManagedExecutionUsageGroupBy"},{"type":"null"}]},"buckets":{"items":{"$ref":"#/components/schemas/UsageBucket"},"type":"array","title":"Buckets"},"groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/UsageResourceGroup"},"type":"array"},{"type":"null"}],"title":"Groups"}},"type":"object","required":["account","workspace","since","until","current","total_used_seconds","total_run_count","buckets"],"title":"ManagedExecutionUsageResponse"},"MapAggregate":{"properties":{"function":{"type":"string","const":"MAP_AGG","title":"Function","default":"MAP_AGG"},"key":{"type":"string","enum":["minor","low","moderate","high","critical"],"title":"Key","description":"The key to map the column to"},"aggregate":{"type":"string","enum":["SUM","MEAN","MIN","MAX","COUNT"],"title":"Aggregate","description":"The aggregate to apply"}},"type":"object","required":["key","aggregate"],"title":"MapAggregate","description":"For aggregating over a value in a map column."},"MarvinResult":{"properties":{"result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result","description":"Result returned by an LLM, if any."},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail","description":"Details about an error that occurred while running the LLM, if any."}},"type":"object","title":"MarvinResult"},"MaterializationEvent":{"properties":{"asset_key":{"type":"string","title":"Asset Key","description":"The unique key identifying the asset"},"occurred":{"type":"string","format":"date-time","title":"Occurred","description":"When the materialization occurred"},"status":{"type":"string","enum":["succeeded","failed"],"title":"Status","description":"The outcome of the materialization attempt"},"task_run_id":{"type":"string","format":"uuid","title":"Task Run Id","description":"The task run that materialized this asset"},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run context in which the materialization occurred"},"event_id":{"type":"string","format":"uuid","title":"Event Id","description":"The ID of the event that created this materialization"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Metadata about the materialization (row counts, processing times, etc.)"},"name":{"type":"string","title":"Name","description":"Human-readable name of the asset at materialization time","default":""},"url":{"type":"string","title":"Url","description":"URL associated with the asset at materialization time","default":""},"description":{"type":"string","title":"Description","description":"Description of the asset at materialization time","default":""},"owners":{"items":{"type":"string"},"type":"array","title":"Owners","description":"Owners of the asset at materialization time"},"upstream_assets":{"items":{"type":"string"},"type":"array","title":"Upstream Assets","description":"Asset keys that this materialization depended on"},"by_tools":{"items":{"type":"string"},"type":"array","title":"By Tools","description":"Tools that performed the materialization (e.g., 'dbt', 'spark')"},"originating_workspace_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Originating Workspace Id","description":"The workspace where this materialization originally occurred (for replicated assets)"}},"type":"object","required":["asset_key","occurred","status","task_run_id","event_id"],"title":"MaterializationEvent","description":"Represents a single asset materialization event.\n\nCaptures a historical snapshot of an asset materialization, including the asset's\nproperties at the time of materialization (not the current state)."},"Maximum":{"properties":{"function":{"type":"string","const":"MAX","title":"Function","default":"MAX"}},"type":"object","title":"Maximum"},"MeReadResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"handle":{"type":"string","title":"Handle","description":"A unique handle for the user, containing only lowercase letters, numbers, and dashes."},"first_name":{"type":"string","title":"First Name","description":"The first name of a user."},"last_name":{"type":"string","title":"Last Name","description":"The last name of a user."},"email":{"type":"string","format":"email","title":"Email","description":"User email."},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"An optional physical location for a user, e.g. Washington, D.C."},"personal_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Personal Account Id","description":"The user's personal account id, if it exists."},"settings":{"anyOf":[{"$ref":"#/components/schemas/UserSettings"},{"type":"null"}],"description":"The user's default color settings","default":{"tutorial_completed":false,"feature_previews":[]}}},"additionalProperties":false,"type":"object","required":["handle","first_name","last_name","email"],"title":"MeReadResponse","description":"Data returned by the api when reading the current user"},"Mean":{"properties":{"function":{"type":"string","const":"MEAN","title":"Function","default":"MEAN"}},"type":"object","title":"Mean"},"MetricTrigger":{"properties":{"type":{"type":"string","const":"metric","title":"Type","default":"metric"},"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID of this trigger"},"match":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object"}],"title":"Match","description":"Labels for resources which this trigger will match."},"match_related":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object"},{"items":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object"}]},"type":"array"}],"title":"Match Related","description":"Labels for related resources which this trigger will match."},"posture":{"type":"string","const":"Metric","title":"Posture","description":"Periodically evaluate the configured metric query.","default":"Metric"},"metric":{"$ref":"#/components/schemas/MetricTriggerQuery","description":"The metric query to evaluate for this trigger. "}},"type":"object","required":["metric"],"title":"MetricTrigger","description":"A trigger that fires based on the results of a metric query."},"MetricTriggerOperator":{"type":"string","enum":["<","<=",">",">="],"title":"MetricTriggerOperator"},"MetricTriggerQuery":{"properties":{"name":{"$ref":"#/components/schemas/PrefectMetric","description":"The name of the metric to query."},"threshold":{"type":"number","title":"Threshold","description":"The threshold value against which we'll compare the query result."},"operator":{"$ref":"#/components/schemas/MetricTriggerOperator","description":"The comparative operator (LT / LTE / GT / GTE) used to compare the query result against the threshold value."},"range":{"type":"number","title":"Range","description":"The lookback duration (seconds) for a metric query. This duration is used to determine the time range over which the query will be executed. The minimum value is 300 seconds (5 minutes).","default":300.0},"firing_for":{"type":"number","title":"Firing For","description":"The duration (seconds) for which the metric query must breach or resolve continuously before the state is updated and the automation is triggered. The minimum value is 300 seconds (5 minutes).","default":300.0}},"type":"object","required":["name","threshold","operator"],"title":"MetricTriggerQuery","description":"Defines a subset of the Trigger subclass, which is specific\nto Metric automations, that specify the query configurations\nand breaching conditions for the Automation"},"MinimalConcurrencyLimitResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["id","name","limit"],"title":"MinimalConcurrencyLimitResponse"},"MinimalFlowRun":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","description":"The name of the flow run. Defaults to a random slug if not specified.","examples":["my-flow-run"]},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The id of the flow being run."},"flow_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Version","description":"The version of the flow executed in this flow run.","examples":["1.0"]},"state_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"State Id","description":"The id of the flow run's current state."},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The deployment associated with this flow run"},"deployment_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Version Id","description":"The deployment version associated with this flow run."},"deployment_version_info":{"anyOf":[{"$ref":"#/components/schemas/VersionInfo"},{"type":"null"}],"description":"The version info of the deployment associated with this flow run."},"deployment_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deployment Version","description":"The version of the deployment associated with this flow run.","examples":["1.0"]},"work_queue_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Queue Name","description":"The work queue that handled this flow run."},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"Parameters for the flow run."},"idempotency_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency Key","description":"An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times."},"context":{"additionalProperties":true,"type":"object","title":"Context","description":"Additional context for the flow run.","examples":[{"my_var":"my_val"}]},"empirical_policy":{"$ref":"#/components/schemas/FlowRunPolicy"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags on the flow run","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"parent_task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Task Run Id","description":"If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state."},"state_type":{"anyOf":[{"$ref":"#/components/schemas/StateType"},{"type":"null"}],"description":"The type of the current flow run state."},"state_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Name","description":"The name of the current flow run state."},"state_timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"State Timestamp","description":"The timestamp of the current flow run state."},"run_count":{"type":"integer","title":"Run Count","description":"The number of times the flow run was executed.","default":0},"expected_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expected Start Time","description":"The flow run's expected start time."},"next_scheduled_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Scheduled Start Time","description":"The next time the flow run is scheduled to start."},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time","description":"The actual start time."},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"The actual end time."},"total_run_time":{"type":"number","title":"Total Run Time","description":"Total run time. If the flow run was executed multiple times, the time of each run will be summed.","default":0.0},"estimated_start_time_delta":{"type":"number","title":"Estimated Start Time Delta","description":"The difference between actual and expected start time.","default":0.0},"auto_scheduled":{"type":"boolean","title":"Auto Scheduled","description":"Whether or not the flow run was automatically scheduled.","default":false},"infrastructure_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Infrastructure Document Id","description":"The block document defining infrastructure to use this flow run."},"infrastructure_pid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Infrastructure Pid","description":"The id of the flow run as returned by an infrastructure block."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Optional information about the creator of this flow run."},"cancelled_by":{"anyOf":[{"$ref":"#/components/schemas/CancelledBy"},{"type":"null"}],"description":"Optional information about the actor that cancelled this flow run."},"work_queue_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Queue Id","description":"The id of the run's work pool queue."},"work_queue":{"anyOf":[{"$ref":"#/components/schemas/WorkQueue"},{"type":"null"}],"description":"The work queue that handled this flow run."},"flow":{"anyOf":[{"$ref":"#/components/schemas/Flow"},{"type":"null"}],"description":"The flow queue that handled this flow run."},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables","description":"Variables used as overrides in the base job template."}},"type":"object","required":["flow_id"],"title":"MinimalFlowRun","description":"An ORM representation a flow run for use by the UI.\n\nThis representation does not include state data, to improve\nperformance of flow run-related APIs."},"Minimum":{"properties":{"function":{"type":"string","const":"MIN","title":"Function","default":"MIN"}},"type":"object","title":"Minimum"},"Node":{"properties":{"kind":{"type":"string","enum":["flow-run","task-run"],"title":"Kind"},"id":{"type":"string","format":"uuid","title":"Id"},"label":{"type":"string","title":"Label"},"state_type":{"$ref":"#/components/schemas/StateType"},"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"},"parents":{"items":{"$ref":"#/components/schemas/Edge"},"type":"array","title":"Parents"},"children":{"items":{"$ref":"#/components/schemas/Edge"},"type":"array","title":"Children"},"encapsulating":{"items":{"$ref":"#/components/schemas/Edge"},"type":"array","title":"Encapsulating"},"artifacts":{"items":{"$ref":"#/components/schemas/GraphArtifact"},"type":"array","title":"Artifacts"}},"type":"object","required":["kind","id","label","state_type","start_time","end_time","parents","children","encapsulating","artifacts"],"title":"Node"},"ObjectActorAccess":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}],"title":"Id","description":"The actor id."},"name":{"type":"string","title":"Name","description":"The actor name."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The actor email if they're a user, otherwise None."},"type":{"type":"string","enum":["user","service_account","team","*"],"title":"Type","description":"The actor type."}},"type":"object","required":["id","name","email","type"],"title":"ObjectActorAccess","description":"Data describing an actor with object-level access."},"ObservedLogger":{"properties":{"logger_name":{"type":"string","title":"Logger Name","description":"The logger name"},"count":{"type":"integer","title":"Count","description":"Number of log entries from this logger"},"first_seen":{"type":"string","format":"date-time","title":"First Seen","description":"When this logger was first observed"},"last_seen":{"type":"string","format":"date-time","title":"Last Seen","description":"When this logger was last observed"}},"type":"object","required":["logger_name","count","first_seen","last_seen"],"title":"ObservedLogger","description":"An observed logger name from logs."},"ObservedLoggerSort":{"type":"string","enum":["NAME_ASC","LAST_SEEN_DESC"],"title":"ObservedLoggerSort","description":"Defines observed logger sorting options."},"ObservedState":{"properties":{"state_type":{"type":"string","title":"State Type","description":"The state type (e.g., 'COMPLETED', 'FAILED')"},"state_name":{"type":"string","title":"State Name","description":"The state name (e.g., 'Completed', 'Failed', 'Cancelled')"},"first_seen":{"type":"string","format":"date-time","title":"First Seen","description":"When this state combination was first observed"},"last_seen":{"type":"string","format":"date-time","title":"Last Seen","description":"When this state combination was last observed"}},"type":"object","required":["state_type","state_name","first_seen","last_seen"],"title":"ObservedState","description":"An observed state type/name combination from spans."},"ObservedStateSort":{"type":"string","enum":["NAME_ASC","LAST_SEEN_DESC"],"title":"ObservedStateSort","description":"Defines observed state sorting options."},"ObservedTag":{"properties":{"tag":{"type":"string","title":"Tag","description":"The tag name"},"count":{"type":"integer","title":"Count","description":"Number of spans with this tag in the trace"}},"type":"object","required":["tag","count"],"title":"ObservedTag","description":"An observed tag from spans within a trace."},"Operator":{"type":"string","enum":["and_","or_"],"title":"Operator","description":"Operators for combining filter criteria."},"OrchestrationResult":{"properties":{"state":{"anyOf":[{"$ref":"#/components/schemas/State"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/SetStateStatus"},"details":{"anyOf":[{"$ref":"#/components/schemas/StateAcceptDetails"},{"$ref":"#/components/schemas/StateWaitDetails"},{"$ref":"#/components/schemas/StateRejectDetails"},{"$ref":"#/components/schemas/StateAbortDetails"}],"title":"Details"}},"type":"object","required":["state","status","details"],"title":"OrchestrationResult","description":"A container for the output of state orchestration."},"Ordering":{"properties":{"aggregate":{"type":"integer","title":"Aggregate","description":"The index of the aggregate to order by"},"direction":{"type":"string","enum":["ASC","DESC"],"title":"Direction","description":"The direction to sort the results by","default":"DESC"}},"type":"object","required":["aggregate"],"title":"Ordering"},"Parameter":{"properties":{"input_type":{"type":"string","const":"parameter","title":"Input Type","default":"parameter"},"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"Parameter","description":"Represents a parameter input to a task run."},"PauseAutomation":{"properties":{"type":{"type":"string","const":"pause-automation","title":"Type","default":"pause-automation"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected automation (given by `automation_id`), or to an automation that is inferred from the triggering event.  If the source is 'inferred', the `automation_id` may not be set.  If the source is 'selected', the `automation_id` must be set.","default":"selected"},"automation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Automation Id","description":"The identifier of the automation to act on"}},"type":"object","title":"PauseAutomation","description":"Pauses a Work Queue"},"PauseDeployment":{"properties":{"type":{"type":"string","const":"pause-deployment","title":"Type","default":"pause-deployment"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected deployment (given by `deployment_id`), or to a deployment that is inferred from the triggering event.  If the source is 'inferred', the `deployment_id` may not be set.  If the source is 'selected', the `deployment_id` must be set.","default":"selected"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The identifier of the deployment"}},"type":"object","title":"PauseDeployment","description":"Pauses the given Deployment"},"PauseScheduleForFlowRun":{"properties":{"type":{"type":"string","const":"pause-schedule-for-flow-run","title":"Type","default":"pause-schedule-for-flow-run"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The identifier of the deployment"},"schedule_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Schedule Id","description":"The identifier of the schedule"}},"type":"object","title":"PauseScheduleForFlowRun","description":"Pauses the schedule for a flow run associated with the trigger"},"PauseWorkPool":{"properties":{"type":{"type":"string","const":"pause-work-pool","title":"Type","default":"pause-work-pool"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected work pool (given by `work_pool_id`), or to a work pool that is inferred from the triggering event.  If the source is 'inferred', the `work_pool_id` may not be set.  If the source is 'selected', the `work_pool_id` must be set.","default":"selected"},"work_pool_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Pool Id","description":"The identifier of the work pool to pause"}},"type":"object","title":"PauseWorkPool","description":"Pauses a Work Pool"},"PauseWorkQueue":{"properties":{"type":{"type":"string","const":"pause-work-queue","title":"Type","default":"pause-work-queue"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected work queue (given by `work_queue_id`), or to a work queue that is inferred from the triggering event.  If the source is 'inferred', the `work_queue_id` may not be set.  If the source is 'selected', the `work_queue_id` must be set.","default":"selected"},"work_queue_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Queue Id","description":"The identifier of the work queue to pause"}},"type":"object","title":"PauseWorkQueue","description":"Pauses a Work Queue"},"PendingClaim":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"execution_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Execution Id"},"timeout_seconds":{"type":"integer","exclusiveMinimum":0.0,"title":"Timeout Seconds"},"max_timeouts":{"type":"integer","exclusiveMinimum":0.0,"title":"Max Timeouts"}},"type":"object","required":["id","timeout_seconds","max_timeouts"],"title":"PendingClaim","description":"Server-resolved ownership metadata for an active pending attempt."},"PendingClaimCreate":{"properties":{"id":{"type":"string","format":"uuid7","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"PendingClaimCreate","description":"Client-authored identity for a claim-scoped PENDING proposal."},"PendingClaimPolicy":{"properties":{"mode":{"anyOf":[{"type":"string","enum":["auto","enabled","disabled"]},{"type":"null"}],"title":"Mode"},"timeout":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Timeout"},"max_timeouts":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Timeouts"}},"type":"object","title":"PendingClaimPolicy","description":"Partial pending-claim policy stored on an operational owner."},"PendingClaimPolicyInput":{"properties":{"mode":{"anyOf":[{"type":"string","enum":["auto","enabled","disabled"]},{"type":"null"}],"title":"Mode"},"timeout":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Timeout"},"max_timeouts":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Timeouts"}},"additionalProperties":false,"type":"object","title":"PendingClaimPolicyInput","description":"Strict client-authored pending-claim policy override."},"PinnableResourceType":{"type":"string","enum":["flow","deployment","work_pool"],"title":"PinnableResourceType","description":"Resource types that can be pinned by users."},"PrefectMetric":{"type":"string","enum":["lateness","duration","successes","volume","sla_violations","sla_violations_by_severity"],"title":"PrefectMetric"},"PublicationCreate":{"properties":{"event":{"items":{"type":"string"},"type":"array","title":"Event"},"resource":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Resource"},"related":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Related"}},"type":"object","required":["event"],"title":"PublicationCreate","description":"POST body for creating a publication."},"PublicationPage":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PublicationResponse"},"type":"array","title":"Results"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["results"],"title":"PublicationPage","description":"Paginated list of publications with an opaque cursor for the next page."},"PublicationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"account_id":{"type":"string","format":"uuid","title":"Account Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"enabled":{"type":"boolean","title":"Enabled"},"event":{"items":{"type":"string"},"type":"array","title":"Event"},"resource":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Resource"},"related":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Related"},"created":{"type":"string","format":"date-time","title":"Created"},"updated":{"type":"string","format":"date-time","title":"Updated"},"subscriber_count":{"type":"integer","title":"Subscriber Count","default":0}},"type":"object","required":["id","account_id","workspace_id","enabled","event","created","updated"],"title":"PublicationResponse","description":"Response model for a publication."},"PublicationSubscriber":{"properties":{"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"subscription_id":{"type":"string","format":"uuid","title":"Subscription Id"},"enabled":{"type":"boolean","title":"Enabled"}},"type":"object","required":["workspace_id","subscription_id","enabled"],"title":"PublicationSubscriber","description":"Summary of a workspace that subscribes to a publication."},"PublicationSubscriberPage":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PublicationSubscriber"},"type":"array","title":"Results"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["results"],"title":"PublicationSubscriberPage","description":"Paginated list of subscribers to a publication."},"PublicationUpdate":{"properties":{"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled"},"event":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event"},"resource":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Resource"},"related":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Related"}},"type":"object","title":"PublicationUpdate","description":"PATCH body — all fields optional, only provided fields are updated."},"Quantile":{"properties":{"function":{"type":"string","const":"QUANTILE","title":"Function","default":"QUANTILE"},"level":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Level","description":"The quantile level to compute"}},"type":"object","required":["level"],"title":"Quantile"},"QueueFilter":{"properties":{"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Only include flow runs with these tags in the work queue."},"deployment_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Deployment Ids","description":"Only include flow runs from these deployments in the work queue."}},"type":"object","title":"QueueFilter","description":"Filter criteria definition for a work queue."},"RRuleSchedule":{"properties":{"rrule":{"type":"string","title":"Rrule"},"timezone":{"type":"string","pattern":"Africa/Abidjan|Africa/Accra|Africa/Addis_Ababa|Africa/Algiers|Africa/Asmara|Africa/Asmera|Africa/Bamako|Africa/Bangui|Africa/Banjul|Africa/Bissau|Africa/Blantyre|Africa/Brazzaville|Africa/Bujumbura|Africa/Cairo|Africa/Casablanca|Africa/Ceuta|Africa/Conakry|Africa/Dakar|Africa/Dar_es_Salaam|Africa/Djibouti|Africa/Douala|Africa/El_Aaiun|Africa/Freetown|Africa/Gaborone|Africa/Harare|Africa/Johannesburg|Africa/Juba|Africa/Kampala|Africa/Khartoum|Africa/Kigali|Africa/Kinshasa|Africa/Lagos|Africa/Libreville|Africa/Lome|Africa/Luanda|Africa/Lubumbashi|Africa/Lusaka|Africa/Malabo|Africa/Maputo|Africa/Maseru|Africa/Mbabane|Africa/Mogadishu|Africa/Monrovia|Africa/Nairobi|Africa/Ndjamena|Africa/Niamey|Africa/Nouakchott|Africa/Ouagadougou|Africa/Porto-Novo|Africa/Sao_Tome|Africa/Timbuktu|Africa/Tripoli|Africa/Tunis|Africa/Windhoek|America/Adak|America/Anchorage|America/Anguilla|America/Antigua|America/Araguaina|America/Argentina/Buenos_Aires|America/Argentina/Catamarca|America/Argentina/ComodRivadavia|America/Argentina/Cordoba|America/Argentina/Jujuy|America/Argentina/La_Rioja|America/Argentina/Mendoza|America/Argentina/Rio_Gallegos|America/Argentina/Salta|America/Argentina/San_Juan|America/Argentina/San_Luis|America/Argentina/Tucuman|America/Argentina/Ushuaia|America/Aruba|America/Asuncion|America/Atikokan|America/Atka|America/Bahia|America/Bahia_Banderas|America/Barbados|America/Belem|America/Belize|America/Blanc-Sablon|America/Boa_Vista|America/Bogota|America/Boise|America/Buenos_Aires|America/Cambridge_Bay|America/Campo_Grande|America/Cancun|America/Caracas|America/Catamarca|America/Cayenne|America/Cayman|America/Chicago|America/Chihuahua|America/Ciudad_Juarez|America/Coral_Harbour|America/Cordoba|America/Costa_Rica|America/Coyhaique|America/Creston|America/Cuiaba|America/Curacao|America/Danmarkshavn|America/Dawson|America/Dawson_Creek|America/Denver|America/Detroit|America/Dominica|America/Edmonton|America/Eirunepe|America/El_Salvador|America/Ensenada|America/Fort_Nelson|America/Fort_Wayne|America/Fortaleza|America/Glace_Bay|America/Godthab|America/Goose_Bay|America/Grand_Turk|America/Grenada|America/Guadeloupe|America/Guatemala|America/Guayaquil|America/Guyana|America/Halifax|America/Havana|America/Hermosillo|America/Indiana/Indianapolis|America/Indiana/Knox|America/Indiana/Marengo|America/Indiana/Petersburg|America/Indiana/Tell_City|America/Indiana/Vevay|America/Indiana/Vincennes|America/Indiana/Winamac|America/Indianapolis|America/Inuvik|America/Iqaluit|America/Jamaica|America/Jujuy|America/Juneau|America/Kentucky/Louisville|America/Kentucky/Monticello|America/Knox_IN|America/Kralendijk|America/La_Paz|America/Lima|America/Los_Angeles|America/Louisville|America/Lower_Princes|America/Maceio|America/Managua|America/Manaus|America/Marigot|America/Martinique|America/Matamoros|America/Mazatlan|America/Mendoza|America/Menominee|America/Merida|America/Metlakatla|America/Mexico_City|America/Miquelon|America/Moncton|America/Monterrey|America/Montevideo|America/Montreal|America/Montserrat|America/Nassau|America/New_York|America/Nipigon|America/Nome|America/Noronha|America/North_Dakota/Beulah|America/North_Dakota/Center|America/North_Dakota/New_Salem|America/Nuuk|America/Ojinaga|America/Panama|America/Pangnirtung|America/Paramaribo|America/Phoenix|America/Port-au-Prince|America/Port_of_Spain|America/Porto_Acre|America/Porto_Velho|America/Puerto_Rico|America/Punta_Arenas|America/Rainy_River|America/Rankin_Inlet|America/Recife|America/Regina|America/Resolute|America/Rio_Branco|America/Rosario|America/Santa_Isabel|America/Santarem|America/Santiago|America/Santo_Domingo|America/Sao_Paulo|America/Scoresbysund|America/Shiprock|America/Sitka|America/St_Barthelemy|America/St_Johns|America/St_Kitts|America/St_Lucia|America/St_Thomas|America/St_Vincent|America/Swift_Current|America/Tegucigalpa|America/Thule|America/Thunder_Bay|America/Tijuana|America/Toronto|America/Tortola|America/Vancouver|America/Virgin|America/Whitehorse|America/Winnipeg|America/Yakutat|America/Yellowknife|Antarctica/Casey|Antarctica/Davis|Antarctica/DumontDUrville|Antarctica/Macquarie|Antarctica/Mawson|Antarctica/McMurdo|Antarctica/Palmer|Antarctica/Rothera|Antarctica/South_Pole|Antarctica/Syowa|Antarctica/Troll|Antarctica/Vostok|Arctic/Longyearbyen|Asia/Aden|Asia/Almaty|Asia/Amman|Asia/Anadyr|Asia/Aqtau|Asia/Aqtobe|Asia/Ashgabat|Asia/Ashkhabad|Asia/Atyrau|Asia/Baghdad|Asia/Bahrain|Asia/Baku|Asia/Bangkok|Asia/Barnaul|Asia/Beirut|Asia/Bishkek|Asia/Brunei|Asia/Calcutta|Asia/Chita|Asia/Choibalsan|Asia/Chongqing|Asia/Chungking|Asia/Colombo|Asia/Dacca|Asia/Damascus|Asia/Dhaka|Asia/Dili|Asia/Dubai|Asia/Dushanbe|Asia/Famagusta|Asia/Gaza|Asia/Harbin|Asia/Hebron|Asia/Ho_Chi_Minh|Asia/Hong_Kong|Asia/Hovd|Asia/Irkutsk|Asia/Istanbul|Asia/Jakarta|Asia/Jayapura|Asia/Jerusalem|Asia/Kabul|Asia/Kamchatka|Asia/Karachi|Asia/Kashgar|Asia/Kathmandu|Asia/Katmandu|Asia/Khandyga|Asia/Kolkata|Asia/Krasnoyarsk|Asia/Kuala_Lumpur|Asia/Kuching|Asia/Kuwait|Asia/Macao|Asia/Macau|Asia/Magadan|Asia/Makassar|Asia/Manila|Asia/Muscat|Asia/Nicosia|Asia/Novokuznetsk|Asia/Novosibirsk|Asia/Omsk|Asia/Oral|Asia/Phnom_Penh|Asia/Pontianak|Asia/Pyongyang|Asia/Qatar|Asia/Qostanay|Asia/Qyzylorda|Asia/Rangoon|Asia/Riyadh|Asia/Saigon|Asia/Sakhalin|Asia/Samarkand|Asia/Seoul|Asia/Shanghai|Asia/Singapore|Asia/Srednekolymsk|Asia/Taipei|Asia/Tashkent|Asia/Tbilisi|Asia/Tehran|Asia/Tel_Aviv|Asia/Thimbu|Asia/Thimphu|Asia/Tokyo|Asia/Tomsk|Asia/Ujung_Pandang|Asia/Ulaanbaatar|Asia/Ulan_Bator|Asia/Urumqi|Asia/Ust-Nera|Asia/Vientiane|Asia/Vladivostok|Asia/Yakutsk|Asia/Yangon|Asia/Yekaterinburg|Asia/Yerevan|Atlantic/Azores|Atlantic/Bermuda|Atlantic/Canary|Atlantic/Cape_Verde|Atlantic/Faeroe|Atlantic/Faroe|Atlantic/Jan_Mayen|Atlantic/Madeira|Atlantic/Reykjavik|Atlantic/South_Georgia|Atlantic/St_Helena|Atlantic/Stanley|Australia/ACT|Australia/Adelaide|Australia/Brisbane|Australia/Broken_Hill|Australia/Canberra|Australia/Currie|Australia/Darwin|Australia/Eucla|Australia/Hobart|Australia/LHI|Australia/Lindeman|Australia/Lord_Howe|Australia/Melbourne|Australia/NSW|Australia/North|Australia/Perth|Australia/Queensland|Australia/South|Australia/Sydney|Australia/Tasmania|Australia/Victoria|Australia/West|Australia/Yancowinna|Brazil/Acre|Brazil/DeNoronha|Brazil/East|Brazil/West|CET|CST6CDT|Canada/Atlantic|Canada/Central|Canada/Eastern|Canada/Mountain|Canada/Newfoundland|Canada/Pacific|Canada/Saskatchewan|Canada/Yukon|Chile/Continental|Chile/EasterIsland|Cuba|EET|EST|EST5EDT|Egypt|Eire|Etc/GMT|Etc/GMT+0|Etc/GMT+1|Etc/GMT+10|Etc/GMT+11|Etc/GMT+12|Etc/GMT+2|Etc/GMT+3|Etc/GMT+4|Etc/GMT+5|Etc/GMT+6|Etc/GMT+7|Etc/GMT+8|Etc/GMT+9|Etc/GMT-0|Etc/GMT-1|Etc/GMT-10|Etc/GMT-11|Etc/GMT-12|Etc/GMT-13|Etc/GMT-14|Etc/GMT-2|Etc/GMT-3|Etc/GMT-4|Etc/GMT-5|Etc/GMT-6|Etc/GMT-7|Etc/GMT-8|Etc/GMT-9|Etc/GMT0|Etc/Greenwich|Etc/UCT|Etc/UTC|Etc/Universal|Etc/Zulu|Europe/Amsterdam|Europe/Andorra|Europe/Astrakhan|Europe/Athens|Europe/Belfast|Europe/Belgrade|Europe/Berlin|Europe/Bratislava|Europe/Brussels|Europe/Bucharest|Europe/Budapest|Europe/Busingen|Europe/Chisinau|Europe/Copenhagen|Europe/Dublin|Europe/Gibraltar|Europe/Guernsey|Europe/Helsinki|Europe/Isle_of_Man|Europe/Istanbul|Europe/Jersey|Europe/Kaliningrad|Europe/Kiev|Europe/Kirov|Europe/Kyiv|Europe/Lisbon|Europe/Ljubljana|Europe/London|Europe/Luxembourg|Europe/Madrid|Europe/Malta|Europe/Mariehamn|Europe/Minsk|Europe/Monaco|Europe/Moscow|Europe/Nicosia|Europe/Oslo|Europe/Paris|Europe/Podgorica|Europe/Prague|Europe/Riga|Europe/Rome|Europe/Samara|Europe/San_Marino|Europe/Sarajevo|Europe/Saratov|Europe/Simferopol|Europe/Skopje|Europe/Sofia|Europe/Stockholm|Europe/Tallinn|Europe/Tirane|Europe/Tiraspol|Europe/Ulyanovsk|Europe/Uzhgorod|Europe/Vaduz|Europe/Vatican|Europe/Vienna|Europe/Vilnius|Europe/Volgograd|Europe/Warsaw|Europe/Zagreb|Europe/Zaporozhye|Europe/Zurich|Factory|GB|GB-Eire|GMT|GMT+0|GMT-0|GMT0|Greenwich|HST|Hongkong|Iceland|Indian/Antananarivo|Indian/Chagos|Indian/Christmas|Indian/Cocos|Indian/Comoro|Indian/Kerguelen|Indian/Mahe|Indian/Maldives|Indian/Mauritius|Indian/Mayotte|Indian/Reunion|Iran|Israel|Jamaica|Japan|Kwajalein|Libya|MET|MST|MST7MDT|Mexico/BajaNorte|Mexico/BajaSur|Mexico/General|NZ|NZ-CHAT|Navajo|PRC|PST8PDT|Pacific/Apia|Pacific/Auckland|Pacific/Bougainville|Pacific/Chatham|Pacific/Chuuk|Pacific/Easter|Pacific/Efate|Pacific/Enderbury|Pacific/Fakaofo|Pacific/Fiji|Pacific/Funafuti|Pacific/Galapagos|Pacific/Gambier|Pacific/Guadalcanal|Pacific/Guam|Pacific/Honolulu|Pacific/Johnston|Pacific/Kanton|Pacific/Kiritimati|Pacific/Kosrae|Pacific/Kwajalein|Pacific/Majuro|Pacific/Marquesas|Pacific/Midway|Pacific/Nauru|Pacific/Niue|Pacific/Norfolk|Pacific/Noumea|Pacific/Pago_Pago|Pacific/Palau|Pacific/Pitcairn|Pacific/Pohnpei|Pacific/Ponape|Pacific/Port_Moresby|Pacific/Rarotonga|Pacific/Saipan|Pacific/Samoa|Pacific/Tahiti|Pacific/Tarawa|Pacific/Tongatapu|Pacific/Truk|Pacific/Wake|Pacific/Wallis|Pacific/Yap|Poland|Portugal|ROC|ROK|Singapore|Turkey|UCT|US/Alaska|US/Aleutian|US/Arizona|US/Central|US/East-Indiana|US/Eastern|US/Hawaii|US/Indiana-Starke|US/Michigan|US/Mountain|US/Pacific|US/Samoa|UTC|Universal|W-SU|WET|Zulu","title":"Timezone","default":"UTC","examples":["America/New_York"]}},"additionalProperties":false,"type":"object","required":["rrule"],"title":"RRuleSchedule","description":"RRule schedule, based on the iCalendar standard\n([RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545)) as\nimplemented in `dateutils.rrule`.\n\nRRules are appropriate for any kind of calendar-date manipulation, including\nirregular intervals, repetition, exclusions, week day or day-of-month\nadjustments, and more.\n\nNote that as a calendar-oriented standard, `RRuleSchedules` are sensitive to\nto the initial timezone provided. A 9am daily schedule with a daylight saving\ntime-aware start date will maintain a local 9am time through DST boundaries;\na 9am daily schedule with a UTC start date will maintain a 9am UTC time.\n\nArgs:\n    rrule (str): a valid RRule string\n    timezone (str, optional): a valid timezone string"},"RateLimitGroupedUsageByGroup":{"properties":{"requested":{"items":{"type":"integer"},"type":"array","title":"Requested","description":"Tokens requested per minute"},"granted":{"items":{"type":"integer"},"type":"array","title":"Granted","description":"Tokens granted per minute"}},"type":"object","required":["requested","granted"],"title":"RateLimitGroupedUsageByGroup","description":"Usage data for a single group over time."},"RateLimitGroupedUsageResponse":{"properties":{"account":{"type":"string","format":"uuid","title":"Account","description":"The account UUID"},"since":{"type":"string","format":"date-time","title":"Since","description":"Start of the time range"},"until":{"type":"string","format":"date-time","title":"Until","description":"End of the time range"},"limit":{"type":"integer","title":"Limit","description":"Account rate limit (applies to all groups combined)"},"minutes":{"items":{"type":"string","format":"date-time"},"type":"array","title":"Minutes","description":"List of minute timestamps"},"groups":{"additionalProperties":{"$ref":"#/components/schemas/RateLimitGroupedUsageByGroup"},"type":"object","title":"Groups","description":"Usage data keyed by group value (the dimension value)"}},"type":"object","required":["account","since","until","limit","minutes","groups"],"title":"RateLimitGroupedUsageResponse","description":"Response model for rate limit usage grouped by a dimension over time."},"RateLimitStatusResponse":{"properties":{"exceeded_buckets":{"items":{"type":"string"},"type":"array","title":"Exceeded Buckets","description":"Rate limit buckets currently exceeded (e.g., 'orchestration-api', 'logs-and-events')"}},"type":"object","required":["exceeded_buckets"],"title":"RateLimitStatusResponse","description":"Current rate limit exceeded status for an account."},"RateLimitUsageByKey":{"properties":{"limit":{"items":{"type":"integer"},"type":"array","title":"Limit"},"usage":{"items":{"type":"integer"},"type":"array","title":"Usage"},"requested":{"items":{"type":"integer"},"type":"array","title":"Requested"},"granted":{"items":{"type":"integer"},"type":"array","title":"Granted"}},"type":"object","required":["limit","usage","requested","granted"],"title":"RateLimitUsageByKey"},"RateLimitUsageResponse":{"properties":{"account":{"type":"string","format":"uuid","title":"Account"},"since":{"type":"string","format":"date-time","title":"Since"},"until":{"type":"string","format":"date-time","title":"Until"},"minutes":{"items":{"type":"string","format":"date-time"},"type":"array","title":"Minutes"},"keys":{"additionalProperties":{"$ref":"#/components/schemas/RateLimitUsageByKey"},"type":"object","title":"Keys"}},"type":"object","required":["account","since","until","minutes","keys"],"title":"RateLimitUsageResponse"},"Ratio":{"properties":{"function":{"type":"string","const":"RATIO","title":"Function","default":"RATIO"},"numerator":{"anyOf":[{"$ref":"#/components/schemas/Count"},{"$ref":"#/components/schemas/CountIf"},{"$ref":"#/components/schemas/Sum"},{"$ref":"#/components/schemas/Mean"},{"$ref":"#/components/schemas/Minimum"},{"$ref":"#/components/schemas/Maximum"},{"$ref":"#/components/schemas/StandardDeviation"},{"$ref":"#/components/schemas/Quantile"}],"title":"Numerator","description":"The numerator of the ratio"},"denominator":{"anyOf":[{"$ref":"#/components/schemas/Count"},{"$ref":"#/components/schemas/CountIf"},{"$ref":"#/components/schemas/Sum"},{"$ref":"#/components/schemas/Mean"},{"$ref":"#/components/schemas/Minimum"},{"$ref":"#/components/schemas/Maximum"},{"$ref":"#/components/schemas/StandardDeviation"},{"$ref":"#/components/schemas/Quantile"}],"title":"Denominator","description":"The denominator of the ratio"}},"type":"object","required":["numerator","denominator"],"title":"Ratio"},"ReceivedEvent":{"properties":{"occurred":{"type":"string","format":"date-time","title":"Occurred","description":"When the event happened from the sender's perspective"},"event":{"type":"string","maxLength":1024,"title":"Event","description":"The name of the event that happened"},"resource":{"$ref":"#/components/schemas/Resource","description":"The primary Resource this event concerns"},"related":{"items":{"$ref":"#/components/schemas/RelatedResource"},"type":"array","title":"Related","description":"A list of additional Resources involved in this event"},"payload":{"additionalProperties":true,"type":"object","title":"Payload","description":"An open-ended set of data describing what happened"},"id":{"type":"string","format":"uuid","title":"Id","description":"The client-provided identifier of this event"},"follows":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Follows","description":"The ID of an event that is known to have occurred prior to this one. If set, this may be used to establish a more precise ordering of causally-related events when they occur close enough together in time that the system may receive them out-of-order."},"account":{"type":"string","format":"uuid","title":"Account","description":"The Prefect Cloud Account for which this event happened"},"workspace":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace","description":"The optional Prefect Cloud Workspace in which this event happened"},"received":{"type":"string","format":"date-time","title":"Received","description":"When the event was received by Prefect Cloud"}},"type":"object","required":["occurred","event","resource","id","account"],"title":"ReceivedEvent","description":"The server-side view of an event that has happened to a Resource after it has\nbeen received by the server in the context of an account and optional workspace"},"ReferenceEvent":{"properties":{"asset_key":{"type":"string","title":"Asset Key","description":"The unique key identifying the asset"},"occurred":{"type":"string","format":"date-time","title":"Occurred","description":"When the asset was referenced"},"task_run_id":{"type":"string","format":"uuid","title":"Task Run Id","description":"The task run that referenced this asset"},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run context in which the reference occurred"},"event_id":{"type":"string","format":"uuid","title":"Event Id","description":"The ID of the event that created this reference"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Metadata about the reference event"},"name":{"type":"string","title":"Name","description":"Human-readable name of the asset at reference time","default":""},"url":{"type":"string","title":"Url","description":"URL associated with the asset at reference time","default":""},"description":{"type":"string","title":"Description","description":"Description of the asset at reference time","default":""},"owners":{"items":{"type":"string"},"type":"array","title":"Owners","description":"Owners of the asset at reference time"},"originating_workspace_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Originating Workspace Id","description":"The workspace where this reference originally occurred (for replicated assets)"}},"type":"object","required":["asset_key","occurred","task_run_id","event_id"],"title":"ReferenceEvent","description":"Represents a single asset reference event.\n\nCaptures when an asset was referenced/read during a run, including the asset's\nproperties at the time of reference (not the current state)."},"RelatedResource":{"additionalProperties":{"type":"string"},"type":"object","title":"RelatedResource","description":"A Resource with a specific role in an Event"},"RelatedResourcePage":{"properties":{"resources":{"items":{"$ref":"#/components/schemas/RelatedResourceResult"},"type":"array","title":"Resources","description":"The Resources that were interacted with"},"total":{"type":"integer","title":"Total","description":"The total number of matching Resources"},"next_page":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Next Page","description":"The URL for the next page of results, if there are more"}},"type":"object","required":["resources","total","next_page"],"title":"RelatedResourcePage"},"RelatedResourceResult":{"properties":{"direction":{"type":"string","enum":["upstream","downstream"],"title":"Direction","description":"The direction of the interaction"},"resources":{"items":{"$ref":"#/components/schemas/Resource"},"type":"array","title":"Resources","description":"The Resources that were interacted with"}},"type":"object","required":["direction","resources"],"title":"RelatedResourceResult"},"ReplaceBlockDocumentAccess":{"properties":{"manage_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"Manage Actor Ids","description":"The list of actor IDs to grant `manage` access to."},"view_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"View Actor Ids","description":"The list of actor IDs to grant `view` access to."},"manage_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Manage Team Ids","description":"The list of team IDs to grant `manage` access to."},"view_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"View Team Ids","description":"The list of team IDs to grant `view` access to."}},"additionalProperties":false,"type":"object","required":["manage_actor_ids","view_actor_ids"],"title":"ReplaceBlockDocumentAccess","description":"Data used to replace the existing block document access."},"ReplaceDeploymentAccess":{"properties":{"manage_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"Manage Actor Ids","description":"The list of actor IDs to grant `manage` access to."},"run_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"Run Actor Ids","description":"The list of actor IDs to grant `run` access to."},"view_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"View Actor Ids","description":"The list of actor IDs to grant `view` access to."},"manage_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Manage Team Ids","description":"The list of team IDs to grant `manage` access to."},"run_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Run Team Ids","description":"The list of team IDs to grant `run` access to."},"view_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"View Team Ids","description":"The list of team IDs to grant `view` access to."}},"additionalProperties":false,"type":"object","required":["manage_actor_ids","run_actor_ids","view_actor_ids"],"title":"ReplaceDeploymentAccess","description":"Data used to replace the existing deployment access."},"ReplaceWorkPoolAccess":{"properties":{"manage_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"Manage Actor Ids","description":"The list of actor IDs to grant `manage` access to."},"run_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"Run Actor Ids","description":"The list of actor IDs to grant `run` access to."},"view_actor_ids":{"items":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","const":"*"}]},"type":"array","title":"View Actor Ids","description":"The list of actor IDs to grant `view` access to."},"manage_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Manage Team Ids","description":"The list of team IDs to grant `manage` access to."},"run_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Run Team Ids","description":"The list of team IDs to grant `run` access to."},"view_team_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"View Team Ids","description":"The list of team IDs to grant `view` access to."}},"additionalProperties":false,"type":"object","required":["manage_actor_ids","run_actor_ids","view_actor_ids"],"title":"ReplaceWorkPoolAccess","description":"Data used to replace the existing work pool access."},"Resource":{"additionalProperties":{"type":"string"},"type":"object","title":"Resource","description":"An observable business object of interest to the user"},"ResourceExclusionList":{"properties":{"paths":{"items":{"type":"string"},"type":"array","title":"Paths","description":"The paths of the resources to exclude"}},"type":"object","required":["paths"],"title":"ResourceExclusionList"},"ResourceExclusions":{"properties":{"paths":{"items":{"type":"string"},"type":"array","title":"Paths","description":"The paths of the resources to exclude"}},"type":"object","required":["paths"],"title":"ResourceExclusions"},"ResourcePage":{"properties":{"resources":{"items":{"$ref":"#/components/schemas/Resource"},"type":"array","title":"Resources","description":"The Resources matching the query"},"total":{"type":"integer","title":"Total","description":"The total number of matching Resources"},"next_page":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Next Page","description":"The URL for the next page of results, if there are more"}},"type":"object","required":["resources","total","next_page"],"title":"ResourcePage","description":"A single page of resources returned from the API, with an optional link to the\nnext page of results"},"ResourcePeak":{"properties":{"metric_name":{"type":"string","title":"Metric Name"},"unit":{"type":"string","title":"Unit"},"max_value":{"type":"number","title":"Max Value"},"flow_run_id":{"type":"string","title":"Flow Run Id"}},"type":"object","required":["metric_name","unit","max_value","flow_run_id"],"title":"ResourcePeak"},"ResourceSpecification":{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object","title":"ResourceSpecification","description":"A specification that may match zero, one, or many resources, used to target or\nselect a set of resources in a query or automation.  A resource must match at least\none value of all of the provided labels"},"ResumeAutomation":{"properties":{"type":{"type":"string","const":"resume-automation","title":"Type","default":"resume-automation"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected automation (given by `automation_id`), or to an automation that is inferred from the triggering event.  If the source is 'inferred', the `automation_id` may not be set.  If the source is 'selected', the `automation_id` must be set.","default":"selected"},"automation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Automation Id","description":"The identifier of the automation to act on"}},"type":"object","title":"ResumeAutomation","description":"Resumes a Work Queue"},"ResumeDeployment":{"properties":{"type":{"type":"string","const":"resume-deployment","title":"Type","default":"resume-deployment"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected deployment (given by `deployment_id`), or to a deployment that is inferred from the triggering event.  If the source is 'inferred', the `deployment_id` may not be set.  If the source is 'selected', the `deployment_id` must be set.","default":"selected"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The identifier of the deployment"}},"type":"object","title":"ResumeDeployment","description":"Resumes the given Deployment"},"ResumeFlowRun":{"properties":{"type":{"type":"string","const":"resume-flow-run","title":"Type","default":"resume-flow-run"}},"type":"object","title":"ResumeFlowRun","description":"Resumes a paused or suspended flow run associated with the trigger"},"ResumeSchedule":{"properties":{"type":{"type":"string","const":"resume-schedule-for-flow-run","title":"Type","default":"resume-schedule-for-flow-run"},"deployment_id":{"type":"string","format":"uuid","title":"Deployment Id","description":"The identifier of the deployment"},"schedule_id":{"type":"string","format":"uuid","title":"Schedule Id","description":"The identifier of the schedule"}},"type":"object","required":["deployment_id","schedule_id"],"title":"ResumeSchedule","description":"Resumes the given schedule"},"ResumeWorkPool":{"properties":{"type":{"type":"string","const":"resume-work-pool","title":"Type","default":"resume-work-pool"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected work pool (given by `work_pool_id`), or to a work pool that is inferred from the triggering event.  If the source is 'inferred', the `work_pool_id` may not be set.  If the source is 'selected', the `work_pool_id` must be set.","default":"selected"},"work_pool_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Pool Id","description":"The identifier of the work pool to pause"}},"type":"object","title":"ResumeWorkPool","description":"Resumes a Work Pool"},"ResumeWorkQueue":{"properties":{"type":{"type":"string","const":"resume-work-queue","title":"Type","default":"resume-work-queue"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected work queue (given by `work_queue_id`), or to a work queue that is inferred from the triggering event.  If the source is 'inferred', the `work_queue_id` may not be set.  If the source is 'selected', the `work_queue_id` must be set.","default":"selected"},"work_queue_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Queue Id","description":"The identifier of the work queue to pause"}},"type":"object","title":"ResumeWorkQueue","description":"Resumes a Work Queue"},"RunDeployment":{"properties":{"type":{"type":"string","const":"run-deployment","title":"Type","default":"run-deployment"},"source":{"type":"string","enum":["selected","inferred"],"title":"Source","description":"Whether this Action applies to a specific selected deployment (given by `deployment_id`), or to a deployment that is inferred from the triggering event.  If the source is 'inferred', the `deployment_id` may not be set.  If the source is 'selected', the `deployment_id` must be set.","default":"selected"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The identifier of the deployment"},"parameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameters","description":"The parameters to pass to the deployment, or None to use the deployment's default parameters"},"job_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job Variables","description":"The job variables to pass to the created flow run, or None to use the deployment's default job variables"},"schedule_after":{"type":"number","title":"Schedule After","description":"The amount of time to wait before running the deployment. Defaults to running the deployment immediately.","default":0.0}},"type":"object","title":"RunDeployment","description":"Runs the given deployment with the given parameters"},"RunExecutionPlan":{"properties":{"type":{"type":"string","const":"run-execution-plan","title":"Type","default":"run-execution-plan"},"parameters":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Parameters","description":"The parameters to pass to the execution plan run, or None to pass no parameters"},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The flow whose active execution plan version to run"}},"type":"object","required":["flow_id"],"title":"RunExecutionPlan","description":"Runs the active execution plan version of the given flow"},"SavedSearch":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","description":"The name of the saved search."},"filters":{"items":{"$ref":"#/components/schemas/SavedSearchFilter"},"type":"array","title":"Filters","description":"The filter set for the saved search."}},"type":"object","required":["name"],"title":"SavedSearch","description":"An ORM representation of saved search data. Represents a set of filter criteria."},"SavedSearchCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the saved search."},"filters":{"items":{"$ref":"#/components/schemas/SavedSearchFilter"},"type":"array","title":"Filters","description":"The filter set for the saved search."}},"additionalProperties":false,"type":"object","required":["name"],"title":"SavedSearchCreate","description":"Data used by the Orion API to create a saved search."},"SavedSearchFilter":{"properties":{"object":{"type":"string","title":"Object","description":"The object over which to filter."},"property":{"type":"string","title":"Property","description":"The property of the object on which to filter."},"type":{"type":"string","title":"Type","description":"The type of the property."},"operation":{"type":"string","title":"Operation","description":"The operator to apply to the object. For example, `equals`."},"value":{"title":"Value","description":"A JSON-compatible value for the filter."}},"type":"object","required":["object","property","type","operation","value"],"title":"SavedSearchFilter","description":"A filter for a saved search model. Intended for use by the Prefect UI."},"SendEmailNotification":{"properties":{"type":{"type":"string","const":"send-email-notification","title":"Type","default":"send-email-notification"},"block_document_id":{"type":"string","format":"uuid","title":"Block Document Id","description":"The identifier of the notification block to use"},"subject":{"type":"string","title":"Subject","default":"Prefect automated notification"},"body":{"type":"string","title":"Body","description":"The body of the notification to send"},"body_format":{"type":"string","enum":["text","html"],"title":"Body Format","description":"The format of the email body: 'text' for plain text, 'html' for rich HTML content","default":"text"},"emails":{"items":{"type":"string","format":"email"},"type":"array","title":"Emails","description":"The email addresses to send the notification to"}},"type":"object","required":["body","emails"],"title":"SendEmailNotification","description":"Send an email notification when an Automation is triggered"},"SendNotification":{"properties":{"type":{"type":"string","const":"send-notification","title":"Type","default":"send-notification"},"block_document_id":{"type":"string","format":"uuid","title":"Block Document Id","description":"The identifier of the notification block to use"},"subject":{"type":"string","title":"Subject","default":"Prefect automated notification"},"body":{"type":"string","title":"Body","description":"The text of the notification to send"}},"type":"object","required":["block_document_id","body"],"title":"SendNotification","description":"Send a notification when an Automation is triggered"},"SendPrefectNotification":{"properties":{"type":{"type":"string","const":"prefect-notification","title":"Type","default":"prefect-notification"},"notification_type":{"type":"string","title":"Notification Type","description":"The type of notification to emit"},"message":{"type":"string","title":"Message","description":"The message to emit"}},"type":"object","required":["notification_type","message"],"title":"SendPrefectNotification"},"SequenceTrigger-Input":{"properties":{"type":{"type":"string","const":"sequence","title":"Type","default":"sequence"},"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID of this trigger"},"triggers":{"items":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Input"},{"$ref":"#/components/schemas/SequenceTrigger-Input"}]},"type":"array","title":"Triggers"},"within":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Within"}},"type":"object","required":["triggers","within"],"title":"SequenceTrigger","description":"A composite trigger that requires some number of triggers to have fired\nwithin the given time period in a specific order"},"SequenceTrigger-Output":{"properties":{"type":{"type":"string","const":"sequence","title":"Type","default":"sequence"},"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID of this trigger"},"triggers":{"items":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Output"},{"$ref":"#/components/schemas/SequenceTrigger-Output"}]},"type":"array","title":"Triggers"},"within":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Within"}},"type":"object","required":["triggers","within"],"title":"SequenceTrigger","description":"A composite trigger that requires some number of triggers to have fired\nwithin the given time period in a specific order"},"ServiceLevelAgreement":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this automation"},"description":{"type":"string","maxLength":5000,"title":"Description","description":"A longer description of this automation","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether this automation will be evaluated","default":true},"trigger":{"anyOf":[{"$ref":"#/components/schemas/EventTrigger"},{"$ref":"#/components/schemas/MetricTrigger"},{"$ref":"#/components/schemas/CompoundTrigger-Output"},{"$ref":"#/components/schemas/SequenceTrigger-Output"}],"title":"Trigger","description":"The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"},"actions":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions","description":"The actions to perform when this Automation triggers"},"actions_on_trigger":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Trigger","description":"The actions to perform when an Automation goes into a triggered state"},"actions_on_resolve":{"items":{"anyOf":[{"$ref":"#/components/schemas/DoNothing"},{"$ref":"#/components/schemas/RunDeployment"},{"$ref":"#/components/schemas/RunExecutionPlan"},{"$ref":"#/components/schemas/PauseDeployment"},{"$ref":"#/components/schemas/ResumeDeployment"},{"$ref":"#/components/schemas/PauseScheduleForFlowRun"},{"$ref":"#/components/schemas/ResumeSchedule"},{"$ref":"#/components/schemas/CancelFlowRun"},{"$ref":"#/components/schemas/DeleteFlowRun"},{"$ref":"#/components/schemas/ChangeFlowRunState"},{"$ref":"#/components/schemas/PauseWorkQueue"},{"$ref":"#/components/schemas/ResumeWorkQueue"},{"$ref":"#/components/schemas/SendNotification"},{"$ref":"#/components/schemas/CallWebhook"},{"$ref":"#/components/schemas/PauseAutomation"},{"$ref":"#/components/schemas/ResumeAutomation"},{"$ref":"#/components/schemas/SuspendFlowRun"},{"$ref":"#/components/schemas/ResumeFlowRun"},{"$ref":"#/components/schemas/DeclareIncident"},{"$ref":"#/components/schemas/PauseWorkPool"},{"$ref":"#/components/schemas/ResumeWorkPool"},{"$ref":"#/components/schemas/SlaViolation"},{"$ref":"#/components/schemas/SendEmailNotification"},{"$ref":"#/components/schemas/SendPrefectNotification"}]},"type":"array","title":"Actions On Resolve","description":"The actions to perform when an Automation goes into a resolving state"},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"Labels to apply to this automation"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the automation","examples":[["tag-1","tag-2"]]},"severity":{"$ref":"#/components/schemas/SlaSeverity","description":"The severity level of violations of this SLA","default":"moderate"},"type":{"type":"string","enum":["TimeToCompletionSla","FrequencySla","FreshnessSla","LatenessSla"],"title":"Type","description":"The type of the SLA"},"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account":{"type":"string","format":"uuid","title":"Account","description":"The Account to which this automation belongs"},"workspace":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace","description":"The Workspace to which this automation belongs"},"actor":{"anyOf":[{"$ref":"#/components/schemas/ActorReference"},{"type":"null"}],"description":"The Prefect Actor to use when running actions, defaulting to the Actor who created the Automation"}},"type":"object","required":["name","trigger","actions","type","account","workspace"],"title":"ServiceLevelAgreement","description":"A Service Level Agreement that inherits from ServiceLevelAgreementCore"},"ServiceLevelAgreementPartialUpdate":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether this SLA will be evaluated"}},"additionalProperties":false,"type":"object","required":["enabled"],"title":"ServiceLevelAgreementPartialUpdate","description":"Model for partially updating Service Level Agreements"},"SetStateStatus":{"type":"string","enum":["ACCEPT","REJECT","ABORT","WAIT"],"title":"SetStateStatus","description":"Enumerates return statuses for setting run states."},"SimpleFlowRun":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The flow run id."},"state_type":{"$ref":"#/components/schemas/StateType","description":"The state type."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The start time of the run, or the expected start time if it hasn't run yet."},"duration":{"type":"number","title":"Duration","description":"The total run time of the run."},"lateness":{"type":"number","title":"Lateness","description":"The delay between the expected and actual start time."}},"type":"object","required":["id","state_type","timestamp","duration","lateness"],"title":"SimpleFlowRun"},"SimpleNextFlowRun":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The flow run id."},"flow_id":{"type":"string","format":"uuid","title":"Flow Id","description":"The flow id."},"name":{"type":"string","title":"Name","description":"The flow run name"},"state_name":{"type":"string","title":"State Name","description":"The state name."},"state_type":{"$ref":"#/components/schemas/StateType","description":"The state type."},"next_scheduled_start_time":{"type":"string","format":"date-time","title":"Next Scheduled Start Time","description":"The next scheduled start time"}},"type":"object","required":["id","flow_id","name","state_name","state_type","next_scheduled_start_time"],"title":"SimpleNextFlowRun"},"SlaFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterId"},{"type":"null"}],"description":"Filter criteria for `Automation.id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterName"},{"type":"null"}],"description":"Filter criteria for `Automation.name`"},"created":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterCreated"},{"type":"null"}],"description":"Filter criteria for `Automation.created`"},"tags":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterTags"},{"type":"null"}],"description":"Filter criteria for `Automation.tags`"},"managed":{"anyOf":[{"$ref":"#/components/schemas/AutomationFilterManaged"},{"type":"null"}],"description":"Filter criteria for whether an automation is Prefect-managed"},"severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity","description":"Filter criteria for `Automation.severity`"}},"additionalProperties":false,"type":"object","title":"SlaFilter"},"SlaSeverity":{"type":"string","enum":["minor","low","moderate","high","critical"],"title":"SlaSeverity","description":"The severity of a SLA violation"},"SlaSort":{"type":"string","enum":["CREATED_DESC","UPDATED_DESC","NAME_ASC","NAME_DESC"],"title":"SlaSort","description":"Defines SLAs sorting options."},"SlaViolation":{"properties":{"type":{"type":"string","const":"sla-violation","title":"Type","default":"sla-violation"},"source":{"type":"string","const":"inferred","title":"Source","default":"inferred"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id","description":"The identifier of the deployment"},"sla_severity":{"type":"string","enum":["minor","low","moderate","high","critical"],"title":"Sla Severity","default":"high"},"sla_payload":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"integer"},{"type":"number"}]},"type":"object","title":"Sla Payload","default":{}}},"type":"object","title":"SlaViolation","description":"Base class for actions that operate on SLA violations"},"SpanIdentifierResponse":{"properties":{"trace_id":{"type":"string","format":"uuid","title":"Trace Id","description":"The trace ID containing this span"},"span_id":{"type":"string","format":"uuid","title":"Span Id","description":"The span ID"}},"type":"object","required":["trace_id","span_id"],"title":"SpanIdentifierResponse","description":"Response containing trace_id and span_id for a span lookup."},"SpanResponse":{"properties":{"span_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Span Id"},"trace_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trace Id"},"parent_span_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Span Id"},"path":{"items":{"type":"string"},"type":"array","title":"Path"},"start_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Time"},"end_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Time"},"running_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Running Time"},"published":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Published"},"name":{"type":"string","title":"Name"},"span_type":{"type":"string","title":"Span Type"},"state_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Type"},"state_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Name"},"version":{"type":"integer","title":"Version"},"attributes":{"additionalProperties":true,"type":"object","title":"Attributes"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"has_children":{"type":"boolean","title":"Has Children","description":"Whether this span has any child spans","default":false},"child_count":{"type":"integer","title":"Child Count","description":"Number of child spans","default":0},"child_state_counts":{"additionalProperties":{"additionalProperties":{"type":"integer"},"type":"object"},"type":"object","title":"Child State Counts","description":"Child span counts grouped by child span type and state name."}},"type":"object","required":["span_id","trace_id","start_time","end_time","name","span_type","state_type","state_name","version","attributes"],"title":"SpanResponse","description":"Span with additional computed fields for API responses."},"SpansResponse":{"properties":{"spans":{"items":{"$ref":"#/components/schemas/SpanResponse"},"type":"array","title":"Spans"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"prev_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Cursor"}},"type":"object","required":["spans"],"title":"SpansResponse","description":"Unified response for both list and context endpoints."},"StandardDeviation":{"properties":{"function":{"type":"string","const":"STDDEV","title":"Function","default":"STDDEV"}},"type":"object","title":"StandardDeviation"},"State":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"$ref":"#/components/schemas/StateType"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","examples":["Run started"]},"data":{"anyOf":[{},{"type":"null"}],"title":"Data","description":"Data associated with the state, e.g. a result. Content must be storable as JSON."},"state_details":{"$ref":"#/components/schemas/StateDetails"}},"type":"object","required":["type"],"title":"State","description":"Represents the state of a run."},"StateAbortDetails":{"properties":{"type":{"type":"string","const":"abort_details","title":"Type","description":"The type of state transition detail. Used to ensure pydantic does not coerce into a different type.","default":"abort_details"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason why the state transition was aborted."}},"type":"object","title":"StateAbortDetails","description":"Details associated with an ABORT state transition."},"StateAcceptDetails":{"properties":{"type":{"type":"string","const":"accept_details","title":"Type","description":"The type of state transition detail. Used to ensure pydantic does not coerce into a different type.","default":"accept_details"}},"type":"object","title":"StateAcceptDetails","description":"Details associated with an ACCEPT state transition."},"StateCreate":{"properties":{"type":{"$ref":"#/components/schemas/StateType"},"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","examples":["Run started"]},"data":{"anyOf":[{},{"type":"null"}],"title":"Data","description":"Data associated with the state, e.g. a result. Content must be storable as JSON."},"state_details":{"$ref":"#/components/schemas/StateDetails"}},"additionalProperties":false,"type":"object","required":["type"],"title":"StateCreate","description":"Data used by the Orion API to create a new state."},"StateDetails":{"properties":{"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id"},"task_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Run Id"},"child_flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Child Flow Run Id"},"scheduled_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled Time"},"cache_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cache Key"},"cache_expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cache Expiration"},"deferred":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Deferred"},"untrackable_result":{"type":"boolean","title":"Untrackable Result","default":false},"pause_timeout":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Pause Timeout"},"pause_reschedule":{"type":"boolean","title":"Pause Reschedule","default":false},"pause_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pause Key"},"run_input_keyset":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Run Input Keyset"},"refresh_cache":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Refresh Cache"},"retriable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Retriable"},"transition_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Transition Id"},"task_parameters_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Task Parameters Id"},"traceparent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Traceparent"},"deployment_concurrency_lease_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Concurrency Lease Id"}},"type":"object","title":"StateDetails"},"StateRejectDetails":{"properties":{"type":{"type":"string","const":"reject_details","title":"Type","description":"The type of state transition detail. Used to ensure pydantic does not coerce into a different type.","default":"reject_details"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason why the state transition was rejected."}},"type":"object","title":"StateRejectDetails","description":"Details associated with a REJECT state transition."},"StateType":{"type":"string","enum":["SCHEDULED","PENDING","RUNNING","COMPLETED","FAILED","CANCELLED","CRASHED","PAUSED","CANCELLING"],"title":"StateType","description":"Enumeration of state types."},"StateWaitDetails":{"properties":{"type":{"type":"string","const":"wait_details","title":"Type","description":"The type of state transition detail. Used to ensure pydantic does not coerce into a different type.","default":"wait_details"},"delay_seconds":{"type":"integer","title":"Delay Seconds","description":"The length of time in seconds the client should wait before transitioning states."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason why the state transition should wait."}},"type":"object","required":["delay_seconds"],"title":"StateWaitDetails","description":"Details associated with a WAIT state transition."},"SubscriptionCreate":{"properties":{"publication_id":{"type":"string","format":"uuid","title":"Publication Id"},"event":{"items":{"type":"string"},"type":"array","title":"Event"},"resource":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Resource"},"related":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Related"}},"type":"object","required":["publication_id","event"],"title":"SubscriptionCreate","description":"POST body for creating a subscription."},"SubscriptionPage":{"properties":{"results":{"items":{"$ref":"#/components/schemas/SubscriptionResponse"},"type":"array","title":"Results"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["results"],"title":"SubscriptionPage","description":"Paginated list of subscriptions with an opaque cursor for the next page."},"SubscriptionResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"account_id":{"type":"string","format":"uuid","title":"Account Id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"publication_id":{"type":"string","format":"uuid","title":"Publication Id"},"enabled":{"type":"boolean","title":"Enabled"},"event":{"items":{"type":"string"},"type":"array","title":"Event"},"resource":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Resource"},"related":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Related"},"created":{"type":"string","format":"date-time","title":"Created"},"updated":{"type":"string","format":"date-time","title":"Updated"},"publication_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publication Enabled","description":"Publication's enabled status; None if deleted"},"publication_exists":{"type":"boolean","title":"Publication Exists","description":"False if the publication has been deleted (orphaned subscription)"}},"type":"object","required":["id","account_id","workspace_id","publication_id","enabled","event","created","updated","publication_exists"],"title":"SubscriptionResponse","description":"Response model — subscription + publication status."},"SubscriptionUpdate":{"properties":{"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled"},"event":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event"},"resource":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Resource"},"related":{"anyOf":[{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"},{"type":"null"}],"title":"Related"}},"type":"object","title":"SubscriptionUpdate","description":"PATCH body — all fields optional, only provided fields are updated."},"Sum":{"properties":{"function":{"type":"string","const":"SUM","title":"Function","default":"SUM"}},"type":"object","title":"Sum"},"SuspendFlowRun":{"properties":{"type":{"type":"string","const":"suspend-flow-run","title":"Type","default":"suspend-flow-run"},"force":{"type":"boolean","title":"Force","description":"Force the state change, bypassing orchestration rules","default":false}},"type":"object","title":"SuspendFlowRun","description":"Suspends a flow run associated with the trigger"},"Tag":{"properties":{"name":{"type":"string","title":"Name"},"first_seen":{"type":"string","format":"date-time","title":"First Seen"},"last_seen":{"type":"string","format":"date-time","title":"Last Seen"}},"type":"object","required":["name","first_seen","last_seen"],"title":"Tag"},"TagPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"TagPaginationResponse"},"TagSort":{"type":"string","enum":["NAME_ASC","NAME_DESC","LAST_SEEN_ASC","LAST_SEEN_DESC"],"title":"TagSort","description":"Defines tags sorting options."},"TaskRun":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","examples":["my-task-run"]},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run id of the task run."},"task_key":{"type":"string","title":"Task Key","description":"A unique identifier for the task being run."},"dynamic_key":{"type":"string","title":"Dynamic Key","description":"A dynamic key used to differentiate between multiple runs of the same task within the same flow run."},"cache_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cache Key","description":"An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run."},"cache_expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cache Expiration","description":"Specifies when the cached state should expire."},"task_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Version","description":"The version of the task being run."},"empirical_policy":{"$ref":"#/components/schemas/TaskRunPolicy"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the task run.","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"state_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"State Id","description":"The id of the current task run state."},"task_inputs":{"additionalProperties":{"items":{"anyOf":[{"$ref":"#/components/schemas/TaskRunResult"},{"$ref":"#/components/schemas/FlowRunResult"},{"$ref":"#/components/schemas/Parameter"},{"$ref":"#/components/schemas/Constant"}]},"type":"array"},"type":"object","title":"Task Inputs","description":"Tracks the source of inputs to a task run. Used for internal bookkeeping."},"state_type":{"anyOf":[{"$ref":"#/components/schemas/StateType"},{"type":"null"}],"description":"The type of the current task run state."},"state_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State Name","description":"The name of the current task run state."},"run_count":{"type":"integer","title":"Run Count","description":"The number of times the task run has been executed.","default":0},"flow_run_run_count":{"type":"integer","title":"Flow Run Run Count","description":"If the parent flow has retried, this indicates the flow retry this run is associated with.","default":0},"expected_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expected Start Time","description":"The task run's expected start time."},"next_scheduled_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Scheduled Start Time","description":"The next time the task run is scheduled to start."},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time","description":"The actual start time."},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"The actual end time."},"total_run_time":{"type":"number","title":"Total Run Time","description":"Total run time. If the task run was executed multiple times, the time of each run will be summed.","default":0.0},"estimated_run_time":{"type":"number","title":"Estimated Run Time","description":"A real-time estimate of total run time.","default":0.0},"estimated_start_time_delta":{"type":"number","title":"Estimated Start Time Delta","description":"The difference between actual and expected start time.","default":0.0},"state":{"anyOf":[{"$ref":"#/components/schemas/State"},{"type":"null"}],"description":"The current task run state."}},"type":"object","required":["task_key","dynamic_key"],"title":"TaskRun","description":"An ORM representation of task run data."},"TaskRunCreate":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"The ID to use for the task run. If not provided, a random UUID will be generated."},"state":{"anyOf":[{"$ref":"#/components/schemas/StateCreate"},{"type":"null"}],"description":"The state of the task run to create"},"name":{"type":"string","maxLength":5000,"title":"Name","examples":["my-task-run"]},"flow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Flow Run Id","description":"The flow run id of the task run."},"task_key":{"type":"string","maxLength":5000,"title":"Task Key","description":"A unique identifier for the task being run."},"dynamic_key":{"type":"string","maxLength":5000,"title":"Dynamic Key","description":"A dynamic key used to differentiate between multiple runs of the same task within the same flow run."},"cache_key":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Cache Key","description":"An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run."},"cache_expiration":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Cache Expiration","description":"Specifies when the cached state should expire."},"task_version":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Task Version","description":"The version of the task being run."},"empirical_policy":{"$ref":"#/components/schemas/TaskRunPolicy"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of tags for the task run.","examples":[["tag-1","tag-2"]]},"labels":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"object"},{"type":"null"}],"title":"Labels","description":"A dictionary of key-value labels. Values can be strings, numbers, or booleans.","examples":[{"key":"value1","key2":42}]},"task_inputs":{"additionalProperties":{"items":{"anyOf":[{"$ref":"#/components/schemas/TaskRunResult"},{"$ref":"#/components/schemas/FlowRunResult"},{"$ref":"#/components/schemas/Parameter"},{"$ref":"#/components/schemas/Constant"}]},"type":"array"},"type":"object","title":"Task Inputs","description":"The inputs to the task run."}},"additionalProperties":false,"type":"object","required":["task_key","dynamic_key"],"title":"TaskRunCreate","description":"Data used by the Orion API to create a task run"},"TaskRunFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterId"},{"type":"null"}],"description":"Filter criteria for `TaskRun.id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterName"},{"type":"null"}],"description":"Filter criteria for `TaskRun.name`"},"tags":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterTags"},{"type":"null"}],"description":"Filter criteria for `TaskRun.tags`"},"state":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterState"},{"type":"null"}],"description":"Filter criteria for `TaskRun.state`"},"start_time":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterStartTime"},{"type":"null"}],"description":"Filter criteria for `TaskRun.start_time`"},"end_time":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterEndTime"},{"type":"null"}],"description":"Filter criteria for `TaskRun.end_time`"},"expected_start_time":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterExpectedStartTime"},{"type":"null"}],"description":"Filter criteria for TaskRun.expected_start_time"},"subflow_runs":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterSubFlowRuns"},{"type":"null"}],"description":"Filter criteria for `TaskRun.subflow_run`"},"flow_run_id":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterFlowRunId"},{"type":"null"}],"description":"Filter criteria for `TaskRun.flow_run_id`"}},"additionalProperties":false,"type":"object","title":"TaskRunFilter","description":"Filter task runs. Only task runs matching all criteria will be returned"},"TaskRunFilterEndTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include task runs ending at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include task runs ending at or after this time"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only return task runs without an end time"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterEndTime","description":"Filter by `TaskRun.end_time`."},"TaskRunFilterExpectedStartTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include task runs expected to start at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include task runs expected to start at or after this time"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterExpectedStartTime","description":"Filter by `TaskRun.expected_start_time`."},"TaskRunFilterFlowRunId":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run flow run ids to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"Filter for task runs with None as their flow run id","default":false}},"additionalProperties":false,"type":"object","title":"TaskRunFilterFlowRunId","description":"Filter by `TaskRun.flow_run_id`."},"TaskRunFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run ids to include"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterId","description":"Filter by `TaskRun.id`."},"TaskRunFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run names to include","examples":[["my-task-run-1","my-task-run-2"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"TaskRunFilterName","description":"Filter by `TaskRun.name`."},"TaskRunFilterStartTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include task runs starting at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include task runs starting at or after this time"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only return task runs without a start time"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterStartTime","description":"Filter by `TaskRun.start_time`."},"TaskRunFilterState":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"type":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterStateType"},{"type":"null"}],"description":"Filter criteria for `TaskRun.state_type`"},"name":{"anyOf":[{"$ref":"#/components/schemas/TaskRunFilterStateName"},{"type":"null"}],"description":"Filter criteria for `TaskRun.state_name`"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterState"},"TaskRunFilterStateName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run state names to include"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterStateName"},"TaskRunFilterStateType":{"properties":{"any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/StateType"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of task run state types to include"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterStateType","description":"Filter by `TaskRun.state_type`."},"TaskRunFilterSubFlowRuns":{"properties":{"exists_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exists","description":"If true, only include task runs that are subflow run parents; if false, exclude parent task runs"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterSubFlowRuns","description":"Filter by `TaskRun.subflow_run`."},"TaskRunFilterTags":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"all_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"All","description":"A list of tags. Task runs will be returned only if their tags are a superset of the list","examples":[["tag-1","tag-2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include task runs without tags"}},"additionalProperties":false,"type":"object","title":"TaskRunFilterTags","description":"Filter by `TaskRun.tags`."},"TaskRunPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/TaskRun"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"TaskRunPaginationResponse"},"TaskRunPolicy":{"properties":{"max_retries":{"type":"integer","title":"Max Retries","description":"The maximum number of retries. Field is not used. Please use `retries` instead.","default":0,"deprecated":true},"retry_delay_seconds":{"type":"number","title":"Retry Delay Seconds","description":"The delay between retries. Field is not used. Please use `retry_delay` instead.","default":0,"deprecated":true},"retries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retries","description":"The number of retries."},"retry_delay":{"anyOf":[{"type":"integer"},{"type":"number"},{"items":{"type":"integer"},"type":"array"},{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Retry Delay","description":"A delay time or list of delay times between retries, in seconds."},"retry_jitter_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Retry Jitter Factor","description":"Determines the amount a retry should jitter"}},"type":"object","title":"TaskRunPolicy","description":"Defines of how a task run should retry."},"TaskRunResult":{"properties":{"input_type":{"type":"string","const":"task_run","title":"Input Type","default":"task_run"},"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"TaskRunResult","description":"Represents a task run result input to another task run."},"TaskRunSort":{"type":"string","enum":["ID_DESC","EXPECTED_START_TIME_ASC","EXPECTED_START_TIME_DESC","NAME_ASC","NAME_DESC","NEXT_SCHEDULED_START_TIME_ASC","END_TIME_DESC"],"title":"TaskRunSort","description":"Defines task run sorting options."},"TaskRunUpdate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","examples":["my-task-run"]}},"additionalProperties":false,"type":"object","title":"TaskRunUpdate","description":"Data used by the Orion API to update a task run"},"TaskWorkerFilter":{"properties":{"task_keys":{"items":{"type":"string"},"type":"array","title":"Task Keys"}},"type":"object","required":["task_keys"],"title":"TaskWorkerFilter"},"TaskWorkerResponse":{"properties":{"identifier":{"type":"string","title":"Identifier"},"task_keys":{"items":{"type":"string"},"type":"array","title":"Task Keys"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"}},"type":"object","required":["identifier","task_keys","timestamp"],"title":"TaskWorkerResponse"},"TeamCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the team."},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"An optional description of the team.","default":""}},"additionalProperties":false,"type":"object","required":["name"],"title":"TeamCreate","description":"Data used by the api to create a new team"},"TeamFilter":{"properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/TeamFilterId"},{"type":"null"}],"description":"Filter criteria for Team.id"},"name":{"anyOf":[{"$ref":"#/components/schemas/TeamNameFilter"},{"type":"null"}],"description":"Filter criteria for Team.name"},"directory_id":{"anyOf":[{"$ref":"#/components/schemas/TeamFilterDirectoryId"},{"type":"null"}],"description":"Filter criteria for Team.workos_directory_id"},"workspace_id":{"anyOf":[{"$ref":"#/components/schemas/TeamFilterWorkspaceId"},{"type":"null"}],"description":"Filter criteria for WorkspaceTeamAccess.workspace_id"},"workspace_role_id":{"anyOf":[{"$ref":"#/components/schemas/TeamFilterWorkspaceRoleId"},{"type":"null"}],"description":"Filter criteria for WorkspaceTeamAccess.workspace_role_id"},"member_id":{"anyOf":[{"$ref":"#/components/schemas/TeamFilterMemberId"},{"type":"null"}],"description":"Filter criteria for TeamMembership.actor_id"}},"additionalProperties":false,"type":"object","title":"TeamFilter"},"TeamFilterDirectoryId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include teams with one of these directory ids"}},"additionalProperties":false,"type":"object","title":"TeamFilterDirectoryId"},"TeamFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include teams with one of these ids"}},"additionalProperties":false,"type":"object","title":"TeamFilterId"},"TeamFilterMemberId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include teams with a member matching one of these actor ids"}},"additionalProperties":false,"type":"object","title":"TeamFilterMemberId"},"TeamFilterWorkspaceId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include teams with access to one of these workspace ids"}},"additionalProperties":false,"type":"object","title":"TeamFilterWorkspaceId"},"TeamFilterWorkspaceRoleId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include teams with one of these workspace role ids"}},"additionalProperties":false,"type":"object","title":"TeamFilterWorkspaceRoleId"},"TeamMemberResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The actor id."},"handle":{"type":"string","title":"Handle","description":"The actor handle."},"name":{"type":"string","title":"Name","description":"The actor name."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The actor email if they're a user, otherwise None."},"type":{"type":"string","enum":["user","service_account"],"title":"Type","description":"The actor type."}},"type":"object","required":["id","handle","name","email","type"],"title":"TeamMemberResponse","description":"Describes a member of a team."},"TeamMembershipCreate":{"properties":{"member_id":{"type":"string","format":"uuid","title":"Member Id","description":"The id of the user or service account to add to the team."},"member_type":{"type":"string","enum":["user","service_account"],"title":"Member Type","description":"The type of member to add to the team."}},"additionalProperties":false,"type":"object","required":["member_id","member_type"],"title":"TeamMembershipCreate"},"TeamNameFilter":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include teams matching these names"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin-ops', 'ceo-marvin', and 'marvin-engineering'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"TeamNameFilter"},"TeamResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The account id associated with this team."},"name":{"type":"string","title":"Name","description":"The name of the team."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"An optional description of the team.","default":""},"workos_directory_group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workos Directory Group Id","description":"The WorkOS directory group id."},"memberships":{"items":{"$ref":"#/components/schemas/TeamMemberResponse"},"type":"array","title":"Memberships","description":"The members of the team."},"workspaces":{"items":{"$ref":"#/components/schemas/TeamWorkspaceAccess"},"type":"array","title":"Workspaces","description":"The workspaces the team has access to."}},"type":"object","required":["account_id","name"],"title":"TeamResponse","description":"Data returned by the API when reading a team."},"TeamSort":{"type":"string","enum":["NAME_ASC","NAME_DESC","CREATED_ASC","CREATED_DESC"],"title":"TeamSort","description":"Sort options for teams"},"TeamSummary":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The team id."},"name":{"type":"string","title":"Name","description":"The team name."}},"additionalProperties":false,"type":"object","required":["id","name"],"title":"TeamSummary"},"TeamUpdate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the team."},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"An optional description of the team.","default":""},"workos_directory_group_id":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Workos Directory Group Id","description":"The id of the WorkOS directory group that this team should be associated with."}},"additionalProperties":false,"type":"object","required":["name"],"title":"TeamUpdate","description":"Data used by the api to update a team"},"TeamWorkspaceAccess":{"properties":{"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace id."},"workspace_handle":{"type":"string","title":"Workspace Handle","description":"The workspace handle."},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id held by the team."},"workspace_role_name":{"type":"string","title":"Workspace Role Name","description":"The workspace role name held by the team."}},"type":"object","required":["workspace_id","workspace_handle","workspace_role_id","workspace_role_name"],"title":"TeamWorkspaceAccess","description":"Describes the access a team has to a workspace."},"TimeToCompletionSla":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of this SLA"},"severity":{"$ref":"#/components/schemas/SlaSeverity","description":"The severity of the SLA","default":"high"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"Whether this SLA will be evaluated"},"owner_resource":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Owner Resource","description":"The resource that owns this SLA"},"duration":{"type":"integer","title":"Duration","description":"The maximum flow run duration in seconds allowed before the SLA is violated."}},"additionalProperties":false,"type":"object","required":["name","duration"],"title":"TimeToCompletionSla","description":"An SLA that triggers when a flow run takes longer than the specified duration."},"TimeUnit":{"type":"string","enum":["week","day","hour","minute","second"],"title":"TimeUnit"},"TimeseriesMetricQuery":{"properties":{"after":{"type":"string","format":"date-time","title":"After","description":"The start of the time series"},"before":{"type":"string","format":"date-time","title":"Before","description":"The end of the time series, defaulting to now"},"timezone":{"type":"string","title":"Timezone","description":"The timezone to use for the time series","default":"Etc/UTC"},"resource":{"$ref":"#/components/schemas/ResourceSpecification","description":"Filter to only flow runs matching these labels"},"related":{"anyOf":[{"$ref":"#/components/schemas/ResourceSpecification"},{"items":{"$ref":"#/components/schemas/ResourceSpecification"},"type":"array"}],"title":"Related","description":"Filter to only flow runs with a related resource matching these labels"},"aggregates":{"items":{"anyOf":[{"$ref":"#/components/schemas/Count"},{"$ref":"#/components/schemas/CountIf"},{"$ref":"#/components/schemas/Sum"},{"$ref":"#/components/schemas/Mean"},{"$ref":"#/components/schemas/Minimum"},{"$ref":"#/components/schemas/Maximum"},{"$ref":"#/components/schemas/StandardDeviation"},{"$ref":"#/components/schemas/Quantile"},{"$ref":"#/components/schemas/Ratio"},{"$ref":"#/components/schemas/MapAggregate"}]},"type":"array","maxItems":10,"minItems":1,"title":"Aggregates","description":"The aggregate functions to apply.  The order they are specified here will determine the order of the returned data columns."},"resolution":{"type":"integer","enum":[1,5,15,60,360,1440],"title":"Resolution","description":"The resolution of the time series, in minutes"}},"type":"object","required":["after","aggregates","resolution"],"title":"TimeseriesMetricQuery"},"TimeseriesMetricResponse":{"properties":{"metric":{"$ref":"#/components/schemas/PrefectMetric","description":"The metric that was queried"},"query":{"$ref":"#/components/schemas/TimeseriesMetricQuery","description":"The metric query that was executed"},"rollup":{"items":{},"type":"array","title":"Rollup","description":"A rollup of the time series over the entire time range, in the same order as `query.aggregates`."},"series":{"items":{"prefixItems":[{"type":"string","format":"date-time"},{"items":{},"type":"array"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Series","description":"The time series, with each row being a pair of an ISO8601 timestamp and the row of values, in the same order as `query.aggregates`.  Each row represents given aggregates over the `query.resolution` minutes starting at the timestamp."}},"type":"object","required":["metric","query","rollup","series"],"title":"TimeseriesMetricResponse"},"UpdatedBy":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"The id of the updater of the object."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"The type of the updater of the object."},"display_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Value","description":"The display value for the updater."}},"type":"object","title":"UpdatedBy"},"UsageBucket":{"properties":{"start":{"type":"string","format":"date-time","title":"Start"},"used_seconds":{"type":"number","title":"Used Seconds"},"run_count":{"type":"integer","title":"Run Count"},"latest_total_usage_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest Total Usage Seconds"},"latest_limit_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest Limit Seconds"},"latest_remaining_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latest Remaining Seconds"},"groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/UsageBucketGroup"},"type":"array"},{"type":"null"}],"title":"Groups"}},"type":"object","required":["start","used_seconds","run_count"],"title":"UsageBucket"},"UsageBucketGroup":{"properties":{"key":{"type":"string","title":"Key"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"role":{"type":"string","title":"Role"},"name":{"type":"string","title":"Name"},"used_seconds":{"type":"number","title":"Used Seconds"},"run_count":{"type":"integer","title":"Run Count"}},"type":"object","required":["key","id","role","name","used_seconds","run_count"],"title":"UsageBucketGroup"},"UsageCurrent":{"properties":{"limit_seconds":{"type":"number","title":"Limit Seconds"},"period_usage_seconds":{"type":"number","title":"Period Usage Seconds"},"remaining_seconds":{"type":"number","title":"Remaining Seconds"},"utilization_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Utilization Percent"},"period_start":{"type":"string","format":"date-time","title":"Period Start"},"resets_at":{"type":"string","format":"date-time","title":"Resets At"},"as_of":{"type":"string","format":"date-time","title":"As Of"}},"type":"object","required":["limit_seconds","period_usage_seconds","remaining_seconds","utilization_percent","period_start","resets_at","as_of"],"title":"UsageCurrent"},"UsageLimitsResponse":{"properties":{"audit_log_retention_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Audit Log Retention Days","description":"The audit log retention days limit."},"automations_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Automations Limit","description":"The automations limit."},"automation_actions_rate_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Automation Actions Rate Limit","description":"The number of automation actions the account may run per interval. Shared by every automation in every workspace of the account."},"automation_actions_rate_limit_interval_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Automation Actions Rate Limit Interval Seconds","description":"The length of the automation action rate limit window, in seconds."},"log_rate_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Log Rate Limit","description":"The log rate limit."},"max_deployments_per_workspace":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Deployments Per Workspace","description":"The max deployments per workspace limit."},"mex_compute_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mex Compute Limit","description":"The mex compute limit."},"mex_concurrency_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mex Concurrency Limit","description":"The mex concurrency limit."},"mex_work_pool_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Mex Work Pool Limit","description":"The mex work pool limit."},"non_mex_work_pool_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Non Mex Work Pool Limit","description":"The maximum number of non-managed work pools that can be created in a workspace."},"orchestration_rate_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Orchestration Rate Limit","description":"The orchestration rate limit."},"run_retention_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Run Retention Days","description":"The run retention days limit."},"user_limit":{"anyOf":[{"type":"number"},{"type":"integer"}],"title":"User Limit","description":"The user limit."},"free_user_slots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Free User Slots","description":"The number of free user slots included with this plan."},"work_pool_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Work Pool Limit","description":"The work pool limit."},"workspace_limit":{"anyOf":[{"type":"number"},{"type":"integer"}],"title":"Workspace Limit","description":"The workspace limit."}},"type":"object","required":["audit_log_retention_days","automations_limit","log_rate_limit","max_deployments_per_workspace","mex_compute_limit","mex_concurrency_limit","mex_work_pool_limit","orchestration_rate_limit","run_retention_days","user_limit","work_pool_limit","workspace_limit"],"title":"UsageLimitsResponse","description":"Data returned by the API when reading a workspace's usage limits"},"UsagePortalResponse":{"properties":{"url":{"type":"string","title":"Url","description":"Short-lived URL to the account's Orb usage portal."}},"type":"object","required":["url"],"title":"UsagePortalResponse","description":"A freshly minted, short-lived URL to an account's Orb-hosted usage portal."},"UsageResourceGroup":{"properties":{"key":{"type":"string","title":"Key"},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"role":{"type":"string","title":"Role"},"name":{"type":"string","title":"Name"},"used_seconds":{"type":"number","title":"Used Seconds"},"run_count":{"type":"integer","title":"Run Count"},"group_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Count"}},"type":"object","required":["key","id","role","name","used_seconds","run_count"],"title":"UsageResourceGroup"},"User":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"An optional title for the user."},"image_location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Location","description":"A url linking to an image for the user."},"personal_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Personal Account Id","description":"The user's personal account id, if it exists."},"settings":{"anyOf":[{"$ref":"#/components/schemas/UserSettings"},{"type":"null"}],"description":"The user's default color settings","default":{"tutorial_completed":false,"feature_previews":[]}},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login","description":"The last time the user logged in."},"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"handle":{"type":"string","title":"Handle","description":"A unique handle for the user, containing only lowercase letters, numbers, and dashes."},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The actor_id associated with this user."},"idp_user_id":{"type":"string","title":"Idp User Id","description":"The idp (WorkOS or GitHub) id of a user."},"first_name":{"type":"string","maxLength":500,"title":"First Name","description":"The first name of a user."},"last_name":{"type":"string","maxLength":500,"title":"Last Name","description":"The last name of a user."},"email":{"type":"string","format":"email","title":"Email","description":"User email."},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"An optional physical location for a user, e.g. Washington, D.C."}},"type":"object","required":["handle","actor_id","idp_user_id","first_name","last_name","email"],"title":"User","description":"An ORM representation of an User"},"UserAccountResponse":{"properties":{"account_membership_id":{"type":"string","format":"uuid","title":"Account Membership Id","description":"The id of the user's account membership."},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"Account id."},"account_name":{"type":"string","title":"Account Name","description":"Account name."},"account_role_name":{"type":"string","title":"Account Role Name","description":"The name of the user's role in the account."},"account_handle":{"type":"string","title":"Account Handle","description":"The account's unique handle."},"account_plan_type":{"type":"string","title":"Account Plan Type","description":"The account's billing tier."},"account_plan_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Plan Tier","description":"The account's billing tier."},"account_plan_features":{"items":{"type":"string"},"type":"array","uniqueItems":true,"title":"Account Plan Features","description":"The features enabled on the account's plan."},"self_serve":{"type":"boolean","title":"Self Serve","description":"Whether the account's plan is self-serve.","default":false},"annual_billing":{"type":"boolean","title":"Annual Billing","description":"Whether the account's plan is billed annually.","default":false},"annual_self_serve_enabled":{"type":"boolean","title":"Annual Self Serve Enabled","description":"Whether the per-account `annual-self-serve-addons` flag is enabled for this account. Together with `self_serve` and `annual_billing`, this lets the UI evaluate the edit-plan gate entirely from /me/accounts, identically to the backend.","default":false},"serverless_usage_from_ledger_enabled":{"type":"boolean","title":"Serverless Usage From Ledger Enabled","description":"Whether the `serverless-usage-from-ledger` flag is enabled for this account, by an account-level enable or a global one. The UI reads serverless usage per workspace only when this is true.","default":false},"salesforce_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Salesforce Account Id","description":"Salesforce account id associated with the account."}},"additionalProperties":false,"type":"object","required":["account_membership_id","account_id","account_name","account_role_name","account_handle","account_plan_type","account_plan_tier"],"title":"UserAccountResponse","description":"Data returned the api when reading accounts a user is a member of"},"UserFilter":{"properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/UserFilterId"},{"type":"null"}],"description":"Filter criteria for User.id"},"email":{"anyOf":[{"$ref":"#/components/schemas/UserFilterEmail"},{"type":"null"}],"description":"Filter criteria for UserEmail.email"},"handle":{"anyOf":[{"$ref":"#/components/schemas/UserFilterHandle"},{"type":"null"}],"description":"Filter criteria for User.handle"},"name":{"anyOf":[{"$ref":"#/components/schemas/UserFilterName"},{"type":"null"}],"description":"Filter criteria for User.first_name or User.last_name"}},"additionalProperties":false,"type":"object","title":"UserFilter"},"UserFilterEmail":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of user emails to include","examples":[["marvin@prefect.example","marvin.jr@prefect.example"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin@prefect.example', 'sad-Marvin@prefect.example', and 'marvin-robot@prefect.example'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"UserFilterEmail","description":"Filter by `UserEmail.email`."},"UserFilterHandle":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of user handles to include","examples":[["marvin-ops","ceo-marvin","marvin-engineering"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin-ops', 'ceo-marvin', and 'marvin-engineering'.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"UserFilterHandle","description":"Filter by `User.handle`."},"UserFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of user ids to include"},"not_any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of user ids to exclude"}},"additionalProperties":false,"type":"object","title":"UserFilterId"},"UserFilterName":{"properties":{"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match on first_name or last_name. For example, passing 'marvin' will match users with 'marvin' in their first or last name.","examples":["marvin"]}},"additionalProperties":false,"type":"object","title":"UserFilterName","description":"Filter by `User.first_name` or `User.last_name`."},"UserOrganizationResponse":{"properties":{"account_membership_id":{"type":"string","format":"uuid","title":"Account Membership Id","description":"The id of the user's account membership."},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"Account id."},"account_name":{"type":"string","title":"Account Name","description":"Account name."},"account_role_name":{"type":"string","title":"Account Role Name","description":"The name of the user's role in the account."},"account_handle":{"type":"string","title":"Account Handle","description":"The account's unique handle."}},"additionalProperties":false,"type":"object","required":["account_membership_id","account_id","account_name","account_role_name","account_handle"],"title":"UserOrganizationResponse","description":"Data returned the api when reading organizations a user is a member of"},"UserPin":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"The actor who created the pin."},"resource_type":{"$ref":"#/components/schemas/PinnableResourceType","description":"The type of resource that is pinned."},"resource_id":{"type":"string","format":"uuid","title":"Resource Id","description":"The ID of the pinned resource."},"resource_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Name","description":"The name of the pinned resource, hydrated at read time."}},"type":"object","required":["actor_id","resource_type","resource_id"],"title":"UserPin","description":"An ORM representation of a user pin."},"UserPinCreate":{"properties":{"resource_type":{"$ref":"#/components/schemas/PinnableResourceType","description":"The type of resource to pin."},"resource_id":{"type":"string","format":"uuid","title":"Resource Id","description":"The ID of the resource to pin."}},"additionalProperties":false,"type":"object","required":["resource_type","resource_id"],"title":"UserPinCreate","description":"Data used by the Orion API to create a user pin."},"UserSessionFilter":{"properties":{"ip_address":{"anyOf":[{"$ref":"#/components/schemas/UserSessionFilterIpAddress"},{"type":"null"}],"description":"Filter criteria for UserSession.ip_address"},"location":{"anyOf":[{"$ref":"#/components/schemas/UserSessionFilterLocation"},{"type":"null"}],"description":"Filter criteria for UserSession.location"},"expires_at":{"anyOf":[{"$ref":"#/components/schemas/UserSessionFilterExpiresAt"},{"type":"null"}],"description":"Filter criteria for UserSession.expires_at"},"restricted":{"anyOf":[{"$ref":"#/components/schemas/UserSessionFilterRestricted"},{"type":"null"}],"description":"Filter criteria for UserSession.restricted"}},"additionalProperties":false,"type":"object","title":"UserSessionFilter","description":"Filter by `UserSession` attributes."},"UserSessionFilterExpiresAt":{"properties":{"before_":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Before","description":"Only include sessions expiring at or before this time (in UTC seconds)"},"after_":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"After","description":"Only include sessions expiring at or after this time (in UTC seconds)"}},"additionalProperties":false,"type":"object","title":"UserSessionFilterExpiresAt","description":"Filter by `UserSession.expires_at`."},"UserSessionFilterIpAddress":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of ip addresses to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing '192.168' will match '192.168.1.1', '192.168.1.2', and '2.5.192.168'."}},"additionalProperties":false,"type":"object","title":"UserSessionFilterIpAddress","description":"Filter by `UserSession.ip_address`."},"UserSessionFilterLocation":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of locations to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example,  passing 'Lo' will match 'London', 'Los Angeles', and 'Lagos'."}},"additionalProperties":false,"type":"object","title":"UserSessionFilterLocation","description":"Filter by `UserSession.location`."},"UserSessionFilterRestricted":{"properties":{"is_restricted_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Restricted","description":"Only include sessions that are restricted"}},"additionalProperties":false,"type":"object","title":"UserSessionFilterRestricted","description":"Filter by `UserSession.restricted`."},"UserSessionResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"user_id":{"type":"string","format":"uuid","title":"User Id","description":"The user id associated with this session."},"ip_address":{"type":"string","title":"Ip Address","description":"The ip address associated with this session."},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"The approximate location of the session based on the ip address."},"user_agent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Agent","description":"The user agent that created or updated this session."},"expires_at":{"type":"integer","title":"Expires At","description":"The time at which this session will expire."},"restricted":{"type":"boolean","title":"Restricted","description":"Whether this session is restricted from accessing account and workspace resources.","default":false}},"additionalProperties":false,"type":"object","required":["user_id","ip_address","expires_at"],"title":"UserSessionResponse","description":"Data returned by the api when reading user sessions"},"UserSettings":{"properties":{"default_timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Timezone","description":"Default timezone for the user."},"default_color_palette":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Color Palette","description":"Default color settings for the users UI."},"tutorial_completed":{"type":"boolean","title":"Tutorial Completed","description":"Whether the user has gone through the first time tutorial.","default":false},"feature_previews":{"items":{"type":"string"},"type":"array","title":"Feature Previews","description":"A list of feature previews enabled for the user."}},"type":"object","title":"UserSettings"},"UserUpdate":{"properties":{"handle":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Handle","description":"A unique handle for the user, containing only lowercase letters, numbers, and dashes."},"first_name":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"First Name","description":"The first name of a user."},"last_name":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Last Name","description":"The last name of a user."},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email","description":"User email."},"location":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Location","description":"An optional physical location for a user, e.g. Washington, D.C."},"title":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Title","description":"An optional title for the user."},"image_location":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Image Location","description":"A url linking to an image for the user."},"settings":{"anyOf":[{"$ref":"#/components/schemas/UserSettings"},{"type":"null"}],"description":"The user's default color settings","default":{"tutorial_completed":false,"feature_previews":[]}},"last_login":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Login","description":"The last time the user logged in."}},"additionalProperties":false,"type":"object","title":"UserUpdate","description":"Data used by API to update a user"},"UserWorkspaceResponse":{"properties":{"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The account id of the workspace."},"account_name":{"type":"string","title":"Account Name","description":"The account name."},"account_handle":{"type":"string","title":"Account Handle","description":"The account's unique handle."},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace id."},"workspace_name":{"type":"string","title":"Workspace Name","description":"The workspace name."},"workspace_description":{"type":"string","title":"Workspace Description","description":"Description of the workspace."},"workspace_handle":{"type":"string","title":"Workspace Handle","description":"The workspace's unique handle."}},"additionalProperties":false,"type":"object","required":["account_id","account_name","account_handle","workspace_id","workspace_name","workspace_description","workspace_handle"],"title":"UserWorkspaceResponse","description":"Data returned the api when reading workspaces a user has access to"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Variable":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","maxLength":255,"title":"Name","description":"The name of the variable","examples":["my_variable"]},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Value","description":"The value of the variable","examples":["my-value"]},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"A list of variable tags","examples":[["tag-1","tag-2"]]}},"type":"object","required":["name","value"],"title":"Variable"},"VariableCreate":{"properties":{"name":{"type":"string","maxLength":255,"title":"Name","description":"The name of the variable","examples":["my_variable"]},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Value","description":"The value of the variable","examples":["my-value"]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"A list of variable tags","examples":[["tag-1","tag-2"]]}},"additionalProperties":false,"type":"object","required":["name","value"],"title":"VariableCreate","description":"Data used by the Orion API to create a Variable."},"VariableFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/VariableFilterId"},{"type":"null"}],"description":"Filter criteria for `Variable.id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/VariableFilterName"},{"type":"null"}],"description":"Filter criteria for `Variable.name`"},"value":{"anyOf":[{"$ref":"#/components/schemas/VariableFilterValue"},{"type":"null"}],"description":"Filter criteria for `Variable.value`"},"tags":{"anyOf":[{"$ref":"#/components/schemas/VariableFilterTags"},{"type":"null"}],"description":"Filter criteria for `Variable.tags`"}},"additionalProperties":false,"type":"object","title":"VariableFilter","description":"Filter variables. Only variables matching all criteria will be returned"},"VariableFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of variable ids to include"}},"additionalProperties":false,"type":"object","title":"VariableFilterId","description":"Filter by `Variable.id`."},"VariableFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of variables names to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A string to match variable names against. This can include SQL wildcard characters like `%` and `_`.","examples":["my_variable_%"]}},"additionalProperties":false,"type":"object","title":"VariableFilterName","description":"Filter by `Variable.name`."},"VariableFilterTags":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"all_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"All","description":"A list of tags. Variables will be returned only if their tags are a superset of the list","examples":[["tag-1","tag-2"]]},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include Variables without tags"}},"additionalProperties":false,"type":"object","title":"VariableFilterTags","description":"Filter by `Variable.tags`."},"VariableFilterValue":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of variables value to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A string to match variable value against. This can include SQL wildcard characters like `%` and `_`.","examples":["my-value-%"]}},"additionalProperties":false,"type":"object","title":"VariableFilterValue","description":"Filter by `Variable.value`."},"VariableSort":{"type":"string","enum":["CREATED_DESC","UPDATED_DESC","NAME_DESC","NAME_ASC"],"title":"VariableSort","description":"Defines variables sorting options."},"VariableUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name","description":"The name of the variable","examples":["my_variable"]},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Value","description":"The value of the variable","examples":["my-value"]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"A list of variable tags","examples":[["tag-1","tag-2"]]}},"additionalProperties":false,"type":"object","title":"VariableUpdate","description":"Data used by the Orion API to update a Variable."},"VersionInfo":{"properties":{"type":{"type":"string","title":"Type","description":"The type of version info."},"version":{"type":"string","title":"Version","description":"The version of the deployment."}},"additionalProperties":true,"type":"object","required":["type","version"],"title":"VersionInfo"},"Webhook":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the webhook"},"description":{"type":"string","title":"Description","description":"A longer description of the webhook","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the webhook is enabled","default":true},"service_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Service Account Id","description":"The Service Account to which this webhook belongs"},"template":{"type":"string","maxLength":30000,"title":"Template","description":"The template which translates the incoming HTTP headers and body into a Prefect Event"},"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account":{"type":"string","format":"uuid","title":"Account","description":"The Account to which this webhook belongs"},"workspace":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace","description":"The Workspace to which this webhook belongs"},"slug":{"type":"string","title":"Slug","description":"The slug of the webhook, used in the URL"}},"type":"object","required":["name","template","account","workspace"],"title":"Webhook","description":"Defines an inbound webhook to receive events from external systems"},"WebhookCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the webhook"},"description":{"type":"string","maxLength":5000,"title":"Description","description":"A longer description of the webhook","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the webhook is enabled","default":true},"service_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Service Account Id","description":"The Service Account to which this webhook belongs"},"template":{"type":"string","maxLength":30000,"title":"Template","description":"The template which translates the incoming HTTP headers and body into a Prefect Event"}},"additionalProperties":false,"type":"object","required":["name","template"],"title":"WebhookCreate","description":"Defines an inbound webhook to receive events from external systems"},"WebhookPartialUpdate":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether the webhook is enabled","default":true}},"additionalProperties":false,"type":"object","title":"WebhookPartialUpdate","description":"Defines an inbound webhook to receive events from external systems"},"WebhookRead":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the webhook"},"description":{"type":"string","title":"Description","description":"A longer description of the webhook","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the webhook is enabled","default":true},"service_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Service Account Id","description":"The Service Account to which this webhook belongs"},"template":{"type":"string","maxLength":30000,"title":"Template","description":"The template which translates the incoming HTTP headers and body into a Prefect Event"},"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account":{"type":"string","format":"uuid","title":"Account","description":"The Account to which this webhook belongs"},"workspace":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace","description":"The Workspace to which this webhook belongs"},"slug":{"type":"string","title":"Slug","description":"The slug of the webhook, used in the URL"},"service_account":{"anyOf":[{"$ref":"#/components/schemas/BotPartial"},{"type":"null"}],"description":"The Service Account to which this webhook belongs"}},"additionalProperties":false,"type":"object","required":["name","template","account","workspace","service_account"],"title":"WebhookRead"},"WebhookSort":{"type":"string","enum":["CREATED_ASC","CREATED_DESC","UPDATED_ASC","UPDATED_DESC","NAME_ASC","NAME_DESC","KEY_EXPIRATION_ASC","KEY_EXPIRATION_DESC"],"title":"WebhookSort","description":"Defines webhook sorting options."},"WebhookUpdate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The name of the webhook"},"description":{"type":"string","maxLength":5000,"title":"Description","description":"A longer description of the webhook","default":""},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the webhook is enabled","default":true},"service_account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Service Account Id","description":"The Service Account to which this webhook belongs"},"template":{"type":"string","maxLength":30000,"title":"Template","description":"The template which translates the incoming HTTP headers and body into a Prefect Event"}},"additionalProperties":false,"type":"object","required":["name","template"],"title":"WebhookUpdate","description":"Defines an inbound webhook to receive events from external systems"},"WorkOSIntegrationResponse":{"properties":{"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Id"},"connections":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Connections","default":[]},"directories":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Directories","default":[]}},"type":"object","title":"WorkOSIntegrationResponse"},"WorkPool":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","pattern":"^[^/%&><]+$","title":"Name","description":"The name of the work pool."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the work pool."},"type":{"type":"string","title":"Type","description":"The work pool type."},"base_job_template":{"additionalProperties":true,"type":"object","title":"Base Job Template","description":"The work pool's base job template."},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimPolicy"},{"type":"null"}],"description":"Pending-claim policy overrides for this work pool."},"is_paused":{"type":"boolean","title":"Is Paused","description":"Pausing the work pool stops the delivery of all work.","default":false},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"A concurrency limit for the work pool."},"is_push_pool":{"type":"boolean","title":"Is Push Pool","description":"Whether or not the work pool is a push pool. Push pools are not polled by workers to deliver work.","default":false},"is_mex_pool":{"type":"boolean","title":"Is Mex Pool","description":"Whether or not the work pool is a managed pool. Managed pools execute work within Prefect Cloud.","default":false},"status":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolStatus"},{"type":"null"}],"description":"The current status of the work pool."},"default_queue_id":{"type":"string","format":"uuid","title":"Default Queue Id","description":"The id of the pool's default queue."},"storage_configuration":{"$ref":"#/components/schemas/WorkPoolStorageConfiguration","description":"The storage configuration for the work pool."},"last_polled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Polled","description":"The last time a worker polled this work pool for work."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Information about the creator of this work pool."},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/UpdatedBy"},{"type":"null"}],"description":"Information about the updater of this work pool."}},"type":"object","required":["name","type","default_queue_id"],"title":"WorkPool","description":"An ORM representation of a work pool"},"WorkPoolAccessControl":{"properties":{"manage_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"Manage Actors","description":"A list of actors with access to manage the deployment."},"run_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"Run Actors","description":"A list of actors with access to run the deployment."},"view_actors":{"items":{"$ref":"#/components/schemas/ObjectActorAccess"},"type":"array","title":"View Actors","description":"A list of actors with access to view the deployment."}},"type":"object","title":"WorkPoolAccessControl","description":"A representation of the access control for a deployment."},"WorkPoolConcurrencyStatusPage":{"properties":{"active_slots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active Slots"},"concurrency_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Concurrency Limit"},"queues":{"items":{"$ref":"#/components/schemas/WorkQueueConcurrencyStatusDetail"},"type":"array","title":"Queues"},"pool_slots":{"items":{"$ref":"#/components/schemas/FlowRunSlotSummary"},"type":"array","title":"Pool Slots"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["active_slots","concurrency_limit","queues","pool_slots","count","limit","pages","page"],"title":"WorkPoolConcurrencyStatusPage","description":"Paginated concurrency status for a work pool."},"WorkPoolCreate":{"properties":{"name":{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$","title":"Name","description":"The name of the work pool."},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"The work pool description."},"type":{"type":"string","maxLength":5000,"title":"Type","description":"The work pool type.","default":"prefect-agent"},"base_job_template":{"additionalProperties":true,"type":"object","title":"Base Job Template","description":"The work pool's base job template."},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimPolicyInput"},{"type":"null"}],"description":"Pending-claim policy overrides for this work pool."},"is_paused":{"type":"boolean","title":"Is Paused","description":"Pausing the work pool stops the delivery of all work.","default":false},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"A concurrency limit for the work pool."},"storage_configuration":{"$ref":"#/components/schemas/WorkPoolStorageConfiguration","description":"The storage configuration for the work pool."}},"additionalProperties":false,"type":"object","required":["name"],"title":"WorkPoolCreate","description":"Data used by the Orion API to create a work pool."},"WorkPoolFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilterId"},{"type":"null"}],"description":"Filter criteria for `WorkPool.id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilterName"},{"type":"null"}],"description":"Filter criteria for `WorkPool.name`"},"type":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilterType"},{"type":"null"}],"description":"Filter criteria for `WorkPool.type`"},"paused":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilterPaused"},{"type":"null"}],"description":"Filter criteria for `WorkPool.is_paused`"},"status":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilterStatus"},{"type":"null"}],"description":"Filter criteria for `WorkPool.status`"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilterCreatedBy"},{"type":"null"}],"description":"Filter criteria for `WorkPool.created_by`"},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolFilterUpdatedBy"},{"type":"null"}],"description":"Filter criteria for `WorkPool.updated_by`"}},"additionalProperties":false,"type":"object","title":"WorkPoolFilter"},"WorkPoolFilterCreatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of creator IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of creator types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include work pools without a creator"}},"additionalProperties":false,"type":"object","title":"WorkPoolFilterCreatedBy","description":"Filter by `WorkPool.created_by`."},"WorkPoolFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work pool ids to include"}},"additionalProperties":false,"type":"object","title":"WorkPoolFilterId","description":"Filter by `WorkPool.id`."},"WorkPoolFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work pool names to include"},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"A case-insensitive partial match. For example, passing 'my-pool' will match 'my-pool', 'my-pool-1', and 'MY-POOL'."}},"additionalProperties":false,"type":"object","title":"WorkPoolFilterName","description":"Filter by `WorkPool.name`."},"WorkPoolFilterPaused":{"properties":{"eq_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Eq","description":"Only returns where work pool is/is not paused"}},"additionalProperties":false,"type":"object","title":"WorkPoolFilterPaused","description":"Filter by `WorkPool.is_paused`."},"WorkPoolFilterStatus":{"properties":{"any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/WorkPoolStatus"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work pool statuses to include"}},"additionalProperties":false,"type":"object","title":"WorkPoolFilterStatus","description":"Filter by `WorkPool.status`."},"WorkPoolFilterType":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work pool types to include"},"not_any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of work pool types to exclude"}},"additionalProperties":false,"type":"object","title":"WorkPoolFilterType","description":"Filter by `WorkPool.type`."},"WorkPoolFilterUpdatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of updater IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of updater types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include work pools without an updater"}},"additionalProperties":false,"type":"object","title":"WorkPoolFilterUpdatedBy","description":"Filter by `WorkPool.updated_by`."},"WorkPoolPaginationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/WorkPoolResponse"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"WorkPoolPaginationResponse"},"WorkPoolResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","pattern":"^[^/%&><]+$","title":"Name","description":"The name of the work pool."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the work pool."},"type":{"type":"string","title":"Type","description":"The work pool type."},"base_job_template":{"additionalProperties":true,"type":"object","title":"Base Job Template","description":"The work pool's base job template."},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimPolicy"},{"type":"null"}],"description":"Pending-claim policy overrides for this work pool."},"is_paused":{"type":"boolean","title":"Is Paused","description":"Pausing the work pool stops the delivery of all work.","default":false},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"A concurrency limit for the work pool."},"is_push_pool":{"type":"boolean","title":"Is Push Pool","description":"Whether or not the work pool is a push pool. Push pools are not polled by workers to deliver work.","default":false},"is_mex_pool":{"type":"boolean","title":"Is Mex Pool","description":"Whether or not the work pool is a managed pool. Managed pools execute work within Prefect Cloud.","default":false},"status":{"anyOf":[{"$ref":"#/components/schemas/WorkPoolStatus"},{"type":"null"}],"description":"The current status of the work pool."},"default_queue_id":{"type":"string","format":"uuid","title":"Default Queue Id","description":"The id of the pool's default queue."},"storage_configuration":{"$ref":"#/components/schemas/WorkPoolStorageConfiguration","description":"The storage configuration for the work pool."},"last_polled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Polled","description":"The last time a worker polled this work pool for work."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Information about the creator of this work pool."},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/UpdatedBy"},{"type":"null"}],"description":"Information about the updater of this work pool."},"active_slots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active Slots","description":"The number of active concurrency slots for the work pool."}},"type":"object","required":["name","type","default_queue_id"],"title":"WorkPoolResponse"},"WorkPoolSort":{"type":"string","enum":["NAME_ASC","NAME_DESC"],"title":"WorkPoolSort","description":"Defines work pool sorting options."},"WorkPoolStatus":{"type":"string","enum":["READY","NOT_READY","PAUSED"],"title":"WorkPoolStatus","description":"Enumeration of work pool statuses."},"WorkPoolStorageConfiguration":{"properties":{"bundle_upload_step":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Bundle Upload Step","description":"The step to use for uploading bundles to storage."},"bundle_execution_step":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Bundle Execution Step","description":"The step to use for executing bundles."},"default_result_storage_block_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Result Storage Block Id","description":"The block document ID of the default result storage block."}},"type":"object","title":"WorkPoolStorageConfiguration","description":"A representation of a work pool's storage configuration"},"WorkPoolUpdate":{"properties":{"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description"},"is_paused":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Paused"},"base_job_template":{"additionalProperties":true,"type":"object","title":"Base Job Template"},"pending_claim":{"anyOf":[{"$ref":"#/components/schemas/PendingClaimPolicyInput"},{"type":"null"}],"description":"Pending-claim policy overrides for this work pool."},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit"},"storage_configuration":{"$ref":"#/components/schemas/WorkPoolStorageConfiguration","description":"The storage configuration for the work pool."}},"additionalProperties":false,"type":"object","title":"WorkPoolUpdate","description":"Data used by the Prefect REST API to update a work pool."},"WorkQueue":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","pattern":"^[^/%&><]+$","title":"Name","description":"The name of the work queue."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"An optional description for the work queue.","default":""},"is_paused":{"type":"boolean","title":"Is Paused","description":"Whether or not the work queue is paused.","default":false},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"An optional concurrency limit for the work queue."},"priority":{"type":"integer","exclusiveMinimum":0.0,"title":"Priority","description":"The queue's priority. Lower values are higher priority (1 is the highest).","default":1},"work_pool_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Pool Id","description":"The work pool with which the queue is associated."},"filter":{"anyOf":[{"$ref":"#/components/schemas/QueueFilter"},{"type":"null"}],"description":"DEPRECATED: Filter criteria for the work queue.","deprecated":true},"last_polled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Polled","description":"The last time an agent polled this queue for work."},"status":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueStatus"},{"type":"null"}],"description":"The current status of the work queue."},"work_pool":{"anyOf":[{"$ref":"#/components/schemas/WorkPool"},{"type":"null"}],"description":"The work pool with which the queue is associated."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Information about the creator of this work queue."},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/UpdatedBy"},{"type":"null"}],"description":"Information about the updater of this work queue."}},"type":"object","required":["name"],"title":"WorkQueue","description":"An ORM representation of a work queue"},"WorkQueueConcurrencyStatusDetail":{"properties":{"queue_id":{"type":"string","format":"uuid","title":"Queue Id"},"queue_name":{"type":"string","title":"Queue Name"},"active_slots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active Slots"},"concurrency_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Concurrency Limit"},"flow_runs":{"items":{"$ref":"#/components/schemas/FlowRunSlotSummary"},"type":"array","title":"Flow Runs"},"flow_run_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Flow Run Count"}},"type":"object","required":["queue_id","queue_name","active_slots","concurrency_limit","flow_runs","flow_run_count"],"title":"WorkQueueConcurrencyStatusDetail","description":"Concurrency status for a single work queue within a work pool."},"WorkQueueConcurrencyStatusPage":{"properties":{"active_slots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active Slots"},"concurrency_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Concurrency Limit"},"flow_runs":{"items":{"$ref":"#/components/schemas/FlowRunSlotSummary"},"type":"array","title":"Flow Runs"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["active_slots","concurrency_limit","flow_runs","count","limit","pages","page"],"title":"WorkQueueConcurrencyStatusPage","description":"Paginated concurrency status for a single work queue."},"WorkQueueCreate":{"properties":{"name":{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$","title":"Name","description":"The name of the work queue."},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"An optional description for the work queue.","default":""},"is_paused":{"type":"boolean","title":"Is Paused","description":"Whether or not the work queue is paused.","default":false},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"The work queue's concurrency limit."},"priority":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Priority","description":"The queue's priority. Lower values are higher priority (1 is the highest)."},"filter":{"anyOf":[{"$ref":"#/components/schemas/QueueFilter"},{"type":"null"}],"description":"DEPRECATED: Filter criteria for the work queue.","deprecated":true}},"additionalProperties":false,"type":"object","required":["name"],"title":"WorkQueueCreate","description":"Data used by the Prefect REST API to create a work queue."},"WorkQueueFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilterId"},{"type":"null"}],"description":"Filter criteria for `WorkQueue.id`"},"name":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilterName"},{"type":"null"}],"description":"Filter criteria for `WorkQueue.name`"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilterCreatedBy"},{"type":"null"}],"description":"Filter criteria for `WorkQueue.created_by`"},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueFilterUpdatedBy"},{"type":"null"}],"description":"Filter criteria for `WorkQueue.updated_by`"}},"additionalProperties":false,"type":"object","title":"WorkQueueFilter","description":"Filter work queues. Only work queues matching all criteria will be\nreturned"},"WorkQueueFilterCreatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of creator IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of creator types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include work queues without a creator"}},"additionalProperties":false,"type":"object","title":"WorkQueueFilterCreatedBy","description":"Filter by `WorkQueue.created_by`."},"WorkQueueFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work queue ids to include"}},"additionalProperties":false,"type":"object","title":"WorkQueueFilterId","description":"Filter by `WorkQueue.id`."},"WorkQueueFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of work queue names to include","examples":[["wq-1","wq-2"]]},"startswith_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Startswith","description":"A list of case-insensitive starts-with matches. For example,  passing 'marvin' will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'.","examples":[["marvin","Marvin-robot"]]}},"additionalProperties":false,"type":"object","title":"WorkQueueFilterName","description":"Filter by `WorkQueue.name`."},"WorkQueueFilterUpdatedBy":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"id_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Id","description":"A list of updater IDs to include"},"type_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"A list of updater types to include"},"is_null_":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Null","description":"If true, only include work queues without an updater"}},"additionalProperties":false,"type":"object","title":"WorkQueueFilterUpdatedBy","description":"Filter by `WorkQueue.updated_by`."},"WorkQueueHealthPolicy":{"properties":{"maximum_late_runs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum Late Runs","description":"The maximum number of late runs in the work queue before it is deemed unhealthy. Defaults to `0`.","default":0},"maximum_seconds_since_last_polled":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum Seconds Since Last Polled","description":"The maximum number of time in seconds elapsed since work queue has been polled before it is deemed unhealthy. Defaults to `60`.","default":60}},"type":"object","title":"WorkQueueHealthPolicy"},"WorkQueuePaginatedResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/WorkQueueResponse"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"WorkQueuePaginatedResponse"},"WorkQueueResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","pattern":"^[^/%&><]+$","title":"Name","description":"The name of the work queue."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"An optional description for the work queue.","default":""},"is_paused":{"type":"boolean","title":"Is Paused","description":"Whether or not the work queue is paused.","default":false},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit","description":"An optional concurrency limit for the work queue."},"priority":{"type":"integer","exclusiveMinimum":0.0,"title":"Priority","description":"The queue's priority. Lower values are higher priority (1 is the highest).","default":1},"work_pool_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Work Pool Id","description":"The work pool with which the queue is associated."},"filter":{"anyOf":[{"$ref":"#/components/schemas/QueueFilter"},{"type":"null"}],"description":"DEPRECATED: Filter criteria for the work queue.","deprecated":true},"last_polled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Polled","description":"The last time an agent polled this queue for work."},"status":{"anyOf":[{"$ref":"#/components/schemas/WorkQueueStatus"},{"type":"null"}],"description":"The work queue's current status."},"work_pool":{"anyOf":[{"$ref":"#/components/schemas/WorkPool"},{"type":"null"}],"description":"The work pool with which the queue is associated."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Information about the creator of this work queue."},"updated_by":{"anyOf":[{"$ref":"#/components/schemas/UpdatedBy"},{"type":"null"}],"description":"Information about the updater of this work queue."},"active_slots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active Slots","description":"The number of active concurrency slots for the work queue."},"work_pool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Pool Name","description":"The name of the work pool the work pool resides within."}},"type":"object","required":["name"],"title":"WorkQueueResponse"},"WorkQueueStatus":{"type":"string","enum":["READY","NOT_READY","PAUSED"],"title":"WorkQueueStatus","description":"Enumeration of work queue statuses."},"WorkQueueStatusDetail":{"properties":{"healthy":{"type":"boolean","title":"Healthy","description":"Whether or not the work queue is healthy."},"late_runs_count":{"type":"integer","title":"Late Runs Count","description":"The number of late flow runs in the work queue.","default":0},"last_polled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Polled","description":"The last time an agent polled this queue for work."},"health_check_policy":{"$ref":"#/components/schemas/WorkQueueHealthPolicy","description":"The policy used to determine whether or not the work queue is healthy."}},"type":"object","required":["healthy","health_check_policy"],"title":"WorkQueueStatusDetail"},"WorkQueueUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000,"pattern":"^[^/%&><]+$"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description"},"is_paused":{"type":"boolean","title":"Is Paused","description":"Whether or not the work queue is paused.","default":false},"concurrency_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Concurrency Limit"},"priority":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Priority"},"last_polled":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Polled"},"filter":{"anyOf":[{"$ref":"#/components/schemas/QueueFilter"},{"type":"null"}],"description":"DEPRECATED: Filter criteria for the work queue.","deprecated":true}},"additionalProperties":false,"type":"object","title":"WorkQueueUpdate","description":"Data used by the Orion API to update a work queue."},"Worker":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"name":{"type":"string","title":"Name","description":"The name of the worker."},"work_pool_id":{"type":"string","format":"uuid","title":"Work Pool Id","description":"The work pool with which the queue is associated."},"last_heartbeat_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Heartbeat Time","description":"The last time the worker process sent a heartbeat."},"status":{"$ref":"#/components/schemas/WorkerStatus","description":"Current status of the worker.","default":"OFFLINE"},"heartbeat_interval_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Heartbeat Interval Seconds","description":"The number of seconds to expect between heartbeats sent by the worker."},"client_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Version","description":"The version of the Prefect client used to create the worker."},"metadata_":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"The metadata of the client that is running the worker."},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CreatedBy"},{"type":"null"}],"description":"Optional information about the creator of this worker."}},"type":"object","required":["name","work_pool_id"],"title":"Worker","description":"An ORM representation of a worker"},"WorkerFilter":{"properties":{"operator":{"$ref":"#/components/schemas/Operator","description":"Operator for combining filter criteria. Defaults to 'and_'.","default":"and_"},"last_heartbeat_time":{"anyOf":[{"$ref":"#/components/schemas/WorkerFilterLastHeartbeatTime"},{"type":"null"}],"description":"Filter criteria for `Worker.last_heartbeat_time`"},"status":{"anyOf":[{"$ref":"#/components/schemas/WorkerFilterStatus"},{"type":"null"}],"description":"Filter criteria for `Worker.status`"},"name":{"anyOf":[{"$ref":"#/components/schemas/WorkerFilterName"},{"type":"null"}],"description":"Filter criteria for `Worker.name`"}},"additionalProperties":false,"type":"object","title":"WorkerFilter"},"WorkerFilterLastHeartbeatTime":{"properties":{"before_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before","description":"Only include processes whose last heartbeat was at or before this time"},"after_":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After","description":"Only include processes whose last heartbeat was at or after this time"}},"additionalProperties":false,"type":"object","title":"WorkerFilterLastHeartbeatTime","description":"Filter by `Worker.last_heartbeat_time`."},"WorkerFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of worker names to include","examples":[["my-worker-1","my-worker-2"]]},"not_any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of worker names to exclude","examples":[["my-worker-3","my-worker-4"]]},"like_":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Like","description":"Fuzzy-match for worker name"}},"additionalProperties":false,"type":"object","title":"WorkerFilterName","description":"Filter by `Worker.name`."},"WorkerFilterStatus":{"properties":{"any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/WorkerStatus"},"type":"array"},{"type":"null"}],"title":"Any","description":"A list of worker statuses to include"},"not_any_":{"anyOf":[{"items":{"$ref":"#/components/schemas/WorkerStatus"},"type":"array"},{"type":"null"}],"title":"Not Any","description":"A list of worker statuses to exclude"}},"additionalProperties":false,"type":"object","title":"WorkerFilterStatus","description":"Filter by `Worker.status`."},"WorkerFlowRunResponse":{"properties":{"work_pool_id":{"type":"string","format":"uuid","title":"Work Pool Id"},"work_queue_id":{"type":"string","format":"uuid","title":"Work Queue Id"},"flow_run":{"$ref":"#/components/schemas/FlowRunWithRunTimeField"}},"type":"object","required":["work_pool_id","work_queue_id","flow_run"],"title":"WorkerFlowRunResponse"},"WorkerPaginatedResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/Worker"},"type":"array","title":"Results"},"count":{"type":"integer","title":"Count"},"limit":{"type":"integer","title":"Limit"},"pages":{"type":"integer","title":"Pages"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["results","count","limit","pages","page"],"title":"WorkerPaginatedResponse"},"WorkerSort":{"type":"string","enum":["NAME_ASC","NAME_DESC","LAST_HEARTBEAT_ASC","LAST_HEARTBEAT_DESC","STATUS_ASC","STATUS_DESC","CLIENT_VERSION_ASC","CLIENT_VERSION_DESC"],"title":"WorkerSort","description":"Defines flow sorting options."},"WorkerStatus":{"type":"string","enum":["ONLINE","OFFLINE"],"title":"WorkerStatus","description":"Enumeration of worker statuses."},"Workspace":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The account id"},"name":{"type":"string","title":"Name","description":"The workspace name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the workspace","default":""},"handle":{"type":"string","title":"Handle","description":"A unique handle for the workspace"},"default_workspace_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Workspace Role Id","description":"The default workspace role id."},"is_public":{"type":"boolean","title":"Is Public","description":"Whether the workspace is public.","default":false}},"type":"object","required":["account_id","name","handle"],"title":"Workspace","description":"An ORM representation of a Workspace"},"WorkspaceActorAccessFilter":{"properties":{"workspace_role_id":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceActorAccessFilterWorkspaceRoleId"},{"type":"null"}],"description":"Filter criteria for WorkspaceActorAccess.workspace_role_id"},"actor_id":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceActorAccessFilterActorId"},{"type":"null"}],"description":"Filter criteria for WorkspaceActorAccess.actor_id"}},"additionalProperties":false,"type":"object","title":"WorkspaceActorAccessFilter"},"WorkspaceActorAccessFilterActorId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include workspace accesses with one of these actor ids"}},"additionalProperties":false,"type":"object","title":"WorkspaceActorAccessFilterActorId"},"WorkspaceActorAccessFilterWorkspaceRoleId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include workspace accesses with one of these workspace role ids"}},"additionalProperties":false,"type":"object","title":"WorkspaceActorAccessFilterWorkspaceRoleId"},"WorkspaceAutomationSummary":{"properties":{"type":{"$ref":"#/components/schemas/ManagedAutomationType"},"enabled":{"type":"boolean","title":"Enabled"}},"type":"object","required":["type","enabled"],"title":"WorkspaceAutomationSummary"},"WorkspaceBotAccessCreate":{"properties":{"bot_id":{"type":"string","format":"uuid","title":"Bot Id","description":"id of bot to create a workspace access for"},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id"}},"additionalProperties":false,"type":"object","required":["bot_id","workspace_role_id"],"title":"WorkspaceBotAccessCreate","description":"Data used by the api to create workspace bot access"},"WorkspaceBotAccessResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace id"},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id"},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"actor_id of bot assigned a workspace access"},"bot_id":{"type":"string","format":"uuid","title":"Bot Id","description":"id of bot assigned a workspace access"},"bot_name":{"type":"string","title":"Bot Name","description":"The name of the bot assigned a workspace access"}},"additionalProperties":false,"type":"object","required":["workspace_id","workspace_role_id","actor_id","bot_id","bot_name"],"title":"WorkspaceBotAccessResponse","description":"Data returned by the api after creating a new user workspace access"},"WorkspaceBotAccessSort":{"type":"string","enum":["CREATED_ASC","CREATED_DESC","BOT_NAME_ASC","BOT_NAME_DESC"],"title":"WorkspaceBotAccessSort","description":"Sort options for workspace bot accesses"},"WorkspaceCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The workspace name"},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"A description of the workspace","default":""},"handle":{"type":"string","maxLength":5000,"title":"Handle","description":"A unique handle for the workspace"}},"additionalProperties":false,"type":"object","required":["name","handle"],"title":"WorkspaceCreate","description":"Data used by the api to create a workspace"},"WorkspaceFilter":{"properties":{"id":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceFilterId"},{"type":"null"}],"description":"Filter criteria for Workspace.id"},"handle":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceFilterHandle"},{"type":"null"}],"description":"Filter criteria for Workspace.handle"}},"additionalProperties":false,"type":"object","title":"WorkspaceFilter"},"WorkspaceFilterHandle":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include workspaces matching these handles"}},"additionalProperties":false,"type":"object","title":"WorkspaceFilterHandle"},"WorkspaceFilterId":{"properties":{"any_":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include workspaces matching these ids"}},"additionalProperties":false,"type":"object","title":"WorkspaceFilterId"},"WorkspaceLimitsUsageResponse":{"properties":{"compute_usage_seconds":{"type":"integer","title":"Compute Usage Seconds","description":"Total compute usage seconds used in the workspace during the current billing period."},"compute_usage_limit_seconds":{"type":"integer","title":"Compute Usage Limit Seconds","description":"Total compute usage seconds allowed in the workspace during the current billing period."},"mex_concurrency_limit":{"type":"integer","title":"Mex Concurrency Limit","description":"The maximum number of managed execution flow runs that can be running at the same time in a workspace."},"mex_work_pool_limit":{"type":"integer","title":"Mex Work Pool Limit","description":"The maximum number of `prefect:managed` work pools that can be created in a workspace."},"next_compute_usage_reset_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Compute Usage Reset Date","description":"The date when the compute usage seconds will be reset to zero."}},"type":"object","required":["compute_usage_seconds","compute_usage_limit_seconds","mex_concurrency_limit","mex_work_pool_limit"],"title":"WorkspaceLimitsUsageResponse"},"WorkspaceManagedAutomationsResponse":{"properties":{"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"workspace_name":{"type":"string","title":"Workspace Name"},"workspace_handle":{"type":"string","title":"Workspace Handle"},"automations":{"items":{"$ref":"#/components/schemas/WorkspaceAutomationSummary"},"type":"array","title":"Automations"}},"type":"object","required":["workspace_id","workspace_name","workspace_handle","automations"],"title":"WorkspaceManagedAutomationsResponse"},"WorkspaceRateLimitAllocation":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account_id":{"type":"string","format":"uuid","title":"Account Id","description":"The account ID this allocation belongs to."},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace ID this allocation applies to."},"rate_limit_percentage":{"type":"number","maximum":100.0,"minimum":0.1,"title":"Rate Limit Percentage","description":"Percentage of account's rate limits allocated to this workspace (0.1-100)."}},"type":"object","required":["account_id","workspace_id","rate_limit_percentage"],"title":"WorkspaceRateLimitAllocation","description":"A percentage-based rate limit allocation for a workspace."},"WorkspaceRateLimitAllocationEntry":{"properties":{"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace ID to allocate rate limits for."},"rate_limit_percentage":{"type":"number","maximum":100.0,"minimum":0.1,"title":"Rate Limit Percentage","description":"Percentage of account's rate limits allocated to this workspace (0.1-100)."}},"additionalProperties":false,"type":"object","required":["workspace_id","rate_limit_percentage"],"title":"WorkspaceRateLimitAllocationEntry","description":"A single workspace allocation entry for bulk upsert."},"WorkspaceRateLimitAllocationsUpsert":{"properties":{"allocations":{"items":{"$ref":"#/components/schemas/WorkspaceRateLimitAllocationEntry"},"type":"array","title":"Allocations","description":"List of workspace allocations. Workspaces not in this list will have their allocations removed."}},"additionalProperties":false,"type":"object","title":"WorkspaceRateLimitAllocationsUpsert","description":"Data used to upsert all workspace rate limit allocations for an account."},"WorkspaceRole":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"account_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Account Id","description":"The account id"},"name":{"type":"string","title":"Name","description":"The workspace role name"},"description":{"type":"string","maxLength":140,"title":"Description","description":"A short description of the role.","default":""},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","description":"The workspace role's permissions","deprecated":true},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"The workspace role's scopes."},"inherited_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Inherited Role Id","description":"An optional built-in workspace role id from which this workspace role inherits."}},"type":"object","required":["account_id","name"],"title":"WorkspaceRole","description":"An ORM representation of a WorkspaceRole"},"WorkspaceRoleCreate":{"properties":{"name":{"type":"string","maxLength":5000,"title":"Name","description":"The workspace role name"},"description":{"type":"string","maxLength":140,"title":"Description","description":"A short description of the role.","default":""},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"The workspace role's scopes."},"inherited_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Inherited Role Id","description":"An optional built-in workspace role id from which this workspace role inherits."}},"additionalProperties":false,"type":"object","required":["name"],"title":"WorkspaceRoleCreate","description":"Data used by the api to create a workspace role"},"WorkspaceRoleFilter":{"properties":{"name":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceRoleFilterName"},{"type":"null"}],"description":"Filter criteria for WorkspaceRole.name"},"is_global":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Global","description":"\n        If True, only return global built-in roles. If False,\n        only return workspace roles from this account. Defaults to `None`, which includes both.\n        "}},"additionalProperties":false,"type":"object","title":"WorkspaceRoleFilter"},"WorkspaceRoleFilterName":{"properties":{"any_":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Any","description":"Only include workspace roles matching these names"}},"additionalProperties":false,"type":"object","title":"WorkspaceRoleFilterName"},"WorkspaceRoleUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name","description":"The workspace role name."},"description":{"anyOf":[{"type":"string","maxLength":140},{"type":"null"}],"title":"Description","description":"A short description of the role."},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"The workspace role's scopes."},"inherited_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Inherited Role Id","description":"An optional built-in workspace role id from which this workspace role inherits."}},"additionalProperties":false,"type":"object","title":"WorkspaceRoleUpdate","description":"Data used by the api to update a workspace role"},"WorkspaceScope":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the scope.","examples":["see_flows"]},"title":{"type":"string","title":"Title","description":"\n            A human readable title for the scope that describes the marginal permissions granted by this scope.\n            For example, although `manage_deployments` grants the right to take any action\n            against a deployment, the marginal permission given is to delete deployments, as\n            `write_deployments` grants everything except this.\n\n            These titles are only used by the UI for display purposes.\n            ","examples":["See flows and runs"]},"feature_group":{"type":"string","title":"Feature Group","description":"The feature to which this scope relates. Used for grouping scopes in the UI."},"includes_scopes":{"items":{"type":"string"},"type":"array","title":"Includes Scopes","description":"Optional list of scopes from which this scope inherits.","examples":[["see_flows","see_deployments"]]},"see_scope":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceScopeName"},{"type":"null"}],"description":"Which scope grants access to see the object"}},"type":"object","required":["name","title","feature_group","see_scope"],"title":"WorkspaceScope","description":"A workspace scope represents permissions to take a set of actions\nwithin a Prefect Cloud workspace.\n\nOnly `name` and `includes_scopes` should be relied on for\nauthorization logic."},"WorkspaceScopeName":{"type":"string","enum":["see_flows","manage_saved_search","run_flows","manage_flows","run_tasks","see_blocks","see_secret_blocks","manage_blocks","see_deployments","run_deployments","write_deployments","manage_deployments","see_notifications","write_notifications","manage_notifications","see_workspace_settings","write_workspace_settings","manage_workspace_settings","see_workspace_users","manage_workspace_users","see_workspace_service_accounts","manage_workspace_service_accounts","manage_workspace_teams","see_work_queues","write_work_queues","manage_work_queues","see_concurrency_limits","manage_concurrency_limits","see_events","manage_events","see_event_publications","manage_event_publications","see_event_subscriptions","manage_event_subscriptions","see_automations","manage_automations","see_work_pools","write_work_pools","manage_work_pools","see_workers","write_workers","manage_workers","see_artifacts","write_artifacts","manage_artifacts","see_variables","write_variables","manage_variables","manage_acls","see_incidents","write_incidents","manage_incidents","manage_mex_storage","manage_mex_deploy","see_tags","manage_tags","see_assets","write_assets","manage_assets","see_webhooks","manage_webhooks"],"title":"WorkspaceScopeName","description":"Canonical list of workspace scope names.\n\nScope names should be semantically meaningful, roughly in the form of\n`<verb>_<obj>`. For example, `see_flows` allows viewing of flows within\nthe workspace.\n\nA few common patterns to follow:\n    - `see_*`: ability to view objects\n    - `write_*`: ability to create, update or view objects\n    - `manage_*`: ability to create, update, view, or delete objects"},"WorkspaceSettings":{"properties":{"inherit_default_result_storage":{"type":"boolean","title":"Inherit Default Result Storage","description":"Whether the workspace should inherit its default result storage from the account.","default":true},"default_result_storage_block_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Result Storage Block Id","description":"The block document ID of the workspace's default result storage block."}},"type":"object","title":"WorkspaceSettings"},"WorkspaceSettingsUpdate":{"properties":{"inherit_default_result_storage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inherit Default Result Storage","description":"Whether the workspace should inherit its default result storage from the account."},"default_result_storage_block_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Result Storage Block Id","description":"The block document ID of the workspace's default result storage block."}},"additionalProperties":false,"type":"object","title":"WorkspaceSettingsUpdate","description":"Data used by API to update workspace settings"},"WorkspaceTeamAccess":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"team_id":{"type":"string","format":"uuid","title":"Team Id","description":"The team id"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace id"},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id"}},"type":"object","required":["team_id","workspace_id","workspace_role_id"],"title":"WorkspaceTeamAccess"},"WorkspaceTeamAccessCreate":{"properties":{"team_id":{"type":"string","format":"uuid","title":"Team Id","description":"The team id"},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id"}},"additionalProperties":false,"type":"object","required":["team_id","workspace_role_id"],"title":"WorkspaceTeamAccessCreate","description":"Data used by the api to create workspace team access"},"WorkspaceTeamAccessResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace id"},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id"},"team_id":{"type":"string","format":"uuid","title":"Team Id","description":"id of team assigned a workspace access"},"team_name":{"type":"string","title":"Team Name","description":"The name of the team assigned a workspace access"}},"additionalProperties":false,"type":"object","required":["workspace_id","workspace_role_id","team_id","team_name"],"title":"WorkspaceTeamAccessResponse","description":"Data returned by the api after creating a new team workspace access"},"WorkspaceUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Name","description":"The workspace name"},"handle":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Handle","description":"A unique handle for the workspace"},"description":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"title":"Description","description":"A description of the workspace","default":""},"default_workspace_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Default Workspace Role Id","description":"The default workspace role id."}},"additionalProperties":false,"type":"object","title":"WorkspaceUpdate","description":"Data used by the api to update a workspace"},"WorkspaceUsageResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The workspace id."},"name":{"type":"string","title":"Name","description":"The workspace name."},"automations":{"type":"integer","title":"Automations","description":"The number of automations."},"deployments":{"type":"integer","title":"Deployments","description":"The number of deployments."},"mex_compute":{"type":"integer","title":"Mex Compute","description":"The amount of mex compute used."},"work_pools":{"type":"integer","title":"Work Pools","description":"The number of work pools."},"non_managed_work_pools":{"type":"integer","title":"Non Managed Work Pools","description":"The number of non-managed work pools."},"managed_work_pools":{"type":"integer","title":"Managed Work Pools","description":"The number of mex work pools."}},"type":"object","required":["id","name","automations","deployments","mex_compute","work_pools","non_managed_work_pools","managed_work_pools"],"title":"WorkspaceUsageResponse","description":"Data returned by the API when reading a workspace's usage limits"},"WorkspaceUserAccessCreate":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id","description":"id of user to create a workspace access for"},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id"}},"additionalProperties":false,"type":"object","required":["user_id","workspace_role_id"],"title":"WorkspaceUserAccessCreate","description":"Data used by the api to create workspace actor access"},"WorkspaceUserAccessResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"},"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id","description":"The workspace id"},"workspace_role_id":{"type":"string","format":"uuid","title":"Workspace Role Id","description":"The workspace role id"},"actor_id":{"type":"string","format":"uuid","title":"Actor Id","description":"actor_id of user assigned a workspace access"},"user_id":{"type":"string","format":"uuid","title":"User Id","description":"id of user assigned a workspace access"},"first_name":{"type":"string","title":"First Name","description":"first name of user assigned a workspace access"},"last_name":{"type":"string","title":"Last Name","description":"last name of user assigned a workspace access"},"email":{"type":"string","title":"Email","description":"email of user assigned a workspace access"},"handle":{"type":"string","title":"Handle","description":"unique handle of user assigned a workspace access"}},"additionalProperties":false,"type":"object","required":["workspace_id","workspace_role_id","actor_id","user_id","first_name","last_name","email","handle"],"title":"WorkspaceUserAccessResponse","description":"Data returned by the API after creating a new user workspace access"},"WorkspaceUserAccessSort":{"type":"string","enum":["CREATED_ASC","CREATED_DESC","NAME_ASC","NAME_DESC","EMAIL_ASC","EMAIL_DESC","HANDLE_ASC","HANDLE_DESC"],"title":"WorkspaceUserAccessSort","description":"Sort options for workspace user accesses"}}},"tags":[{"name":"Auth","description":"Operations for authenticating with Prefect Cloud."},{"name":"Me","description":"Inspect the current User."},{"name":"Users","description":"Interact with User objects, including creating API Keys.","externalDocs":{"description":"Manage users","url":"https://docs.prefect.io/v3/manage/cloud/manage-users/index"}},{"name":"Accounts","description":"Interact with Prefect Cloud Accounts."},{"name":"Account Billing","description":"View and update account billing information."},{"name":"Account Intent","description":"Set up an account."},{"name":"Account SSO","description":"Set up an account.","externalDocs":{"description":"Configure SSO","url":"https://docs.prefect.io/v3/manage/cloud/manage-users/configure-sso#configure-sso"}},{"name":"Account Memberships","description":"View and update user memberships to an Account.","externalDocs":{"description":"Manage account roles","url":"https://docs.prefect.io/v3/manage/cloud/manage-users/manage-teams"}},{"name":"Account Roles","description":"View and define user Roles within an Account.","externalDocs":{"description":"Manage account roles","url":"https://docs.prefect.io/v3/manage/cloud/manage-users/manage-roles#manage-account-roles"}},{"name":"Bots","description":"Manage bots (service accounts) within an Account","externalDocs":{"description":"Manage service accounts","url":"https://docs.prefect.io/v3/manage/cloud/manage-users/service-accounts"}},{"name":"Invitations","description":"Manage account invitations.","externalDocs":{"description":"Manage workspaces: control access","url":"https://docs.prefect.io/v3/manage/cloud/workspaces#control-access"}},{"name":"Workspaces","description":"Interact with Prefect Cloud Workspaces.","externalDocs":{"description":"Manage workspaces: control access","url":"https://docs.prefect.io/v3/manage/cloud/workspaces#control-access"}},{"name":"Workspace User Access","description":"Manage users' access to a Workspace.","externalDocs":{"description":"Manage workspaces: control access","url":"https://docs.prefect.io/v3/manage/cloud/workspaces#control-access"}},{"name":"Workspace Roles","description":"View and define Roles within a Workspace.","externalDocs":{"description":"Manage workspaces: control access","url":"https://docs.prefect.io/v3/manage/cloud/workspaces#control-access"}},{"name":"Workspace Scopes","description":"View available workspace scopes.","externalDocs":{"description":"Manage workspaces: control access","url":"https://docs.prefect.io/v3/manage/cloud/workspaces#control-access"}},{"name":"Events","description":"Interact with Prefect Observability","externalDocs":{"description":"Track activity through events","url":"https://docs.prefect.io/v3/automate/events/events"}},{"name":"Logs","description":"Interact with a Workspace's Logs.","externalDocs":{"description":"Configure logging","url":"https://docs.prefect.io/v3/develop/logging#configure-logging"}},{"name":"Flows","description":"Interact with a Workspace's Flows.","externalDocs":{"description":"Write and run flows","url":"https://docs.prefect.io/v3/develop/write-flows"}},{"name":"Deployments","description":"Interact with a Workspace's Deployments.","externalDocs":{"description":"Deployment overview","url":"https://docs.prefect.io/v3/deploy/index"}},{"name":"Flow Runs","description":"Interact with a Workspace's Flow Runs.","externalDocs":{"description":"Write and run flows","url":"https://docs.prefect.io/v3/develop/write-flows"}},{"name":"Flow Run States","description":"Interact with a Workspace's Flow Run States.","externalDocs":{"description":"Write and run flows","url":"https://docs.prefect.io/v3/develop/write-flows"}},{"name":"Execution Plans","description":"Discover and validate authored execution plan document contracts."},{"name":"Task Runs","description":"Interact with a Workspace's Task Runs.","externalDocs":{"description":"Write and run tasks","url":"https://docs.prefect.io/v3/develop/write-tasks"}},{"name":"Task Run States","description":"Interact with a Workspace's Task Run States.","externalDocs":{"description":"Write and run tasks","url":"https://docs.prefect.io/v3/develop/write-tasks"}},{"name":"Concurrency Limits","description":"Interact with a Workspace's Task Run Concurrency Limits.","externalDocs":{"description":"Limit concurrent task runs with tags","url":"https://docs.prefect.io/v3/develop/task-run-limits"}},{"name":"Concurrency Limits V2","description":"Interact with a Workspace's Global Concurrency Limits.","externalDocs":{"description":"Apply global concurrency and rate limits","url":"https://docs.prefect.io/v3/develop/global-concurrency-limits"}},{"name":"Block documents","description":"Interact with a Workspace's Blocks.","externalDocs":{"description":"Securely store typed configuration","url":"https://docs.prefect.io/v3/develop/blocks"}},{"name":"Block schemas","description":"Interact with a Workspace's Block schemas.","externalDocs":{"description":"Securely store typed configuration","url":"https://docs.prefect.io/v3/develop/blocks"}},{"name":"Block types","description":"Interact with a Workspace's Block types.","externalDocs":{"description":"Securely store typed configuration","url":"https://docs.prefect.io/v3/develop/blocks"}},{"name":"Work Queues","description":"Interact with a Workspace's Work Queues.","externalDocs":{"description":"Configure dynamic infrastructure with work pools","url":"https://docs.prefect.io/v3/deploy/infrastructure-concepts/work-pools#work-queues"}},{"name":"SavedSearches","description":"Interact with a Workspace's Saved Searches."}]}