Keyword / Term Extraction: Text API

AlchemyAPI provides easy-to-use facilities for extracting topic keywords from any textual content: Post (upload) any content directly to our service for analysis.

Posted content is analyzed to detect the primary document language, and topic keywords are extracted automatically.

These API calls may be utilized to process posted (uploaded) textual content. If you are processing content hosted on a publicly accessible website, consider using our URL processing calls.

API Call: TextGetKeywords

Description: The TextGetKeywords call is utilized to extract important topic keywords from within a posted text document.

Endpoint: http://access.alchemyapi.com/calls/text/TextGetKeywords

Parameters:

http argument parameter description
apikey your private api key

(required parameter)
text Text document content (must be uri-argument encoded)

(required parameter)
url Text document URL (must be uri-argument encoded)

(optional parameter, for response tracking purposes.)
maxRetrieve maximum number of keywords to extract (default: 10)

(optional parameter)
maxNumWords maximum number of words in each extracted keyword (default: 3)

(optional parameter)
outputMode desired API output format

Possible values:
xml (default)
json
rdf
rel-tag
rel-tag-raw

(optional parameter)
showSourceText whether to include the original 'source text' the keywords were extracted from within the API response.

Possible values:
1 - enabled
0 - disabled (default)

(optional parameter)
baseUrl rel-tag output base http url (must be uri-argument encoded)

(optional parameter, used with rel-tag or rel-tag-raw outputMode.)

Response Format (XML):

<results>
    <status>REQUEST_STATUS</status>
    <url>DOCUMENT_URL</url>
    <language>DOCUMENT_LANGUAGE</language>
    <text>DOCUMENT_TEXT</text>
    <keywords>
        <keyword>DETECTED_KEYWORD</keyword>
        <keyword>DETECTED_KEYWORD</keyword>
    </keywords>
</results>

Response Format (JSON):

{
    "status": "REQUEST_STATUS",
    "url": "DOCUMENT_URL",
    "language": "DOCUMENT_LANGUAGE",
    "text": "DOCUMENT_TEXT",/text>
    "keywords": [
        "keyword": "DETECTED_KEYWORD",
        "keyword": "DETECTED_KEYWORD"
    ]
}

Response Format (RDF):

<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
                 xmlns:aapi="http://rdf.alchemyapi.com/rdf/v1/s/aapi-schema#"
                 xml:base="http://rdf.alchemyapi.com/rdf/v1/r/response.rdf">
    <rdf:Description rdf:ID="DOCUMENT_HASH">
        <rdf:type rdf:resource="http://rdf.alchemyapi.com/rdf/v1/s/aapi-schema#DocInfo"/>
        <aapi:ResultStatus>REQUEST_STATUS</aapi:ResultStatus>
        <aapi:URL>DOCUMENT_URL</aapi:URL>
        <aapi:Language>DOCUMENT_LANGUAGE</aapi:Language>
        <aapi:DocText>DOCUMENT_TEXT</aapi:DocText>
        <aapi:DocKeyword>DETECTED_KEYWORD</aapi:DocKeyword>
        <aapi:DocKeyword>DETECTED_KEYWORD</aapi:DocKeyword>
    </rdf:Description>
</rdf:RDF>

Response Format (REL-TAG Microformat [XML-embedded] ):

<results>
    <status>REQUEST_STATUS</status>
    <url>REQUESTED_URL</url>
    <language>DOCUMENT_LANGUAGE</language>
    <text>DOCUMENT_TEXT</text>
    <microformats>
        <a href="REQUESTED_BASE_URL/DETECTED_KEYWORD" rel="tag">DETECTED_KEYWORD</a>
        <a href="REQUESTED_BASE_URL/DETECTED_KEYWORD" rel="tag">DETECTED_KEYWORD</a>
    </microformats>
</results>

Response Format (REL-TAG Microformat [raw] ):

<a href="REQUESTED_BASE_URL/DETECTED_KEYWORD" rel="tag">DETECTED_KEYWORD</a>
<a href="REQUESTED_BASE_URL/DETECTED_KEYWORD" rel="tag">DETECTED_KEYWORD</a>

Response Fields:

field name field description
status success / failure status indicating whether the request was processed.

Possible values:
OK
ERROR
language the detected language that the source text was written in.
url http url information was requested for.
keyword a detected keyword.
statusInfo failure status information (sent only if "status" == "ERROR").

Possible values:
invalid-api-key

API Notes:

  • 1. Calls to TextGetKeywords should be made using HTTP POST.
  • 2. HTTP POST calls should include the Content-Type header: application/x-www-form-urlencoded
  • 3. Posted text documents can be a maximum of 150 kilobytes. Larger documents will result in a "content-exceeds-size-limit" error response.
  • 4. Language detection is performed on the retrieved document before attempting keyword extraction. A minimum of 15 characters of text must exist within the requested HTTP document to perform language detection.
  • 5. Documents containing less than 15 characters of text are assumed to be English-language content.


 - return to top of page -