|
1 | 1 | - name: Actors |
2 | | - x-displayName: Actors |
| 2 | + x-displayName: Actors - Introduction |
3 | 3 | x-legacy-doc-urls: |
4 | 4 | - '#/reference/actors' |
5 | 5 | - '#tag/Actors' |
|
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. |
12 | | - For more information, see the <a href="https://docs.apify.com/platform/actors">Actor documentation</a>. |
| 11 | + The API endpoints in this section allow you to manage Apify Actors. For more details about Actors, refer to the [Actor documentation](https://docs.apify.com/platform/actors). |
13 | 12 |
|
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`). |
| 13 | + For API endpoints that require the `actorId` parameter to identify an Actor, you can provide either: |
| 14 | + - The Actor ID (e.g., `HG7ML7M8z78YcAPEB`), or |
| 15 | + - A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`). |
17 | 16 |
|
18 | | - Some of the API endpoints return runs objects. Note that if any such run object |
19 | | - contains usage in dollars, your effective unit pricing at the time of query |
20 | | - has been used for computation of this dollar equivalent, and hence it should be |
21 | | - used only for informative purposes. You can learn more |
22 | | - about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>. |
23 | 17 | - name: Actors/Actor versions |
24 | 18 | x-displayName: Actor versions |
25 | 19 | x-parent-tag-name: Actors |
|
34 | 28 | - '#tag/ActorsEnvironment-variable-object' |
35 | 29 | x-trait: 'true' |
36 | 30 | description: | |
37 | | - The **Version object** contains the source code of a specific version of an actor. |
38 | | - The `sourceType` property indicates where the source code is hosted, and based |
| 31 | + The API endpoints in this section allow you to manage your Apify Actors versions. |
| 32 | +
|
| 33 | + - The _Version object_ contains the source code of a specific version of an Actor. |
| 34 | + - The `sourceType` property indicates where the source code is hosted, and based |
39 | 35 | on its value the Version object has the following additional property: |
40 | 36 |
|
41 | | - <table> |
42 | | - <tr> |
43 | | - <td><code>"SOURCE_FILES"</code></td> |
44 | | - <td> |
45 | | - Source code is comprised of multiple files specified in the <code>sourceFiles</code> array. |
46 | | - Each item of the array is an object with the following fields:<br /> |
47 | | - <ul> |
48 | | - <li><code>name</code></li> - File path and name<br /> |
49 | | - <li><code>format</code></li> - Format of the content, can be either <code>"TEXT"</code> |
50 | | - or <code>"BASE64"</code><br /> |
51 | | - <li><code>content</code></li> - File content<br /> |
52 | | - </ul> |
53 | | - <br /> |
54 | | - Source files can be shown and edited in the Apify Console's Web IDE. |
55 | | - </td> |
56 | | - </tr> |
57 | | - <tr> |
58 | | - <td><code>"GIT_REPO"</code></td> |
59 | | - <td> |
60 | | - Source code is cloned from a Git repository, whose URL is specified in |
61 | | - the <code>gitRepoUrl</code> field. |
62 | | - </td> |
63 | | - </tr> |
64 | | - <tr> |
65 | | - <td><code>"TARBALL"</code></td> |
66 | | - <td> |
67 | | - Source code is downloaded using a tarball or Zip file from a URL specified |
68 | | - in the <code>tarballUrl</code> field. |
69 | | - </td> |
70 | | - </tr> |
71 | | - <tr> |
72 | | - <td><code>"GITHUB_GIST"</code></td> |
73 | | - <td> |
74 | | - Source code is taken from a GitHub Gist, whose URL is specified in the |
75 | | - <code>gitHubGistUrl</code> field. |
76 | | - </td> |
77 | | - </tr> |
78 | | - </table> |
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) |
| 37 | + | **Value** | **Description** | |
| 38 | + |---|---| |
| 39 | + | `"SOURCE_FILES"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:<br/> - `name`: File path and name<br/> - `format`: Format of the content, can be either `"TEXT"` or `"BASE64"`<br/> - `content`: File content<br/><br/>Source files can be shown and edited in the Apify Console's Web IDE. | |
| 40 | + | `"GIT_REPO"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. | |
| 41 | + | `"TARBALL"` | Source code is downloaded using a tarball or Zip file from a URL specified in the `tarballUrl` field. | |
| 42 | + |`"GITHUB_GIST"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. | |
| 43 | +
|
| 44 | + For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) |
81 | 45 | in Actors documentation. |
82 | 46 | - name: Actors/Actor builds |
83 | 47 | x-displayName: Actor builds |
|
104 | 68 | - '#tag/ActorsRun-actor-synchronously' |
105 | 69 | - '#/reference/actors/run-actor-synchronously-and-get-dataset-items' |
106 | 70 | - '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items' |
| 71 | + description: | |
| 72 | + The API endpoints in this section allow you to run Apify Actors. |
| 73 | +
|
| 74 | + Some API endpoints return run objects. If a run object includes usage costs in dollars, note that these values are calculated based on your effective unit pricing at the time of the query. As a result, the dollar amounts should be treated as informational only and not as exact figures. |
| 75 | +
|
| 76 | + For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). |
107 | 77 | x-trait: 'true' |
108 | 78 | - name: Actors/Webhook collection |
109 | 79 | x-displayName: Webhook collection |
110 | 80 | x-parent-tag-name: Actors |
111 | 81 | x-legacy-doc-urls: |
112 | 82 | - '#/reference/actors/webhook-collection' |
113 | 83 | - '#tag/ActorsWebhook-collection' |
| 84 | + description: | |
| 85 | + The API endpoint in this section allows you to get a list of webhooks of a specific Actor. |
114 | 86 | x-trait: 'true' |
115 | 87 | - name: Actors/Last run object and its storages |
116 | 88 | x-displayName: Last run object and its storages |
|
175 | 147 |
|
176 | 148 | In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. |
177 | 149 | - name: Actor builds |
178 | | - x-displayName: Introduction |
| 150 | + x-displayName: Actor builds - Introduction |
179 | 151 | x-legacy-doc-urls: |
180 | 152 | - '#/reference/actor-builds' |
181 | 153 | - '#tag/Actor-builds' |
|
188 | 160 | - '#/reference/actor-builds/build-log' |
189 | 161 | - '#tag/Actor-buildsBuild-log' |
190 | 162 | description: | |
191 | | - The API endpoints described in this section enable you to manage Apify Actor builds. |
| 163 | + The API endpoints described in this section enable you to create, manage, and delete Apify Actor builds. |
| 164 | +
|
| 165 | + :::note |
192 | 166 |
|
193 | 167 | Note that if any returned build object contains usage in dollars, your effective |
194 | 168 | unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be |
195 | 169 | used only for informative purposes. |
196 | 170 | You can learn more about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>. |
| 171 | +
|
| 172 | + ::: |
197 | 173 | - name: Actor runs |
198 | | - x-displayName: Introduction |
| 174 | + x-displayName: Actor runs - Introduction |
199 | 175 | x-legacy-doc-urls: |
200 | 176 | - '#/reference/actor-runs' |
201 | 177 | - '#tag/Actor-runs' |
|
206 | 182 | description: | |
207 | 183 | The API endpoints described in this section enable you to manage Apify Actor runs. |
208 | 184 |
|
| 185 | + :::note |
| 186 | +
|
209 | 187 | Note that if any returned run object contains usage in dollars, your effective unit pricing at the time of query |
210 | 188 | has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. |
211 | 189 | You can learn more about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>. |
| 190 | +
|
| 191 | + ::: |
212 | 192 | - name: Key-value stores |
213 | 193 | x-displayName: Key-value stores |
214 | 194 | x-legacy-doc-urls: |
215 | 195 | - '#/reference/key-value-stores' |
216 | 196 | - '#tag/Key-value-stores' |
217 | 197 | description: | |
218 | | - This section describes API endpoints to manage Key-value stores. |
| 198 | + The API endpoints described in this section enable you to manage Key-value stores. |
219 | 199 | Key-value store is a simple storage for saving and reading data records or files. |
220 | 200 | Each data record is represented by a unique key and associated with a MIME content type. |
221 | 201 | Key-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages, |
|
0 commit comments