<commit_before>
### Getting Started
The api is exposed via REST and JSON. To make a call to one of the endpoints you'll need an HTTP client. To call the endpoint, just use the appropriate method i.e (GET,POST,PUT,DELETE), the url and the body (if required). The web service will send back a response code (200, 401) and a JSON response.

### Making Authenticated Calls
To call an endpoint where authentication is required you will need an auth token. Use the `login` endpoint to recieve that token and then add a header to you api call named `X-Auth-Token` with the token as a value. 

### Available EndPoints
	
#### Authentication

| DESCRIPTION | METHOD  | URL | AUTH REQUIRED? | DETAILS |
| ----------- | ------- | --- | -------------- | ------- | 
| Login In    |  POST   | /api/authenticate/userpass username=username&password=password | NO | [View Details](authenticate.md)


#### Children



#### Standards

| DESCRIPTION                 | METHOD  | URL               | AUTH REQUIRED? | DETAILS |
| -----------                 | ------- | ---               | -------------- | ------- | 
| Get all available standards | GET     | /api/v1/standards | NO             | [View Details](standards.md#all  <commit_msg>Update API.md<commit_after>
### Getting Started
The api is exposed via REST and JSON. To make a call to one of the endpoints you'll need an HTTP client. To call the endpoint, just use the appropriate method i.e (GET,POST,PUT,DELETE), the url and the body (if required). The web service will send back a response code (200, 401) and a JSON response.

### Making Authenticated Calls
To call an endpoint where authentication is required you will need an auth token. Use the `login` endpoint to recieve that token and then add a header to you api call named `X-Auth-Token` with the token as a value. 

### Available EndPoints
	
#### Authentication

| DESCRIPTION | METHOD  | URL | AUTH REQUIRED? | DETAILS |
| ----------- | ------- | --- | -------------- | ------- | 
| Login In    |  POST   | /api/authenticate/userpass username=username&password=password | NO | [View Details](authenticate.md)


#### Children



#### Standards

| DESCRIPTION                 | METHOD  | URL               | AUTH REQUIRED? | DETAILS |
| -----------                 | ------- | ---               | -------------- | ------- | 
| Get all available standards | GET     | /api/v1/standards | NO             | [View Details](standards.md#all)  
{'fraction_non_alphanumeric': 0.15592942141977842, 'fraction_numerical': 0.005744768157570784, 'mean_word_length': 2.1621271076523993, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1948270', 'n_tokens_mistral': 691, 'n_tokens_neox': 624, 'n_words': 269}