Share
Explore

Supahands API Documentation v1.2.1

Last updated (January 2020)
Welcome to the Supahands API Documentation.

Supahands offers each client a fully managed enterprise-friendly solution for all your annotation needs. Through our APIs you will be able to just send us your data at the beginning of a project, and we’ll take care of the rest!

Authentification

Before submitting an API call with your task, you will need to authenticate access to our API.
Supahands uses a system token to allow access to the API.

How to get your system token?


Call the following endpoint to get your token.

GET https://supahandsapis.com/auth/auth/system_auth

You must include a system token in order to send API requests to the server. The token can be passed in the header or as a query string depending on the application. The secret_key and access_id are both generated from our end and will only be given to authorised parties.

Example of a request header

Screenshot 2021-01-27 at 11.52.15 AM.png

Example of a response body

Screenshot 2021-01-27 at 11.52.45 AM.png

GET https://supahandsapis.com/auth/auth/inspect

Query string:

Screenshot 2021-01-27 at 11.53.56 AM.png

*Note: Calling the endpoint with a valid token will refresh the current expiration period of the token

Example of the response body

Screenshot 2021-01-27 at 11.55.04 AM.png


Sending a task to Supahands


For all projects, we currently accept files in either CSV or JSON format

POST https://supahandsapis.com/gayte/gayte/comm

Example of a request header

Screenshot 2021-01-27 at 11.57.49 AM.png

Example of a request body

Our platform is built to handle a range of parameters for your project. There’s no predefined ways to name your parameters because we customise every project based on your individual project requirements.

The only parameters that you
must
define are:
project_name
- which we will provide in the beginning of the project.
model_name
- use leads as default

Screenshot 2021-01-27 at 11.58.18 AM.png

Important

The response will show
200
if succeed
403
if failed

Sending a file via CSV


POST https://supahandsapis.com/gayte/gayte/xlaod

Example of a request header

Screenshot 2021-01-27 at 12.02.53 PM.png

Example of a request body:

Our platform is built to handle a range of parameters for your project. There’s no predefined ways to name your parameters because we customise every project based on your own individual requirements.

The only parameters that you
must
define are:
project_name
- which we will provide in the beginning of the project.
model_name
- use leads as default

Screenshot 2021-01-27 at 12.03.56 PM.png

Important

The response will show
200
if succeed
403
if failed

Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.