Image Difference Generator
Pricing
Pay per usage
Go to Store
Image Difference Generator
Returns a difference of two given images as JPEG or PNG image.
4.0 (3)
Pricing
Pay per usage
4
Monthly users
3
Runs succeeded
91%
Last modified
10 months ago
You can access the Image Difference Generator programmatically from your own applications by using the Apify API. You can also 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": "R5XWZ5ShproEQgzht"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/apify~image-diff/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-apify-image-diff",
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/apify~image-diff/runs": {
50 "post": {
51 "operationId": "runs-sync-apify-image-diff",
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/apify~image-diff/run-sync": {
93 "post": {
94 "operationId": "run-sync-apify-image-diff",
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 "imageUrl1",
135 "imageUrl2",
136 "proxy"
137 ],
138 "properties": {
139 "imageUrl1": {
140 "title": "The first image URL",
141 "type": "string",
142 "description": "URL of the first image to be diffed."
143 },
144 "imageUrl2": {
145 "title": "The second image URL",
146 "type": "string",
147 "description": "URL of the second image to be diffed."
148 },
149 "outputAsJpeg": {
150 "title": "Output as JPEG",
151 "type": "boolean",
152 "description": "Outputs resulting image in JPEG format. Default is PNG."
153 },
154 "pixelmatchOptions": {
155 "title": "Pixelmatch options",
156 "type": "object",
157 "description": "Options for pixelmatch package that is used image comparison.",
158 "default": {
159 "threshold": 0.1
160 }
161 },
162 "proxy": {
163 "title": "Proxy configuration",
164 "type": "object",
165 "description": "Sets the proxy configuration",
166 "default": {
167 "useApifyProxy": true
168 }
169 }
170 }
171 },
172 "runsResponseSchema": {
173 "type": "object",
174 "properties": {
175 "data": {
176 "type": "object",
177 "properties": {
178 "id": {
179 "type": "string"
180 },
181 "actId": {
182 "type": "string"
183 },
184 "userId": {
185 "type": "string"
186 },
187 "startedAt": {
188 "type": "string",
189 "format": "date-time",
190 "example": "2025-01-08T00:00:00.000Z"
191 },
192 "finishedAt": {
193 "type": "string",
194 "format": "date-time",
195 "example": "2025-01-08T00:00:00.000Z"
196 },
197 "status": {
198 "type": "string",
199 "example": "READY"
200 },
201 "meta": {
202 "type": "object",
203 "properties": {
204 "origin": {
205 "type": "string",
206 "example": "API"
207 },
208 "userAgent": {
209 "type": "string"
210 }
211 }
212 },
213 "stats": {
214 "type": "object",
215 "properties": {
216 "inputBodyLen": {
217 "type": "integer",
218 "example": 2000
219 },
220 "rebootCount": {
221 "type": "integer",
222 "example": 0
223 },
224 "restartCount": {
225 "type": "integer",
226 "example": 0
227 },
228 "resurrectCount": {
229 "type": "integer",
230 "example": 0
231 },
232 "computeUnits": {
233 "type": "integer",
234 "example": 0
235 }
236 }
237 },
238 "options": {
239 "type": "object",
240 "properties": {
241 "build": {
242 "type": "string",
243 "example": "latest"
244 },
245 "timeoutSecs": {
246 "type": "integer",
247 "example": 300
248 },
249 "memoryMbytes": {
250 "type": "integer",
251 "example": 1024
252 },
253 "diskMbytes": {
254 "type": "integer",
255 "example": 2048
256 }
257 }
258 },
259 "buildId": {
260 "type": "string"
261 },
262 "defaultKeyValueStoreId": {
263 "type": "string"
264 },
265 "defaultDatasetId": {
266 "type": "string"
267 },
268 "defaultRequestQueueId": {
269 "type": "string"
270 },
271 "buildNumber": {
272 "type": "string",
273 "example": "1.0.0"
274 },
275 "containerUrl": {
276 "type": "string"
277 },
278 "usage": {
279 "type": "object",
280 "properties": {
281 "ACTOR_COMPUTE_UNITS": {
282 "type": "integer",
283 "example": 0
284 },
285 "DATASET_READS": {
286 "type": "integer",
287 "example": 0
288 },
289 "DATASET_WRITES": {
290 "type": "integer",
291 "example": 0
292 },
293 "KEY_VALUE_STORE_READS": {
294 "type": "integer",
295 "example": 0
296 },
297 "KEY_VALUE_STORE_WRITES": {
298 "type": "integer",
299 "example": 1
300 },
301 "KEY_VALUE_STORE_LISTS": {
302 "type": "integer",
303 "example": 0
304 },
305 "REQUEST_QUEUE_READS": {
306 "type": "integer",
307 "example": 0
308 },
309 "REQUEST_QUEUE_WRITES": {
310 "type": "integer",
311 "example": 0
312 },
313 "DATA_TRANSFER_INTERNAL_GBYTES": {
314 "type": "integer",
315 "example": 0
316 },
317 "DATA_TRANSFER_EXTERNAL_GBYTES": {
318 "type": "integer",
319 "example": 0
320 },
321 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
322 "type": "integer",
323 "example": 0
324 },
325 "PROXY_SERPS": {
326 "type": "integer",
327 "example": 0
328 }
329 }
330 },
331 "usageTotalUsd": {
332 "type": "number",
333 "example": 0.00005
334 },
335 "usageUsd": {
336 "type": "object",
337 "properties": {
338 "ACTOR_COMPUTE_UNITS": {
339 "type": "integer",
340 "example": 0
341 },
342 "DATASET_READS": {
343 "type": "integer",
344 "example": 0
345 },
346 "DATASET_WRITES": {
347 "type": "integer",
348 "example": 0
349 },
350 "KEY_VALUE_STORE_READS": {
351 "type": "integer",
352 "example": 0
353 },
354 "KEY_VALUE_STORE_WRITES": {
355 "type": "number",
356 "example": 0.00005
357 },
358 "KEY_VALUE_STORE_LISTS": {
359 "type": "integer",
360 "example": 0
361 },
362 "REQUEST_QUEUE_READS": {
363 "type": "integer",
364 "example": 0
365 },
366 "REQUEST_QUEUE_WRITES": {
367 "type": "integer",
368 "example": 0
369 },
370 "DATA_TRANSFER_INTERNAL_GBYTES": {
371 "type": "integer",
372 "example": 0
373 },
374 "DATA_TRANSFER_EXTERNAL_GBYTES": {
375 "type": "integer",
376 "example": 0
377 },
378 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
379 "type": "integer",
380 "example": 0
381 },
382 "PROXY_SERPS": {
383 "type": "integer",
384 "example": 0
385 }
386 }
387 }
388 }
389 }
390 }
391 }
392 }
393 }
394}Image Difference Generator 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 Image Difference Generator 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:
Pricing
Pricing model
Pay per usageThis Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage.
