Send a feedback ticket

Send a feedback ticket (a bug, an idea or a question) from the CLI or Studio. Any credential (API key, CLI login, session) or none: an anonymous sender may leave an email. Credentials in the text are redacted before it is stored. At most 10 tickets per account, or 5 per address without a credential, per hour

POST /api/v1/feedback

Send a feedback ticket

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "email": "<string>",
  "client": {
    "cliVersion": "<string>",
    "commit": "<string>",
    "os": "<string>",
    "arch": "<string>",
    "runtimeVersion": "<string>",
    "gpu": "<string>",
    "agent": "<string>"
  },
  "page": "<string>"
}
'

200

{
  "id": "<string>",
  "status": "open",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Body

application/json

kind · enum<string> · required

Available options: bug, idea, question

message · string · required

Required string length: 1 - 4000

source · enum<string> · required

Available options: cli, studio

email · string

Maximum string length: 254

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$

client · object

Show child attributes

lastError · object

Show child attributes

doctor · object

Show child attributes

page · string

Maximum string length: 512

Response

200

application/json

The stored ticket.

id · string · required

Minimum string length: 1

status · enum<string> · required

Available options: open, closed

createdAt · string<date-time> · required