# Writine

> Live chat for your website and a shared inbox for your team.

- [Getting started](https://docs.writine.com/docs/getting-started/overview.md): Put live chat on your website and start answering visitors.
- [Install the widget](https://docs.writine.com/docs/getting-started/install-the-widget.md): Add the chat widget to your website with one script tag.
- [The widget](https://docs.writine.com/docs/widget/overview.md): What visitors see on your website, and how to shape it.
- [Customize the widget](https://docs.writine.com/docs/widget/appearance.md): Colours, corners and your own launcher mark.
- [The inbox](https://docs.writine.com/docs/inbox/overview.md): Where your team reads and answers conversations.
- [Tickets](https://docs.writine.com/docs/tickets/overview.md): Requests filed by visitors who would rather not wait for a reply.
- [Your workspace](https://docs.writine.com/docs/workspace/overview.md): Members, roles, websites and business hours.
- [Members and roles](https://docs.writine.com/docs/workspace/members-and-roles.md): Who can do what in a workspace.
- [Billing](https://docs.writine.com/docs/billing/overview.md): Plans, seats, invoices and payment details.
- [Plans and pricing](https://docs.writine.com/docs/billing/plans.md): What each plan includes and how billing works.
- [Get widget settings](https://docs.writine.com/api-reference/get-widget-settings.md): Read public widget settings from an allowed website origin. Authorization and resource ownership are evaluated on every request.
- [Get the widget icon](https://docs.writine.com/api-reference/get-the-widget-icon.md): Read the workspace icon shown in the widget header; an img element sends no Origin, so this is not origin checked. Authorization and resource ownership are evaluated on every request.
- [Start a conversation](https://docs.writine.com/api-reference/start-a-conversation.md): Start a conversation; offline capture requires an email. Authorization and resource ownership are evaluated on every request.
- [File a request](https://docs.writine.com/api-reference/file-a-request.md): File a request that expects an answer later; it reaches the same inbox as a chat and draws on the same daily allowance. No visitor token is issued, because nothing is read back over the widget session. Files are described here, not uploaded here: the reply carries one presigned destination per file.…
- [Confirm a request attachment](https://docs.writine.com/api-reference/confirm-a-request-attachment.md): Confirm that a file finished uploading to its presigned destination. The object store is asked for the size, so the declared one cannot be used to smuggle a larger file through, and a file the team can see is one that actually arrived. Authorization and resource ownership are evaluated on every requ…
- [Record a page view](https://docs.writine.com/api-reference/record-a-page-view.md): Record that a visitor is on a page; the visitor id labels a row and grants nothing. Authorization and resource ownership are evaluated on every request.
- [List messages](https://docs.writine.com/api-reference/list-messages.md): Read only this visitor's public message history. Authorization and resource ownership are evaluated on every request.
- [Send a message](https://docs.writine.com/api-reference/send-a-message.md): Persist a visitor message; notes are rejected. Authorization and resource ownership are evaluated on every request.
- [Get a member picture](https://docs.writine.com/api-reference/get-a-member-picture.md): Read the picture of a member who has replied in this conversation; the bytes are base64 because the visitor credential cannot travel on an image request. Authorization and resource ownership are evaluated on every request.
- [Replay events](https://docs.writine.com/api-reference/replay-events.md): Replay public events for the token's conversation only. Authorization and resource ownership are evaluated on every request.
- [Renew the visitor token](https://docs.writine.com/api-reference/renew-the-visitor-token.md): Rotate an unexpired visitor token for another 24 hours. Authorization and resource ownership are evaluated on every request.
- [Get typing presence](https://docs.writine.com/api-reference/get-typing-presence.md): Read or refresh this conversation's typing presence. Authorization and resource ownership are evaluated on every request.
- [Update typing presence](https://docs.writine.com/api-reference/update-typing-presence.md): Read or refresh this conversation's typing presence. Authorization and resource ownership are evaluated on every request.
- [Open the event stream](https://docs.writine.com/api-reference/open-the-event-stream.md): WebSocket upgrade; authenticate with a versioned first frame. See backend/docs/realtime.md. No bearer tokens in URLs. This is a WebSocket protocol, not a REST envelope.

## OpenAPI Specs

- [widget](/openapi/widget.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.