Record an issue report

POST

/v1/yac/issue_report

curl --request POST \
  --url https://example.com/v1/yac/issue_report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "contact": "example", "source": "menu", "session": {} }'

Record a user’s issue report, with their session export, in LangFuse.

Filed under the conversation’s LangFuse session, next to the traces of the turns being reported. Needs LangFuse: without it there is nowhere to put a report, so the endpoint says so instead of accepting and dropping it.

Authorizations

• HTTPBearer

Parameters

Header Parameters

X-Conversation-Id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

YACIssueReportRequest

object

description

required

Description

The user’s note.

string

>= 1 characters <= 5000 characters

contact

Any of:

string

string

<= 200 characters

null

null

source

required

Source

Where the report was filed from: the Session menu, an agent offer in the chat, or the crash screen.

string

Allowed values: menu chat crash

session

required

Session

The client’s session export (on the crash screen, plus an error block).

object

key

additional properties

any

Responses

200

Successful Response

Media typeapplication/json

IssueReportResponse

object

traceId

required

Any of:

string

string

null

null

Example ^generated

{
  "traceId": "example"
}

401

Missing, invalid or expired token (detail).

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}

413

too_large: the report is larger than 10 MiB.

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}

422

bad_request: the report is invalid; errors lists every bad field.

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}

503

issue_reports_unavailable: LangFuse is not configured, so reports cannot be recorded. Or: The identity provider’s keys could not be fetched (JWT_JWKS_URL).

Media typeapplication/json

ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object

error

Any of:

string

string

null

null

code

Any of:

string

string

null

null

errors

Any of:

Array<string>

Array<string>

null

null

detail

Any of:

string

string

Array<object>

Array<object>

object

key

additional properties

any

null

null

Example ^generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}