# AmberScript Integration via LowCodeAPI

## Overview

Speech-to-text transcription service with automatic and manual transcription options

## Base Endpoint

```
https://api.lowcodeapi.com/amberscript/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [https://www.amberscript.com](https://www.amberscript.com)
2. **Get your credentials** from [https://app.amberscript.com/api](https://app.amberscript.com/api)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

The `api_token` is your LowCodeAPI authentication token. LowCodeAPI will automatically:
- Fetch your AmberScript API key
- Apply it to each request with `Authorization` header

**Auth Type**: API Key (Authorization header)

## API Categories

- Speech to Text AI

## Common Endpoints

### Category: Glossary

#### Create a glossary

**Method**: `POST` | **LowCodeAPI Path**: `/v1/users`

**Full URL**:
```
https://api.lowcodeapi.com/amberscript/v1/users&api_token={api_token}
```


**Body Parameters**:

| `name` | string | Yes | Name of the glossary |
| `items` | array | No | Array of glossary items. GlossaryItem format is described in the table below. |
| `names` | array | No | Array of names |
| `item.name` | string | Yes | Term which is being described. |
| `item.description` | string | No | Description of the term |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/amberscript/v1/users?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"value","items":"value","names":"value"}'
```

**Official Documentation**: [https://amberscript.github.io/api-docs/?javascript#create-a-glossary](https://amberscript.github.io/api-docs/?javascript#create-a-glossary)

---

#### Get a list of glossaries

**Method**: `GET` | **LowCodeAPI Path**: `/v1/users`

**Full URL**:
```
https://api.lowcodeapi.com/amberscript/v1/users?...&api_token={api_token}
```


**Query Parameters**:

| `sortBy` | string | No | Field by which to sort the resulting list of glossaries. |
| `sortDirection` | string | No | DESC or ASC |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/amberscript/v1/users?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://amberscript.github.io/api-docs/?javascript#get-a-list-of-glossaries](https://amberscript.github.io/api-docs/?javascript#get-a-list-of-glossaries)

---

#### Delete a glossary

**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/users`

**Full URL**:
```
https://api.lowcodeapi.com/amberscript/v1/users&api_token={api_token}
```


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/amberscript/v1/users&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://amberscript.github.io/api-docs/?javascript#delete-a-glossary](https://amberscript.github.io/api-docs/?javascript#delete-a-glossary)

---

#### Update a glossary

**Method**: `PUT` | **LowCodeAPI Path**: `/v1/users`

**Full URL**:
```
https://api.lowcodeapi.com/amberscript/v1/users&api_token={api_token}
```


**Body Parameters**:

| `name` | string | Yes | Name of the glossary |
| `items` | array | No | Array of glossary items. GlossaryItem format is described in the table below. |
| `names` | array | No | Array of names |
| `item.name` | string | Yes | Term which is being described. |
| `item.description` | string | No | Description of the term |


**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/amberscript/v1/users?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"value","items":"value","names":"value"}'
```

**Official Documentation**: [https://amberscript.github.io/api-docs/?javascript#update-a-glossary](https://amberscript.github.io/api-docs/?javascript#update-a-glossary)

---

## Usage Examples

### Example 1: Basic Usage

Get started with AmberScript API by making your first request.

```bash
# Your example code here
# This demonstrates basic usage
curl -X GET "https://api.lowcodeapi.com/amberscript/?api_token=YOUR_API_TOKEN"
```

### Example 2: Advanced Usage

Explore more advanced features and parameters.

```bash
# Your example code here
# This demonstrates advanced usage
curl -X GET "https://api.lowcodeapi.com/amberscript/?api_token=YOUR_API_TOKEN"
```

## Complete Endpoint Reference

For a complete list of all endpoints and their parameters, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/amberscript/definition`
- **Official Provider Documentation**: [https://amberscript.github.io/api-docs/](https://amberscript.github.io/api-docs/)

## Rate Limits & Best Practices

- Check your AmberScript account for specific rate limits
- Use appropriate error handling and retry logic
- Cache responses when appropriate to reduce API calls

## Error Handling

Standard HTTP status codes apply:
- `400` - Invalid request parameters
- `401` - Unauthorized (check your API key)
- `429` - Rate limit exceeded
- `500` - Internal server error