Create a note

POST

{team_id}

notes

Create a new note

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/notes \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Team Note",
  "transcript": "<string>",
  "transcripts": [
    {
      "content": "This is a transcript",
      "source": "author"
    }
  ],
  "user_notes": "<string>",
  "is_public": true,
  "attendees": [
    {
      "user_id": "uDsu0j19",
      "email": "[email protected]",
      "name": "John Doe"
    }
  ],
  "metadata_date": 1608742037016,
  "metadata_time": 1608742037016,
  "google_calendar_event": {
    "id": "<string>",
    "recurring_event_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "meeting_links": [
      {
        "provider": "google",
        "link": "<string>"
      }
    ],
    "attendees": [
      {
        "email": "<string>",
        "name": "<string>",
        "organizer": true
      }
    ],
    "start": 1608742037016,
    "end": 1608742037016,
    "updated": 1608742037016,
    "location": "<string>"
  }
}
'

{
  "note": {
    "id": "",
    "title": "Team Note",
    "transcript": "<string>",
    "transcripts": [
      {
        "content": "This is a transcript",
        "source": "author",
        "id": "43",
        "time_created": 1608742037016,
        "time_updated": 1608742037016
      }
    ],
    "user_notes": "<string>",
    "ai_notes": [
      {
        "id": "866a3b86-4651-482c-bb69-61921ea4548c",
        "note_template_id": "1da3b68c-3a82-495c-a6c9-e7a494281a36",
        "title": "Team Note",
        "content": "<string>",
        "time_updated": 1608742037016,
        "related_resources": [
          {
            "id": "123",
            "type": "card",
            "cosine_similarity": 0.8
          }
        ]
      }
    ],
    "user": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "[email protected]",
        "email_verified": false
      }
    },
    "user_updated": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "[email protected]",
        "email_verified": false
      }
    },
    "team_id": "tdsu0j19",
    "last_note_template_id": "<string>",
    "is_public": false,
    "public_settings": {
      "url": "https://notes.superthread.com/n/1"
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "meeting_metadata": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "links": [
        {
          "provider": "google",
          "link": "<string>"
        }
      ],
      "location": "<string>",
      "start_time": 1608742037016,
      "end_time": 1608742037016
    },
    "meeting_date": 1608742037016,
    "meeting_time": 1608742037016,
    "meeting_organizer": {
      "user_id": "uDsu0j19",
      "email": "[email protected]",
      "name": "John Doe"
    },
    "meeting_attendees": [
      {
        "user_id": "uDsu0j19",
        "email": "[email protected]",
        "name": "John Doe"
      }
    ]
  }
}

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

title

string

Example:

"Team Note"

transcript

string | null

transcripts

object[]

Show child attributes

transcripts.content

string

Example:

"This is a transcript"

transcripts.source

enum<string>

Available options:

author,

other

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

Show child attributes

attendees.user_id

string | null

Internal User ID if the email of the meeting attendee belongs to a Superthread user in the workspace.

Example:

"uDsu0j19"

attendees.email

string

Email address of the participant

Example:

"[email protected]"

attendees.name

string

The display name of the participant

Example:

"John Doe"

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

Show child attributes

google_calendar_event.id

string

Unique identifier for the event.

google_calendar_event.recurring_event_id

string

Identifier for the recurring event series.

google_calendar_event.title

string

The event's title or name (Summary in Google Calendar).

google_calendar_event.description

string

Detailed description of the event.

google_calendar_event.meeting_links

object[]

A list of meeting links with their respective providers.

Show child attributes

google_calendar_event.meeting_links.provider

enum<string>

The provider for the meeting link (e.g., google, zoom, teams, other).

Available options:

google,

zoom,

teams,

other

google_calendar_event.meeting_links.link

string

The meeting link.

google_calendar_event.attendees

object[]

List of event attendees.

Show child attributes

google_calendar_event.attendees.email

string | null

The email of the attendee.

google_calendar_event.attendees.name

string | null

The name of the attendee.

google_calendar_event.attendees.organizer

boolean | null

Set to true when the attendee is the event organizer.

google_calendar_event.start

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

google_calendar_event.end

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

google_calendar_event.updated

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

google_calendar_event.location

string

Free-form text for the event location.

Response

note created

note

object

Show child attributes

note.id

string

Example:

""

note.title

string

Example:

"Team Note"

note.transcript

string

note.transcripts

object[]

Show child attributes

note.transcripts.content

string

Example:

"This is a transcript"

note.transcripts.source

enum<string>

Available options:

author,

other

note.transcripts.id

string

Example:

"43"

note.transcripts.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

note.transcripts.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

note.user_notes

string

Maximum string length: 102400

note.ai_notes

object[]

Show child attributes

note.ai_notes.id

string

Example:

"866a3b86-4651-482c-bb69-61921ea4548c"

note.ai_notes.note_template_id

string

Example:

"1da3b68c-3a82-495c-a6c9-e7a494281a36"

note.ai_notes.title

string

Example:

"Team Note"

note.ai_notes.content

string

Maximum string length: 102400

note.ai_notes.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

Show child attributes

Example:

"123"

Available options:

card

Example:

"card"

cosine similarity score

Example:

0.8

note.user

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

note.user.user_id

string

Example:

"uDsu0j19"

note.user.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

note.user.source

ActorSource · object

describes the source of an actor

Show child attributes

note.user.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

note.user.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

note.user.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

note.user.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

note.user.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

note.user.source.email_verified

boolean

whether the email sender was verified

Example:

false

note.user_updated

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

note.user_updated.user_id

string

Example:

"uDsu0j19"

note.user_updated.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

note.user_updated.source

ActorSource · object

describes the source of an actor

Show child attributes

note.user_updated.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

note.user_updated.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

note.user_updated.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

note.user_updated.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

note.user_updated.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

note.user_updated.source.email_verified

boolean

whether the email sender was verified

Example:

false

note.team_id

string

Example:

"tdsu0j19"

note.last_note_template_id

string

ID of the last note template used for this note

note.is_public

boolean

Example:

false

note.public_settings

object

Show child attributes

note.public_settings.url

string

Example:

"https://notes.superthread.com/n/1"

note.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

note.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

note.meeting_metadata

object

Show child attributes

note.meeting_metadata.id

string

External ID for the event

note.meeting_metadata.name

string

Meeting name or event title

note.meeting_metadata.description

string

Meeting description, or event summary

note.meeting_metadata.links

object[]

List of meeting links (with a provider) where users can join the event

Show child attributes

note.meeting_metadata.links.provider

enum<string>

The provider for the meeting link (e.g., google, zoom, teams, other).

Available options:

google,

zoom,

teams,

other

note.meeting_metadata.links.link

string

The meeting link.

note.meeting_metadata.location

string

Location of the event

note.meeting_metadata.start_time

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

note.meeting_metadata.end_time

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

note.meeting_date

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

note.meeting_time

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

note.meeting_organizer

object

Show child attributes

note.meeting_organizer.user_id

string | null

Internal User ID if the email of the meeting attendee belongs to a Superthread user in the workspace.

Example:

"uDsu0j19"

note.meeting_organizer.email

string

Email address of the participant

Example:

"[email protected]"

note.meeting_organizer.name

string

The display name of the participant

Example:

"John Doe"

note.meeting_attendees

(object | null)[] | null

Show child attributes

note.meeting_attendees.user_id

string | null

Internal User ID if the email of the meeting attendee belongs to a Superthread user in the workspace.

Example:

"uDsu0j19"

note.meeting_attendees.email

string

Email address of the participant

Example:

"[email protected]"

note.meeting_attendees.name

string

The display name of the participant

Example:

"John Doe"

Get a noteRetrieves a specific note within the specified workspace (`team_id`). The note is identified by the provided note_id and returned in the response.

⌘I

Create a new note

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/notes \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Team Note",
  "transcript": "<string>",
  "transcripts": [
    {
      "content": "This is a transcript",
      "source": "author"
    }
  ],
  "user_notes": "<string>",
  "is_public": true,
  "attendees": [
    {
      "user_id": "uDsu0j19",
      "email": "[email protected]",
      "name": "John Doe"
    }
  ],
  "metadata_date": 1608742037016,
  "metadata_time": 1608742037016,
  "google_calendar_event": {
    "id": "<string>",
    "recurring_event_id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "meeting_links": [
      {
        "provider": "google",
        "link": "<string>"
      }
    ],
    "attendees": [
      {
        "email": "<string>",
        "name": "<string>",
        "organizer": true
      }
    ],
    "start": 1608742037016,
    "end": 1608742037016,
    "updated": 1608742037016,
    "location": "<string>"
  }
}
'

{
  "note": {
    "id": "",
    "title": "Team Note",
    "transcript": "<string>",
    "transcripts": [
      {
        "content": "This is a transcript",
        "source": "author",
        "id": "43",
        "time_created": 1608742037016,
        "time_updated": 1608742037016
      }
    ],
    "user_notes": "<string>",
    "ai_notes": [
      {
        "id": "866a3b86-4651-482c-bb69-61921ea4548c",
        "note_template_id": "1da3b68c-3a82-495c-a6c9-e7a494281a36",
        "title": "Team Note",
        "content": "<string>",
        "time_updated": 1608742037016,
        "related_resources": [
          {
            "id": "123",
            "type": "card",
            "cosine_similarity": 0.8
          }
        ]
      }
    ],
    "user": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "[email protected]",
        "email_verified": false
      }
    },
    "user_updated": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "[email protected]",
        "email_verified": false
      }
    },
    "team_id": "tdsu0j19",
    "last_note_template_id": "<string>",
    "is_public": false,
    "public_settings": {
      "url": "https://notes.superthread.com/n/1"
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "meeting_metadata": {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "links": [
        {
          "provider": "google",
          "link": "<string>"
        }
      ],
      "location": "<string>",
      "start_time": 1608742037016,
      "end_time": 1608742037016
    },
    "meeting_date": 1608742037016,
    "meeting_time": 1608742037016,
    "meeting_organizer": {
      "user_id": "uDsu0j19",
      "email": "[email protected]",
      "name": "John Doe"
    },
    "meeting_attendees": [
      {
        "user_id": "uDsu0j19",
        "email": "[email protected]",
        "name": "John Doe"
      }
    ]
  }
}

Get started

Users

Cards

Projects

Notes

Pages

Comments

Boards

Sprints

Spaces

Search

Path Parameters

Body

Response