Skip to main content
POST
Create a finding

Authorizations

Authorization
string
header
required

Send Authorization: Bearer YOUR_API_KEY. The key resolves to a single organization.

Body

application/json
title
string
required
Minimum string length: 1
description
object

TipTap JSON document.

status
enum<string>
default:open
Available options:
open,
acknowledged,
resolved,
ignored
priority
enum<string>
default:none
Available options:
none,
low,
medium,
high,
urgent
tags
string[]
findingType
integer | null
conversationIds
string<uuid>[]

Optional conversation UUIDs to attach to the new finding on creation.

analyzedFromDate
string<date-time>

Optional start of the analyzed time range this finding summarizes.

analyzedToDate
string<date-time>

Optional end of the analyzed time range this finding summarizes.

Response

Created finding.

id
string<uuid>
required
title
string
required
status
enum<string>
required
Available options:
open,
acknowledged,
resolved,
ignored
priority
enum<string>
required
Available options:
none,
low,
medium,
high,
urgent
tags
string[]
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
object

TipTap JSON document.

findingType
integer | null
assigneeUserId
string<uuid> | null