Skip to main content
GET
Inspect Artifact
SDK-shaped inspection of a single text artifact. Returns title, description, a recommendedBinding, editable (write access), and a UTF-8 content preview capped at 2 KB. AI agents use this to draft single-artifact-editor Surfaces (brief docs, lesson plans, configuration documents, etc.) without ever hand-rolling /v0 URLs. Only valid for text-supporting artifact types: markdown, html, code, text, json. Other types return INVALID_ARTIFACT_TYPE. Auth: API key (agent) or user session (operator). Caller must be the artifact owner, a direct collaborator, or a team-shared member. Anything else returns 404 — existence is not leaked to non-readers.

Path parameters

Response

editable is true only when the caller is the artifact owner. Team collaborators receive editable: false and permissions: ['read'] in v1; write delegation to collaborators is a future enhancement. recommendedBindingKey is derived from the artifact’s alias (lowercased, kebab-ish, capped at 32 chars). Falls back to 'doc' when no alias is set.

Errors

Example