LowCodeAPI voicegainai skill

# VoiceGain AI Integration via LowCodeAPI

**Last Updated**: February 10, 2026

## Overview
Speech-to-text transcription platform with real-time and batch processing capabilities

**Categories:**
- {'id': 'speech-to-text', 'name': 'Speech to Text AI'}

## Base Endpoint
https://api.lowcodeapi.com/voicegainai

**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`

## Authentication
**Type:** TOKEN

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#tag/transcribe

## URL Format (Important)

LowCodeAPI supports two URL formats. **Always try the New Format first**, then fall back to Old Format if needed.

### New Format (Priority)
- Path parameters stay in the URL path
- Do NOT include path parameters as query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/{id}?api_token=XXX`

### Old Format (Fallback)
- Path parameters become query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/id?id={id}&api_token=XXX`

### Decision Flow for AI Agents
1. Always use **New Format** first - keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider

## API Categories

## Common Endpoints

### Poll by WS name

**Method:** GET
**LowCodeAPI Path:** /v1/asr/transcribe

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| full | boolean |  |
| stop | enum |  |
| wsName | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrTranscribeAsyncGetByWSName

### Sync Transcribe

**Method:** POST
**LowCodeAPI Path:** /v1/asr/transcribe

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| audio | object |  |
| setting | object |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrTranscribePost

### Transcribe Queue Status

**Method:** GET
**LowCodeAPI Path:** /v1/asr/transcribe/status/queue

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/status/queue?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/status/queue?api_token=YOUR_API_TOKEN

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/status/queue?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrTranscribeStatusQueueGet

### Async Transcribe

**Method:** POST
**LowCodeAPI Path:** /v1/asr/transcribe/async

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/async?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/async?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| contextId | string |  |

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| audio | object |  |
| sessions | array |  |
| settings | object |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/async?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrTranscribeAsyncPost

### Delete Transcript

**Method:** DELETE
**LowCodeAPI Path:** /v1/asr/transcribe/{sessionId}

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/{sessionId}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/sessionid?sessionId={sessionId}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| sessionId | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| contextId | string |  |

**Example Request (New Format):**

```bash
curl -X DELETE 'https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/{sessionId}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrTranscribeAsyncDelete

### Poll Transcript

**Method:** GET
**LowCodeAPI Path:** /v1/asr/transcribe/{sessionId}

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/{sessionId}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/sessionid?sessionId={sessionId}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| sessionId | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| full | boolean |  |
| rmsInclude | boolean |  |
| stop | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/{sessionId}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrTranscribeAsyncGet

### Modify Transcribe Sess.

**Method:** PUT
**LowCodeAPI Path:** /v1/asr/transcribe/{sessionId}

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/{sessionId}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/sessionid?sessionId={sessionId}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| sessionId | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| contextId | string |  |

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| metadata | array of objects |  |
| sessionId | string |  |

**Example Request (New Format):**

```bash
curl -X PUT 'https://api.lowcodeapi.com/voicegainai/v1/asr/transcribe/{sessionId}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrTranscribeAsyncPut

### Sync Recognition

**Method:** POST
**LowCodeAPI Path:** /v1/asr/recognize

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/recognize?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/recognize?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| audio | object |  |
| settings | object |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/voicegainai/v1/asr/recognize?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrRecognizePost

### Async Recognition

**Method:** GET
**LowCodeAPI Path:** /v1/asr/recognize/async

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/recognize/async?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/recognize/async?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| audio | object |  |
| session | array |  |
| settings | object |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/voicegainai/v1/asr/recognize/async?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrRecognizeAsync

### Poll Recognition

**Method:** GET
**LowCodeAPI Path:** /v1/asr/recognize/{sessionId}

**New Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/recognize/{sessionId}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/voicegainai/v1/asr/recognize/sessionid?sessionId={sessionId}&api_token=YOUR_API_TOKEN

**Path Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| sessionId | string |  |

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| stop | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/voicegainai/v1/asr/recognize/{sessionId}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://console.voicegain.ai/api/v1/index.html#operation/asrRecognizeAsyncGet


## Usage Examples

### Example 1: Basic Chat Completion

Creating a simple text completion or chat message:

```bash
# Create a chat completion - no path parameters needed
curl -X POST "https://api.lowcodeapi.com/voicegainai/v1/chat/completions?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-name",
    "messages": [
      {"role": "user", "content": "Hello, how can you help me?"}
    ]
  }'

# Response includes generated content
```

### Example 2: Text Generation with Path Parameters

Generating text with specific model settings:

```bash
# Generate content using a specific model
curl -X POST "https://api.lowcodeapi.com/voicegainai/v1/models/generate?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Write a short poem about technology",
    "max_tokens": 100
  }'

# Or if the provider uses model in the path:
curl -X POST "https://api.lowcodeapi.com/voicegainai/v1/models/{MODEL_ID}:generateContent?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [{"parts": [{"text": "Write a short story"}]}]
  }'
```

### Example 3: List Available Models

```bash
# Get list of available models
curl -X GET "https://api.lowcodeapi.com/voicegainai/v1/models?api_token=YOUR_API_TOKEN"
```

## Error Handling

LowCodeAPI returns standard HTTP status codes. Common errors:

| Status Code | Description |
|-------------|-------------|
| 200 | Success - Request completed successfully |
| 400 | Bad Request - Invalid parameters or request body |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Endpoint or resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Server Error - Provider API error |

All error responses include error details:

```json
{
  "data": {
    "error": {
      "message": "Error description",
      "code": "ERROR_CODE"
    }
  }
}
```

## Complete Endpoint Reference

| Endpoint | Method | Category |
|----------|--------|----------|
| Poll by WS name | GET | Transcribe |
| Sync Transcribe | POST | Transcribe |
| Transcribe Queue Status | GET | Transcribe |
| Async Transcribe | POST | Transcribe |
| Delete Transcript | DELETE | Transcribe |
| Poll Transcript | GET | Transcribe |
| Modify Transcribe Sess. | PUT | Transcribe |
| Sync Recognition | POST | Recognize |
| Async Recognition | GET | Recognize |
| Poll Recognition | GET | Recognize |
| Recognition Callback | POST | STT Callback |
| Transcription Callback | POST | STT Callback |
| New Bot Session | POST | Tel Bot Callback |
| End Bot Session | DELETE | Tel Bot Callback |
| Existing Bot Session | PUT | Tel Bot Callback |
| Query Sp. Analytics Data | GET | Speech Analytics |
| New Speech Analytics Ses. | POST | Speech Analytics |
| Get Sp. Analytics Data | GET | Speech Analytics |
| Poll Sp. Analytics Ses. | GET | Speech Analytics |
| SA Transcript Content | GET | Speech Analytics |
| Query Sp. Analytics Cfg. | GET | Speech Analytics |
| Delete SA Cfg. | DELETE | Speech Analytics |
| Get Sp. Analytics Cfg. | GET | Speech Analytics |
| Mod Sp. Analytics Cfg. | PUT | Speech Analytics |
| Redact Text | POST | Text |

## API Definition Endpoints

You can fetch the complete API specification for this provider:

**New Format (OpenAPI spec):**
```bash
curl 'https://backend.lowcodeapi.com/voicegainai/openapi'
```

**Old Format (API definition):**
```bash
curl 'https://backend.lowcodeapi.com/voicegainai/definition'
```

## Response Format

All responses are wrapped in a `data` key:

```json
{
  "data": {
    // Actual response from provider (object or array)
  }
}
```