Skip to content
OpenParablePublic APIs

Amazon Comprehend API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

Amazon Comprehend is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 84 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Cloud Platforms
Version
2017-11-27
Endpoints
84
OpenAPI
Specification ↗
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=Comprehend_20171127.BatchDetectDominantLanguageDetermines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see <a href="https://doc
POST/#X-Amz-Target=Comprehend_20171127.BatchDetectEntitiesInspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see <a href="https:/
POST/#X-Amz-Target=Comprehend_20171127.BatchDetectKeyPhrasesDetects the key noun phrases found in a batch of documents.
POST/#X-Amz-Target=Comprehend_20171127.BatchDetectSentimentInspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NE
POST/#X-Amz-Target=Comprehend_20171127.BatchDetectSyntaxInspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more informatio
POST/#X-Amz-Target=Comprehend_20171127.BatchDetectTargetedSentiment<p>Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.</p> <p>For more information about targeted sentim
POST/#X-Amz-Target=Comprehend_20171127.ClassifyDocument<p>Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
POST/#X-Amz-Target=Comprehend_20171127.ContainsPiiEntitiesAnalyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, b
POST/#X-Amz-Target=Comprehend_20171127.CreateDatasetCreates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see <a href="https://docs.aws.ama
POST/#X-Amz-Target=Comprehend_20171127.CreateDocumentClassifierCreates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled wit
POST/#X-Amz-Target=Comprehend_20171127.CreateEndpointCreates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see <a href="https://docs.aws
POST/#X-Amz-Target=Comprehend_20171127.CreateEntityRecognizerCreates an entity recognizer using submitted files. After your <code>CreateEntityRecognizer</code> request is submitted, you can check job status using the <cod
POST/#X-Amz-Target=Comprehend_20171127.CreateFlywheel<p>A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You c
POST/#X-Amz-Target=Comprehend_20171127.DeleteDocumentClassifier<p>Deletes a previously created document classifier</p> <p>Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an activ
POST/#X-Amz-Target=Comprehend_20171127.DeleteEndpointDeletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information abo
POST/#X-Amz-Target=Comprehend_20171127.DeleteEntityRecognizer<p>Deletes an entity recognizer.</p> <p>Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is
POST/#X-Amz-Target=Comprehend_20171127.DeleteFlywheel<p>Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.</p> <p>For more
POST/#X-Amz-Target=Comprehend_20171127.DeleteResourcePolicyDeletes a resource-based policy that is attached to a custom model.
POST/#X-Amz-Target=Comprehend_20171127.DescribeDatasetReturns information about the dataset that you specify. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywh
POST/#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassificationJobGets the properties associated with a document classification job. Use this operation to get the status of a classification job.
POST/#X-Amz-Target=Comprehend_20171127.DescribeDocumentClassifierGets the properties associated with a document classifier.
POST/#X-Amz-Target=Comprehend_20171127.DescribeDominantLanguageDetectionJobGets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
POST/#X-Amz-Target=Comprehend_20171127.DescribeEndpointGets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see <a href="http
POST/#X-Amz-Target=Comprehend_20171127.DescribeEntitiesDetectionJobGets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
POST/#X-Amz-Target=Comprehend_20171127.DescribeEntityRecognizerProvides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
POST/#X-Amz-Target=Comprehend_20171127.DescribeEventsDetectionJobGets the status and details of an events detection job.
POST/#X-Amz-Target=Comprehend_20171127.DescribeFlywheelProvides configuration information about the flywheel. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywh
POST/#X-Amz-Target=Comprehend_20171127.DescribeFlywheelIterationRetrieve the configuration properties of a flywheel iteration. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/
POST/#X-Amz-Target=Comprehend_20171127.DescribeKeyPhrasesDetectionJobGets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
POST/#X-Amz-Target=Comprehend_20171127.DescribePiiEntitiesDetectionJobGets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
POST/#X-Amz-Target=Comprehend_20171127.DescribeResourcePolicyGets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
POST/#X-Amz-Target=Comprehend_20171127.DescribeSentimentDetectionJobGets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
POST/#X-Amz-Target=Comprehend_20171127.DescribeTargetedSentimentDetectionJobGets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
POST/#X-Amz-Target=Comprehend_20171127.DescribeTopicsDetectionJobGets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
POST/#X-Amz-Target=Comprehend_20171127.DetectDominantLanguageDetermines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehe
POST/#X-Amz-Target=Comprehend_20171127.DetectEntities<p>Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model. </p> <p> When
POST/#X-Amz-Target=Comprehend_20171127.DetectKeyPhrasesDetects the key noun phrases found in the text.
POST/#X-Amz-Target=Comprehend_20171127.DetectPiiEntitiesInspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
POST/#X-Amz-Target=Comprehend_20171127.DetectSentimentInspects text and returns an inference of the prevailing sentiment (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>).
POST/#X-Amz-Target=Comprehend_20171127.DetectSyntaxInspects text for syntax and the part of speech of words in the document. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/ho
POST/#X-Amz-Target=Comprehend_20171127.DetectTargetedSentiment<p>Inspects the input text and returns a sentiment analysis for each entity identified in the text.</p> <p>For more information about targeted sentiment, see <a
POST/#X-Amz-Target=Comprehend_20171127.ImportModel<p>Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.
POST/#X-Amz-Target=Comprehend_20171127.ListDatasetsList the datasets that you have configured in this Region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/fl
POST/#X-Amz-Target=Comprehend_20171127.ListDocumentClassificationJobsGets a list of the documentation classification jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListDocumentClassifierSummariesGets a list of summaries of the document classifiers that you have created
POST/#X-Amz-Target=Comprehend_20171127.ListDocumentClassifiersGets a list of the document classifiers that you have created.
POST/#X-Amz-Target=Comprehend_20171127.ListDominantLanguageDetectionJobsGets a list of the dominant language detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListEndpointsGets a list of all existing endpoints that you've created. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage
POST/#X-Amz-Target=Comprehend_20171127.ListEntitiesDetectionJobsGets a list of the entity detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListEntityRecognizerSummariesGets a list of summaries for the entity recognizers that you have created.
POST/#X-Amz-Target=Comprehend_20171127.ListEntityRecognizers<p>Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recog
POST/#X-Amz-Target=Comprehend_20171127.ListEventsDetectionJobsGets a list of the events detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListFlywheelIterationHistoryInformation about the history of a flywheel iteration. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywh
POST/#X-Amz-Target=Comprehend_20171127.ListFlywheelsGets a list of the flywheels that you have created.
POST/#X-Amz-Target=Comprehend_20171127.ListKeyPhrasesDetectionJobsGet a list of key phrase detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListPiiEntitiesDetectionJobsGets a list of the PII entity detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListSentimentDetectionJobsGets a list of sentiment detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListTagsForResourceLists all tags associated with a given Amazon Comprehend resource.
POST/#X-Amz-Target=Comprehend_20171127.ListTargetedSentimentDetectionJobsGets a list of targeted sentiment detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.ListTopicsDetectionJobsGets a list of the topic detection jobs that you have submitted.
POST/#X-Amz-Target=Comprehend_20171127.PutResourcePolicyAttaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom m
POST/#X-Amz-Target=Comprehend_20171127.StartDocumentClassificationJobStarts an asynchronous document classification job. Use the <code>DescribeDocumentClassificationJob</code> operation to track the progress of the job.
POST/#X-Amz-Target=Comprehend_20171127.StartDominantLanguageDetectionJobStarts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
POST/#X-Amz-Target=Comprehend_20171127.StartEntitiesDetectionJob<p>Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.</p> <p>This API can be used for ei
POST/#X-Amz-Target=Comprehend_20171127.StartEventsDetectionJobStarts an asynchronous event detection job for a collection of documents.
POST/#X-Amz-Target=Comprehend_20171127.StartFlywheelIterationStart the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see <a href="https://docs.
POST/#X-Amz-Target=Comprehend_20171127.StartKeyPhrasesDetectionJobStarts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
POST/#X-Amz-Target=Comprehend_20171127.StartPiiEntitiesDetectionJobStarts an asynchronous PII entity detection job for a collection of documents.
POST/#X-Amz-Target=Comprehend_20171127.StartSentimentDetectionJobStarts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
POST/#X-Amz-Target=Comprehend_20171127.StartTargetedSentimentDetectionJobStarts an asynchronous targeted sentiment detection job for a collection of documents. Use the <code>DescribeTargetedSentimentDetectionJob</code> operation to t
POST/#X-Amz-Target=Comprehend_20171127.StartTopicsDetectionJobStarts an asynchronous topic detection job. Use the <code>DescribeTopicDetectionJob</code> operation to track the status of a job.
POST/#X-Amz-Target=Comprehend_20171127.StopDominantLanguageDetectionJob<p>Stops a dominant language detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <
POST/#X-Amz-Target=Comprehend_20171127.StopEntitiesDetectionJob<p>Stops an entities detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STO
POST/#X-Amz-Target=Comprehend_20171127.StopEventsDetectionJobStops an events detection job in progress.
POST/#X-Amz-Target=Comprehend_20171127.StopKeyPhrasesDetectionJob<p>Stops a key phrases detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>S
POST/#X-Amz-Target=Comprehend_20171127.StopPiiEntitiesDetectionJobStops a PII entities detection job in progress.
POST/#X-Amz-Target=Comprehend_20171127.StopSentimentDetectionJob<p>Stops a sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put into the <code>ST
POST/#X-Amz-Target=Comprehend_20171127.StopTargetedSentimentDetectionJob<p>Stops a targeted sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put into the
POST/#X-Amz-Target=Comprehend_20171127.StopTrainingDocumentClassifier<p>Stops a document classifier training job while in progress.</p> <p>If the training job state is <code>TRAINING</code>, the job is marked for termination and
POST/#X-Amz-Target=Comprehend_20171127.StopTrainingEntityRecognizer<p>Stops an entity recognizer training job while in progress.</p> <p>If the training job state is <code>TRAINING</code>, the job is marked for termination and p
POST/#X-Amz-Target=Comprehend_20171127.TagResourceAssociates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For exa
POST/#X-Amz-Target=Comprehend_20171127.UntagResourceRemoves a specific tag associated with an Amazon Comprehend resource.
POST/#X-Amz-Target=Comprehend_20171127.UpdateEndpointUpdates information about the specified endpoint. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoint
POST/#X-Amz-Target=Comprehend_20171127.UpdateFlywheelUpdate the configuration information for an existing flywheel.

Questions

Does the Amazon Comprehend API need an API key?

Yes. The Amazon Comprehend API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Comprehend API support HTTPS?

Yes, the Amazon Comprehend API is served over HTTPS.

How many endpoints does the Amazon Comprehend API have?

Its OpenAPI description lists 84 endpoints in version 2017-11-27. All of them are shown on this page.

What are alternatives to the Amazon Comprehend API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).