Skip to main content
GET

Authorizations

Authorization
string
header
required

Factrove API key, usually prefixed ftrv_. Send Authorization: Bearer <key>. Product routes do not accept x-api-key as a credential. A present Authorization header that is not a valid key does not fall back to the session cookie.

Path Parameters

id
string<uuid>
required

Artifact UUID.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

format
enum<string>

html or markdown. Omitted means html.

Available options:
html,
markdown
access
string

Viewer content grant. HTML only, at most five minutes, ignored when a credential header is present. A valid grant returns 200 with no cookie or bearer key.

Minimum string length: 1

Response

HTML (text/html) or Markdown (text/markdown) bytes with charset=utf-8.

The response is of type string.