Start Building with Skriver APIs

Step 1: Create a Skriver Account

Head to auth.skriver.app and register for a free account. You will be redirected to dash.skriver.app.

Step 2: Create your API Keys

Once logged int, click on your username and then "Organization API Keys".

🚧
Store the keys somewhere safe.
Note that Skriver will make your API key available only once. Hence make sure to immediately copy and save the key in a safe and secure location.
Your key is used to authenticate into our APIs and is hence highly sensitive. Please make sure to keep the keys in a secure environment. In the event of a compromise, you can immediately revoke key access from our dashboard and generate a new key.

Optional: Create Postman Collection

Import our OpenAPI spec into Postman to create a collection

https://api.skriver.app/docs/private/api.json

Step 3: Transcribe your first audio

You are now ready to query our APIs.

curl --request POST \
     --url 'https://api.skriver.app/v1/transcripts/?name=My%20First%20Transcription&level=basic' \
     --header 'X-Api-Key: <API_KEY>' \
     --header 'Content-Type: application/octet-stream' \
     --header 'Accept: application/json' \
     --data-binary @path/to/audio/file.mp3

This endpoint will return a response like the following:

{
    "id": "018c00cf-076c-7c01-bcc1-dad2e8074bc8",
    "level": "basic",
    "status": "queued",
    "summary": null,
    "text": null,
    "duration_in_seconds": null,
    "metadata": null,
    "created_at": "2023-11-24T10:10:18.761661Z",
    "updated_at": "2023-11-24T10:10:18.761661Z"
}

Use the id to monitor the status of the transcription by calling the GET endpoint

curl --request GET \
     --url 'https://api.skriver.app/v1/transcripts/018c00cf-076c-7c01-bcc1-dad2e8074bc8' \
     --header 'X-Api-Key: <API_KEY>' \
     --header 'Accept: application/json'

You will get a response that contains the transcription text

{
    "id": "018c00cf-076c-7c01-bcc1-dad2e8074bc8",
    "level": "basic",
    "status": "completed",
    "summary": null,
    "text": "when customers first bring the software...",
    "duration_in_seconds": 96.56319,
    "metadata": null,
    "created_at": "2023-11-24T10:10:18.761661Z",
    "updated_at": "2023-11-24T10:10:18.761661Z"
}

Congratulations! You have converted an audio file into text.