☃️ SALE ☃️ Dictanote Pro + Audio Scribe AI Writing Assistant for just $4/month Upgrade Now →

AudioScribe API Documentation

1. Authorization

All API requests require authentication. The authentication is managed through a bearer token.

Bearer Token

To access the APIs, include your bearer token in the Authorization header of each request.
The header format should be: Authorization: Bearer YOUR_TOKEN


2. List Sessions API

This API retrieves a paginated list of audio sessions for the authenticated user.

HTTP Request

GET /api/v1/audioscribe/sessions/

Query Parameters

Parameter Type Description
page Integer Page number for pagination. Defaults to 0 if not provided.

Response

The response is a JSON array of session objects. Each object contains the following fields:

Field Type Description
id Integer Unique identifier of the session.
title String Title of the audio session.
note String Final transcript of the session.
originalTranscript String Original transcript of the session.
tags String Associated tags (currently empty).
createdAt String ISO format creation date and time.

3. Get Session API

This API retrieves details of a specific audio session for the authenticated user.

HTTP Request

GET /api/v1/audioscribe/sessions/<int:id>/

URL Parameters

Parameter Type Description
id Integer Unique identifier of the session.

Response

The response is a JSON object containing the following fields:

Field Type Description
id Integer Unique identifier of the session.
title String Title of the audio session.
note String Final transcript of the session.
originalTranscript String Original transcript of the session.
tags String Associated tags (currently empty).
createdAt String ISO format creation date and time.

4. Webhook Configuration

This section describes how users can configure a webhook URL for their account. Once configured, the system will send a notification to the specified webhook URL every time a new session is created.

Setting Up a Webhook

Webhooks are in Beta. Please contact us at support@dictanote.co to set this up. We support integration via Zapier and manual configuration.

Webhook Notification

When a new audio session is created, the system automatically sends a POST request to the configured webhook URL. The request contains a JSON object with details of the session.

JSON Data Structure

The JSON data sent to the webhook URL includes the following fields:

Field Type Description
id Integer Unique identifier of the session.
title String Title of the audio session.
note String Final transcript of the session.
originalTranscript String Original transcript before processing.
tags String Associated tags (if any).
createdAt String ISO format creation date and time of the session.

Webhook Response

The response from the webhook endpoint is not used to control the behavior of the system. However, it is recommended for the endpoint to respond with a status code of 200 OK to indicate successful receipt of the notification.