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
Required string length: 1 - 255
description
object

TipTap JSON document. May contain agentPrompt blocks ({type: agentPrompt, attrs: {agentId, agentName, agentVersionId?, versionNumber?, lineStart?, lineEnd?, excerpt}}); excerpt must be verbatim from that agent version's system prompt, else 400.

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
Required range: 0 <= x <= 2147483647
conversationIds
string<uuid>[]

Optional conversation UUIDs to attach to the new finding on creation. Each must be a conversation of your organization (otherwise 400 conversation_not_found, with the offending ids in unknownConversationIds). They are linked even without an analyzed window; the window adds the volume snapshot.

Maximum array length: 1000
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. On a plan without Findings the body also carries a warning string; if the body held fields this endpoint ignores, it carries a warnings array naming them.

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. May contain agentPrompt blocks ({type: agentPrompt, attrs: {agentId, agentName, agentVersionId?, versionNumber?, lineStart?, lineEnd?, excerpt}}); excerpt must be verbatim from that agent version's system prompt, else 400.

findingType
integer | null
assigneeUserId
string<uuid> | null
warning
string
warnings
string[]