Skip to main content
POST
Create a new note

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string<uuid>

Optional id for the new note, so your app can open the note before the request finishes. Retrying with the same key returns the note already created instead of making another. The server generates an id when omitted. Must be a lowercase version 7 UUID; any other value, or the id of an existing or deleted note, is rejected with a 400.

Path Parameters

team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Body

application/json

Note object that needs to be created

auto_redact_pii
boolean | null

Per-note PII redaction selection. Omission or null preserves unredacted behavior for older clients and defaults to false; supported clients explicitly initialize this from the personal transcription_auto_redact_pii setting.

title
string
Example:

"Team Note"

transcript
string | null
transcripts
object[]
user_notes
string | null
Maximum string length: 102400
is_public
boolean | null
attendees
(object | null)[]

List of initial attendees to add. Assumes all fields of MeetingParticipant are set (Meaning all participants are Superthread members).

Maximum array length: 100
metadata_date
integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

metadata_time
integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

google_calendar_event
object
microsoft_calendar_event
object

Normalized meeting data for Notes. IDs must be stable across Microsoft sync and updates; consumers qualify them by provider, account and calendar. Note create/update must re-fetch the selected event through this user's installation and persist only the server-verified event, not caller-supplied meeting contents.

Response

The note was already created with this Idempotency-Key and is returned.

note
object