Atomizations

Export an atomization

Returns one atomization rendered for the requested format. Requires the read:atomize scope; the lookup is organization-scoped, so an id from another organization returns 404 not_found.

format=json (the default) returns the usual JSON envelope — the same record as GET /atomizations/{id} minus content_id and organization_id. format=markdown and format=text return the rendered document as the raw response body (text/markdown / text/plain, both charset=utf-8) with Content-Disposition: attachment; filename="{type}-{first 8 chars of id}.md|.txt" — not the JSON envelope. Plain text is a special case for twitter_thread (numbered tweets, no Markdown); every other type is the Markdown rendering with #, * and _ stripped.

The Markdown and text renderers read type-specific fields straight out of the stored payload, so exporting an atomization whose generation has not finished (empty data) fails and returns 500 — check that status is past generating first.

get/atomizations/{id}/export

Request

  • Base URL: https://next.frase.io/api/v1
  • URL: https://next.frase.io/api/v1/atomizations/{id}/export
  • Auth: API key in header X-API-KEY

Path parameters

idstring uuid required

Atomization ID. Must be a UUID; anything else returns 400 invalid_param.

Query parameters

format'json' | 'markdown' | 'text'

Output format. Anything outside the enum returns 400 invalid_param on format.

Response

The exported atomization. Content type depends on format.

Changes

No recorded changes to this operation across all 1 revision of this API.