Skip to main content
Some tool results reference an artifact by artifact_id (for example, a persisted chart spec or an exported document). This endpoint returns the artifact’s status and, once ready, its metadata. Fetch the bytes with Get Artifact Payload.
Artifacts are member-scoped through the chat they hang off — an artifact from another member’s chat returns 404. This is the structured-output companion to the chat stream; see Structured Output.
table_export and its filename, row_count, and truncated metadata are implemented for a forthcoming API deployment. They are not available on the currently deployed API revision.
string
required
Bearer token obtained from the authenticate endpoint.
string
required
The artifact id, as surfaced on a tool_result frame.

Response

string
required
The artifact id.
string
required
The kind of artifact, such as chart_spec, plot_html, plotly_figure, or chat_export. table_export is added by a forthcoming API deployment.
string
required
The MIME type of the payload.
string
required
One of pending, ready, or failed. A row stuck pending past the staleness window reports failed.
string | null
required
Suggested filename for the payload. chart_spec artifacts currently return null; choose a local fallback such as chart.json when saving the payload.
string
Failure detail, present only when status is failed.
string
Chat-export mode, present once an export has been written.
string
Chat-export format, present once an export has been written.
string
The rendered markdown for a chat-export artifact, present once written.
integer
Rows written for a ready table_export. null for other artifact types and while the export is pending. This additive field is in a forthcoming API deployment and is not on the currently deployed API revision.
boolean
For a ready table_export, whether the export reached its separate 250,000-row ceiling. null for other artifact types and while pending. This additive field is in a forthcoming API deployment and is not on the currently deployed API revision.