# Responses

## Create

**post** `/v1/responses`

Create a model response. Supports text conversations and computer-use (CUA) workflows. Set stream=true for server-sent events. Include tools with type "computer_use" for CUA mode, which returns structured computer_call actions. Use previous_response_id to chain multi-turn conversations.

### Body Parameters

- `input: optional array of object { call_id, content, output, 2 more }`

  - `call_id: optional string`

  - `content: optional array of ContentBlock`

    - `image_url: optional string`

    - `text: optional string`

    - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

      - `"input_text"`

      - `"output_text"`

      - `"summary_text"`

      - `"input_image"`

  - `output: optional ContentBlock`

    - `image_url: optional string`

    - `text: optional string`

    - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

      - `"input_text"`

      - `"output_text"`

      - `"summary_text"`

      - `"input_image"`

  - `role: optional string`

  - `type: optional "computer_call_output"`

    - `"computer_call_output"`

- `instructions: optional string`

- `max_output_tokens: optional number`

- `model: optional string`

- `previous_response_id: optional string`

- `stream: optional boolean`

- `temperature: optional number`

- `tools: optional array of object { display_height, display_width, environment, type }`

  - `display_height: optional number`

  - `display_width: optional number`

  - `environment: optional string`

  - `type: optional "computer_use"`

    - `"computer_use"`

- `top_p: optional number`

### Returns

- `ResponsesResponse = object { id, computer_id, created_at, 9 more }`

  - `id: optional string`

  - `computer_id: optional string`

  - `created_at: optional string`

  - `max_output_tokens: optional number`

  - `model: optional string`

  - `object: optional string`

  - `output: optional array of V2GoBackendInternalServiceOutputItem`

    - `id: optional string`

    - `action: optional V2GoBackendInternalServiceAction`

      - `button: optional string`

      - `end_x: optional number`

      - `end_y: optional number`

      - `keys: optional array of string`

      - `result: optional string`

      - `scroll_x: optional number`

      - `scroll_y: optional number`

      - `status: optional string`

      - `text: optional string`

      - `type: optional "click" or "double_click" or "triple_click" or 14 more`

        - `"click"`

        - `"double_click"`

        - `"triple_click"`

        - `"right_click"`

        - `"type"`

        - `"key"`

        - `"keypress"`

        - `"key_down"`

        - `"key_up"`

        - `"scroll"`

        - `"hscroll"`

        - `"navigate"`

        - `"drag"`

        - `"wait"`

        - `"terminate"`

        - `"answer"`

        - `"done"`

      - `url: optional string`

      - `x: optional number`

      - `y: optional number`

    - `call_id: optional string`

    - `content: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `role: optional string`

    - `status: optional string`

    - `summary: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `type: optional "reasoning" or "computer_call" or "computer_call_output" or "message"`

      - `"reasoning"`

      - `"computer_call"`

      - `"computer_call_output"`

      - `"message"`

  - `status: optional string`

  - `temperature: optional number`

  - `top_p: optional number`

  - `usage: optional V2GoBackendInternalServiceResponsesUsage`

    - `input_tokens: optional number`

    - `output_tokens: optional number`

    - `total_tokens: optional number`

  - `viewport: optional V2GoBackendInternalServiceViewport`

    - `environment: optional string`

    - `height: optional number`

    - `width: optional number`

### Example

```http
curl https://api.tzafon.ai/v1/responses \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $TZAFON_API_KEY" \
    -d '{}'
```

## Retrieve

**get** `/v1/responses/{id}`

Retrieve a previously created response by its ID, including all output items.

### Path Parameters

- `id: string`

### Returns

- `ResponsesResponse = object { id, computer_id, created_at, 9 more }`

  - `id: optional string`

  - `computer_id: optional string`

  - `created_at: optional string`

  - `max_output_tokens: optional number`

  - `model: optional string`

  - `object: optional string`

  - `output: optional array of V2GoBackendInternalServiceOutputItem`

    - `id: optional string`

    - `action: optional V2GoBackendInternalServiceAction`

      - `button: optional string`

      - `end_x: optional number`

      - `end_y: optional number`

      - `keys: optional array of string`

      - `result: optional string`

      - `scroll_x: optional number`

      - `scroll_y: optional number`

      - `status: optional string`

      - `text: optional string`

      - `type: optional "click" or "double_click" or "triple_click" or 14 more`

        - `"click"`

        - `"double_click"`

        - `"triple_click"`

        - `"right_click"`

        - `"type"`

        - `"key"`

        - `"keypress"`

        - `"key_down"`

        - `"key_up"`

        - `"scroll"`

        - `"hscroll"`

        - `"navigate"`

        - `"drag"`

        - `"wait"`

        - `"terminate"`

        - `"answer"`

        - `"done"`

      - `url: optional string`

      - `x: optional number`

      - `y: optional number`

    - `call_id: optional string`

    - `content: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `role: optional string`

    - `status: optional string`

    - `summary: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `type: optional "reasoning" or "computer_call" or "computer_call_output" or "message"`

      - `"reasoning"`

      - `"computer_call"`

      - `"computer_call_output"`

      - `"message"`

  - `status: optional string`

  - `temperature: optional number`

  - `top_p: optional number`

  - `usage: optional V2GoBackendInternalServiceResponsesUsage`

    - `input_tokens: optional number`

    - `output_tokens: optional number`

    - `total_tokens: optional number`

  - `viewport: optional V2GoBackendInternalServiceViewport`

    - `environment: optional string`

    - `height: optional number`

    - `width: optional number`

### Example

```http
curl https://api.tzafon.ai/v1/responses/$ID \
    -H "Authorization: Bearer $TZAFON_API_KEY"
```

## Delete

**delete** `/v1/responses/{id}`

Permanently delete a response and all its output items.

### Path Parameters

- `id: string`

### Returns

- `id: optional string`

- `deleted: optional boolean`

- `object: optional string`

### Example

```http
curl https://api.tzafon.ai/v1/responses/$ID \
    -X DELETE \
    -H "Authorization: Bearer $TZAFON_API_KEY"
```

## Cancel

**post** `/v1/responses/{id}/cancel`

Cancel an in-progress response. Only responses with status "in_progress" can be cancelled.

### Path Parameters

- `id: string`

### Returns

- `ResponsesResponse = object { id, computer_id, created_at, 9 more }`

  - `id: optional string`

  - `computer_id: optional string`

  - `created_at: optional string`

  - `max_output_tokens: optional number`

  - `model: optional string`

  - `object: optional string`

  - `output: optional array of V2GoBackendInternalServiceOutputItem`

    - `id: optional string`

    - `action: optional V2GoBackendInternalServiceAction`

      - `button: optional string`

      - `end_x: optional number`

      - `end_y: optional number`

      - `keys: optional array of string`

      - `result: optional string`

      - `scroll_x: optional number`

      - `scroll_y: optional number`

      - `status: optional string`

      - `text: optional string`

      - `type: optional "click" or "double_click" or "triple_click" or 14 more`

        - `"click"`

        - `"double_click"`

        - `"triple_click"`

        - `"right_click"`

        - `"type"`

        - `"key"`

        - `"keypress"`

        - `"key_down"`

        - `"key_up"`

        - `"scroll"`

        - `"hscroll"`

        - `"navigate"`

        - `"drag"`

        - `"wait"`

        - `"terminate"`

        - `"answer"`

        - `"done"`

      - `url: optional string`

      - `x: optional number`

      - `y: optional number`

    - `call_id: optional string`

    - `content: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `role: optional string`

    - `status: optional string`

    - `summary: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `type: optional "reasoning" or "computer_call" or "computer_call_output" or "message"`

      - `"reasoning"`

      - `"computer_call"`

      - `"computer_call_output"`

      - `"message"`

  - `status: optional string`

  - `temperature: optional number`

  - `top_p: optional number`

  - `usage: optional V2GoBackendInternalServiceResponsesUsage`

    - `input_tokens: optional number`

    - `output_tokens: optional number`

    - `total_tokens: optional number`

  - `viewport: optional V2GoBackendInternalServiceViewport`

    - `environment: optional string`

    - `height: optional number`

    - `width: optional number`

### Example

```http
curl https://api.tzafon.ai/v1/responses/$ID/cancel \
    -X POST \
    -H "Authorization: Bearer $TZAFON_API_KEY"
```

## Domain Types

### Content Block

- `ContentBlock = object { image_url, text, type }`

  - `image_url: optional string`

  - `text: optional string`

  - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

    - `"input_text"`

    - `"output_text"`

    - `"summary_text"`

    - `"input_image"`

### Responses Response

- `ResponsesResponse = object { id, computer_id, created_at, 9 more }`

  - `id: optional string`

  - `computer_id: optional string`

  - `created_at: optional string`

  - `max_output_tokens: optional number`

  - `model: optional string`

  - `object: optional string`

  - `output: optional array of V2GoBackendInternalServiceOutputItem`

    - `id: optional string`

    - `action: optional V2GoBackendInternalServiceAction`

      - `button: optional string`

      - `end_x: optional number`

      - `end_y: optional number`

      - `keys: optional array of string`

      - `result: optional string`

      - `scroll_x: optional number`

      - `scroll_y: optional number`

      - `status: optional string`

      - `text: optional string`

      - `type: optional "click" or "double_click" or "triple_click" or 14 more`

        - `"click"`

        - `"double_click"`

        - `"triple_click"`

        - `"right_click"`

        - `"type"`

        - `"key"`

        - `"keypress"`

        - `"key_down"`

        - `"key_up"`

        - `"scroll"`

        - `"hscroll"`

        - `"navigate"`

        - `"drag"`

        - `"wait"`

        - `"terminate"`

        - `"answer"`

        - `"done"`

      - `url: optional string`

      - `x: optional number`

      - `y: optional number`

    - `call_id: optional string`

    - `content: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `role: optional string`

    - `status: optional string`

    - `summary: optional array of ContentBlock`

      - `image_url: optional string`

      - `text: optional string`

      - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

        - `"input_text"`

        - `"output_text"`

        - `"summary_text"`

        - `"input_image"`

    - `type: optional "reasoning" or "computer_call" or "computer_call_output" or "message"`

      - `"reasoning"`

      - `"computer_call"`

      - `"computer_call_output"`

      - `"message"`

  - `status: optional string`

  - `temperature: optional number`

  - `top_p: optional number`

  - `usage: optional V2GoBackendInternalServiceResponsesUsage`

    - `input_tokens: optional number`

    - `output_tokens: optional number`

    - `total_tokens: optional number`

  - `viewport: optional V2GoBackendInternalServiceViewport`

    - `environment: optional string`

    - `height: optional number`

    - `width: optional number`

### V2 Go Backend Internal Service Action

- `V2GoBackendInternalServiceAction = object { button, end_x, end_y, 10 more }`

  - `button: optional string`

  - `end_x: optional number`

  - `end_y: optional number`

  - `keys: optional array of string`

  - `result: optional string`

  - `scroll_x: optional number`

  - `scroll_y: optional number`

  - `status: optional string`

  - `text: optional string`

  - `type: optional "click" or "double_click" or "triple_click" or 14 more`

    - `"click"`

    - `"double_click"`

    - `"triple_click"`

    - `"right_click"`

    - `"type"`

    - `"key"`

    - `"keypress"`

    - `"key_down"`

    - `"key_up"`

    - `"scroll"`

    - `"hscroll"`

    - `"navigate"`

    - `"drag"`

    - `"wait"`

    - `"terminate"`

    - `"answer"`

    - `"done"`

  - `url: optional string`

  - `x: optional number`

  - `y: optional number`

### V2 Go Backend Internal Service Output Item

- `V2GoBackendInternalServiceOutputItem = object { id, action, call_id, 5 more }`

  - `id: optional string`

  - `action: optional V2GoBackendInternalServiceAction`

    - `button: optional string`

    - `end_x: optional number`

    - `end_y: optional number`

    - `keys: optional array of string`

    - `result: optional string`

    - `scroll_x: optional number`

    - `scroll_y: optional number`

    - `status: optional string`

    - `text: optional string`

    - `type: optional "click" or "double_click" or "triple_click" or 14 more`

      - `"click"`

      - `"double_click"`

      - `"triple_click"`

      - `"right_click"`

      - `"type"`

      - `"key"`

      - `"keypress"`

      - `"key_down"`

      - `"key_up"`

      - `"scroll"`

      - `"hscroll"`

      - `"navigate"`

      - `"drag"`

      - `"wait"`

      - `"terminate"`

      - `"answer"`

      - `"done"`

    - `url: optional string`

    - `x: optional number`

    - `y: optional number`

  - `call_id: optional string`

  - `content: optional array of ContentBlock`

    - `image_url: optional string`

    - `text: optional string`

    - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

      - `"input_text"`

      - `"output_text"`

      - `"summary_text"`

      - `"input_image"`

  - `role: optional string`

  - `status: optional string`

  - `summary: optional array of ContentBlock`

    - `image_url: optional string`

    - `text: optional string`

    - `type: optional "input_text" or "output_text" or "summary_text" or "input_image"`

      - `"input_text"`

      - `"output_text"`

      - `"summary_text"`

      - `"input_image"`

  - `type: optional "reasoning" or "computer_call" or "computer_call_output" or "message"`

    - `"reasoning"`

    - `"computer_call"`

    - `"computer_call_output"`

    - `"message"`

### V2 Go Backend Internal Service Responses Usage

- `V2GoBackendInternalServiceResponsesUsage = object { input_tokens, output_tokens, total_tokens }`

  - `input_tokens: optional number`

  - `output_tokens: optional number`

  - `total_tokens: optional number`

### V2 Go Backend Internal Service Viewport

- `V2GoBackendInternalServiceViewport = object { environment, height, width }`

  - `environment: optional string`

  - `height: optional number`

  - `width: optional number`