This is mainly auto-generated documentation for the AYON Python API.
pip install ayon-python-api
git clone git@github.com:ynput/ayon-python-api.git
cd ayon-python-api
pip install .
python -c "import ayon_api ; print(ayon_api.__version__)"
GlobalServerAPI
RequestTypes
ServerAPIServerAPI.access_tokenServerAPI.as_username()ServerAPI.base_urlServerAPI.certServerAPI.client_versionServerAPI.close_session()ServerAPI.create_session()ServerAPI.default_download_chunk_sizeServerAPI.default_settings_variantServerAPI.default_upload_chunk_sizeServerAPI.delete()ServerAPI.download_file()ServerAPI.download_file_to_stream()ServerAPI.get()ServerAPI.get_background_operations_status()ServerAPI.get_base_url()ServerAPI.get_cert()ServerAPI.get_client_version()ServerAPI.get_default_fields_for_type()ServerAPI.get_default_max_retries()ServerAPI.get_default_service_username()ServerAPI.get_default_settings_variant()ServerAPI.get_default_timeout()ServerAPI.get_graphql_schema()ServerAPI.get_headers()ServerAPI.get_info()ServerAPI.get_max_retries()ServerAPI.get_rest_entity_by_id()ServerAPI.get_rest_url()ServerAPI.get_schemas()ServerAPI.get_sender()ServerAPI.get_sender_type()ServerAPI.get_server_schema()ServerAPI.get_server_version()ServerAPI.get_server_version_tuple()ServerAPI.get_site_id()ServerAPI.get_ssl_verify()ServerAPI.get_timeout()ServerAPI.get_user()ServerAPI.get_user_by_name()ServerAPI.get_users()ServerAPI.graphql_allows_traits_in_representationsServerAPI.has_valid_tokenServerAPI.is_server_availableServerAPI.is_service_user()ServerAPI.logServerAPI.login()ServerAPI.logout()ServerAPI.max_retriesServerAPI.patch()ServerAPI.post()ServerAPI.put()ServerAPI.query_graphql()ServerAPI.raw_delete()ServerAPI.raw_get()ServerAPI.raw_patch()ServerAPI.raw_post()ServerAPI.raw_put()ServerAPI.reset_token()ServerAPI.rest_urlServerAPI.send_background_batch_operations()ServerAPI.send_batch_operations()ServerAPI.senderServerAPI.sender_typeServerAPI.server_versionServerAPI.server_version_tupleServerAPI.set_cert()ServerAPI.set_client_version()ServerAPI.set_default_service_username()ServerAPI.set_default_settings_variant()ServerAPI.set_max_retries()ServerAPI.set_sender()ServerAPI.set_sender_type()ServerAPI.set_site_id()ServerAPI.set_ssl_verify()ServerAPI.set_timeout()ServerAPI.set_token()ServerAPI.site_idServerAPI.ssl_verifyServerAPI.timeoutServerAPI.trigger_server_restart()ServerAPI.upload_file()ServerAPI.upload_file_from_stream()ServerAPI.upload_reviewable()ServerAPI.validate_server_availability()ServerAPI.validate_token()ServiceContext
SortOrder
TransferProgressTransferProgress.add_transferred_chunk()TransferProgress.content_sizeTransferProgress.destination_urlTransferProgress.fail_reasonTransferProgress.failedTransferProgress.get_content_size()TransferProgress.get_destination_url()TransferProgress.get_fail_reason()TransferProgress.get_failed()TransferProgress.get_source_url()TransferProgress.get_started()TransferProgress.get_transfer_done()TransferProgress.get_transferred_size()TransferProgress.is_runningTransferProgress.set_content_size()TransferProgress.set_destination_url()TransferProgress.set_failed()TransferProgress.set_source_url()TransferProgress.set_started()TransferProgress.set_transfer_done()TransferProgress.set_transferred_size()TransferProgress.source_urlTransferProgress.startedTransferProgress.transfer_doneTransferProgress.transfer_progressTransferProgress.transferred_sizeabort_action()abort_web_action_event()change_token()check_bundle_compatibility()close_connection()create_activity()create_bundle()create_connection()create_dependency_package()create_dependency_package_basename()create_entity_list()create_entity_list_item()create_event()create_folder()create_installer()create_link()create_link_type()create_product()create_project()create_representation()create_task()create_thumbnail()create_version()create_workfile_entity()delete()delete_activity()delete_addon()delete_addon_version()delete_bundle()delete_dependency_package()delete_entity_list()delete_entity_list_item()delete_event()delete_folder()delete_installer()delete_link()delete_link_type()delete_product()delete_project()delete_representation()delete_secret()delete_task()delete_version()delete_workfile_entity()delete_workfile_info()dispatch_event()download_addon_private_file()download_dependency_package()download_file()download_file_to_stream()download_installer()enroll_event_job()get()get_action_config()get_actions()get_activities()get_activity_by_id()get_addon_endpoint()get_addon_project_settings()get_addon_settings()get_addon_settings_schema()get_addon_site_settings()get_addon_site_settings_schema()get_addon_studio_settings()get_addon_url()get_addons_info()get_addons_project_settings()get_addons_settings()get_addons_studio_settings()get_attributes_fields_for_type()get_attributes_for_type()get_attributes_schema()get_background_operations_status()get_base_url()get_build_in_anatomy_preset()get_built_in_anatomy_preset()get_bundle_settings()get_bundles()get_cert()get_client_version()get_default_anatomy_preset_name()get_default_fields_for_type()get_default_settings_variant()get_dependency_packages()get_entities_links()get_entity_list_attribute_definitions()get_entity_list_by_id()get_entity_list_rest()get_entity_lists()get_event()get_events()get_folder_by_id()get_folder_by_name()get_folder_by_path()get_folder_ids_with_products()get_folder_links()get_folder_thumbnail()get_folders()get_folders_hierarchy()get_folders_links()get_folders_rest()get_full_link_type_name()get_graphql_schema()get_hero_version_by_id()get_hero_version_by_product_id()get_hero_versions()get_info()get_installers()get_last_version_by_product_id()get_last_version_by_product_name()get_last_versions()get_link_type()get_link_types()get_max_retries()get_product_by_id()get_product_by_name()get_product_links()get_product_type_names()get_product_types()get_products()get_products_links()get_project()get_project_anatomy_preset()get_project_anatomy_presets()get_project_names()get_project_product_types()get_project_root_overrides()get_project_root_overrides_by_site_id()get_project_roots_by_platform()get_project_roots_by_site()get_project_roots_by_site_id()get_project_roots_for_site()get_projects()get_repre_ids_by_context_filters()get_representation_by_id()get_representation_by_name()get_representation_hierarchy()get_representation_links()get_representation_parents()get_representations()get_representations_hierarchy()get_representations_links()get_representations_parents()get_rest_entity_by_id()get_rest_folder()get_rest_folders()get_rest_product()get_rest_project()get_rest_projects()get_rest_representation()get_rest_task()get_rest_url()get_rest_version()get_schemas()get_secret()get_secrets()get_sender()get_sender_type()get_server_api_connection()get_server_schema()get_server_version()get_server_version_tuple()get_service_addon_name()get_service_addon_settings()get_service_addon_version()get_service_name()get_site_id()get_ssl_verify()get_task_by_folder_path()get_task_by_id()get_task_by_name()get_task_links()get_task_thumbnail()get_tasks()get_tasks_by_folder_path()get_tasks_by_folder_paths()get_tasks_links()get_thumbnail()get_thumbnail_by_id()get_timeout()get_user()get_user_by_name()get_user_by_token()get_users()get_version_by_id()get_version_by_name()get_version_links()get_version_thumbnail()get_versions()get_versions_links()get_workfile_entities()get_workfile_entity()get_workfile_entity_by_id()get_workfile_info()get_workfile_info_by_id()get_workfile_thumbnail()get_workfiles_info()init_service()is_connection_created()is_service_user()is_token_valid()login_to_server()make_sure_link_type_exists()patch()post()put()query_graphql()raw_delete()raw_get()raw_patch()raw_post()raw_put()remove_attribute_config()reset_attributes_schema()save_secret()send_activities_batch_operations()send_background_batch_operations()send_batch_operations()set_action_config()set_attribute_config()set_cert()set_client_version()set_default_settings_variant()set_entity_list_attribute_definitions()set_environments()set_max_retries()set_sender()set_sender_type()set_site_id()set_ssl_verify()set_timeout()slugify_string()take_action()take_web_action_event()trigger_action()trigger_server_restart()update_activity()update_bundle()update_dependency_package()update_entity_list()update_entity_list_item()update_entity_list_items()update_event()update_folder()update_installer()update_product()update_project()update_representation()update_task()update_thumbnail()update_version()update_workfile_entity()update_workfile_info()upload_addon_zip()upload_dependency_package()upload_file()upload_file_from_stream()upload_installer()upload_reviewable()validate_url()version_is_latest()