APIKEY

Use Audio2SRT.app through the API

1. Get APIKEY

Create a personal production key

2. Integration JSON

Copy the API integration JSON

{
  "product": "Audio2SRT.app",
  "official_site": "https://audio2srt.app",
  "base_url": "https://auth.xiaojinpro.com/asr",
  "authentication": {
    "type": "bearer",
    "header": "Authorization: Bearer <APIKEY>",
    "api_key": "<YOUR_AUDIO2SRT_APIKEY>"
  },
  "billing": {
    "api_channel": "$1 per audio hour",
    "credit_rate": "60 credits = 1 audio hour",
    "rounding": "charged by actual processed media duration, rounded up to the next minute"
  },
  "endpoints": {
    "upload_file": {
      "method": "POST",
      "path": "/v1/transcribe/upload",
      "url": "https://auth.xiaojinpro.com/asr/v1/transcribe/upload",
      "content_type": "multipart/form-data",
      "fields": {
        "file": "audio or video file",
        "options": "{\"language_hint\":\"auto\",\"diarization\":true,\"enable_punctuation\":true,\"return_word_timestamps\":true}"
      },
      "curl": "curl -sS -X POST \"https://auth.xiaojinpro.com/asr/v1/transcribe/upload\" \\\n  -H \"Authorization: Bearer $AUDIO2SRT_APIKEY\" \\\n  -F \"file=@./audio.m4a\" \\\n  -F 'options={\"language_hint\":\"auto\",\"diarization\":true,\"enable_punctuation\":true,\"return_word_timestamps\":true}'"
    },
    "transcribe_link": {
      "method": "POST",
      "path": "/v1/transcribe/link",
      "url": "https://auth.xiaojinpro.com/asr/v1/transcribe/link",
      "content_type": "application/json",
      "body": {
        "url": "https://example.com/video",
        "options": {
          "language_hint": "auto",
          "diarization": true,
          "enable_punctuation": true,
          "return_word_timestamps": true
        }
      },
      "curl": "curl -sS -X POST \"https://auth.xiaojinpro.com/asr/v1/transcribe/link\" \\\n  -H \"Authorization: Bearer $AUDIO2SRT_APIKEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"url\":\"https://example.com/video\",\"options\":{\"language_hint\":\"auto\",\"diarization\":true,\"enable_punctuation\":true,\"return_word_timestamps\":true}}'"
    },
    "get_task": {
      "method": "GET",
      "path": "/v1/tasks/{task_id}",
      "url": "https://auth.xiaojinpro.com/asr/v1/tasks/{task_id}",
      "curl": "curl -sS \"https://auth.xiaojinpro.com/asr/v1/tasks/$TASK_ID\" \\\n  -H \"Authorization: Bearer $AUDIO2SRT_APIKEY\""
    },
    "list_tasks": {
      "method": "GET",
      "path": "/v1/tasks",
      "url": "https://auth.xiaojinpro.com/asr/v1/tasks",
      "curl": "curl -sS \"https://auth.xiaojinpro.com/asr/v1/tasks\" \\\n  -H \"Authorization: Bearer $AUDIO2SRT_APIKEY\""
    }
  },
  "polling": {
    "terminal_statuses": [
      "completed",
      "failed"
    ],
    "suggested_interval_seconds": 3,
    "result_path": "transcript"
  },
  "output_layers": [
    "word_timestamps",
    "speaker_segments",
    "sentence_srt",
    "punctuated_text"
  ],
  "environment_variables": {
    "AUDIO2SRT_API_BASE": "https://auth.xiaojinpro.com/asr",
    "AUDIO2SRT_APIKEY": "<YOUR_AUDIO2SRT_APIKEY>"
  }
}