Ensure Document Preview

Dostęp

Członek organizacji z tym uprawnieniem:

documents:read

Klucz API z zakresami potrzebuje też tego uprawnienia w swoich zakresach.

POST

/orgs/{organizationId}/documents/{documentId}/preview

POST

/orgs/{organizationId}/documents/{documentId}/preview

Returns how to show the document in a browser (image or PDF rendition). Starts PDF generation when a rendition is missing; poll while the status is generating.

Authorization

ApiKeyAuth

headerx-api-key<token>

API key for authentication

Path Parameters

organizationId*string

The ID or slug of the organization

documentId*string

Length1 <= length

Response Body

application/json

response

status*string

Value in"ready""generating""unsupported"

kind*|null

url*|

Signed URL of the browser-renderable rendition

createdAt*string

Formatdate-time

createdByName*string|null

Example Request

curl -X POST 'https://api.tillor.eu/orgs//documents/string/preview'

Example Request

curl -X POST 'https://api.tillor.eu/orgs//documents/string/preview'

Example ResponseSchema

{
  "status": "ready",
  "kind": "pdf",
  "url": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "createdByName": "string"
}

{  "status": "ready",  "kind": "pdf",  "url": "string",  "createdAt": "2019-08-24T14:15:22Z",  "createdByName": "string"}

Ensure Document Preview

AuthorizationKopiuj link do tej sekcji

Path ParametersKopiuj link do tej sekcji

Response BodyKopiuj link do tej sekcji

Authorization

Path Parameters

Response Body