Skip to main content
POST
Create an artifact

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string
required

Human-readable title for the artifact.

Required string length: 1 - 200
output
object
required

The artifact output payload. Pick exactly one type.

sessionId
string<uuid>
required
description
string

Short description of what the artifact shows.

Required string length: 1 - 2000
category
enum<string>

Artifact category for display and filtering.

Available options:
code_walkthrough,
bug_report,
incident_report,
license_audit,
data_flow_map,
security_findings,
cost_map,
ux_variations,
architecture_map,
migration_summary,
release_checklist,
shipped_summary,
rollout_plan,
diagram,
chart,
dashboard,
timeline,
comparison,
report

Optional PR URLs related to this artifact.

Maximum array length: 20

Response

Create an artifact

createdAt
string<date-time>
required
id
string<uuid>
required
sessionId
string<uuid>
required
type
enum<string>
default:PullRequest
required
Available options:
PullRequest,
ToolCall,
Plan,
Response,
File,
Service,
Source
updatedAt
string<date-time>
required
assetId
string<uuid> | null
required
assetUrl
string<uri> | null
required
category
enum<string> | null
required
Available options:
code_walkthrough,
bug_report,
incident_report,
license_audit,
data_flow_map,
security_findings,
cost_map,
ux_variations,
architecture_map,
migration_summary,
release_checklist,
shipped_summary,
rollout_plan,
diagram,
chart,
dashboard,
timeline,
comparison,
report,
null
content
string
required
contentType
string | null
required
description
string | null
required
fileKind
enum<string>
required
Available options:
image,
video,
audio,
html,
markdown,
text,
file
fileName
string | null
required
outputType
enum<string> | null
required
Available options:
html,
markdown,
json,
csv,
asset,
null
runtime
object | null
required
servicePort
integer | null
required
Required range: 1 <= x <= 65535
serviceUrl
string<uri> | null
required
sizeBytes
integer | null
required
Required range: x >= 0
sourceUrl
string<uri> | null
required
title
string
required