apyhub
ARTIFICIAL INTELLIGENCE

AI Text Entity Recognition API

What it does

Entity Recognition identifies named entities in text and returns the detected results through the provider you select: ApyHub, Google, or Azure. Send a text string, optionally include provider-specific credentials, and get entity analysis back in a structured response.

Use it when you need to extract people, organisations, places, or other referenced entities from user content, notes, support tickets, or documents that have already been converted to text. The request body accepts text, encoding, language, requested_service, and optional azure or google credential objects. That makes it easy to route the same input through your preferred NLP stack without changing your integration shape.

The response contains a data object with a service-specific object for azure, apyhub, or google, depending on which provider you request. Because the output is provider-specific, you can plug the result into downstream classification, enrichment, search indexing, or content analysis workflows without guessing at the schema.

Entity Recognition fits pipelines that need lightweight NLP around plain text: enrich CRM notes, detect mentions in article archives, or pre-process incoming messages before storage and routing.

POST
Recognize entities in text
https://api.eu.apyverse.com/apyhub/recognize-entities-in-text

QUICKSTART

GUIDE

Quickstart

Send a short piece of text to extract recognized entities.

curl -X POST "https://api.eu.apyverse.com/apyhub/recognize-entities-in-text" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"Google was founded in 1998 by Larry Page and Sergey Brin.","requested_service":"apyhub"}'

What you'll get back

Returns a JSON object with a data object. That data object may contain azure, apyhub, and google objects, 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

Recognizes entities in the provided text and returns a JSON object containing provider-specific result data under data. You can optionally supply custom Azure or Google credentials, choose the requested service, and set language/encoding parameters.

Request Body

ParameterTypeMandatoryDescription
textStringYesThe text to analyze for entity recognition.
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 object. See schema for nested fields.
encodingStringNoText encoding.
languageStringNoLanguage of the input text.
requested_serviceENUMNoWhich service to use. Allowed values: azure, google, apyhub. Default: apyhub.

Response

Returns a JSON object with a data object field. The data object may include azure, apyhub, and google fields, each representing the response object from the corresponding provider.

ParameterTypeMandatoryDescription
dataObjectNoContainer for provider-specific response objects.
data.azureObjectNoResponse object from Microsoft Azure Cognitive Services.
data.apyhubObjectNoResponse object from ApyHub language tools.
data.googleObjectNoResponse object from Google Cloud NLP API.

Body

Name
Type
Description
bodyREQUIRED
object
▣ 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.