TITAN API

Build powerful cognitive software with Natural Language Understanding capabilities.

Titan API

The Titan API provides access to the Titan Cognitive Agent. You can apply natural language understanding (NLU) to your applications with the Titan API.

To access the Titan API, you must request your private key.

one API
"text-in," "text-out" 

You don't need to label.
You don't need to annotate.
You don't need to train.
5 things you can quickly do with the API.

Titan API reference guide

Table of Contents

1. Introduction

Titan comprises several integrated AI engines and algorithms that work together to deliver a simulated intelligent behavior through the Titan API.

The Titan API can be applied to any natural language task that involves learning, understanding or acting.

You can use the Titan API to build applications like knowledge mining, semantic search, question answering, conversational AI agents, digital workers, digital twins, intelligent automation, prediction engines, fraud detection engines, and much more.

2. Getting started

You can integrate the API into your environment and immediately endow your applications with the ability to learn, understand, and act on natural language queries and instructions.

Your app will need a valid key to make successful Titan API requests. To obtain a key, you must register for the API below.

3. Registration

Titan API is available in the form of a subscription service (Coming Soon). We selected RapidAPI (The leading API marketplace for software developers) as a service partner to help facilitate the implementation of the Titan API service with your software.

Please register (Coming Soon). to request your API key.

After completing the registration form, RapidAPI will provide you with an X-RapidAPI-Key. You will use the X-RapidAPI-Key to authenticate against our API.

Once you have received your key, you immediately start adding Titan cognitive services to your web, mobile, and desktop apps.

4. Documentation

4.1 Definition

The Titan API works simply by capturing the text you submit through the API and forwarding it to a Titan cognitive Agent for analysis. (figure 1)

Once the information is processed, you can either: (figure 2)
Scenario A- Ask the agent questions about the content of the text you submitted.
Scenario B- Instruct your agent to take action based on natural language-driven rules.

4.2 Request

4.2.1 Operation

Titan API is structured around REST principles. Data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint. Where possible, Titan API uses appropriate HTTP verbs:

METHOD
ACTION
GET
Retrieves Resources.
POST
Creates Resources.
PUT
Changes and/or Replaces Resources.
DELETE
Deletes Resouces.
4.2.2 Endpoints & SDKs

The Titan API endpoints always return a response in JSON metadata format at the base address: 

https://titan-ai.p.rapidapi.com/

Based on your subscription plan (Coming Soon), the endpoints to access Titan cognitive services will vary. So please check that you are using the correct endpoints to communicate with our API. 

TITAN API ENDPOINTS
SUBSCRIPTION PLANS
TO LOAD CONTENT
TO ASK QUESTIONS
TO INSTRUCT AGENT
TO RETRIEVE ANSWERS
BASIC
/Basic/Data
/Basic/Query
/Basic/Rule
/Basic/Response
PRO
/Pro/Data
/Pro/Query
/Pro/Rules
/Pro/Response
ULTRA
/Ultra/Data
/Ultra/Query
/Ultra/Rules
/Ultra/Response

Regardless of what you prefer as a programing language, we have included a list of SDKs to get you started easily and quickly. You can just import the SDK of your choice by copying the provided code snippet into your application.

SDKs

4.2.3 JSON Objects

In the API requests and responses, you will frequently encounter the following JSON objects:

OBJECTS
DESCRIPTION
EXAMPLE
ID
Enter session identifier (x-rapidapi-key) 
"a8e0619xxxx40f9c19"
CONTENT
Enter your content
"What color is the sun?"
4.2.4 Authentication

We use API keys as mean to authenticate your application. We expect developers to build internal applications that don’t need to access more than a single user’s data.

All requests to Titan API require authentication (your X-RapidAPI-key). This is achieved by sending a valid API key in the request header.
The API key assigned to you is in the form of:

"x-rapidapi-key”: “a8e009619xxxxxxxxxx4ea2840f9c19"

4.3 Response

Titan API returns all response data as a JSON object.

4.4 Response Status Codes

Titan API uses the following response status codes, as defined in the RFC 2616 and RFC 6585:

STATUS CODE
DESCRIPTION
200
OK - The request has succeeded. The client can read the result of the request in the body and the headers of the response.
400
Bad Request - The request could not be understood by the server due to malformed syntax. The message body will contain more information; see Response Schema.
401
Unauthorized - The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials.
403
Forbidden - The server understood the request, but is refusing to fulfill it.
404
Not Found - The requested resource could not be found. This error can be due to a temporary or permanent condition.
429
Too Many Requests - Rate limiting has been applied.
500
Internal Server Error- When this happens try your request again at a later time or contact our support team to get assistance.
502
Bad Gateway - The server was acting as a gateway or proxy and received an invalid response from the upstream server.
503
Bad Gateway - The server was acting as a gateway or proxy and received an invalid response from the upstream server.

4.5 Rate Limiting

Rate Limiting enables Titan API to share access bandwidth to its resources equally across all users.

Rate limiting is applied as per application based on Client ID/API key, and regardless of the number of users who use the application simultaneously.

To reduce the amount of requests, fetch multiple entities in one request.
For example: You can ask multiple questions about your text at the same time in the same request and that will drastically reduce the amount of requests your application utilizes.

Note: If Titan API returns status code 429, it means that you have sent too many requests. When this happens try your request again at a later time or contact our support team to get assistance.