Decrackle API Docs
  • Welcome
  • Quick Start
  • Reference
    • API Reference
      • Start Enhancing
      • Check Enhancement Status
      • Retrieve Results
Powered by GitBook
On this page
  • Headers
  • Request
  • Response
  1. Reference
  2. API Reference

Retrieve Results

Once processing is complete, You can retrieve the link for the enhanced file and other details in the response

Headers

Key
Value

Content-Type

application/json

X-API-KEY

<Your API Key Here>

Request

GET

/api/v1/audiaize/unify/{id}/

From the Start Enhancement API get the Job ID and pass it in the GET request

Response

{
    "status": "completed"
    "id": {id},
    "file_url": "input file url",
    "enhanced_audio": {
        "enhanced_filename": "unique-enhanced-filename_audiaize.wav",
        "enhanced_file_url": "https://storage.googleapis.com/enhanced/file/url"
    },
    "transcription": {
        "transcription_text": "Transcripted Text"
    },
    "sentimentalAnalysis": {
        "sentimental_text": "Sentimental text"
    },
    "actionableinsight":{
        "actionable_text": "Actionable Insight"
    },
    "summary":{
        "summary_text":"Summary text"
    }
    "transcriptionLanguage": "Seclected Language"
}
  • 200 OK: The request was successful, and the details of the completed job are returned.

  • 400 Bad Request: The server could not understand the request due to invalid syntax.

  • 401 Unauthorized: Authentication is required and has failed or has not yet been provided.

  • 403 Forbidden: The request was a valid request, but the server is refusing action.

  • 404 Not Found: The requested resource (job ID) was not found.

  • 500 Internal Server Error: An unexpected condition was encountered.

id

integer

The unique identifier for the enhancement job.

file_url

string

The URL of the original input audio file.

enhanced_filename

string

The filename of the enhanced audio file.

enhanced_file_url

string

The URL where the enhanced audio file can be downloaded.

transcription_text

string

The transcribed text of the audio.

sentimental_text

string

The result of the sentimental analysis.

actionable_text

string

The result of the actionable insights

summary_text

string

The result of the summary

enhancement_type

object

The types of enhancements applied to the audio file.

status

string

The final status of the job, which should be completed for a successful retrieval.

PreviousCheck Enhancement Status

Last updated 10 months ago