apyhub
ARTIFICIAL INTELLIGENCE · IMAGE PROCESSING

AI Image Objects Detection API

What it does

Object Detection identifies common visual objects in an image and returns the detector response from the selected service. Send either an image URL or an uploaded file, and choose requested_service as apyhub, azure, or google.

Use the /url endpoint when the image is already hosted somewhere accessible by URL. Its input accepts url, optional azure credentials, optional google credentials, and requested_service. Use /file when you have the image bytes directly; it accepts file plus optional Azure fields such as azure_key, azure_region, azure_endpoint, azure_account_id, and azure_access_token, along with google_key and requested_service.

The response is nested under data and includes the result from the chosen backend: azure, apyhub, or google. That makes it useful when you need a single object-detection interface across providers, whether you are labeling product photos, flagging objects in user uploads, or adding lightweight visual analysis to an internal workflow.

Object Detection is a good fit when you want to route the same image through different vision engines without changing your integration shape. Keep the provider-specific credentials where needed, send the image, and read the returned provider object from the response.

▣ ENDPOINT 01 / 02
POST
Detect common visual objects (URL input)
https://api.eu.apyverse.com/apyhub/detect-objects/url

QUICKSTART

GUIDE

Quickstart

Detect objects in an image from a public URL.

curl -X POST "https://api.eu.apyverse.com/apyhub/detect-objects/url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/objects.jpg"
  }'

What you'll get back

Returns a JSON object with a data object field. The data object contains provider-specific results under one of the keys azure, apyhub, or google, depending on the service used.

{
  "data": {
    "apyhub": {}
  }
}
TRY ITLIVE · 500 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
azure
Custom credentials for Azure services.
Azure subscription key.
Azure service region.
Azure endpoint URL.
Azure account ID.
OAuth access token for Azure service.
google
Custom credentials for Google services.
Target language locale.
google_credential_json

About this endpoint

What it does

Detects common visual objects from an image URL. You send the image url and can optionally provide provider credentials and choose which service to use via requested_service.

Request Body

ParameterTypeMandatoryDescription
urlStringYesImage URL to analyze. Must be a URI.
azureObjectNoCustom credentials for Azure services.
azure.keyStringNoAzure subscription key.
azure.regionStringNoAzure service region.
azure.endpointStringNoAzure endpoint URL.
azure.account_idStringNoAzure account ID.
azure.access_tokenStringNoOAuth access token for Azure service.
googleObjectNoCustom credentials for Google services.
google.google_languageStringNoTarget language locale.
google.google_credential_jsonObjectNoGoogle service account credential JSON. See schema for nested fields.
requested_serviceENUMNoProvider to use. Allowed values: azure, google, apyhub. Default: apyhub.

Response

Returns a JSON object with a data object field. The data object may contain provider-specific objects for azure, apyhub, and google.

ParameterTypeMandatoryDescription
dataObjectNoWrapper object for provider-specific response payloads.
data.azureObjectNoResponse object from Microsoft Azure Computer Vision.
data.apyhubObjectNoResponse object from ApyHub Vision detector.
data.googleObjectNoResponse object from Google Cloud Vision.

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 02 / 02
POST
Detect common visual objects (file upload)
https://api.eu.apyverse.com/apyhub/detect-objects/file

QUICKSTART

GUIDE

Quickstart

Upload an image file to detect objects using the default ApyHub vision detector.

curl -X POST "https://api.eu.apyverse.com/apyhub/detect-objects/file" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/image.jpg"

What you'll get back

Returns a JSON object with a data object field. Inside data, the API may include azure, apyhub, and google response objects, depending on which detector is used.

{
  "data": {
    "azure": {},
    "apyhub": {},
    "google": {}
  }
}
TRY ITLIVE · 500 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*

About this endpoint

What it does

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.

Request Body

ParameterTypeMandatoryDescription
fileStringYesFile to analyze, sent as binary data.
azure_keyStringNoAzure key value.
google_keyStringNoGoogle key value.
azure_regionStringNoAzure region, such as westus.
azure_endpointStringNoAzure endpoint URL.
azure_account_idStringNoAzure account identifier.
requested_serviceENUMNoService to use. Allowed values: azure, google, apyhub. Default: apyhub.
azure_access_tokenStringNoAzure access token.

Response

Returns a JSON object with a data object field. Inside data, the schema defines azure, apyhub, and google object fields, each representing the response object from the corresponding vision service. The schema does not define any additional fields.

ParameterTypeMandatoryDescription
dataObjectNoWrapper object for the service-specific detection results.
data.azureObjectNoResponse object from Microsoft Azure Computer Vision.
data.apyhubObjectNoResponse object from ApyHub Vision detector.
data.googleObjectNoResponse object from Google Cloud Vision.

Body

Name
Type
Description
bodyREQUIRED
object

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.