Visual Object Detection identifies common objects in an image sent as a file upload or by URL. Send a file or a url, and choose which detector to use with requested_service (azure, google, or apyhub).
Use this service when you need to label images, filter uploads, or add image understanding to workflows that depend on object recognition. The file-based endpoint also accepts provider credentials where needed: Azure fields such as azure_key, azure_region, azure_endpoint, azure_account_id, and azure_access_token, plus google_key. The URL-based endpoint accepts nested azure and google credential objects, including Google service-account JSON and an optional google_language.
The response returns a data object with provider-specific results under azure, apyhub, and google. That lets you route results from the detector you selected without guessing at the response shape.
Typical uses include moderating user uploads, auto-tagging product photos, and building image search or inventory pipelines where you need basic object labels from a remote image or uploaded file.
| Provider (requested_service) | Atoms |
|---|---|
| Azure | 500 |
| 500 | |
| ApyHub | 2000 |
Call this endpoint with your ApyHub API key:
curl -X POST "http://localhost:8080/apyhub/detect-common-visual-objects/file" \
-H 'apy-token: $APY_TOKEN' \
-F 'file=@/path/to/file' \
-F 'requested_service=apyhub'Loading your default key…Detect common visual objects (file upload)
Uploads a file and runs common object detection against the selected visual recognition service. The response returns a data object containing the service-specific result object for Azure, ApyHub, and/or Google, depending on what the endpoint produces.
Documentation imported from spec — please review and complete before submitting.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
Send an image URL to detect common visual objects in it.
curl -X POST "http://localhost:8080/apyhub/detect-common-visual-objects/url" \
-H "apy-token: $APY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"https://assets.apyhub.com/samples/sample.png"}'Returns a JSON object with a data object. The data field may contain azure, apyhub, and google objects, depending on which detector response is returned.
{
"data": {
"apyhub": {}
}
}Loading your default key…Detects common visual objects in an image referenced by URL. You provide the image URL in the request body and can choose which service to use; the response returns a JSON object with a data object containing the provider-specific result object.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | Image URL to analyze. Format: URI. |
| azure | Object | No | Custom credentials for Azure services. |
| azure.key | String | No | Azure subscription key. |
| azure.region | String | No | Azure service region. |
| azure.endpoint | String | No | Azure endpoint URL. |
| azure.account_id | String | No | Azure account ID. |
| azure.access_token | String | No | OAuth access token for Azure service. |
| Object | No | Custom credentials for Google services. | |
| google.google_language | String | No | Target language locale. |
| google.google_credential_json | Object | No | Google service account credential JSON. See schema for nested fields. |
| requested_service | ENUM | No | Service to use. Allowed values: azure, google, apyhub. Default: apyhub. |
Returns a JSON object with a data object field. The data object may contain azure, apyhub, and/or google result objects depending on the service used.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | No | Container for provider-specific response objects. |
| data.azure | Object | No | Response object from Microsoft Azure Computer Vision. |
| data.apyhub | Object | No | Response object from ApyHub Vision detector. |
| data.google | Object | No | Response object from Google Cloud Vision. |
bad_requestRequired parameter missing or malformed body.
unauthorizedAPI key missing, revoked, or not authorized for this service.
rate_limitedYour plan's per-second rate exceeded. Retry with exponential backoff.
upstream_busyBackend temporarily unavailable. Try again in a few seconds.