👨‍💻API reference

POST/bots

Body

application/json

meeting_url*string (uri)

bot_name*string

bot_imagenullable string (uri)

speech_to_textnullable all of

reserved*boolean

entry_messagenullable string

webhook_urlnullable string

automatic_leavenullable all of

deduplication_keynullable string

Response

200400404422500

Body

application/json

bot_id*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/bots', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "bot_name": "text",
      "meeting_url": "https://example.com",
      "reserved": false
    }),
});
const data = await response.json();

Response

200

{
  "bot_id": "123e4567-e89b-12d3-a456-426614174000"
}

DELETE/bots/{uuid}

Path parameters

uuid*string

Response

200400404422500

Body

application/json

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('/bots/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ok": false
}

GET/bots/meeting_data

Query parameters

Response

200400404422500

Body

application/json

id*integer (int32)

The unique identifier of the project.

name*string

The name of the project.

creator_id*integer (int32)

The creator's identifier.

editors*array of CompleteEditor (object)

A list of editors associated with the project.

created_at*all of

The creation time and date of the project.

updated_at*all of

The time and date when the project was last updated.

is_new_project*boolean

Flag to indicate whether it is a new project.

share_link*string

Random string which is in the url to share the project.

view_counter*integer (int32)

Count of views for the project.

assets*array of Asset (object)

A list of assets associated with the project.

final_zip_pathnullable string

Path to the zip file containing the final renditions (videom mp4, subtitles etc).

final_zip_status*all of

Status of the final video rendering process.

preview_status*all of

Status of the preview video rendering process.

preview_pathnullable string

Path to the preview video ( a gif of the first highlight ).

clipitems*array of Clipitem (object)

List of clip items associated with the project.

labels*array of Label (object)

Labels attached to the project.

categories*array of Category (object)

Categories the project falls under.

delete_markernullable all of

Indicate if the project has been flagged for removal.

workspace_idnullable integer (int32)

Identifies the workspace where the project resides.

new_spokenullable all of

Indicate if this project is new for a certain user

is_workspace_member*boolean

Indicates if the user fetching the project is a workspace member of the project associated workspace

template*all of

Ai meeting report of the project

summary*string

Deprecated: Summary of the project.

summary_length_written*integer (int32)

Deprecated

last_updated_bynullable integer (int32)

Identify the last user who updated the project.

creator_emailnullable string

Email address of the creator.

last_updater_emailnullable string

Email address of the last user who updated the project.

is_synced*boolean

Indicator of whether the project has been synced with an external integration.

hubspot_sync_state*all of

The state of the project's sync with Hubspot.

salesforce_sync_state*all of

The state of the project's sync with Salesforce.

original_agenda_idnullable integer (int32)

Ai template associated with this project

meeting_providernullable all of

The provider of the meeting service used for the original meeting / agenda ( zoom, teams or meet )

share_link_attendees*string

Share link specific to attendees of the project / meeting.

original_agenda_namenullable string

If the project is associated with an ai template, this stores its name

attendees*array of Attendee (object)

List of attendees on the meeting

client_namenullable string

client name on the call

user_feedbacknullable string

user feedback of the spoke

user_star_ratingnullable integer (int32)

user star rating of the spoke (between 0 and 5)

voip_caller_phone_numbernullable string

On VOIP Spokes, the caller phone number

voip_callee_phone_numbernullable string

On VOIP Spokes, the callee phone number

speaking_time*all of

Speaking time.

Request

JavaScriptCurlPython

const response = await fetch('/bots/meeting_data?bot_id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "name": "text",
  "editors": [
    {
      "editor": {
        "final_moment_path": "text",
        "final_moment_status": {}
      },
      "video": {
        "transcripts": [
          {
            "speaker": "text",
            "words": [
              {
                "text": "text",
                "start_time": 0,
                "end_time": 0
              }
            ],
            "original_words": [
              {
                "text": "text",
                "start_time": 0,
                "end_time": 0
              }
            ],
            "google_lang": "text",
            "matching": "text"
          }
        ],
        "thumbnail_path": "text",
        "soundcard_path": "text",
        "microphone_path": "text",
        "duration": 0,
        "audio_offset": 0,
        "transcription_validated": false,
        "transcription_completed": false
      }
    }
  ],
  "created_at": {},
  "updated_at": {},
  "is_new_project": false,
  "share_link": "text",
  "assets": [
    {
      "name": "text",
      "created_at": {},
      "from_app": false,
      "zip_path": "text",
      "s3_path": "text",
      "mp4_s3_path": "text",
      "uploading": false,
      "upload_error": "text",
      "is_meeting_bot": false,
      "duration": 0,
      "delete_marker": {},
      "locked": false
    }
  ],
  "final_zip_path": "text",
  "final_zip_status": {},
  "preview_status": {},
  "preview_path": "text",
  "clipitems": [
    {
      "in_time": 0,
      "out_time": 0,
      "labels": [
        {
          "name": "text",
          "color": "text",
          "multiple": false
        }
      ],
      "summary": "text",
      "share_link": "text",
      "label_share_link": "text"
    }
  ],
  "labels": [
    {
      "name": "text",
      "color": "text",
      "multiple": false
    }
  ],
  "categories": [
    {
      "name": "text",
      "color": "text",
      "private": false
    }
  ],
  "delete_marker": {},
  "new_spoke": {},
  "is_workspace_member": false,
  "template": {
    "blocks": [
      {
        "type": "header",
        "id": "text",
        "data": {
          "text": "text"
        }
      }
    ]
  },
  "summary": "text",
  "creator_email": "text",
  "last_updater_email": "text",
  "is_synced": false,
  "hubspot_sync_state": {},
  "salesforce_sync_state": {},
  "meeting_provider": {},
  "share_link_attendees": "text",
  "original_agenda_name": "text",
  "attendees": [
    {
      "name": "text"
    }
  ],
  "client_name": "text",
  "user_feedback": "text",
  "voip_caller_phone_number": "text",
  "voip_callee_phone_number": "text",
  "speaking_time": {
    "total": 0
  }
}

GET/calendars

Response

200default

Request

JavaScriptCurlPython

const response = await fetch('/calendars', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

synchronize all events of a new calendar

POST/calendars

Body

application/json

oauth_client_idnullable string

oauth_client_secretnullable string

oauth_refresh_token*string

platform*Provider (enum)

Fields with value "simple" parse as Kind::Simple. Fields with value "fancy" parse as Kind::SoFancy.

GoogleMicrosoft

calendar_ids_to_syncnullable array of string

Response

200default

Request

JavaScriptCurlPython

const response = await fetch('/calendars', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "oauth_refresh_token": "text",
      "platform": "Google"
    }),
});
const data = await response.json();

GET/calendars/{uuid}

Path parameters

uuid*string

Response

200default

Request

JavaScriptCurlPython

const response = await fetch('/calendars/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

DELETE/calendars/{uuid}

Path parameters

uuid*string

Response

200default

Request

JavaScriptCurlPython

const response = await fetch('/calendars/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

PATCH/calendars/{uuid}

Path parameters

uuid*string

Response

200default

Request

JavaScriptCurlPython

const response = await fetch('/calendars/{uuid}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

list all events of a calendar

GET/calendar_events

Query parameters

Response

200default

Body

application/json

id*integer (int32)

google_id*string

name*string

account_id*integer (int32)

meeting_url*string

start_time*SystemTime (object)

calendar_id*integer (int32)

attendees*any

record*boolean

is_organizer*boolean

end_time*SystemTime (object)

status*EventStatus (enum)

PrepareRecordingRecordingErrorNone

errornullable string

session_idnullable string

project_idnullable integer (int32)

refuse_recording_bynullable string

delete_token*string

recurring_event_idnullable string

is_recurring*boolean

agenda_idnullable integer (int32)

uuid*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/calendar_events', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "google_id": "text",
    "name": "text",
    "meeting_url": "text",
    "start_time": {},
    "record": false,
    "is_organizer": false,
    "end_time": {},
    "status": "PrepareRecording",
    "error": "text",
    "session_id": "text",
    "refuse_recording_by": "text",
    "delete_token": "text",
    "recurring_event_id": "text",
    "is_recurring": false,
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get event with uuid

GET/calendar_events/{uuid}

Path parameters

uuid*string

Response

200default

Body

application/json

id*integer (int32)

google_id*string

name*string

account_id*integer (int32)

meeting_url*string

start_time*SystemTime (object)

calendar_id*integer (int32)

attendees*any

record*boolean

is_organizer*boolean

end_time*SystemTime (object)

status*EventStatus (enum)

PrepareRecordingRecordingErrorNone

errornullable string

session_idnullable string

project_idnullable integer (int32)

refuse_recording_bynullable string

delete_token*string

recurring_event_idnullable string

is_recurring*boolean

agenda_idnullable integer (int32)

uuid*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/calendar_events/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "google_id": "text",
  "name": "text",
  "meeting_url": "text",
  "start_time": {},
  "record": false,
  "is_organizer": false,
  "end_time": {},
  "status": "PrepareRecording",
  "error": "text",
  "session_id": "text",
  "refuse_recording_by": "text",
  "delete_token": "text",
  "recurring_event_id": "text",
  "is_recurring": false,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

POST/calendar_events/{uuid}/bot

Path parameters

uuid*string

Response

200default

Body

application/json

id*integer (int32)

google_id*string

name*string

account_id*integer (int32)

meeting_url*string

start_time*SystemTime (object)

calendar_id*integer (int32)

attendees*any

record*boolean

is_organizer*boolean

end_time*SystemTime (object)

status*EventStatus (enum)

PrepareRecordingRecordingErrorNone

errornullable string

session_idnullable string

project_idnullable integer (int32)

refuse_recording_bynullable string

delete_token*string

recurring_event_idnullable string

is_recurring*boolean

agenda_idnullable integer (int32)

uuid*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/calendar_events/{uuid}/bot', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "google_id": "text",
  "name": "text",
  "meeting_url": "text",
  "start_time": {},
  "record": false,
  "is_organizer": false,
  "end_time": {},
  "status": "PrepareRecording",
  "error": "text",
  "session_id": "text",
  "refuse_recording_by": "text",
  "delete_token": "text",
  "recurring_event_id": "text",
  "is_recurring": false,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

DELETE/calendar_events/{uuid}/bot

Path parameters

uuid*string

Response

200default

Body

application/json

id*integer (int32)

google_id*string

name*string

account_id*integer (int32)

meeting_url*string

start_time*SystemTime (object)

calendar_id*integer (int32)

attendees*any

record*boolean

is_organizer*boolean

end_time*SystemTime (object)

status*EventStatus (enum)

PrepareRecordingRecordingErrorNone

errornullable string

session_idnullable string

project_idnullable integer (int32)

refuse_recording_bynullable string

delete_token*string

recurring_event_idnullable string

is_recurring*boolean

agenda_idnullable integer (int32)

uuid*string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/calendar_events/{uuid}/bot', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "google_id": "text",
  "name": "text",
  "meeting_url": "text",
  "start_time": {},
  "record": false,
  "is_organizer": false,
  "end_time": {},
  "status": "PrepareRecording",
  "error": "text",
  "session_id": "text",
  "refuse_recording_by": "text",
  "delete_token": "text",
  "recurring_event_id": "text",
  "is_recurring": false,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}