NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Apify

apify

Apify is a platform for building, deploying, and managing web scraping and automation tools, known as Actors.

AI Web ScrapingDeveloper ToolsWeb del proveedor
Acciones
28
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (28)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create ActorAPIFY_CREATE_ACTORAcción

Tool to create a new actor with specified configuration. use when you need to initialize a fresh actor programmatically before publishing or running it.

Parámetros de entrada

  • namestringObligatorio

    Unique name for the new actor (must be 1–63 characters, lowercase letters, digits, and dashes).

  • titlestring

    Human-readable title for the actor.

  • isPublicboolean

    Whether the actor should be publicly visible on Apify Store.

  • versionsobject[]

    Initial actor versions definition. Each item must include versionNumber, sourceType, and buildTag.

  • categoriesstring[]

    List of category IDs to which this actor belongs.

  • descriptionstring

    Detailed description of what the actor does.

  • isDeprecatedboolean

    Whether the actor is deprecated (discouraged for new runs).

  • defaultRunOptionsobject

    Default options passed when running the actor (see Apify docs for schema).

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create DatasetAPIFY_CREATE_DATASETAcción

Tool to create a new dataset. use when you need to initialize or retrieve a dataset by name.

Parámetros de entrada

  • namestring

    Custom unique name for the dataset. If omitted, a random name is generated.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Actor TaskAPIFY_CREATE_TASKAcción

Tool to create a new actor task with specified settings. use when you need to configure or schedule recurring actor runs programmatically.

Parámetros de entrada

  • namestringObligatorio

    Name of the task to create.

  • actIdstringObligatorio

    ID or 'username~actorName' of the Actor to attach the task to.

  • optionsobject

    Task settings object, e.g., input JSON, memoryMbytes, timeoutSecs, build, diskMbytes, webhooks.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Task WebhookAPIFY_CREATE_TASK_WEBHOOKAcción

Tool to create a webhook for an actor task. use when you need external notifications about task run events (e.g., completion or failure) in downstream systems.

Parámetros de entrada

  • isAdHocboolean

    If true, webhook is ad hoc (single dispatch).

  • conditionobjectObligatorio

    Condition object specifying actor or task IDs.

  • eventTypesstring[]Obligatorio

    List of event types that trigger the webhook, e.g., ['ACTOR.TASK.RUN.SUCCEEDED'].

  • requestUrlstringObligatorio

    Target URL to which Apify will POST the webhook payload.

  • descriptionstring

    Description of the webhook.

  • idempotencyKeystring

    Unique key to prevent duplicate webhook creation.

  • headersTemplatestring

    JSON-like template for request headers. Some headers are managed by Apify.

  • payloadTemplatestring

    JSON-like template for the POST body. Handlebars variables allowed.

  • shouldInterpolateStringsboolean

    Whether to interpolate variables inside strings in payloadTemplate.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ActorAPIFY_DELETE_ACTORAcción

Tool to delete an actor permanently. use when you need to remove an actor by its id or username~actorname. confirm before calling.

Parámetros de entrada

  • actorIdstringObligatorio

    Unique identifier of the Actor to delete, in ID format or username~actorName format.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookAPIFY_DELETE_WEBHOOKAcción

Tool to delete a webhook by its id. use when removing a webhook after confirming the webhook id.

Parámetros de entrada

  • webhookIdstringObligatorio

    Unique identifier of the webhook to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Actor DetailsAPIFY_GET_ACTORAcción

Tool to get details of a specific actor. use when you need actor metadata by id or username/actorname.

Parámetros de entrada

  • actorIdstringObligatorio

    Actor ID (24-character hex string) or username/actorName.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get all webhooksAPIFY_GET_ALL_WEBHOOKSAcción

Tool to get a list of all webhooks created by the user. use when you need to enumerate webhooks before filtering or maintenance.

Parámetros de entrada

  • descboolean

    If true, sort results in descending order (by creation date).

  • limitinteger

    Maximum number of webhooks to return (pagination). Must be >= 1.

  • offsetinteger

    Number of webhooks to skip at the start (pagination). Must be >= 0.

Parámetros de salida

  • dataobject[]Obligatorio

    List of webhook objects.

  • errorstring

    Error if any occurred during the execution of the action

  • limitintegerObligatorio

    Limit parameter applied.

  • totalintegerObligatorio

    Total number of webhooks matching the query.

  • offsetintegerObligatorio

    Offset parameter applied.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get dataset itemsAPIFY_GET_DATASET_ITEMSAcción

Tool to retrieve items from a dataset. use when you need to fetch data from a specified dataset by pagination or filtering. only json format is fully supported.

Parámetros de entrada

  • bomboolean

    If true, includes BOM header in CSV output.

  • descboolean

    If true, return items in reverse order. Default is ascending.

  • omitstring

    Comma-separated list of fields to exclude from the returned items.

  • cleanboolean

    When true, removes any Apify-specific metadata from items.

  • limitinteger

    Maximum number of items to return (pagination). Default and max is 1000.

  • fieldsstring

    Comma-separated list of fields to include in the returned items.

  • formatstringenum

    Output format of dataset items. Only 'json' is fully supported.

    jsoncsvxlsx
  • offsetinteger

    Number of items to skip (pagination). Default is 0.

  • unwindstring

    Name of the field to unwind into multiple items.

  • flattenboolean

    If true, flattens nested JSON into a single level for CSV.

  • datasetIdstringObligatorio

    Identifier of the dataset to retrieve items from (e.g., 'username/datasetName' or dataset ID).

  • delimiterstring

    Delimiter to use for CSV format.

  • offsetKeystring

    Key to use for pagination instead of numeric offset.

  • skipEmptyboolean

    If true, skips empty rows in CSV output.

  • attachmentboolean

    If true, forces 'Content-Disposition: attachment' in the response.

  • skipHiddenboolean

    If true, skips hidden items (include only visible items).

  • asciiHeadersboolean

    If true, forces ASCII-only headers in CSV format.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Default BuildAPIFY_GET_DEFAULT_BUILDAcción

Tool to get the default build for an actor. use after specifying the actor id; optionally wait for the build to finish before returning.

Parámetros de entrada

  • actorIdstringObligatorio

    Actor ID or tilde-separated owner's username and Actor name (e.g. 'janedoe~my-actor').

  • waitForFinishnumber

    Maximum number of seconds to wait synchronously for the build to finish. If omitted or 0, returns immediately with the current status.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Key-Value RecordAPIFY_GET_KEY_VALUE_RECORDAcción

Tool to retrieve a record from a key-value store. use when you need to fetch a specific value by key from an apify key-value store.

Parámetros de entrada

  • formatstringenum

    Desired format of the retrieved record.

    jsonxmlhtmltext
  • storeIdstringObligatorio

    ID of the key-value store.

  • recordKeystringObligatorio

    Key of the record to retrieve.

  • attachmentboolean

    If true, force the response as an attachment (for browser downloads).

  • disableRedirectboolean

    If true, do not redirect to the raw value; return metadata only.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get list of buildsAPIFY_GET_LIST_OF_BUILDSAcción

Tool to get a list of builds for a specific actor. use when you need paginated access to an actor’s build (version) history.

Parámetros de entrada

  • descboolean

    If true, sort builds by creation date descending.

  • limitinteger

    Maximum number of builds to retrieve (pagination).

  • offsetinteger

    Number of builds to skip (pagination).

  • statusstringenum

    Filter builds by status.

    RUNNINGSUCCEEDEDFAILEDABORTED
  • actorIdstringObligatorio

    Actor ID or '<username>/<actorName>' to list builds for.

  • unnamedboolean

    If true, return only unnamed builds.

  • waitForFinishinteger

    Seconds to wait for build to finish before returning.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get list of runsAPIFY_GET_LIST_OF_RUNSAcción

Tool to get a list of runs for a specific actor. use when you need to paginate through runs and optionally filter by status before processing run data.

Parámetros de entrada

  • descboolean

    If true, sort by startedAt descending. Default is ascending.

  • limitinteger

    Maximum number of runs to return (pagination). Default and max is 1000.

  • offsetinteger

    Number of runs to skip at the start (pagination). Default is 0.

  • statusstringenum

    Filter runs by this lifecycle status.

    READYRUNNINGSUCCEEDEDFAILEDTIMING-OUTTIMED-OUTABORTINGABORTED
  • actorIdstringObligatorio

    Actor ID or '<username>/<actorName>' whose runs to list.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get list of task runsAPIFY_GET_LIST_OF_TASK_RUNSAcción

Tool to get a list of runs for a specific actor task. use when you need to paginate through task runs and optionally filter by status.

Parámetros de entrada

  • descboolean

    If true, sort by startedAt descending. Default is ascending.

  • limitinteger

    Maximum number of array elements to return. Default and max is 1000.

  • offsetinteger

    Number of array elements to skip. Default is 0.

  • statusstringenum

    Filter runs by this lifecycle status.

    READYRUNNINGSUCCEEDEDFAILEDTIMING-OUTTIMED-OUTABORTINGABORTED
  • actorTaskIdstringObligatorio

    Task ID or '<username>~<taskName>' identifying the task.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get list of tasksAPIFY_GET_LIST_OF_TASKSAcción

Tool to fetch a paginated list of tasks belonging to the authenticated user. use when you need to browse or sort tasks created by the user.

Parámetros de entrada

  • descboolean

    If true, sort by createdAt descending. Default is ascending.

  • limitinteger

    Maximum number of records to return (pagination). Default and max is 1000.

  • offsetinteger

    Number of records to skip at the start (pagination). Default is 0.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get list of task webhooksAPIFY_GET_LIST_OF_TASK_WEBHOOKSAcción

Tool to get a list of webhooks for a specific actor task. use when you need to review or paginate webhooks after creating or updating a task.

Parámetros de entrada

  • descboolean

    If true, sort by createdAt descending. Default is ascending.

  • limitinteger

    Maximum number of webhooks to return (pagination). Default and max is 1000.

  • offsetinteger

    Number of webhooks to skip at the start (pagination). Default is 0.

  • actorTaskIdstringObligatorio

    Actor task ID or '<username>~<taskName>' to list webhooks for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get logAPIFY_GET_LOGAcción

Tool to retrieve logs for a specific actor run or build. use after initiating an actor run or build when you need to inspect execution logs.

Parámetros de entrada

  • buildOrRunIdstringObligatorio

    ID of the Actor run or build to retrieve the log for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get OpenAPI DefinitionAPIFY_GET_OPEN_API_DEFINITIONAcción

Tool to get the openapi definition for a specific actor build. use when you need the api schema for code generation or analysis.

Parámetros de entrada

  • tokenstring

    API authentication token. Only required for private Actors; public Actors can be queried without one.

  • actorIdstringObligatorio

    Actor ID or tilde-separated owner's username and Actor name (e.g., 'user~actor-name').

  • buildIdstringObligatorio

    ID of the build to retrieve, or 'default' for the default Actor build.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Task InputAPIFY_GET_TASK_INPUTAcción

Tool to retrieve the input configuration of a specific task. use when you need to inspect stored task input before execution or debugging.

Parámetros de entrada

  • taskIdstringObligatorio

    Unique identifier of the Actor task to retrieve input for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Resurrect RunAPIFY_RESURRECT_RUNAcción

Tool to resurrect a finished actor run. use when you need to restart a completed or failed run. deprecated endpoint; may be removed in future.

Parámetros de entrada

  • runIdstringObligatorio

    ID of the Actor run to resurrect.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Run Actor AsynchronouslyAPIFY_RUN_ACTORAcción

Tool to run a specific actor asynchronously. use when you need to trigger an actor run without waiting for completion and retrieve its run details immediately.

Parámetros de entrada

  • bodyobject

    JSON input object passed to the Actor.

  • buildstring

    Specifies the Actor build to run (tag or build number). Defaults to default run config.

  • memorynumber

    Memory limit for the run, in megabytes. Must be power of 2 and at least 128.

  • actorIdstringObligatorio

    Actor ID or '<username>~<actorName>', e.g. 'john~my-actor'.

  • timeoutnumber

    Optional timeout for the run, in seconds. Default uses actor's default timeout.

  • maxItemsnumber

    Maximum number of items that the Actor run should return.

  • webhooksstring

    Base64-encoded JSON array of webhook definitions.

  • waitForFinishnumber

    Max seconds the server waits for the run to finish. Default 0, max 60.

  • maxTotalChargeUsdnumber

    Specifies the maximum cost of the Actor run in USD.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Run Actor SyncAPIFY_RUN_ACTOR_SYNCAcción

Tool to run a specific actor synchronously with input and return its output record. use when immediate actor results are needed; runs may timeout after 300 seconds.

Parámetros de entrada

  • buildstring

    Build tag or number to run (default Actor's default build, usually 'latest').

  • inputobjectObligatorio

    JSON object passed as input to the Actor run.

  • memoryinteger

    Memory limit in MB; power of two, minimum 128. Uses default if unset.

  • actorIdstringObligatorio

    Actor ID or tilde-separated owner and actor name (e.g., 'user~actor-name').

  • timeoutnumber

    Run timeout in seconds. Uses Actor default if unset; HTTP wait max 300s.

  • maxItemsinteger

    Maximum number of dataset items to return.

  • webhooksstring

    Base64-encoded JSON array defining webhooks for run notifications.

  • outputRecordKeystring

    Key of the record in the default key-value store to return (default 'OUTPUT').

  • maxTotalChargeUsdnumber

    Maximum total charge in USD for the run.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Run Actor Sync & Get Dataset ItemsAPIFY_RUN_ACTOR_SYNC_GET_DATASET_ITEMSAcción

Tool to run an actor synchronously and retrieve its dataset items. use when immediate access to run results is needed.

Parámetros de entrada

  • inputobject

    JSON input object passed to the Actor run.

  • limitinteger

    Maximum number of items to return for pagination.

  • formatstringenum

    Format of dataset items to retrieve.

    jsoncsvrsshtml
  • offsetinteger

    Number of items to skip for pagination.

  • actorIdstringObligatorio

    Unique identifier or name of the Actor (e.g., 'username/actor-name').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Run Task AsynchronouslyAPIFY_RUN_TASKAcción

Tool to run a specific actor task asynchronously. use when you need to trigger a task run without waiting for completion and immediately retrieve its run details.

Parámetros de entrada

  • bodyobject

    JSON input object passed to the Actor.

  • buildstring

    Specifies the Actor build to run (tag or build number). Defaults to default run config.

  • memorynumber

    Memory limit for the run, in megabytes. Must be power of 2 and at least 128.

  • timeoutnumber

    Optional timeout for the run, in seconds. Default uses task's default timeout.

  • maxItemsnumber

    Maximum number of items that the Actor run should return.

  • webhooksstring

    Base64-encoded JSON array of webhook definitions.

  • actorTaskIdstringObligatorio

    Task ID or '<username>~<taskName>', e.g. 'john~my-task'.

  • waitForFinishnumber

    Max seconds the server waits for the run to finish. Default 0, max 60.

  • maxTotalChargeUsdnumber

    Specifies the maximum cost of the Actor run in USD.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Store Data in DatasetAPIFY_STORE_DATA_IN_DATASETAcción

Tool to store data items in a dataset. use after collecting data when you want to batch-append or update items in an existing dataset.

Parámetros de entrada

  • dataobject[]Obligatorio

    Array of JSON-serializable objects to store in the dataset.

  • omitstring

    Comma-separated list of fields to exclude when storing items.

  • fieldsstring

    Comma-separated list of fields to include when storing items.

  • datasetIdstringObligatorio

    Dataset ID or name (e.g., 'username/datasetName' or dataset ID).

  • deduplicateboolean

    If true, deduplicate incoming items by their 'foreignId'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Store Data in Key-Value StoreAPIFY_STORE_DATA_IN_KEY_VALUE_STOREAcción

Tool to create or update a record in a key-value store. use after you have the store id and record key to persist json data.

Parámetros de entrada

  • storeIdstringObligatorio

    ID of the key-value store where the record will be stored.

  • recordKeystringObligatorio

    Key under which the record will be stored or updated.

  • recordValueobjectObligatorio

    The JSON object to store. Must be JSON-serializable.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Key-Value StoreAPIFY_UPDATE_KEY_VALUE_STOREAcción

Tool to update a key-value store's properties. use when renaming or changing access or schema version of the store after confirming the store id.

Parámetros de entrada

  • namestring

    New name for the key-value store.

  • accessstringenum

    Access level for the store. One of PRIVATE, SHARED, PUBLIC.

    PRIVATESHAREDPUBLIC
  • storeIdstringObligatorio

    Identifier of the key-value store to update.

  • schemaVersioninteger

    Schema version to use for the store. Must be >= 1.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Task InputAPIFY_UPDATE_TASK_INPUTAcción

Tool to update the input configuration of a specific actor task. use when you need to modify a scheduled tasks input before execution.

Parámetros de entrada

  • inputobjectObligatorio

    The new input configuration object for the task.

  • taskIdstringObligatorio

    ID of the Actor task to update.

Parámetros de salida

  • dataobjectObligatorio

    The updated input object for the actor task.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not