• API version: v2
  • Package version: 0.2.27

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install tinq

(you may need to run pip with root permission: `sudo pip install tinq

Then import the package:

import tinq

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import tinq

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import tinq
from tinq.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://tinq.ai/api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = tinq.Configuration(
    host = "https://tinq.ai/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = tinq.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with tinq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tinq.Assistant(api_client)
    accept_charset = 'UTF-8' # str |  (optional)
    content_type = 'application/json' # str |  (optional)
    accept = 'application/json' # str |  (optional)
    body = None # object |  (optional)

    try:
        # Generate
        api_instance.generate(accept_charset=accept_charset, content_type=content_type, accept=accept, body=body)
    except ApiException as e:
        print("Exception when calling Assistant->generate: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://tinq.ai/api/v2

ClassMethodHTTP requestDescription
AssistantgeneratePOST /assistantGenerate
ClassifiersclassifiersGET /classifiersClassifiers
ClassifiersclassifyPOST /classifyClassify
Classifierssentiment_analysisPOST /sentiment-analysisSentiment Analysis
PlagiarismCheckercheck_plagiarismPOST /check-plagiarismCheck Plagiarism
Projectscreate_projectPOST /projectsCreate Project
Projectsget_all_projectsGET /projects/Get All Projects
Projectsget_projectGET /projects/Get Project
Projectsupdate_projectPUT /projects/Update Project
Scraperextract_articlePOST /scraper/extract-articleExtract article
Scrapergoogle_searchPOST /scraper/googleGoogle Search
ScraperscrapePOST /scraper/scrapeScrape
Toolsextract_text_from_filePOST /extract-textExtract text from file
Toolsextract_urlPOST /extract-articleExtract URL
Workflowscreate_workflowPOST /workflowsCreate workflow
Workflowsexecute_workflowPOST /workflows//executeExecute workflow
Workflowsget_one_workflowGET /workflows/Get one workflow
Workflowsget_workflowsGET /workflowsGet workflows

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication

Author

boulama@tinq.ai