> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.mixlayer.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mixlayer.com/_mcp/server.

# Open a Responses WebSocket

GET https://models.mixlayer.ai/v1/responses

Upgrades to a WebSocket for multi-turn Responses API generation. Send UTF-8 JSON `response.create` messages and receive `ResponseStreamEvent` messages. The `stream` field is accepted but WebSocket turns always emit events. The `background` field must not be sent. Ping frames receive pong frames. Authenticate with a Bearer API key or console user session. Clients that cannot set the `Authorization` header may send the legacy `modelsocket-api-key.<API_KEY>` authentication value in `Sec-WebSocket-Protocol`.

Reference: https://docs.mixlayer.com/api-reference/inference-ap-is/responses/responses-websocket

## Authentication

- `Authorization` header (bearer token, required) — Mixlayer API key or console user session supplied as a Bearer token.
- `Sec-WebSocket-Protocol` header (required) — WebSocket clients that cannot set the `Authorization` header may send the legacy `modelsocket-api-key.<API_KEY>` authentication value in `Sec-WebSocket-Protocol`. This value carries credentials.

## Errors

### 400 Bad Request Error

Invalid WebSocket upgrade

- `error` (OpenAIErrorDetails, required)

### 401 Unauthorized Error

Missing or invalid API key

- `error` (OpenAIErrorDetails, required)

### 403 Forbidden Error

The API key lacks inference permission

- `error` (OpenAIErrorDetails, required)

## Types

### OpenAIErrorDetails

- `message` (string, required)
- `type` (string, required)
- `code` (string, optional, nullable)

## Examples

**SDK Code**

```python
import requests

url = "https://models.mixlayer.ai/v1/responses"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://models.mixlayer.ai/v1/responses';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://models.mixlayer.ai/v1/responses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://models.mixlayer.ai/v1/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://models.mixlayer.ai/v1/responses")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://models.mixlayer.ai/v1/responses', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```