Webchat2api

https://github.com/zqbxdev/webchat2api
Admin
webchat2api is a proxy service project that encapsulates the capabilities of GPT/ChatGPT Web,...
Tokens:1,721
Snippets:23
Trust Score:5.3
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Session Initiation Event Example

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Shows the structure of the initial event received to resume or start a conversation, containing a token and conversation ID.

```json
{
  "type": "resume_conversation_token",
  "kind": "topic",
  "token": "...",
  "conversation_id": "..."
}
```

--------------------------------

### Policy Rejection Text Example

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

An example of a plain text response indicating that a request was denied by policy.

```text
I can't assist with that request. If you have another type of modification...
```

--------------------------------

### Text Incremental Update Examples

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Provides examples of how text content is incrementally updated using 'append' and 'patch' operations on message parts, and how to handle status and end-turn updates.

```json
{"p":"/message/content/parts/0","o":"append","v":"Hello"}
{"v":" world"}
{"p":"","o":"patch","v":[
  {"p":"/message/content/parts/0","o":"append","v":"!"},
  {"p":"/message/status","o":"replace","v":"finished_successfully"},
  {"p":"/message/end_turn","o":"replace","v":true}
]}
```

--------------------------------

### Basic SSE Payload Examples

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Illustrates the various types of data payloads that can be received over the SSE stream, including version markers, JSON objects for events, JSON strings for patches, and raw content.

```text
"v1"
{"type":"resume_conversation_token",...}
{"p":"","o":"add","v":{...}}
{"v":{...}}
{"p":"/message/content/parts/0","o":"append","v":"..."}
{"type":"server_ste_metadata","metadata":{...}}
[DONE]
```

--------------------------------

### Title Generation Event Example

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

An example of an event used for generating a title for the conversation, often used in conjunction with other events like policy rejections.

```json
{"type":"title_generation","title":"Request Denied","conversation_id":"..."}
```

--------------------------------

### User Input Message with Image Pointer

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Illustrates an input message containing multimodal content, including an asset pointer for an uploaded image and user-provided text.

```json
{
  "type": "input_message",
  "input_message": {
    "author": {"role": "user"},
    "content": {
      "content_type": "multimodal_text",
      "parts": [
        {"asset_pointer": "sediment://file_input"},
        "编辑提示词"
      ]
    }
  },
  "conversation_id": "..."
}
```

--------------------------------

### New Message Creation Event

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Demonstrates an 'add' operation event used for creating a new message, including author, content status, and conversation ID.

```json
{
  "p": "",
  "o": "add",
  "v": {
    "message": {
      "author": {"role": "assistant"},
      "content": {"content_type": "text", "parts": ["வோம்"]},
      "status": "in_progress"
    },
    "conversation_id": "..."
  },
  "c": 3
}
```

--------------------------------

### Policy Rejection Metadata Event

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Illustrates a metadata event accompanying a policy rejection, indicating no tool was invoked and the turn's use case.

```json
{
  "type": "server_ste_metadata",
  "metadata": {
    "tool_invoked": false,
    "turn_use_case": "multimodal",
    "did_prompt_contain_image": true
  },
  "conversation_id": "..."
}
```

--------------------------------

### Image Generation Tool Success Event

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Shows the structure of a successful tool message for image generation, including asset pointers for the generated image.

```json
{
  "v": {
    "message": {
      "author": {"role": "tool"},
      "content": {
        "content_type": "multimodal_text",
        "parts": [
          {"asset_pointer": "file-service://file_result"},
          {"asset_pointer": "sediment://file_result"}
        ]
      },
      "metadata": {"async_task_type": "image_gen"}
    }
  },
  "conversation_id": "..."
}
```

--------------------------------

### Moderation Blocked Event

Source: https://github.com/zqbxdev/webchat2api/blob/main/docs/upstream-sse-conversation.md

Shows a moderation event where the request was blocked due to policy violations.

```json
{
  "type": "moderation",
  "moderation_response": {
    "blocked": true
  },
  "conversation_id": "..."
}
```
Tokens:
Raw