apyhub
ARTIFICIAL INTELLIGENCE

AI Text Entity Recognition API

Hosted on ApyHub

What it does

Entity Recognition identifies names, organizations, places, and other entities in plain text. Send a text string in the request body, and choose whether to run it through requested_service set to azure, google, or apyhub.

Use it when you need to extract structured meaning from unstructured text. For example, you can process support tickets, news articles, CRM notes, or internal documents to find people, companies, and locations without writing your own NLP pipeline.

The response wraps provider-specific results under data.azure, data.google, or data.apyhub, depending on the service you request. That makes it useful when you want a single endpoint for entity detection while keeping the downstream response aligned with the NLP provider you choose.

If you already have language or encoding details, you can include language, encoding, or provider credentials in azure or google as needed. Entity Recognition is a fit for enrichment workflows, document processing, search indexing, and any automation that starts with free-form text.

Provider (requested_service)Atoms
Azure500
Google500
ApyHub2000
POST
Recognize entities in text
http://localhost:8080/apyhub/recognize-entities-in-text
QUICKSTARTGUIDE

Quickstart

Recognize entities in a short text snippet with the default ApyHub service.

curl -X POST "http://localhost:8080/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 object may include azure, apyhub, and/or google fields, each holding the corresponding service response object.

{
  "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 a text string and returns a JSON object containing provider-specific results under data. You can submit the text and optionally provide Azure or Google credentials/configuration, then choose which service to use via requested_service or let it default to ApyHub.

Request Body

ParameterTypeMandatoryDescription
textStringYesText to analyze for entity recognition.
azureObjectNoCustom credentials for Azure services. See schema for nested fields.
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. See schema for nested fields.
google.google_languageStringNoTarget language locale.
google.google_credential_jsonObjectNoGoogle service account credential JSON. See schema for nested fields.
encodingStringNoText encoding.
languageStringNoLanguage code for the input text.
requested_serviceENUMNoService to use. Allowed values: azure, google, apyhub. Default: apyhub.

Response

Returns a JSON object with a data object field containing provider-specific result objects for azure, apyhub, and google. The schema defines these as top-level keys inside data, each represented as an object.

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.