Create recording

POST

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>",
  "transcript": {
    "type": "upload"
  },
  "video": {
    "type": "upload"
  }
}
'

import requests

url = "https://api.claap.io/v1/recordings"

payload = {
    "authorEmail": "<string>",
    "channelId": "<string>",
    "downloadUrl": "<string>",
    "title": "<string>",
    "transcript": { "type": "upload" },
    "video": { "type": "upload" }
}
headers = {
    "X-Claap-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authorEmail: '<string>',
    channelId: '<string>',
    downloadUrl: '<string>',
    title: '<string>',
    transcript: {type: 'upload'},
    video: {type: 'upload'}
  })
};

fetch('https://api.claap.io/v1/recordings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.claap.io/v1/recordings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'authorEmail' => '<string>',
    'channelId' => '<string>',
    'downloadUrl' => '<string>',
    'title' => '<string>',
    'transcript' => [
        'type' => 'upload'
    ],
    'video' => [
        'type' => 'upload'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Claap-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.claap.io/v1/recordings"

	payload := strings.NewReader("{\n  \"authorEmail\": \"<string>\",\n  \"channelId\": \"<string>\",\n  \"downloadUrl\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transcript\": {\n    \"type\": \"upload\"\n  },\n  \"video\": {\n    \"type\": \"upload\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Claap-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.claap.io/v1/recordings")
  .header("X-Claap-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authorEmail\": \"<string>\",\n  \"channelId\": \"<string>\",\n  \"downloadUrl\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transcript\": {\n    \"type\": \"upload\"\n  },\n  \"video\": {\n    \"type\": \"upload\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.claap.io/v1/recordings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authorEmail\": \"<string>\",\n  \"channelId\": \"<string>\",\n  \"downloadUrl\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transcript\": {\n    \"type\": \"upload\"\n  },\n  \"video\": {\n    \"type\": \"upload\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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": {
        "metaUrl": "<string>",
        "url": "<string>"
      }
    }
  }
}

Create a recording in an empty state. The video attribute tells how the media is supplied:

{ "type": "upload" } (default): send the video or audio payload with an HTTP PUT request on the response upload.url.
{ "type": "download", "url": "..." }: Claap retrieves the payload from a location publicly accessible with an HTTP GET request, returning less than 2 GiB of data within 5 minutes. Do not use the response upload.url.
{ "type": "none" }: the recording has no media and is created from its transcript only, see below.

The downloadUrl attribute is deprecated and equivalent to video: { "type": "download", "url": ... }. It cannot be combined with video. The recording is created on behalf of specified author and related quotas apply. 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

Supplying a transcript

To provide a transcript in addition to the video, set the transcript attribute to { "type": "upload" }. The response will then define the upload.metaUrl attribute. Use it to send the JSON payload with an HTTP PUT request, in the following format:

{
    transcript: {
        // The 2-letters language code of the transcript, if any
        langIso2?: string
        segments: {
            // Segment start timecode in seconds
            start: number
            // Segment end timecode in seconds
            end: number
            // Segment speaker identifier, can reference an item in the speakers
            // collection
            speakerId: string
            // Segment transcript
            text: string 
        }[]
        speakers?: {
            email?: string
            // Set isRecorder to true if the speaker is the meeting recorder
            isRecorder?: boolean
            name: string
            speakerId: string
        }[]
    }
}

For instance:

{
    "transcript": {
        "langIso2": "fr",
        "segments": [
            { "speakerId": "1", "start": 0.5, "end": 1.5, "text": "Bonjour !" },
            { "speakerId": "2", "start": 2.1, "end": 2.9, "text": "Hello" }
        ],
        "speakers": [
            { "email": "eric@claap.io", "name": "Éric", "speakerId": "1" },
            { "email": "marc@claap.io", "name": "Marc", "speakerId": "2" }
        ]
    }
}

NOTE: if the transcript attribute was set, the recording creation will only proceed once both the video and the transcript payloads have been sent. Each upload link is only returned while its payload is pending.

Transcript-only recordings

Set video to { "type": "none" } and transcript to { "type": "upload" } to create a recording from a transcript alone. The response only defines upload.metaUrl, and the recording is created as soon as the transcript payload is received. Its duration is derived from the segments, and it is flagged with transcriptOnly: true once Ready. For instance:

{
    "authorEmail": "eric@claap.io",
    "video": { "type": "none" },
    "transcript": { "type": "upload" }
}

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 folder (aka channel) where the recording should be created.

deal

object

A reference to a CRM deal entity to link to the recording. It requires meeting information to be supplied and the Claap workspace to be connected to the same CRM.

Show child attributes

downloadUrl

string

deprecated

Deprecated, use video with the download type instead. 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.

meeting

object

Show child attributes

title

string

Recording title.

transcript

object

Setting this property signals your intent to supply transcript information in addition to the video payload. The response will then define a metaUrl upload attribute to be used to PUT the transcript payload. The recording creation will not proceed until both payloads are sent. Required when video.type is none.

Show child attributes

video

object

How the recording media is supplied. upload (default): the media is sent with an HTTP PUT request on the response upload.url. download: the media is retrieved from url with an HTTP GET request, do not use the response upload.url. none: the recording has no media and is created from its transcript only, the transcript attribute is then required.

Option 1
Option 2
Option 3

Show child attributes

source

enum<string>

Origin of the recording: meeting platform (e.g. Zoom, GoogleMeet, MsTeams), VoIP provider (e.g. Aircall, Ringover, Allo) or Call for other call platforms. Defaults to Api if none is provided.

Available options:

Aircall,

Allo,

Call,

GoogleMeet,

LemlistVoip,

Loom,

MsTeams,

Ringover,

Zoom

Response

200 - application/json

Recording was successfully created

result

object

required

Show child attributes

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>",
  "transcript": {
    "type": "upload"
  },
  "video": {
    "type": "upload"
  }
}
'

import requests

url = "https://api.claap.io/v1/recordings"

payload = {
    "authorEmail": "<string>",
    "channelId": "<string>",
    "downloadUrl": "<string>",
    "title": "<string>",
    "transcript": { "type": "upload" },
    "video": { "type": "upload" }
}
headers = {
    "X-Claap-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authorEmail: '<string>',
    channelId: '<string>',
    downloadUrl: '<string>',
    title: '<string>',
    transcript: {type: 'upload'},
    video: {type: 'upload'}
  })
};

fetch('https://api.claap.io/v1/recordings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.claap.io/v1/recordings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'authorEmail' => '<string>',
    'channelId' => '<string>',
    'downloadUrl' => '<string>',
    'title' => '<string>',
    'transcript' => [
        'type' => 'upload'
    ],
    'video' => [
        'type' => 'upload'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Claap-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.claap.io/v1/recordings"

	payload := strings.NewReader("{\n  \"authorEmail\": \"<string>\",\n  \"channelId\": \"<string>\",\n  \"downloadUrl\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transcript\": {\n    \"type\": \"upload\"\n  },\n  \"video\": {\n    \"type\": \"upload\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Claap-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.claap.io/v1/recordings")
  .header("X-Claap-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authorEmail\": \"<string>\",\n  \"channelId\": \"<string>\",\n  \"downloadUrl\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transcript\": {\n    \"type\": \"upload\"\n  },\n  \"video\": {\n    \"type\": \"upload\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.claap.io/v1/recordings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authorEmail\": \"<string>\",\n  \"channelId\": \"<string>\",\n  \"downloadUrl\": \"<string>\",\n  \"title\": \"<string>\",\n  \"transcript\": {\n    \"type\": \"upload\"\n  },\n  \"video\": {\n    \"type\": \"upload\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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": {
        "metaUrl": "<string>",
        "url": "<string>"
      }
    }
  }
}

API documentation

Recording

Deal

Company

Contact

Admin automation

Workspace

User

Webhook

Supplying a transcript

Transcript-only recordings

Authorizations

Body

Response

​Supplying a transcript

​Transcript-only recordings

Authorizations

Body

Response

Supplying a transcript

Transcript-only recordings