Hosted platformREST API reference

Support

Help: support tickets (`/support/tickets` - raise a concern, get a reference such as `OSR-00042`, follow the conversation; every answer and status change is e-mailed to the requester), product feedback (`/product-feedback` - bugs, ideas and improvements sent from the platform's pages with screenshots and browser diagnostics, reference `FB-00012`, every status change e-mailed) and the assistant.

Hosted platformAPI version 2.1.0

get/api/v1/product-feedback

List Items

The workspace's feedback, most recent activity first, with counts per status (status=open = every item not yet shipped or declined).

Requires an API key

Parameters

Name	In	Type	Default
status	query	string \| null
limit	query	integer	100
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/product-feedback?limit=100" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/product-feedback

Submit

Send feedback: a bug, an idea, an improvement, praise. diagnostics is what the browser collected on the page (bounded and scrubbed of credentials on the way in), attachments up to three screenshots as data URLs. Answers with the item and its reference; the person is e-mailed the same.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyProductFeedbackIn

Field	Type	Default
attachments	AttachmentIn[]
body(required)	string
diagnostics	object \| null
kind	string	"other"
page	string \| null
request_id	string \| null
title(required)	string
url	string \| null

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/product-feedback" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "body": "string", "title": "string" }'

Bodyjson

{
  "body": "string",
  "title": "string"
}

get/api/v1/product-feedback/{key}

Get Item

One item by id or reference (FB-00012) with its conversation (internal notes excluded), the diagnostics the browser sent and the list of screenshots.

Requires an API key

Parameters

Name	In	Type	Default	Description
key(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/product-feedback/<key>" \
  -H "Authorization: Bearer $OSR_API_KEY"

get/api/v1/product-feedback/{key}/attachments/{attachment_id}

Attachment

A screenshot of the item (the image bytes).

Requires an API key

Parameters

Name	In	Type
key(required)	path	string
attachment_id(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/product-feedback/<key>/attachments/<attachment_id>" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/product-feedback/{key}/comments

Comment

Add to the conversation (not possible once the item is shipped or declined).

Requires an API key

Parameters

Name	In	Type	Default	Description
key(required)	path	string
x-goog-api-key	header	string \| null

Request bodyCommentIn

Field	Type	Default	Description
body(required)	string

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/product-feedback/<key>/comments" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "body": "string" }'

Bodyjson

{
  "body": "string"
}

get/api/v1/support/tickets

List Tickets

The workspace's tickets, most recent activity first, with counts per status.

Requires an API key

Parameters

Name	In	Type	Default
status	query	string \| null
limit	query	integer	100
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/support/tickets?limit=100" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/support/tickets

Open Ticket

Raise a concern. Answers with the ticket and its reference; the requester is e-mailed the same.

Requires an API key

Parameters

Name	In	Type	Default	Description
x-goog-api-key	header	string \| null

Request bodyTicketIn

Field	Type	Default
body(required)	string
category	string	"question"
priority	string	"normal"
request_id	string \| null
subject(required)	string

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/support/tickets" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "body": "string", "subject": "string" }'

Bodyjson

{
  "body": "string",
  "subject": "string"
}

get/api/v1/support/tickets/{key}

Get Ticket

One ticket by id or reference (OSR-00042) with its conversation (internal notes excluded).

Requires an API key

Parameters

Name	In	Type	Default	Description
key(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/support/tickets/<key>" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/support/tickets/{key}/close

The requester considers the matter closed.

Requires an API key

Parameters

Name	In	Type	Default	Description
key(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/support/tickets/<key>/close" \
  -H "Authorization: Bearer $OSR_API_KEY"

post/api/v1/support/tickets/{key}/messages

Add to the conversation; an answered or resolved ticket goes back to open.

Requires an API key

Parameters

Name	In	Type	Default	Description
key(required)	path	string
x-goog-api-key	header	string \| null

Request bodyMessageIn

Field	Type	Default	Description
body(required)	string

Responses

201	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s -X POST "$OSR_URL/api/v1/support/tickets/<key>/messages" \
  -H "Authorization: Bearer $OSR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "body": "string" }'

Bodyjson

{
  "body": "string"
}

get/api/v1/support/tickets/{key}/stream

Stream

Live updates as server-sent events: the ticket with its conversation now, then again whenever it changes (a reply, a status change); a keep-alive comment every 15 s; ends after ten minutes (the client reconnects).

Requires an API key

Parameters

Name	In	Type	Default	Description
key(required)	path	string
x-goog-api-key	header	string \| null

Responses

200	Successful Response
422	Validation ErrorHTTPValidationError
401	Missing, invalid or revoked API key

Requestbash

curl -s "$OSR_URL/api/v1/support/tickets/<key>/stream" \
  -H "Authorization: Bearer $OSR_API_KEY"

Something wrong or out of date on this page? Tell us - the page is named for you, so a one-line note is enough.

Billing

Plan upgrades through Stripe Checkout and the webhook that confirms them.

MCP server

Model Context Protocol server for IDEs and agents (VS Code, Cursor, Claude, Windsurf): `POST /mcp` speaks JSON-RPC with tools to route, quote, recommend, explain and ask; `GET /mcp` describes it.

Support

get/api/v1/product-feedback

Parameters

Responses

post/api/v1/product-feedback

Parameters

Request bodyProductFeedbackIn

Responses

get/api/v1/product-feedback/{key}

Parameters

Responses

get/api/v1/product-feedback/{key}/attachments/{attachment_id}

Parameters

Responses

post/api/v1/product-feedback/{key}/comments

Parameters

Request bodyCommentIn

Responses

get/api/v1/support/tickets

Parameters

Responses

post/api/v1/support/tickets

Parameters

Request bodyTicketIn

Responses

get/api/v1/support/tickets/{key}

Parameters

Responses

post/api/v1/support/tickets/{key}/close

Parameters

Responses

post/api/v1/support/tickets/{key}/messages

Parameters

Request bodyMessageIn

Responses

get/api/v1/support/tickets/{key}/stream

Parameters

Responses

On this page