Recorder info
API Endpoint: Get Recorder Details
Method: GET Endpoint: {{url}}/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.
Request
- Base URL: https://api.speakai.co/v1
- URL: https://api.speakai.co/v1/recorder/{recorderId}
- Auth: API key in header x-speakai-key and API key in header x-access-token
Path parameters
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.