# AI Text Syntax Analysis API

### About

This Utility API breaks up the given text into a series of sentences and tokens (generally words) and provides linguistic information about those tokens.

This API provides insights into the grammatical structure and dependencies within the given text. Whether understanding sentence structure, analyzing grammatical nuances, or extracting linguistic features, this API offers a comprehensive linguistic analysis.

The atoms cost is subjected to change depending on the size of the input file and the provider selected. The list of providers and the atoms cost for each provider is given below:

| Provider (requested_service) | Atoms |
| --- | --- |
| Google | 500 |

### API Playground

ApyHub AI

This API endpoint does not have a playground. You can test it with Voiden.

### API Documentation

input json: output json

#### Request example

```bash
curl --location --request POST 'https://api.apyhub.com/ai/text/syntax/analysis' \
--header 'apy-token: {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "text": "Google, headquartered in Mountain View, unveiled the new Android phone at the Consumer Electronic Show.  Sundar Pichai said in his keynote that users love their new Android phones.",
    "encoding": "UTF8",
    "requested_service": "google",
    "google": {
        "key": "your-google-key"
    }
}'
```

| Provider (requested_service) | Atoms |
| --- | --- |
| Google | 500 |

**Method:** `POST`  
**Content Type:** `application/json`  
**Request Body**

| Attribute | Type | Mandatory | Description |
| --- | --- | --- | --- |
| text | String | Yes | Provide the textual content for which you want to perform syntax analysis. <br> \- The max content size is 125,000 characters. |
| encoding | String | No (use if `google` is selected in requested_service) | Provide the textual content encoding format it can be `UTF8`, `UTF16`, `UTF32` default to `UTF8`. |
| requested_service | String | Yes | Enter the name of service provider. Supported providers are `google`. |
| google.key | String | Yes (if `google` is selected in requested_service) | Input service key provided by google. |

**Sample Response**

A successful request returns the syntax analysis response in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.

### HTTP Response Codes

The method may return one of the following HTTP status codes:

| Status Code | Description |
| --- | --- |
| 200 | The request was successful. |
| 400 | Invalid input - the file is corrupt or the supported inputs are not provided. |
| 401 | Required authentication information is either missing or not valid for the resource. |
| 500 | If any unexpected error occurs while processing the request. |

### Authentication

All API requests to ApyHub services need to be authenticated. Currently we support `tokens` or `basic authentication` mechanisms.  
You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".

Points to note:

- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the `apy-token` as the header parameter to pass the token.
- Use the `Authorization` header to send the basic authentication credentials.

### Error codes

```json
{
  "error": {
    "code": 105,
    "message": "Invalid URL"
  }
}
```

To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.

##### 101 - Missing parameters  
This code is returned when mandatory parameters are missing from the request. For example, if you are trying to validate an email address but did not provide the "email" parameter.

##### 102 - Invalid JSON  
This code is returned when invalid JSON is passed in the request body. For instance, if you forget to include a "{" at the beginning of the request body.

##### 103 - Invalid input  
This code is returned when an invalid input is provided. For instance, if you enter the wrong password while trying to extract secure archives.

##### 104 - Invalid file  
This code is returned when there is an issue with a file. The file may be missing or its format may be invalid.

##### 105 - Invalid URL  
This code is returned when there is an issue with a URL. The URL may be missing or not accessible.

##### 109 - Invalid input format  
This code is returned when input is not provided in the required format. For example, if you send a number instead of a string when a string is expected.

##### 110 - Server error  
This code is returned when an unexpected error occurs while processing a request. This is typically an internal server error.

### Reviews

4.1 /
5
48 ratings

| Rating | Count |
| --- | --- |
| 5 |  
| 4 |  
| 3 |  
| 2 |  
| 1 |

### Related Utility APIs

#### AI Text Sentiment Analysis API  
Analyze text sentiment using the AI Text Sentiment Analysis API. Power feedback, support, and social listening pipelines automatically.

ApyHub

3.9
(99)

- 500 Atoms

#### AI Text Entity Recognition API  
Identify entities like people, places, and organizations with the AI Text Entity Recognition API. Automate data extraction for NLP and analytics.

ApyHub

3.9
(61)

- 500 Atoms

#### AI Text Entity Sentiment Analysis API  
Analyze sentiment toward entities in text using the AI Text Entity Sentiment Analysis API. Get precise positive, negative, or neutral insights programmatically.

ApyHub

3.8
(44)

- 500 Atoms

#### AI Image Objects Detection API  
Identify objects in images with the AI Image Objects Detection API. Detect cars, toys, and more for visual search, AR, and analytics workflows.

ApyHub

4.0
(41)

- 500 Atoms