Developers
REST API
Use the AudioScribe API to read your notes from your own software. The API is read-only.
Authorization
Each request must have a bearer token in the Authorization header:
Authorization: Bearer YOUR_TOKEN
To get a token, send an email to support@dictanote.co. Use the email address of your AudioScribe account.
Caution: The token gives access to all of your notes. Do not put the token in public code or in a web page.
The note object
| Field | Type | Description |
|---|---|---|
id | Integer | The unique identifier of the note. |
title | String | The title of the note. |
note | String | The rewritten text of the note. |
originalTranscript | String | The transcript of the audio. |
tags | String | The tags of the note. |
createdAt | String | The date and time when AudioScribe made the note, in ISO 8601 format. |
List notes
GET /api/v1/audioscribe/notes/
Gives your notes, newest first, as a JSON array of note objects.
Query parameters
| Parameter | Type | Description |
|---|---|---|
limit | Integer | The number of notes on each page. The default is 10. The maximum is 50. |
page | Integer | The page number. The first page is 0. |
cursor | Integer | Gives only the notes with an id less than this value. Use the id of the last note on the previous page. If you use cursor, the API ignores page. |
Example
curl https://dictanote.co/api/v1/audioscribe/notes/?limit=20 \
-H "Authorization: Bearer YOUR_TOKEN"Get one note
GET /api/v1/audioscribe/notes/<id>/
Gives one note object.
Path parameters
| Parameter | Type | Description |
|---|---|---|
id | Integer | The unique identifier of the note. |
Get a new note immediately
Do not request the list again and again to find new notes. Use a webhook. AudioScribe then sends each new note to your URL.