staqlydocs
REST APIAPI referenceAuth

Report a problem or suggest a feature

Report a problem or suggest a feature

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/feedback

Signed-in people (any workspace role) and local installs only; API keys are refused. Up to 5 reports per person per hour. Only the page path is kept; query and fragment are stripped. Screenshots use private storage and are readable only through the platform admin API.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Request Body

multipart/form-data
  1. body
kind*string
Value in"problem""feature"
description*string
Length1 <= length <= 5000
page_path*string
Lengthlength <= 2048
screenshot?array<>

Optional PNG, JPEG or WebP images, up to 10 files, 5 MB and 20 megapixels each. Repeat the screenshot field for each file.

Itemsitems <= 10

Response Body

Feedback saved

application/json
  1. response
id*string
Example Request
curl -X POST 'https://staqly.example.com/v1/feedback' \  -F 'kind=problem' \  -F 'description=string' \  -F 'page_path=string'
Example Response
{  "id": "string"}