Perplexity · Schema

ResponseFailedEvent

Response failed event (type: "response.failed"). Contains error details when streaming fails.

Properties

Name Type Description
error object
sequence_number integer Monotonically increasing sequence number for event ordering
type object
View JSON Schema on GitHub

JSON Schema

perplexity-responsefailedevent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ResponseFailedEvent",
  "title": "ResponseFailedEvent",
  "description": "Response failed event (type: \"response.failed\").\nContains error details when streaming fails.\n",
  "properties": {
    "error": {
      "$ref": "#/components/schemas/ErrorInfo"
    },
    "sequence_number": {
      "description": "Monotonically increasing sequence number for event ordering",
      "format": "int64",
      "type": "integer"
    },
    "type": {
      "$ref": "#/components/schemas/EventType"
    }
  },
  "required": [
    "type",
    "sequence_number",
    "error"
  ],
  "type": "object"
}