Generate Audio Upload URL

curl --request POST \
 --url https://api.caret.so/v1/notes/from-audio/generate-upload-url \
 --header 'Authorization: Bearer <your_api_key>' \
 --header 'Content-Type: application/json' \
 --data '{
"fileExtension": "m4a",
"duration": 3600
}'

{
  "presignedUrl": "https://caret-cdn.s3.us-west-1.amazonaws.com/audio/temp_upload_...",
  "audioUrl": "https://caret-cdn.s3.us-west-1.amazonaws.com/audio/temp_upload_...",
  "contentType": "audio/mp4"
}

{
  "error": {
    "code": "bad_request",
    "message": "Duration is too long"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "API key does not have the required permissions"
  }
}

POST

notes

from-audio

generate-upload-url

curl --request POST \
 --url https://api.caret.so/v1/notes/from-audio/generate-upload-url \
 --header 'Authorization: Bearer <your_api_key>' \
 --header 'Content-Type: application/json' \
 --data '{
"fileExtension": "m4a",
"duration": 3600
}'

{
  "presignedUrl": "https://caret-cdn.s3.us-west-1.amazonaws.com/audio/temp_upload_...",
  "audioUrl": "https://caret-cdn.s3.us-west-1.amazonaws.com/audio/temp_upload_...",
  "contentType": "audio/mp4"
}

{
  "error": {
    "code": "bad_request",
    "message": "Duration is too long"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "API key does not have the required permissions"
  }
}

This endpoint is available only for Enterprise plan users.

Request Body

string

required

The file extension of the audio file (e.g., m4a, mp3, wav, aac)

number

required

Duration of the audio file in seconds (maximum 4 hours / 14400 seconds)

Response

string

The presigned URL to upload the audio file using PUT request

string

The final URL where the audio will be accessible after upload

string

The content type to use when uploading the file

curl --request POST \
 --url https://api.caret.so/v1/notes/from-audio/generate-upload-url \
 --header 'Authorization: Bearer <your_api_key>' \
 --header 'Content-Type: application/json' \
 --data '{
"fileExtension": "m4a",
"duration": 3600
}'

{
  "presignedUrl": "https://caret-cdn.s3.us-west-1.amazonaws.com/audio/temp_upload_...",
  "audioUrl": "https://caret-cdn.s3.us-west-1.amazonaws.com/audio/temp_upload_...",
  "contentType": "audio/mp4"
}

{
  "error": {
    "code": "bad_request",
    "message": "Duration is too long"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "API key does not have the required permissions"
  }
}

Usage

After receiving the presigned URL, upload your audio file:

curl --request PUT \
  --url "<presignedUrl>" \
  --header "Content-Type: audio/mp4" \
  --data-binary @your-audio-file.m4a

Then use the audioUrl with the Create Note from Audio endpoint.

Update Note

Create Note from Audio

⌘I

​Request Body

​Response

​Usage

Request Body

Response

Usage