Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ public static Command Create(string? commandName = null)
var command = new Command(commandName ?? @"openapi-json-get", @"Get OpenAPI definition of Actor build
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:

- [First endpoint](/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.
- [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
- [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`.

Get the OpenAPI definition for a specific Actor build.
Authentication is based on the build's unique ID. No authentication token is required.

:::note

You can also use the [`/api/v2/actor-openapi-json-get`](/api/v2/actor-openapi-json-get) endpoint to get the OpenAPI definition for a build.
You can also use the [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) endpoint (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build.

:::
");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ public static Command Create(string? commandName = null)

##### Convenience endpoints for Actor run default storages

* [Dataset](/api/v2/default-dataset)
* [Default dataset](/api/v2/default-dataset)

* [Key-value store](/api/v2/default-key-value-store)
* [Default key-value store](/api/v2/default-key-value-store)

* [Request queue](/api/v2/default-request-queue)
* [Default request queue](/api/v2/default-request-queue)

Gets an object that contains all the details about a
specific run of an Actor.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ JSON in the PUT payload.
If the object does not define a specific property, its value is not updated.

The response is the full task input as returned by the
[Get task input](#/reference/tasks/task-input-object/get-task-input) endpoint.
[Get Actor task input](/api/v2/actor-task-input-get) endpoint.

The request needs to specify the `Content-Type: application/json` HTTP
header!

When providing your API authentication token, we recommend using the
request's `Authorization` header, rather than the URL. ([More
info](#/introduction/authentication)).
request's `Authorization` header, rather than the URL.
For details, see [Authentication](/api/v2/getting-started#authentication).
");
command.Arguments.Add(ActorTaskId);
command.Options.Add(Input);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ configured to have a long enough connection timeout.
and its status.

To run the Task asynchronously, use the
[Run task asynchronously](#/reference/actor-tasks/run-collection/run-task)
[Run Actor task](/api/v2/actor-task-runs-post)
endpoint instead.
");
command.Arguments.Add(ActorTaskId);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,7 @@ public static Command Create(string? commandName = null)
otherwise the HTTP request fails with a timeout error (this won't abort
the run itself).

You can send all the same options in parameters as the [Get Dataset
Items](#/reference/datasets/item-collection/get-items) API endpoint.
You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint.

Beware that it might be impossible to maintain an idle HTTP connection for
an extended period, due to client timeout or network conditions. Make sure your HTTP client is
Expand All @@ -282,8 +281,7 @@ configured to have a long enough connection timeout.
If the connection breaks, you will not receive any information about the run
and its status.

To run the Task asynchronously, use the [Run task
asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint
To run the Task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) endpoint
instead.
");
command.Arguments.Add(ActorTaskId);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -300,8 +300,7 @@ otherwise the HTTP request fails with a timeout error (this won't abort
input property, the Actor run uses the default value defined by the task (or the Actor's
input schema if not defined by the task).

You can send all the same options in parameters as the [Get Dataset
Items](#/reference/datasets/item-collection/get-items) API endpoint.
You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint.

Beware that it might be impossible to maintain an idle HTTP connection for
an extended period, due to client timeout or network conditions. Make sure your HTTP client is
Expand All @@ -316,8 +315,7 @@ passed as the POST payload.
Just make sure to specify the `Content-Type` header as `application/json`
and that the input is an object.

To run the task asynchronously, use the [Run
task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
To run the task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) API endpoint instead.
");
command.Arguments.Add(ActorTaskId);
command.Options.Add(Timeout);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,7 @@ passed as the POST payload.
Just make sure to specify `Content-Type` header to be `application/json` and
input to be an object.

To run the task asynchronously, use the [Run
task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
To run the task asynchronously, use the [Run Actor task](/api/v2/actor-task-runs-post) API endpoint instead.
");
command.Arguments.Add(ActorTaskId);
command.Options.Add(Timeout);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,17 @@ All the endpoints require an authentication token.
Using the `status` query parameter you can ensure to only get a run with a certain status
(e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means
by which they were started (e.g. `origin=API`). The output of this endpoint and other query
parameters are the same as in the [Run object](/api/v2/actor-run-get) endpoint.
parameters are the same as in the [Get Actor run](/api/v2/actor-run-get) endpoint.

##### Convenience endpoints for last Actor task run

* [Dataset](/api/v2/last-actor-task-runs-default-dataset)
* [Last Actor task run's default dataset](/api/v2/last-actor-task-runs-default-dataset)

* [Key-value store](/api/v2/last-actor-task-runs-default-key-value-store)
* [Last Actor task run's default key-value store](/api/v2/last-actor-task-runs-default-key-value-store)

* [Request queue](/api/v2/last-actor-task-runs-default-request-queue)
* [Last Actor task run's default request queue](/api/v2/last-actor-task-runs-default-request-queue)

* [Log](/api/v2/last-actor-task-runs-log)
* [Last Actor task run's log](/api/v2/last-actor-task-runs-log)
");
command.Arguments.Add(ActorTaskId);
command.Options.Add(Status);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,18 +134,17 @@ public static Command Create(string? commandName = null)
input property, the Actor run uses the default value defined by the task (or Actor's input
schema if not defined by the task).

The response is the Actor Run object as returned by the [Get
run](#/reference/actor-runs/run-object-and-its-storages/get-run) endpoint.
The response is the Actor Run object as returned by the [Get Actor run](/api/v2/actor-run-get) endpoint.

If you want to wait for the run to finish and receive the actual output of
the Actor run as the response, use one of the [Run task
synchronously](#/reference/actor-tasks/run-task-synchronously) API endpoints
instead.
the Actor run as the response, use the [Run Actor task synchronously and get key-value store record](/api/v2/actor-task-run-sync-post)
or [Run Actor task synchronously and get dataset items](/api/v2/actor-task-run-sync-get-dataset-items-post)
endpoint instead.

To fetch the Actor run results that are typically stored in the default
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
received in the response JSON to the
[Get dataset items](#/reference/datasets/item-collection/get-items) API endpoint.
[Get dataset items](/api/v2/dataset-items-get) API endpoint.
");
command.Arguments.Add(ActorTaskId);
command.Options.Add(Timeout);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ public static Command Create(string? commandName = null)
var command = new Command(commandName ?? @"actor-openapi-json-get", @"Get OpenAPI definition of Actor build
Get the OpenAPI definition for Actor builds. Two similar endpoints are available:

- [First endpoint](/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
- [Get OpenAPI definition of Actor build](/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.

- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.
- [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`.

Get the OpenAPI definition for a specific Actor build.

Expand All @@ -59,7 +59,7 @@ Authentication is based on the build's unique ID. No authentication token is req

:::note

You can also use the [`/api/v2/actor-build-openapi-json-get`](/api/v2/actor-build-openapi-json-get) endpoint to get the OpenAPI definition for a build.
You can also use the [Get OpenAPI definition of Actor build](/api/v2/actor-build-openapi-json-get) endpoint (`/v2/actor-builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build.

:::
");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public static Command Create(string? commandName = null)
var command = new Command(commandName ?? @"actors-builds-post", @"Build Actor
Builds an Actor.
The response is the build object as returned by the
[Get build](#/reference/actors/build-object/get-build) endpoint.
[Get Actor build](/api/v2/actor-build-get) endpoint.
");
command.Arguments.Add(ActorId);
command.Options.Add(Version);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-run-resurrect-post", @"Resurrect Actor run
**[DEPRECATED]** API endpoints related to run of the Actor were moved under
new namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished
new namespace `actor-runs`
([Manage Actor runs](/api/v2/actor-runs)). Resurrects a finished
Actor run and returns an object that contains all the details about the
resurrected run.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,7 @@ configured to have a long enough connection timeout.
If the connection breaks, you will not receive any information about the run
and its status.

To run the Actor asynchronously, use the [Run
Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead.
");
command.Arguments.Add(ActorId);
command.Options.Add(OutputRecordKey);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,7 @@ Runs a specific Actor and returns its dataset items.
otherwise the API endpoint returns a timeout error.
The Actor is not passed any input.

It allows to send all possible options in parameters from [Get Dataset
Items](#/reference/datasets/item-collection/get-items) API endpoint.
It allows to send all possible options in parameters from [Get dataset items](/api/v2/dataset-items-get) API endpoint.

Beware that it might be impossible to maintain an idle HTTP connection for a
long period of time,
Expand All @@ -286,8 +285,7 @@ configured to have a long enough connection timeout.
If the connection breaks, you will not receive any information about the run
and its status.

To run the Actor asynchronously, use the [Run
Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead.
");
command.Arguments.Add(ActorId);
command.Options.Add(Timeout);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,7 @@ the Actor (usually `application/json`).
The HTTP response contains the Actors dataset items, while the format of
items depends on specifying dataset items' `format` parameter.

You can send all the same options in parameters as the [Get Dataset
Items](#/reference/datasets/item-collection/get-items) API endpoint.
You can send all the same options in parameters as the [Get dataset items](/api/v2/dataset-items-get) API endpoint.

The Actor is started with the default options; you can override them using
URL query parameters.
Expand All @@ -309,8 +308,7 @@ configured to have a long enough connection timeout.
If the connection breaks, you will not receive any information about the run
and its status.

To run the Actor asynchronously, use the [Run
Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead.
");
command.Arguments.Add(ActorId);
command.Options.Add(Timeout);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@ configured to have a long enough connection timeout.
If the connection breaks, you will not receive any information about the run
and its status.

To run the Actor asynchronously, use the [Run
Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
To run the Actor asynchronously, use the [Run Actor](/api/v2/actors-runs-post) API endpoint instead.
");
command.Arguments.Add(ActorId);
command.Options.Add(OutputRecordKey);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,17 @@ All the endpoints require an authentication token.
Using the `status` query parameter you can ensure to only get a run with a certain status
(e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means
by which they were started (e.g. `origin=API`). The output of this endpoint and other query
parameters are the same as in the [Run object](#/reference/actors/run-object) endpoint.
parameters are the same as in the [Get Actor run](/api/v2/actor-run-get) endpoint.

##### Convenience endpoints for last Actor run

* [Dataset](/api/v2/last-actor-runs-default-dataset)
* [Last Actor run's default dataset](/api/v2/last-actor-runs-default-dataset)

* [Key-value store](/api/v2/last-actor-runs-default-key-value-store)
* [Last Actor run's default key-value store](/api/v2/last-actor-runs-default-key-value-store)

* [Request queue](/api/v2/last-actor-runs-default-request-queue)
* [Last Actor run's default request queue](/api/v2/last-actor-runs-default-request-queue)

* [Log](/api/v2/last-actor-runs-log)
* [Last Actor run's log](/api/v2/last-actor-runs-log)
");
command.Arguments.Add(ActorId);
command.Options.Add(Status);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,18 +142,17 @@ the Actor (usually `application/json`).
The Actor is started with the default options; you can override them using
various URL query parameters.

The response is the Run object as returned by the [Get
run](#/reference/actor-runs/run-object-and-its-storages/get-run) API
The response is the Run object as returned by the [Get Actor run](/api/v2/actor-run-get) API
endpoint.

If you want to wait for the run to finish and receive the actual output of
the Actor as the response, please use one of the [Run Actor
synchronously](#/reference/actors/run-actor-synchronously) API endpoints
instead.
the Actor as the response, please use the [Run Actor synchronously and get key-value store record](/api/v2/actor-run-sync-post)
or [Run Actor synchronously and get dataset items](/api/v2/actor-run-sync-get-dataset-items-post)
endpoint instead.

To fetch the Actor run results that are typically stored in the default
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
received in the response JSON to the [Get dataset items](#/reference/datasets/item-collection/get-items)
received in the response JSON to the [Get dataset items](/api/v2/dataset-items-get)
API endpoint.
");
command.Arguments.Add(ActorId);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.EnvV
public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-version-env-var-get", @"Get environment variable of Actor version
Gets a [EnvVar object](#/reference/actors/environment-variable-object) that
Gets an `EnvVar` object that
contains all the details about a specific environment variable of an Actor.

If `isSecret` is set to `true`, then `value` will never be returned.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.EnvV
public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-version-env-var-post", @"Update environment variable in Actor version (POST)
Updates Actor environment variable using values specified by a [EnvVar
object](#/reference/actors/environment-variable-object)
Updates Actor environment variable using values specified by an `EnvVar`
object
passed as JSON in the POST payload.
This endpoint is an alias for the [`PUT` update environment variable](#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_put) method and behaves identically.
This endpoint is an alias for the [Update environment variable in Actor version](/api/v2/actor-version-env-var-put) endpoint and behaves identically.
");
command.Arguments.Add(ActorId);
command.Arguments.Add(VersionNumber);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ private static string FormatResponse(ParseResult parseResult, global::Apify.EnvV
public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-version-env-var-put", @"Update environment variable in Actor version
Updates Actor environment variable using values specified by a [EnvVar
object](#/reference/actors/environment-variable-object)
Updates Actor environment variable using values specified by an `EnvVar`
object
passed as JSON in the POST payload.
If the object does not define a specific property, its value will not be
updated.
Expand All @@ -77,11 +77,11 @@ passed as JSON in the POST payload.
header!

When providing your API authentication token, we recommend using the
request's `Authorization` header, rather than the URL. ([More
info](#/introduction/authentication)).
request's `Authorization` header, rather than the URL.
For details, see [Authentication](/api/v2/getting-started#authentication).

The response is the [EnvVar object](#/reference/actors/environment-variable-object) as returned by the
[Get environment variable](#/reference/actors/environment-variable-object/get-environment-variable)
The response is the `EnvVar` object as returned by the
[Get environment variable of Actor version](/api/v2/actor-version-env-var-get)
endpoint.
");
command.Arguments.Add(ActorId);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public static Command Create(string? commandName = null)
{
var command = new Command(commandName ?? @"actor-version-env-vars-get", @"Get list of environment variables of Actor version
Gets the list of environment variables for a specific version of an Actor.
The response is a JSON object with the list of [EnvVar objects](#/reference/actors/environment-variable-object), where each contains basic information about a single environment variable.
The response is a JSON object with the list of `EnvVar` objects, where each contains basic information about a single environment variable.
");
command.Arguments.Add(ActorId);
command.Arguments.Add(VersionNumber);
Expand Down
Loading
Loading