Actor CLI Charging
Under maintenance
Try for free
This Actor is paid per event
Go to Store
This Actor is under maintenance.
This Actor may be unreliable while under maintenance. Would you like to try a similar Actor instead?
See alternative ActorsActor CLI Charging
mhamas/actor-cli-charging
Try for free
This Actor is paid per event
Example Actor featuring how you can charge from Apify CLI.
You can access the Actor CLI Charging programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "aqX5XL45QKIzd1b5b"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/mhamas~actor-cli-charging/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-mhamas-actor-cli-charging",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/mhamas~actor-cli-charging/runs": {
50 "post": {
51 "operationId": "runs-sync-mhamas-actor-cli-charging",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/mhamas~actor-cli-charging/run-sync": {
93 "post": {
94 "operationId": "run-sync-mhamas-actor-cli-charging",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "required": [
134 "eventName"
135 ],
136 "properties": {
137 "eventName": {
138 "title": "Event Name",
139 "type": "string",
140 "description": "Name of the event to be charged",
141 "default": "TEST"
142 },
143 "count": {
144 "title": "Event Count",
145 "type": "integer",
146 "description": "Number of events to charge"
147 },
148 "idempotencyKey": {
149 "title": "Idempotency Key",
150 "type": "string",
151 "description": "Optional key to ensure idempotency of the charge"
152 },
153 "testPPE": {
154 "title": "Test pay-per-event",
155 "type": "boolean",
156 "description": "Flag for testing pay-per-event monetization model. If passed, the actor won't charge anything but log the charge instead."
157 }
158 }
159 },
160 "runsResponseSchema": {
161 "type": "object",
162 "properties": {
163 "data": {
164 "type": "object",
165 "properties": {
166 "id": {
167 "type": "string"
168 },
169 "actId": {
170 "type": "string"
171 },
172 "userId": {
173 "type": "string"
174 },
175 "startedAt": {
176 "type": "string",
177 "format": "date-time",
178 "example": "2025-01-08T00:00:00.000Z"
179 },
180 "finishedAt": {
181 "type": "string",
182 "format": "date-time",
183 "example": "2025-01-08T00:00:00.000Z"
184 },
185 "status": {
186 "type": "string",
187 "example": "READY"
188 },
189 "meta": {
190 "type": "object",
191 "properties": {
192 "origin": {
193 "type": "string",
194 "example": "API"
195 },
196 "userAgent": {
197 "type": "string"
198 }
199 }
200 },
201 "stats": {
202 "type": "object",
203 "properties": {
204 "inputBodyLen": {
205 "type": "integer",
206 "example": 2000
207 },
208 "rebootCount": {
209 "type": "integer",
210 "example": 0
211 },
212 "restartCount": {
213 "type": "integer",
214 "example": 0
215 },
216 "resurrectCount": {
217 "type": "integer",
218 "example": 0
219 },
220 "computeUnits": {
221 "type": "integer",
222 "example": 0
223 }
224 }
225 },
226 "options": {
227 "type": "object",
228 "properties": {
229 "build": {
230 "type": "string",
231 "example": "latest"
232 },
233 "timeoutSecs": {
234 "type": "integer",
235 "example": 300
236 },
237 "memoryMbytes": {
238 "type": "integer",
239 "example": 1024
240 },
241 "diskMbytes": {
242 "type": "integer",
243 "example": 2048
244 }
245 }
246 },
247 "buildId": {
248 "type": "string"
249 },
250 "defaultKeyValueStoreId": {
251 "type": "string"
252 },
253 "defaultDatasetId": {
254 "type": "string"
255 },
256 "defaultRequestQueueId": {
257 "type": "string"
258 },
259 "buildNumber": {
260 "type": "string",
261 "example": "1.0.0"
262 },
263 "containerUrl": {
264 "type": "string"
265 },
266 "usage": {
267 "type": "object",
268 "properties": {
269 "ACTOR_COMPUTE_UNITS": {
270 "type": "integer",
271 "example": 0
272 },
273 "DATASET_READS": {
274 "type": "integer",
275 "example": 0
276 },
277 "DATASET_WRITES": {
278 "type": "integer",
279 "example": 0
280 },
281 "KEY_VALUE_STORE_READS": {
282 "type": "integer",
283 "example": 0
284 },
285 "KEY_VALUE_STORE_WRITES": {
286 "type": "integer",
287 "example": 1
288 },
289 "KEY_VALUE_STORE_LISTS": {
290 "type": "integer",
291 "example": 0
292 },
293 "REQUEST_QUEUE_READS": {
294 "type": "integer",
295 "example": 0
296 },
297 "REQUEST_QUEUE_WRITES": {
298 "type": "integer",
299 "example": 0
300 },
301 "DATA_TRANSFER_INTERNAL_GBYTES": {
302 "type": "integer",
303 "example": 0
304 },
305 "DATA_TRANSFER_EXTERNAL_GBYTES": {
306 "type": "integer",
307 "example": 0
308 },
309 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
310 "type": "integer",
311 "example": 0
312 },
313 "PROXY_SERPS": {
314 "type": "integer",
315 "example": 0
316 }
317 }
318 },
319 "usageTotalUsd": {
320 "type": "number",
321 "example": 0.00005
322 },
323 "usageUsd": {
324 "type": "object",
325 "properties": {
326 "ACTOR_COMPUTE_UNITS": {
327 "type": "integer",
328 "example": 0
329 },
330 "DATASET_READS": {
331 "type": "integer",
332 "example": 0
333 },
334 "DATASET_WRITES": {
335 "type": "integer",
336 "example": 0
337 },
338 "KEY_VALUE_STORE_READS": {
339 "type": "integer",
340 "example": 0
341 },
342 "KEY_VALUE_STORE_WRITES": {
343 "type": "number",
344 "example": 0.00005
345 },
346 "KEY_VALUE_STORE_LISTS": {
347 "type": "integer",
348 "example": 0
349 },
350 "REQUEST_QUEUE_READS": {
351 "type": "integer",
352 "example": 0
353 },
354 "REQUEST_QUEUE_WRITES": {
355 "type": "integer",
356 "example": 0
357 },
358 "DATA_TRANSFER_INTERNAL_GBYTES": {
359 "type": "integer",
360 "example": 0
361 },
362 "DATA_TRANSFER_EXTERNAL_GBYTES": {
363 "type": "integer",
364 "example": 0
365 },
366 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
367 "type": "integer",
368 "example": 0
369 },
370 "PROXY_SERPS": {
371 "type": "integer",
372 "example": 0
373 }
374 }
375 }
376 }
377 }
378 }
379 }
380 }
381 }
382}Actor CLI Charging OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Actor CLI Charging from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Developer
Matej HamasMaintained by Community
Actor Metrics
1 monthly user
-
0 No bookmarks yet
>99% runs succeeded
Created in Feb 2025
Modified 3 days ago
Categories
