{ "openapi": "3.0.1", "info": { "title": "Face Compare — Face Verification & Embeddings API (No GPU)", "description": "Check if photos show the same person: compare faces with a reference photo or embedding, get similarity scores, match/no-match and 128-d face embeddings. 99.0% on LFW. Your images only, no web search. Pay per image.", "version": "0.1", "x-build-id": "PMFDhokzswdM4sfGX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adorable_partial~face-compare/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adorable_partial-face-compare", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/adorable_partial~face-compare/runs": { "post": { "operationId": "runs-sync-adorable_partial-face-compare", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/adorable_partial~face-compare/run-sync": { "post": { "operationId": "run-sync-adorable_partial-face-compare", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "referenceImageUrls": { "title": "Reference photo(s)", "type": "array", "description": "One or more clear photos of the person to look for (the largest face in each photo is used; several photos are averaged into a more robust reference). Leave empty to only extract face embeddings.", "items": { "type": "string" } }, "referenceEmbedding": { "title": "Reference embedding (optional)", "type": "array", "description": "A 128-number face embedding returned earlier by this Actor (field \"embedding\" or the REFERENCE record). Lets you compare against a stored person without sending the photo again. Combined with reference photos if both are given." }, "imageUrls": { "title": "Images to check", "type": "array", "description": "Images to analyse (JPEG, PNG, WebP, BMP, TIFF; up to 50 MB each). Every face found is compared with the reference. Public Google Drive and Dropbox links work.", "items": { "type": "string" } }, "threshold": { "title": "Match threshold", "type": "string", "description": "Cosine similarity at or above which two faces count as the same person. 0.363 (default) gave 99.0% accuracy and 0 false matches on the LFW benchmark. Raise it (e.g. 0.45) for fewer false matches, lower it (e.g. 0.30) to miss fewer true matches.", "default": "0.363" }, "returnEmbeddings": { "title": "Return embeddings", "type": "boolean", "description": "Include the 128-number embedding of every face in the output (always on when no reference is given).", "default": false }, "includeLandmarks": { "title": "Return facial landmarks", "type": "boolean", "description": "Include the 5 landmark points (eyes, nose tip, mouth corners) of every face.", "default": false }, "minFaceSize": { "title": "Minimum face size (px)", "minimum": 10, "type": "integer", "description": "Ignore faces smaller than this. Tiny faces give unreliable comparisons.", "default": 40 }, "maxFacesPerImage": { "title": "Max faces per image", "minimum": 1, "maximum": 200, "type": "integer", "description": "Keep only the N largest faces of each image.", "default": 20 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }