Skip to main content

Authentication

Accessing Vulavula API services requires obtaining an API token, serving as a secure credential for accessing our endpoints.

Obtaining Your API Token​

The API token serves as a crucial authentication mechanism, requiring inclusion in the header of every request directed towards our API.

Steps to Acquire the API Token​

  1. Signup and Login to vulavula: Begin by registering and logging into our vulavula platform. You can sign up using either a username and password or through one of our supported social sign-in options, such as email, or GitHub.

  2. Generate a vulavula API Token: After successful authentication via username and password, navigate to the API Keys section. Here, select the 'Generate API Key' button to obtain your unique API token. Subsequently, you can incorporate this token as the X-CLIENT-TOKEN header in your API requests.

  3. Limitations: Please note that each API token is limited to 100 free calls. Be mindful of this restriction when utilizing our services.

Example​

You can use the token in any of our API operations. Below I will show a simple implementation when performing Named Entity Recognition.
This shows a simple Python and Curl implementation.


# Endpoint URL
url = 'https://vulavula-services.lelapa.ai/api/v1/entity_recognition/process'

# Headers
headers = {
    'Content-Type': 'application/json',
    'X-CLIENT-TOKEN': '<INSERT_TOKEN>' # Replace '<INSERT_TOKEN>' with your actual client token
}

# Request body
data = {
    "encoded_text": "President Ramaphosa gaan loop by Emfuleni Municipality"
}

# Sending POST request
response = requests.post(url, headers=headers, json=data)

# Printing response
print(response.json())