Skip to main content
POST
/
v1
/
recordings
cURL
curl --request POST \
  --url https://api.claap.io/v1/recordings \
  --header 'Content-Type: application/json' \
  --header 'X-Claap-Key: <api-key>' \
  --data '
{
  "authorEmail": "<string>",
  "channelId": "<string>",
  "downloadUrl": "<string>",
  "title": "<string>"
}
'
{
  "result": {
    "recording": {
      "createdAt": "<string>",
      "id": "<string>",
      "recorder": {
        "attended": true,
        "email": "<string>",
        "id": "<string>",
        "name": "<string>"
      },
      "state": "Empty",
      "url": "<string>",
      "workspace": {
        "id": "<string>",
        "name": "<string>"
      },
      "channel": {
        "id": "<string>",
        "name": "<string>"
      },
      "title": "<string>",
      "upload": {
        "url": "<string>"
      }
    }
  }
}
Create a recording in an empty state. The video or audio payload can be supplied either by an HTTP PUT request on the upload.url or by pointing the input downloadUrl to a location publicly accessible with an HTTP GET request, returning less than 2 GiB of data within 5 minutes. The recording is created on behalf of specified author and related quotas apply. At most 50 recordings can be created in a 30 days window period. Once the payload is received, state will change to Uploaded then either to Ready or Failed. Payload formats are the same available to manual uploads:
  • aac
  • avi
  • mp3
  • mp4
  • wav
  • webm
  • wmv

Authorizations

​
X-Claap-Key
string
header
required

Body

application/json
​
authorEmail
string
required

Recording author email address. It must belong to a workspace user with enough permissions to create the recording.

​
channelId
string

Identifier of a channel where the recording should be created.

​
downloadUrl
string

URL where the recording video content can be retrieved using an HTTP GET request. Do not use response upload URL if this parameter is supplied.

​
title
string

Recording title.

Response

200 - application/json

Recording was successfully created

​
result
object
required