About this endpoint
What it does
Detects brands from a URL and returns a JSON object containing a data object. The returned brand-detection payload is keyed by the selected requested_service (azure or google), with the corresponding service-specific result object present when that service is used.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | The URL to analyze. Must be a valid URI. |
| azure | Object | No | Azure-specific configuration object. Contains region, account_id, and access_token if provided. |
| azure.region | String | No | Azure region. |
| azure.account_id | String | No | Azure account ID. |
| azure.access_token | String | No | Azure access token. |
| Object | No | Google-specific configuration object. Contains google_language and google_credential_json if provided. | |
| google.google_language | String | No | Google language code, such as en-US. |
| google.google_credential_json | Object | No | Google Cloud service account JSON. Required for Google video routes. |
| google.google_credential_json.type | String | No | Service account type. |
| google.google_credential_json.auth_uri | String | No | OAuth authorization URI. |
| google.google_credential_json.client_id | String | No | Google client ID. |
| google.google_credential_json.token_uri | String | No | OAuth token URI. |
| google.google_credential_json.project_id | String | No | Google Cloud project ID. |
| google.google_credential_json.private_key | String | No | Google private key. |
| google.google_credential_json.client_email | String | No | Service account client email. |
| google.google_credential_json.private_key_id | String | No | Private key ID. |
| google.google_credential_json.universe_domain | String | No | Google universe domain. |
| google.google_credential_json.client_x509_cert_url | String | No | Client X.509 certificate URL. |
| google.google_credential_json.auth_provider_x509_cert_url | String | No | Auth provider X.509 certificate URL. |
| requested_service | ENUM | Yes | The detection service to use: azure or google. |
Response
Returns a JSON object with a data object field. The data object may contain an azure object when requested_service is azure, or a google object when requested_service is google.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Response wrapper containing the service-specific result object. |
| data.azure | Object | No | Present when requested_service is azure. Arbitrary object shape. |
| data.google | Object | No | Present when requested_service is google. Arbitrary object shape. |