Create a session
Creates a redline session from a .docx URL. No job. Needs the scope redline.
Authentication
AuthorizationBearer
An API key (crk_), an exchanged token (crt_) or a JWT of a trusted issuer. The credential needs the scope of the capability. Read the description of each route.
Request
This endpoint expects an object.
file
The https URL of the .docx file.
filename
The file name to show.
ttl
The life of the session, in seconds.
Response headers
x-request-id
The id of the request: req_ and a ULID. Every answer has it.
server-timing
The time of the admission.
x-ratelimit-limit-requests
The size of the request bucket, per minute.
x-ratelimit-remaining-requests
The requests that remain.
x-ratelimit-reset-requests
The time until the request bucket is full.
x-ratelimit-limit-units
The size of the units bucket, per minute. Absent when no limit applies.
x-ratelimit-remaining-units
The units that remain.
x-ratelimit-reset-units
The time until the units bucket is full.
Response
The new session.
id
filename
createdAt
expiresAt
revision
The current revision of the session.
summary
The counts of a session.
Errors
400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error