--- updatedAt: 2025-02-13T15:15:20.000Z agentTools: projectIndex: https://vision.truepic.dev/llms.txt --- # List All Uploaded Captures Get a list of all uploaded captures with results from processing. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Lens API - V1", "description": "RESTful JSON API for Lens web services", "version": "1" }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key" } }, "schemas": { "def-0": { "type": "object", "properties": { "error": { "type": "object", "description": "All `4xx` and `5xx` errors from the application respond with a common payload structure. Errors from outside of the application – like hosting infrastructure – do not, but should be uncommon.", "properties": { "status": { "type": "integer", "description": "The HTTP status code of the response." }, "message": { "type": "string", "description": "A helpful message explaining the error." } }, "required": [ "status", "message" ] } }, "required": [ "error" ], "title": "error" }, "def-1": { "type": "object", "description": "A capture that has been uploaded for processing.", "properties": { "label_detection": { "type": "array", "description": "The labels detected in the photo.\n\nOnly included if the `label_detection` service was enabled.", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The label describing the thing." }, "score": { "type": "number", "minimum": 0, "maximum": 1, "description": "A measure of confidence in the label actually being what the computer thinks it sees. The range is 0 to 1." } }, "required": [ "label", "score" ] } }, "metadata": { "type": "object", "description": "The extracted metadata (EXIF, XMP, etc.).\n\nEach key is the metadata tag prepended with the group type, such as `XMP:Make`. Values can be of any JSON-encodable type.\n\nOnly included if the `metadata` service was enabled.", "additionalProperties": true }, "object_detection": { "type": "array", "description": "The objects detected in the photo.\n\nOnly included if the `object_detection` service was enabled.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the object." }, "score": { "type": "number", "minimum": 0, "maximum": 1, "description": "A measure of confidence in the object actually being what the computer thinks it sees. The range is 0 to 1." }, "bounding_polygon": { "type": "array", "description": "The bounding polygon where the object is located in the photo.", "items": { "type": "object", "description": "A vertex representing a 2D point that's relative to the original photo.\n\nFor example, an `x` and `y` value of 0.5 is a point at the exact center of the original photo.", "properties": { "x": { "type": "number", "minimum": 0, "maximum": 1, "description": "The horizontal coordinate relative to the original photo. The range is 0 to 1." }, "y": { "type": "number", "minimum": 0, "maximum": 1, "description": "The vertical coordinate relative to the original photo. The range is 0 to 1." } }, "required": [ "x", "y" ] } } }, "required": [ "name", "score", "bounding_polygon" ] } }, "recapture": { "type": "object", "description": "Whether the photo was detected as a recapture.\n\nOnly included if the `recapture` service was enabled.", "properties": { "status": { "type": "string", "enum": [ "PASS", "WARNING", "RECAPTURE", "BLURRY", "LOW_ENTROPY", "LOW_RESOLUTION", "SLOW_SHUTTERSPEED" ], "description": "One of the following values:\n\n* `PASS`: no recapture detected\n\n* `WARNING`: a screen was detected\n\n* `RECAPTURE`: the photo was detected as a recapture\n\n* `BLURRY`: `blur_score` <= 40\n\n* `LOW_ENTROPY`: `entropy_score` < 0.02\n\n* `LOW_RESOLUTION`: width x height < 1000 x 1000\n\n* `SLOW_SHUTTERSPEED`: slower than 1/5" }, "blur_score": { "type": "number", "description": "A measure of the sharpness/blurriness of the photo using the variance of a Laplacian kernel.\n\nTypically in the range of 0 to 3,000, but there is no hard upper limit.\n\nA score <= 40 is considered blurry and sets the `status` to `BLURRY`." }, "entropy_score": { "type": "number", "description": "A measure of the entropy of the photo.\n\nA \"flat\" photo with no features (like a wall or ceiling without texture) has low entropy, while a photo with many features has high entropy.\n\nTypically in the range of 0 to 1.5, but there is no hard upper limit.\n\nA score < 0.02 is considered low entropy and sets the `status` to `LOW_ENTROPY`." }, "recapture_score": { "type": "number", "minimum": 0, "maximum": 1, "description": "A measure of the probability that the photo is a recapture.\n\nThe range is 0 to 1.\n\nA score > 0.5 is considered a recapture and sets the `status` to `RECAPTURE`. If the score is borderline, but a screen was detected in the photo, then the `status` is set to `WARNING`." } }, "required": [ "status", "blur_score", "entropy_score", "recapture_score" ] }, "reverse_image_search": { "type": "object", "description": "Whether a matching photo was found on the internet.\n\nOnly included if the `reverse_image_search` service was enabled.", "properties": { "status": { "type": "string", "enum": [ "MATCH", "NO_MATCH" ], "description": "`MATCH` if a matching photo was found, otherwise `NO_MATCH`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the matching photo if `status` is `MATCH`. Otherwise, `null` when `status` is `NO_MATCH`." } }, "required": [ "status", "url" ] }, "text_detection": { "type": "array", "description": "The text detected in the photo.\n\nOnly included if the `text_detection` service was enabled.", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The string of text." }, "locale": { "type": "string", "description": "The language code for the locale of the `text`, or an empty string if unknown." }, "bounding_polygon": { "type": "array", "description": "The bounding polygon where the text is located in the photo.", "items": { "type": "object", "description": "A vertex representing a 2D point that's relative to the original photo.\n\nFor example, an `x` and `y` value of 0.5 is a point at the exact center of the original photo.", "properties": { "x": { "type": "number", "minimum": 0, "maximum": 1, "description": "The horizontal coordinate relative to the original photo. The range is 0 to 1." }, "y": { "type": "number", "minimum": 0, "maximum": 1, "description": "The vertical coordinate relative to the original photo. The range is 0 to 1." } }, "required": [ "x", "y" ] } } }, "required": [ "text", "locale", "bounding_polygon" ] } }, "verification": { "type": "object", "description": "The extracted and verified details about the capture that are cryptographically signed into the file to prevent tampering.\n\nOnly included if the `verification` service was enabled.", "properties": { "status": { "type": "string", "enum": [ "SUCCESS", "ERROR" ], "description": "`SUCCESS` if the capture contains verified details that could be extracted, otherwise `ERROR`. Only the `error` object will be included if `ERROR`." }, "assertions": { "type": "object", "description": "The assertions that are cryptographically signed into the file to prevent tampering.", "properties": { "hash": { "type": "object", "description": "The assertion details about the hash of the capture \"contents\" (pixels, etc.).", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the hash of the capture \"contents\" (pixels, etc.)." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." } }, "required": [ "status" ] }, "thumbnail": { "type": "object", "description": "The assertion details about the thumbnail.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the thumbnail." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "url": { "type": "string", "format": "uri", "description": "The URL of the verified thumbnail file.\n\nA token/signature is included in the query string that grants access for 10 hours. For a fresh token/signature with a new 10 hour expiration, simply re-fetch the capture." } }, "required": [ "status", "url" ] }, "location": { "type": "object", "description": "The assertion details about the location.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the location." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "latitude": { "type": "number", "description": "The GPS latitude (in decimal degrees) where the capture was taken." }, "longitude": { "type": "number", "description": "The GPS longitude (in decimal degrees) where the capture was taken." }, "accuracy": { "type": "number", "description": "The accuracy (in meters) of the GPS reading. " }, "altitude": { "type": "number", "nullable": true, "description": "The GPS altitude (in meters) where the capture was taken." }, "timestamp": { "type": "string", "format": "date-time", "description": "The date/time of the GPS reading." } }, "required": [ "status", "latitude", "longitude", "accuracy", "altitude", "timestamp" ] }, "device": { "type": "object", "description": "The assertion details about the device.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the device." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "make": { "type": "string", "description": "The make of the device." }, "model": { "type": "string", "description": "The model of the device." } }, "required": [ "status", "make", "model" ] }, "date_time": { "type": "object", "description": "The assertion details about the date/time of capture.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the date/time of capture." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "timestamp": { "type": "string", "format": "date-time", "description": "The date/time of capture." } }, "required": [ "status", "timestamp" ] }, "duration": { "type": "object", "description": "The assertion details about the duration of the audio/video.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the duration of the audio/video." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "seconds": { "type": "number", "description": "The duration of the audio/video in seconds and milliseconds." } }, "required": [ "status", "seconds" ] }, "odometry": { "type": "object", "description": "The assertion details about the odometry/sensor readings.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the odometry/sensor readings." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "heading": { "type": "number", "nullable": true, "description": "The direction (in degrees) that the camera was facing at time of capture.\n\n`null` is returned if no odometry/sensor readings were recorded, or if the camera was facing straight up (ceiling) or down (floor)." } }, "required": [ "status", "heading" ] } } }, "certificate": { "type": "object", "description": "The details about the certificate and associated public/private key pair used to sign the assertions.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the certificate." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "issuer_name": { "type": "string", "description": "The common name of the certificate's issuer." }, "name": { "type": "string", "description": "The common name from the certificate's subject DN." }, "org": { "type": "string", "description": "The organization name from the certificate's subject DN." }, "org_unit": { "type": "string", "description": "The organizational unit's name from the certificate's subject DN." }, "valid_from": { "type": "string", "format": "date-time", "description": "The date/time from which the certificate is valid." }, "valid_to": { "type": "string", "format": "date-time", "description": "The date/time until which the certificate is valid." } }, "required": [ "status", "issuer_name", "name", "org", "org_unit", "valid_from", "valid_to" ] }, "signature": { "type": "object", "description": "The details about the signing of the assertions.", "properties": { "status": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "The validation status of the signature." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `INVALID`." }, "name": { "type": "string", "description": "The name of the signer." } }, "required": [ "status", "name" ] }, "is_offline": { "type": "boolean", "description": "Whether the capture was signed when the device had low or no connectivity and was unable to reach the TSA." }, "trusted_timestamp": { "type": "object", "description": "The details about when the capture was signed, according to a trusted timestamp authority (TSA).", "properties": { "status": { "type": "string", "enum": [ "VALID", "OFFLINE", "INVALID", "WARNING" ], "description": "The validation status of the timestamp." }, "status_reason": { "type": "string", "description": "The status details if the `status` is `OFFLINE`, `INVALID`, or `WARNING`." }, "timestamp": { "type": "string", "format": "date-time", "nullable": true, "description": "The date/time of signing.\n\n`null` is returned if the `status` is `OFFLINE`, as the capture was signed when the device had low or no connectivity and was unable to reach the TSA." } }, "required": [ "status", "timestamp" ] }, "producer": { "type": "object", "description": "The details about the software that produced the assertions.", "properties": { "name": { "type": "string", "description": "The name and version of the software." } }, "required": [ "name" ] }, "error": { "type": "object", "description": "The error information if the `status` is `ERROR`.", "properties": { "message": { "type": "string", "description": "A helpful message explaining the error." } }, "required": [ "message" ] } }, "required": [ "status" ] }, "id": { "type": "string", "format": "uuid", "description": "The ID of the uploaded capture." }, "type": { "type": "string", "enum": [ "AUDIO", "PHOTO", "VIDEO" ], "description": "The type of capture." }, "status": { "type": "string", "enum": [ "RECEIVING", "WAITING", "PROCESSING", "SUCCESS", "ERROR", "QUARANTINE" ], "description": "The current processing state of the capture." }, "custom_data": { "type": "object", "description": "Custom data associated with the capture, such as an identifier to connect the capture to after processing. Any JSON-encodable values are allowed.", "additionalProperties": true, "nullable": true }, "uploaded_by_ip_address": { "anyOf": [ { "type": "string", "format": "ipv4", "nullable": true, "title": "IPv4", "description": "The IP address (version 4) that uploaded the capture." }, { "type": "string", "format": "ipv6", "nullable": true, "title": "IPv6", "description": "The IP address (version 6) that uploaded the capture." } ], "description": "The IP address (version 4 or 6) that uploaded the capture." }, "file_size": { "type": "integer", "nullable": true, "description": "The size of the file in bytes." }, "file_hash": { "type": "string", "nullable": true, "description": "The SHA-256, Base64-encoded hash of the file." }, "created_at": { "type": "string", "format": "date-time", "description": "The date/time when the capture was uploaded for processing." }, "updated_at": { "type": "string", "format": "date-time", "description": "The date/time when the capture was last updated." }, "processed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "The date/time when the capture was processed." }, "url": { "type": "string", "format": "uri", "description": "The URL of the capture file. In most cases, this is the original and matches `original_url`. For certain file types, however, we transcode to a more common format, such as WebM to MPEG-4 for Web SDK videos taken in Mobile Chrome.\n\nA token/signature is included in the query string that grants access for 10 hours. For a fresh token/signature with a new 10 hour expiration, simply re-fetch the capture." }, "original_url": { "type": "string", "format": "uri", "description": "The URL of the original capture file.\n\nA token/signature is included in the query string that grants access for 10 hours. For a fresh token/signature with a new 10 hour expiration, simply re-fetch the capture." }, "web_url": { "type": "string", "format": "uri", "description": "The URL of the capture file optimized for the web: 1000x1000px max, keeping aspect ratio intact.\n\nFor video, this is an image of the first frame. Audio does not return a URL.\n\nA token/signature is included in the query string that grants access for 10 hours. For a fresh token/signature with a new 10 hour expiration, simply re-fetch the capture." }, "location": { "nullable": true, "type": "object", "description": "The reverse geocoded address of the verified GPS coordinates.\n\nOnly included if the `location` service was enabled.\n\n`null` is returned if GPS coordinates were not found in the extracted and verified details.", "properties": { "latitude": { "type": "number", "description": "The verified GPS latitude (in decimal degrees) where the capture was taken." }, "longitude": { "type": "number", "description": "The verified GPS longitude (in decimal degrees) where the capture was taken." }, "street": { "type": "string", "nullable": true, "description": "The street component of the address." }, "city": { "type": "string", "nullable": true, "description": "The city component of the address." }, "state": { "type": "string", "nullable": true, "description": "The state component of the address." }, "postal_code": { "type": "string", "nullable": true, "description": "The postal code component of the address." }, "country": { "type": "string", "nullable": true, "description": "The ISO 3166-1 two-letter country code component of the address." }, "formatted_address": { "type": "string", "nullable": true, "description": "The full address formatted appropriately for the locale." }, "comparison": { "type": "object", "description": "The results of calculating the distance between the verified GPS coordinates and another location.\n\nOnly included if enabled in the `location` service options.", "properties": { "latitude": { "type": "number", "description": "The verified GPS latitude (in decimal degrees) where the capture was taken." }, "longitude": { "type": "number", "description": "The verified GPS longitude (in decimal degrees) where the capture was taken." }, "street": { "type": "string", "nullable": true, "description": "The street component of the address." }, "city": { "type": "string", "nullable": true, "description": "The city component of the address." }, "state": { "type": "string", "nullable": true, "description": "The state component of the address." }, "postal_code": { "type": "string", "nullable": true, "description": "The postal code component of the address." }, "country": { "type": "string", "nullable": true, "description": "The ISO 3166-1 two-letter country code component of the address." }, "formatted_address": { "type": "string", "nullable": true, "description": "The full address formatted appropriately for the locale." }, "address": { "type": "string", "description": "The original value specified in the `location` service options." }, "distance_threshold": { "type": "number", "nullable": true, "description": "The original value specified in the `location` service options." }, "distance": { "type": "number", "nullable": true, "description": "The distance in meters between the verified GPS coordinates and the geocoded `address`.\n\nThis does not take into account the accuracy of the GPS reading.\n\n`null` is returned if the `address` could not be geocoded to coordinates." }, "distance_min_accuracy": { "type": "number", "description": "The `distance` in meters adjusted lower to account for the accuracy of the GPS reading.\n\nThe floor is `0` and does not go negative." }, "distance_max_accuracy": { "type": "number", "description": "The `distance` in meters adjusted higher to account for the accuracy of the GPS reading." }, "distance_threshold_exceeded": { "type": "boolean", "description": "Whether the `distance_max_accuracy` is greater than the `distance_threshold`.\n\nOnly included if `distance_threshold` is set." } }, "required": [ "latitude", "longitude", "street", "city", "state", "postal_code", "country", "formatted_address", "address", "distance_threshold", "distance" ] } }, "required": [ "latitude", "longitude", "street", "city", "state", "postal_code", "country", "formatted_address" ] } }, "required": [ "id", "type", "status", "custom_data", "uploaded_by_ip_address", "file_size", "file_hash", "created_at", "updated_at", "processed_at" ], "title": "capture" } } }, "paths": { "/captures": { "get": { "summary": "List All Uploaded Captures", "tags": [ "Captures" ], "description": "Get a list of all uploaded captures with results from processing.", "parameters": [ { "schema": { "type": "object", "properties": { "status": { "type": "object", "description": "Filter by the current processing state of the capture.", "properties": { "=": { "type": "string", "enum": [ "RECEIVING", "WAITING", "PROCESSING", "SUCCESS", "ERROR", "QUARANTINE" ] }, "!=": { "type": "string", "enum": [ "RECEIVING", "WAITING", "PROCESSING", "SUCCESS", "ERROR", "QUARANTINE" ] }, "in": { "type": "array", "items": { "type": "string", "enum": [ "RECEIVING", "WAITING", "PROCESSING", "SUCCESS", "ERROR", "QUARANTINE" ] } }, "not in": { "type": "array", "items": { "type": "string", "enum": [ "RECEIVING", "WAITING", "PROCESSING", "SUCCESS", "ERROR", "QUARANTINE" ] } } } } } }, "in": "query", "name": "filter", "required": false, "description": "Filters to limit the results returned.", "style": "deepObject", "explode": true }, { "schema": { "type": "object", "properties": { "created_at": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc", "description": "Sort by the date/time when the capture was uploaded for processing." } } }, "in": "query", "name": "sort", "required": false, "description": "Sorting to order the results returned.\n\nThe order of properties is important, as sorting is applied in the order specified.\n\nDefaults to `created_at` `desc`.", "style": "deepObject", "explode": true }, { "schema": { "type": "object", "properties": { "size": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20, "description": "The number of results to return per page." }, "number": { "type": "integer", "minimum": 1, "default": 1, "description": "The page number to return." } } }, "in": "query", "name": "page", "required": false, "description": "Pagination to limit the number of results returned.\n\nDefaults to the first page of 20 results, with a maximum of 100 results per page.", "style": "deepObject", "explode": true } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "schema": { "type": "object", "description": "The request was successful.", "properties": { "captures": { "type": "array", "items": { "$ref": "#/components/schemas/def-1" } } }, "required": [ "captures" ] } } } }, "4XX": { "description": "A client error occurred.", "content": { "application/json": { "schema": { "description": "A client error occurred.", "$ref": "#/components/schemas/def-0" } } } }, "5XX": { "description": "A server error occurred.", "content": { "application/json": { "schema": { "description": "A server error occurred.", "$ref": "#/components/schemas/def-0" } } } } } } } }, "servers": [ { "url": "https://lens-api.truepic.com" } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```