|
8 | 8 | - '#/reference/actors/actor-object' |
9 | 9 | - '#tag/ActorsActor-object' |
10 | 10 | description: | |
11 | | - The API endpoints described in this section enable you to manage, build and run Apify actors. |
| 11 | + The API endpoints described in this section enable you to manage, build and run Apify Actors. |
12 | 12 | For more information, see the <a href="https://docs.apify.com/platform/actors">Actor documentation</a>. |
13 | 13 |
|
14 | | - Note that for all the API endpoints that accept the `actorId` parameter to specify an actor, |
15 | | - you can pass either the actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated |
16 | | - username of the actor owner and the actor name (e.g. `janedoe~my-actor`). |
| 14 | + Note that for all the API endpoints that accept the `actorId` parameter to specify an Actor, |
| 15 | + you can pass either the Actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated |
| 16 | + username of the Actor owner and the Actor name (e.g. `janedoe~my-actor`). |
17 | 17 |
|
18 | 18 | Some of the API endpoints return runs objects. Note that if any such run object |
19 | 19 | contains usage in dollars, your effective unit pricing at the time of query |
|
77 | 77 | </tr> |
78 | 78 | </table> |
79 | 79 |
|
80 | | - For more information about source code and actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) |
| 80 | + For more information about source code and Actor versions, see [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) |
81 | 81 | in Actors documentation. |
82 | 82 | - name: Actors/Actor builds |
83 | 83 | x-displayName: Actor builds |
|
121 | 121 | x-trait: 'true' |
122 | 122 | description: | |
123 | 123 | This is not a single endpoint, but an entire group of endpoints that lets you to |
124 | | - retrieve and manage the last run of given actor or any of its default storages. |
| 124 | + retrieve and manage the last run of given Actor or any of its default storages. |
125 | 125 | All the endpoints require an authentication token. |
126 | 126 |
|
127 | 127 | The endpoints accept the same HTTP methods and query parameters as |
128 | 128 | the respective storage endpoints. |
129 | | - The base path represents the last actor run object is: |
| 129 | + The base path represents the last Actor run object is: |
130 | 130 |
|
131 | 131 | `/v2/acts/{actorId}/runs/last{?token,status}` |
132 | 132 |
|
133 | 133 | Using the `status` query parameter you can ensure to only get a run with a certain status |
134 | 134 | (e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters |
135 | 135 | are the same as in the [Run object](#/reference/actors/run-object) endpoint. |
136 | 136 |
|
137 | | - In order to access the default storages of the last actor run, i.e. log, key-value |
| 137 | + In order to access the default storages of the last Actor run, i.e. log, key-value |
138 | 138 | store, dataset and request queue, use the following endpoints: |
139 | 139 |
|
140 | 140 | * `/v2/acts/{actorId}/runs/last/log{?token,status}` |
|
166 | 166 | [Request collection](#/reference/request-queues/request) |
167 | 167 | * `/v2/acts/{actorId}/runs/last/request-queue/head{?token,status}` [Queue head](#/reference/request-queues/queue-head) |
168 | 168 |
|
169 | | - For example, to download data from a dataset of the last succeeded actor run in XML format, |
| 169 | + For example, to download data from a dataset of the last succeeded Actor run in XML format, |
170 | 170 | send HTTP GET request to the following URL: |
171 | 171 |
|
172 | 172 | ``` |
|
188 | 188 | - '#/reference/actor-builds/build-log' |
189 | 189 | - '#tag/Actor-buildsBuild-log' |
190 | 190 | description: | |
191 | | - The API endpoints described in this section enable you to manage Apify actor builds. |
| 191 | + The API endpoints described in this section enable you to manage Apify Actor builds. |
192 | 192 |
|
193 | 193 | Note that if any returned build object contains usage in dollars, your effective |
194 | 194 | unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be |
|
218 | 218 | This section describes API endpoints to manage Key-value stores. |
219 | 219 | Key-value store is a simple storage for saving and reading data records or files. |
220 | 220 | Each data record is represented by a unique key and associated with a MIME content type. |
221 | | - Key-value stores are ideal for saving screenshots, actor inputs and outputs, web pages, |
| 221 | + Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, |
222 | 222 | PDFs or to persist the state of crawlers. |
223 | 223 | For more information, see the <a href="https://docs.apify.com/platform/storage/key-value-store">Key-value |
224 | 224 | store documentation</a>. |
|
247 | 247 | - '#/reference/actor-tasks/last-run-object-and-its-storages' |
248 | 248 | - '#tag/Actor-tasksLast-run-object-and-its-storages' |
249 | 249 | description: | |
250 | | - The API endpoints described in this section enable you to manage and run Apify actor tasks. |
| 250 | + The API endpoints described in this section enable you to manage and run Apify Actor tasks. |
251 | 251 | For more information, see the <a href="https://docs.apify.com/platform/actors/running/tasks">Actor |
252 | 252 | tasks documentation</a>. |
253 | 253 |
|
|
308 | 308 | This section describes API endpoints to manage Key-value stores. |
309 | 309 | Key-value store is a simple storage for saving and reading data records or files. |
310 | 310 | Each data record is represented by a unique key and associated with a MIME content type. |
311 | | - Key-value stores are ideal for saving screenshots, actor inputs and outputs, web pages, |
| 311 | + Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, |
312 | 312 | PDFs or to persist the state of crawlers. |
313 | 313 | For more information, see the <a href="https://docs.apify.com/platform/storage/key-value-store">Key-value |
314 | 314 | store documentation</a>. |
|
380 | 380 | Webhooks provide an easy and reliable way to configure the Apify platform |
381 | 381 | to carry out an action (e.g. a HTTP request to another service) when a certain |
382 | 382 | system event occurs. |
383 | | - For example, you can use webhooks to start another actor when an actor run finishes |
| 383 | + For example, you can use webhooks to start another Actor when an Actor run finishes |
384 | 384 | or fails. |
385 | 385 | For more information see <a href="https://docs.apify.com/platform/integrations/webhooks">Webhooks |
386 | 386 | documentation</a>. |
|
409 | 409 | description: | |
410 | 410 | This section describes API endpoints for managing schedules. |
411 | 411 |
|
412 | | - Schedules are used to automatically start your actors at certain times. Each schedule |
413 | | - can be associated with a number of actors and actor tasks. It is also possible |
414 | | - to override the settings of each actor (task) similarly to when invoking the actor |
| 412 | + Schedules are used to automatically start your Actors at certain times. Each schedule |
| 413 | + can be associated with a number of Actors and Actor tasks. It is also possible |
| 414 | + to override the settings of each Actor (task) similarly to when invoking the Actor |
415 | 415 | (task) using the API. |
416 | 416 | For more information, see <a href="https://docs.apify.com/platform/schedules">Schedules |
417 | 417 | documentation</a>. |
|
443 | 443 | - '#tag/LogsLog' |
444 | 444 | description: | |
445 | 445 | The API endpoints described in this section are used the download the logs |
446 | | - generated by actor builds and runs. Note that only the trailing 5M characters |
| 446 | + generated by Actor builds and runs. Note that only the trailing 5M characters |
447 | 447 | of the log are stored, the rest is discarded. |
448 | 448 |
|
449 | 449 | Note that the endpoints do not require the authentication token, the calls |
450 | | - are authenticated using a hard-to-guess ID of the actor build or run. |
| 450 | + are authenticated using a hard-to-guess ID of the Actor build or run. |
451 | 451 | x-trait: true |
452 | 452 | - name: Users |
453 | 453 | x-displayName: Users |
|
0 commit comments