Skip to main content
POST
Send Clara to a meeting

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

Path Parameters

project_id
string<uuid>
required

UUID of the project

Body

application/json
meeting_url
string
required

Google Meet, Zoom or Microsoft Teams link, as given.

title
string
Maximum string length: 300
brief
string
Maximum string length: 20000
scheduled_start
string<date-time> | null

When the meeting itself starts. Clara is scheduled to join two minutes before it, so a store can prepare a meeting ahead of time without connecting a calendar. Omitted, or already past, means join now.

language
string

ISO code of the meeting's main language, for Clara's live transcription. Omitted, the organisation's meeting_language, else the creator's preferred language, else English. 400 when unsupported.

Example:

"fr"

secondary_languages
string[] | null

Other languages the conversation may switch to. Omitted (or null), the organisation's meeting_secondary_languages when its meeting_language is the default used, else none. 400 when unsupported or more than 3.

Maximum array length: 3
entry_point
enum<string>
default:ui

Analytics only — which surface created the meeting.

Available options:
ui,
mcp
repeats_weekly
boolean
default:false

Clara joins every week at this time (a link series): the next occurrence is booked when this one is over. Requires scheduled_start. Without a calendar, moves and cancellations of the meeting are not seen.

time_zone
string

The sender's IANA time zone. With repeats_weekly, the weeks keep the meeting's local time across daylight-saving changes; omitted or invalid, whole UTC weeks.

Example:

"Europe/Paris"

Response

Meeting created and bot dispatched. similar_meeting names an earlier meeting of this store on the same link (null when none, or when it is already a series): a hint that it may be a recurring meeting worth POST .../series/.

A meeting Clara attends (or attended) as a bot.

id
string<uuid>
conversation_id
string<uuid> | null

The transcript conversation (type meeting); null until the call is over and transcribed.

open_insights
object

Active insights per kind (contradiction, question, action, takeaway).

project
string<uuid>
created_by_email
string<email> | null
source
enum<string>
Available options:
link,
calendar
platform
enum<string>
Available options:
google_meet,
zoom,
microsoft_teams
meeting_url
string
title
string
brief
string

What the meeting is about (markdown); Clara prepares from it before the call.

context_updated_at
string<date-time> | null
documents
object[]

Context documents attached to the meeting (local-documents/ route).

documents_warning
string | null
shared_with_count
integer

Other stores' meetings served by the same bot.

calendar_event_id
string<uuid> | null
language
string

ISO code of the meeting's main language. Clara's live transcription is told it and secondary_languages (open-ended detection mislabels short utterances); the post-call transcript is re-run over the whole recording without them.

Example:

"fr"

secondary_languages
string[]

Other languages the conversation may switch to; never the main one.

Maximum array length: 3
Example:
scheduled_start
string<date-time> | null
scheduled_end
string<date-time> | null
join_at
string<date-time>
status
enum<string>
Available options:
scheduled,
joining,
waiting_room,
in_call_not_recording,
recording,
ended,
processing,
ready,
failed,
cancelled
last_status_sub_code
string
error
string

User-facing note when something went wrong ("" otherwise), including why Clara left a recorded call early ("Clara was removed from the call by the host.").

transcript_translations
string[]

Languages the post-call transcript is already translated into (detail only; empty on list rows). Translate through the meeting conversation's translate/ and translations/ actions.

rejoin_mode
enum<string> | null

How Clara can be added back right now (POST .../rejoin/), or null.

Available options:
retry,
continue,
null
continues_id
string<uuid> | null

The meeting this one continues (part 1 of the same call).

continued_by_id
string<uuid> | null

This call's part 2, once Clara was added back.

part_number
integer

Which part of the call this is (1, then +1 each time Clara was added back).

is_live
boolean
participants
object[]
invited
object[]

The calendar invite's guest list; empty for a meeting sent by link.

screenshare_events
object[]
call_started_at
string<date-time> | null
call_ended_at
string<date-time> | null
transcript_ready_at
string<date-time> | null
last_segment_at
string<date-time> | null
realtime_degraded
boolean

Recording but no live transcript for too long.

recording_url
string | null

Signed inline URL of our MP4 copy, once copied. Detail only; always null in list responses.

series
object | null

A recurring meeting Clara joins every time. calendar follows the calendar's own series (every synced occurrence is booked); link repeats weekly.

can_start_series
boolean

POST .../series/ is possible: a calendar meeting whose event repeats, or a scheduled link meeting with a start time, not already in a series.

last_time
object | null

Detail only, recurring meetings: the previous occurrence with a finished recording (its summary, open actions and questions it didn't cover), which Clara reads as background.

created_at
string<date-time>
updated_at
string<date-time>
similar_meeting
object | null