Collect async voice and video with Speak AI recorders

API Endpoint: Retrieve Recorders

This endpoint retrieves a list of recorders with pagination and sorting options. It allows users to fetch details about available recorders based on specified parameters.

Request

Method: GET
URL: https://api.speakai.co/v1/recorder

Query Parameters:

• page (integer): The page number of the results to retrieve. Default is 0.

• pageSize (integer): The number of records to return per page. Default is 20.

• sortBy (string): The field by which to sort the results, followed by the sorting order. For example, createdAt:desc sorts by the creation date in descending order.

Response

The response will contain a JSON object with the following structure:

• status (string): The status of the request.

• data (object): Contains the results of the request.

  • totalCount (integer): The total number of recorders available.

  • page (integer): The current page number of the results.

  • recorderList (array): A list of recorder objects, each containing:

    • duration (integer): The duration of the recording.

    • isAutoAnalyze (boolean): Indicates if the recorder is set for automatic analysis.

    • isActive (boolean): Indicates if the recorder is currently active.

    • recordings (array): An array of recordings associated with the recorder.

    • createdAt (string): The timestamp when the recorder was created.

    • updatedAt (string): The timestamp when the recorder was last updated.

    • userId (string): The ID of the user associated with the recorder.

    • recorderId (string): The unique ID of the recorder.

    • token (string): A token associated with the recorder.

    • name (string): The name of the recorder.

    • meta (object): Metadata about the recorder, including:

      • type (object): Specifies the types of media supported (e.g., video and audio).

      • client (object): Information about the client, including name and email.

Example Response

{
  "status": "",
  "data": {
    "totalCount": 0,
    "page": "",
    "recorderList": [
      {
        "duration": 0,
        "isAutoAnalyze": true,
        "isActive": true,
        "recordings": [],
        "createdAt": "",
        "updatedAt": "",
        "userId": "",
        "recorderId": "",
        "token": "",
        "name": "",
        "meta": {
          "type": {
            "video": true,
            "audio": true
          },
          "client": {
            "name": true,
            "email": true
          }
        }
      }
    ]
  }
}

Parameters

API Endpoint: Get Recorder Details

Method: GET
Endpoint: https://api.speakai.co/v1/recorder/{recorderId}

This endpoint retrieves detailed information about a specific recorder identified by the recorderId. The response includes various attributes related to the recorder, such as its name, description, user information, recording settings, privacy options, and metadata.

Response Structure:

• status: Status of the request.

• data: Contains the details of the recorder:

  • recorderId: Unique identifier for the recorder.

  • userId: Identifier for the user associated with the recorder.

  • name: Name of the recorder.

  • description: Description of the recorder.

  • token: Authentication token for the recorder.

  • recordings: Array of recordings associated with the recorder.

  • minDuration: Minimum duration for recordings.

  • maxDuration: Maximum duration for recordings.

  • privacyMode: Privacy settings for the recorder.

  • password: Password for accessing the recorder, if applicable.

  • isAutoAnalyze: Indicates if automatic analysis is enabled.

  • assignTo: User or entity to which the recorder is assigned.

  • folderId: Identifier for the folder containing the recorder.

  • sourceLanguage: Language settings for the recorder.

  • meta: Metadata related to the recorder, including:

    • backgroundImg: Background image URL.

    • logo: Logo URL.

    • primaryColor: Primary color used in the recorder interface.

    • type: Supported types of recordings (audio, video, screen share, etc.).

    • client: Client-related information including name, email, and questions.

    • callToActionButtons: Action buttons associated with the recorder.

  • notification: Notification settings for the recorder.

  • isActive: Indicates if the recorder is currently active.

  • createdAt: Timestamp of when the recorder was created.

  • updatedAt: Timestamp of when the recorder was last updated.

  • domain: Domain associated with the recorder.

Parameters

DELETE /v1/recorder/{recorderId}

This endpoint allows clients to delete a specific recorder resource identified by the recorderId.

Parameters

• recorderId (path parameter): The unique identifier of the recorder that you wish to delete. This parameter is required.

Response

Upon successful deletion, the server will respond with a confirmation message indicating the result of the operation. The structure of the response will typically include:

• A status code indicating the success or failure of the operation.

• A message providing additional context about the deletion.

Ensure that the recorderId provided corresponds to an existing recorder, as attempting to delete a non-existent recorder may result in an error response.

Parameters

Clone Recorder to copy all the settings from the existing recorders

All the required fields are as below:

recorderId - Pass the recorderId from the existing recorder

Optional:

name - New name for the recorder. If not pass, it will take the existing recorder name and add (clone) to the new recorder

description - New description for the recorder. If not pass, it will take the existing recorder description as is.

folderId - IMPORTANT! We recommend to pass the folderId to ensure the recordings save in the specific folder. If not pass, it will take the existing recorder folderId setting.

If you need to change any other settings, we recommend to use the Create Recorder API call.

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.

Create a recorder and integrate with your platform easily.

All the required fields are as below:

name - Name of the recorder

All the other fields are optional. Your recorder will be created automatically.

description - Assign description of the recorder for internal purpose.

folderId - Save all your recordings to the assigned FolderId.

Duration of the recorder:

• minDuration - 15 seconds (min) & 5 min (max)

  • Pass the duration in seconds

• maxDuration - 10 seconds (min) & 3 hours (max)

  • Pass the duration in seconds

Source Language:

• You can pass the sourceLanguage as a code.

• Other language codes available at the top of the page.

Recorder options:

• We allow to support creating recorder with the multiple options such as:

  • audio - Audio recorder

  • video - Video recorder

  • screeShare - Allow to screen share on browser (Mobile not supported)

  • uploadFile - Allow to upload various file formats

    • allowMultiple - Supporting multiple file uploads

Notifications:

upload - Recieve an email notification when anyone uploads a recording on the recorder

client - When your user submits a recording (have the email address in a form) - they will receive an submittion email

Client Information Questions:

name - Ask for their name

email - Ask for their email address

questions - Check an API endpoint to update different types of questions.

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.

Deeper nested fields are not listed. See the example response below for the full shape.

Update a recorder questions:

questions - Speak offer different set of questions to create and ask to your clients.

Here’re the few examples with value:

1. Single Line - “single”
2. Multi Line - “multiple”
3. Checkbox* - “checkbox”
4. Radio Button* - “radiobutton”
5. Dropdown* - “dropdownlist”
6. Date - “date”
7. Date & Time - “datetime”

Checkbox, Radio Button, Dropdown offers “Include Others” option.

Checkbox Sample:

{
"question":"My Checkbox question",
"isRequired":true,
"answerType":"checkbox",
"options":["Option A","Option B"],
"includeOther":false
}

Dropdown Sample with Include Other:

{
  "question": "My Dropdown Question with Include Others",
  "isRequired": true,
  "answerType": "dropdownlist",
  "options": [
    "Value 1",
    "Value 2"
  ],
  "includeOther": true
}

Parameters

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.

Get Recording meta details such as:

• Name
• Email
• Other asked questions

Parameters

Update a recorder details.

name - Name of the recorder

All the other fields are optional. Your recorder will be updated automatically.

Duration of the recorder:

• minDuration - 15 seconds (min) & 5 min (max)
  • Pass the duration in seconds
• maxDuration - 10 seconds (min) & 3 hours (max)
  • Pass the duration in seconds

Source Language:

• You can pass the sourceLanguage as a code.
• Other language codes available at the top of the page.

Recorder options:

• We allow to support creating recorder with the multiple options such as:
  • audio - Audio recorder
  • video - Video recorder
  • screeShare - Allow to screen share on browser (Mobile not supported)
  • uploadFile - Allow to upload various file formats
    • allowMultiple - Supporting multiple file uploads

Notifications:

upload - Recieve an email notification when anyone uploads a recording on the recorder

client - When your user submits a recording (have the email address in a form) - they will receive an submittion email

Parameters

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.

Deeper nested fields are not listed. See the example response below for the full shape.

Reveals whether recorder is publically open or password-protected

Parameters

API Endpoint: Get Recorder URL

Method: GET
Endpoint: https://api.speakai.co/v1/recorder/url/{recorderId}

Description

This endpoint retrieves the URL associated with a specific recorder identified by recorderId. It is used to obtain the necessary information to access the recorder’s iframe and page details.

Parameters

• recorderId (path parameter): The unique identifier for the recorder whose URL is being requested.

Response Format

The response will be in JSON format and includes the following fields:

• status: A string indicating the status of the request.

• data: An object containing:

  • iframe: A string representing the iframe URL for the recorder.

  • page: A string representing the page URL for the recorder.

Example Response

{
  "status": "",
  "data": {
    "iframe": "",
    "page": ""
  }
}

Parameters

User to grant\prohobit access to a password-protected recorder

Request body

Field types and names come from the request body the spec records. The spec does not mark request body fields as required, so read this as the shape the endpoint accepts rather than a required field list.