Add validate_input endpoint

Update `run_input` for actor start
Deprecate `content_type` for actor start

Author: Pijukatel

src/apify_client/_utils.py

@@ -143,6 +143,10 @@ def encode_key_value_store_record_value(value: Any, content_type: str | None = N
             content_type = 'application/json; charset=utf-8'
 
     if 'application/json' in content_type and not is_file_or_bytes(value) and not isinstance(value, str):
-        value = json.dumps(value, ensure_ascii=False, indent=2, allow_nan=False, default=str).encode('utf-8')
+        value = _to_json(value).encode('utf-8')
 
-    return (value, content_type)
+    return value, content_type
+
+
+def _to_json(value: Any) -> str:
+    return json.dumps(value, ensure_ascii=False, indent=2, allow_nan=False, default=str)

src/apify_client/clients/resource_clients/actor.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 from typing import TYPE_CHECKING, Any
 
 from apify_shared.utils import (
@@ -9,7 +10,7 @@
     parse_date_fields,
 )
 
-from apify_client._utils import encode_key_value_store_record_value, encode_webhook_list_to_base64, pluck_data
+from apify_client._utils import _to_json, encode_webhook_list_to_base64, pluck_data
 from apify_client.clients.base import ResourceClient, ResourceClientAsync
 from apify_client.clients.resource_clients.actor_version import ActorVersionClient, ActorVersionClientAsync
 from apify_client.clients.resource_clients.actor_version_collection import (
@@ -30,6 +31,8 @@
 
     from apify_shared.consts import ActorJobStatus, MetaOrigin
 
+logger = logging.getLogger(__name__)
+
 
 def get_actor_representation(
     *,
@@ -216,7 +219,7 @@ def delete(self) -> None:
     def start(
         self,
         *,
-        run_input: Any = None,
+        run_input: str | dict | None = None,
         content_type: str | None = None,
         build: str | None = None,
         max_items: int | None = None,
@@ -232,7 +235,7 @@ def start(
 
         Args:
             run_input: The input to pass to the Actor run.
-            content_type: The content type of the input.
+            content_type: Deprecated.
             build: Specifies the Actor build to run. It can be either a build tag or build number. By default,
                 the run uses the build specified in the default run configuration for the Actor (typically latest).
             max_items: Maximum number of results that will be returned by this run. If the Actor is charged
@@ -255,7 +258,11 @@ def start(
         Returns:
             The run object.
         """
-        run_input, content_type = encode_key_value_store_record_value(run_input, content_type)
+        if content_type:
+            logger.warning('`content_type` is deprecated and not used anymore.')
+
+        if not isinstance(run_input, str):
+            run_input = _to_json(run_input)
 
         request_params = self._params(
             build=build,
@@ -270,7 +277,7 @@ def start(
         response = self.http_client.call(
             url=self._url('runs'),
             method='POST',
-            headers={'content-type': content_type},
+            headers={'content-type': 'application/json'},
             data=run_input,
             params=request_params,
         )
@@ -459,6 +466,27 @@ def webhooks(self) -> WebhookCollectionClient:
         """Retrieve a client for webhooks associated with this Actor."""
         return WebhookCollectionClient(**self._sub_resource_init_options())
 
+    def validate_input(self, run_input: str | bytes | dict | None = None) -> bool:
+        """Validate the input for the Actor.
+
+        Args:
+            run_input: The input to validate. Either json string or a dictionary.
+
+        Returns:
+            True if the input is valid, else raise an exception with validation error details.
+        """
+        if not isinstance(run_input, str):
+            run_input = _to_json(run_input)
+
+        self.http_client.call(
+            url=self._url('validate-input'),
+            method='POST',
+            headers={'content-type': 'application/json'},
+            data=run_input,
+        )
+
+        return True
+
 
 class ActorClientAsync(ResourceClientAsync):
     """Async sub-client for manipulating a single Actor."""
@@ -583,7 +611,7 @@ async def delete(self) -> None:
     async def start(
         self,
         *,
-        run_input: Any = None,
+        run_input: str | dict | None = None,
         content_type: str | None = None,
         build: str | None = None,
         max_items: int | None = None,
@@ -599,7 +627,7 @@ async def start(
 
         Args:
             run_input: The input to pass to the Actor run.
-            content_type: The content type of the input.
+            content_type: Deprecated.
             build: Specifies the Actor build to run. It can be either a build tag or build number. By default,
                 the run uses the build specified in the default run configuration for the Actor (typically latest).
             max_items: Maximum number of results that will be returned by this run. If the Actor is charged
@@ -622,7 +650,11 @@ async def start(
         Returns:
             The run object.
         """
-        run_input, content_type = encode_key_value_store_record_value(run_input, content_type)
+        if content_type:
+            logger.warning('`content_type` is deprecated and not used anymore.')
+
+        if not isinstance(run_input, str):
+            run_input = _to_json(run_input)
 
         request_params = self._params(
             build=build,
@@ -637,7 +669,7 @@ async def start(
         response = await self.http_client.call(
             url=self._url('runs'),
             method='POST',
-            headers={'content-type': content_type},
+            headers={'content-type': 'application/json'},
             data=run_input,
             params=request_params,
         )
@@ -829,3 +861,24 @@ def version(self, version_number: str) -> ActorVersionClientAsync:
     def webhooks(self) -> WebhookCollectionClientAsync:
         """Retrieve a client for webhooks associated with this Actor."""
         return WebhookCollectionClientAsync(**self._sub_resource_init_options())
+
+    async def validate_input(self, run_input: str | dict | None = None) -> bool:
+        """Validate the input for the Actor.
+
+        Args:
+            run_input: The input to validate. Either json string or a dictionary.
+
+        Returns:
+            True if the input is valid, else raise an exception with validation error details.
+        """
+        if not isinstance(run_input, str):
+            run_input = _to_json(run_input)
+
+        await self.http_client.call(
+            url=self._url('validate-input'),
+            method='POST',
+            headers={'content-type': 'application/json'},
+            data=run_input,
+        )
+
+        return True