OpenAI Responses Protocol

curl https://api.poixe.com/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $POIXE_API_KEY" \
  -d '{
    "model": "gpt-5.2",
    "input": "Hello!",
    "stream": false
  }'

{
  "id": "resp_01065d515056e8610069611480ba7081959130e6295400c885",
  "object": "response",
  "created_at": 1767969920,
  "status": "completed",
  "background": false,
  "billing": {
    "payer": "developer"
  },
  "completed_at": 1767969921,
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "max_tool_calls": null,
  "model": "gpt-5.2-2025-12-11",
  "output": [
    {
      "id": "msg_01065d515056e8610069611480f34c81959cf2664fe1bec6ee",
      "type": "message",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "annotations": [],
          "logprobs": [],
          "text": "Hello! What would you like to work on today?"
        }
      ],
      "role": "assistant"
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "prompt_cache_key": null,
  "prompt_cache_retention": null,
  "reasoning": {
    "effort": "none",
    "summary": null
  },
  "safety_identifier": null,
  "service_tier": "default",
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "tool_choice": "auto",
  "tools": [],
  "top_logprobs": 0,
  "top_p": 0.98,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 8,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 15,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 23
  },
  "user": null,
  "metadata": {}
}

event: response.created
data: {"type":"response.created","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"in_progress","background":false,"completed_at":null,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":null,"user":null,"metadata":{}},"sequence_number":0}

event: response.in_progress
data: {"type":"response.in_progress","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"in_progress","background":false,"completed_at":null,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":null,"user":null,"metadata":{}},"sequence_number":1}

event: response.output_item.added
data: {"type":"response.output_item.added","item":{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"in_progress","content":[],"role":"assistant"},"output_index":0,"sequence_number":2}

event: response.content_part.added
data: {"type":"response.content_part.added","content_index":0,"item_id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","output_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":""},"sequence_number":3}

....

event: response.content_part.done
data: {"type":"response.content_part.done","content_index":0,"item_id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","output_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"},"sequence_number":14}

event: response.output_item.done
data: {"type":"response.output_item.done","item":{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"}],"role":"assistant"},"output_index":0,"sequence_number":15}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"completed","background":false,"completed_at":1767970095,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"}],"role":"assistant"}],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"default","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":{"input_tokens":8,"input_tokens_details":{"cached_tokens":0},"output_tokens":13,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":21},"user":null,"metadata":{}},"sequence_number":16}

curl https://api.poixe.com/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $POIXE_API_KEY" \
  -d '{
    "model": "gpt-5.2",
    "input": "Hello!",
    "stream": false
  }'

{
  "id": "resp_01065d515056e8610069611480ba7081959130e6295400c885",
  "object": "response",
  "created_at": 1767969920,
  "status": "completed",
  "background": false,
  "billing": {
    "payer": "developer"
  },
  "completed_at": 1767969921,
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "max_tool_calls": null,
  "model": "gpt-5.2-2025-12-11",
  "output": [
    {
      "id": "msg_01065d515056e8610069611480f34c81959cf2664fe1bec6ee",
      "type": "message",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "annotations": [],
          "logprobs": [],
          "text": "Hello! What would you like to work on today?"
        }
      ],
      "role": "assistant"
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "prompt_cache_key": null,
  "prompt_cache_retention": null,
  "reasoning": {
    "effort": "none",
    "summary": null
  },
  "safety_identifier": null,
  "service_tier": "default",
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "tool_choice": "auto",
  "tools": [],
  "top_logprobs": 0,
  "top_p": 0.98,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 8,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 15,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 23
  },
  "user": null,
  "metadata": {}
}

event: response.created
data: {"type":"response.created","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"in_progress","background":false,"completed_at":null,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":null,"user":null,"metadata":{}},"sequence_number":0}

event: response.in_progress
data: {"type":"response.in_progress","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"in_progress","background":false,"completed_at":null,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":null,"user":null,"metadata":{}},"sequence_number":1}

event: response.output_item.added
data: {"type":"response.output_item.added","item":{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"in_progress","content":[],"role":"assistant"},"output_index":0,"sequence_number":2}

event: response.content_part.added
data: {"type":"response.content_part.added","content_index":0,"item_id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","output_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":""},"sequence_number":3}

....

event: response.content_part.done
data: {"type":"response.content_part.done","content_index":0,"item_id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","output_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"},"sequence_number":14}

event: response.output_item.done
data: {"type":"response.output_item.done","item":{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"}],"role":"assistant"},"output_index":0,"sequence_number":15}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"completed","background":false,"completed_at":1767970095,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"}],"role":"assistant"}],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"default","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":{"input_tokens":8,"input_tokens_details":{"cached_tokens":0},"output_tokens":13,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":21},"user":null,"metadata":{}},"sequence_number":16}

curl https://api.poixe.com/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $POIXE_API_KEY" \
  -d '{
    "model": "gpt-5.2",
    "input": "Hello!",
    "stream": false
  }'

{
  "id": "resp_01065d515056e8610069611480ba7081959130e6295400c885",
  "object": "response",
  "created_at": 1767969920,
  "status": "completed",
  "background": false,
  "billing": {
    "payer": "developer"
  },
  "completed_at": 1767969921,
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "max_tool_calls": null,
  "model": "gpt-5.2-2025-12-11",
  "output": [
    {
      "id": "msg_01065d515056e8610069611480f34c81959cf2664fe1bec6ee",
      "type": "message",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "annotations": [],
          "logprobs": [],
          "text": "Hello! What would you like to work on today?"
        }
      ],
      "role": "assistant"
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "prompt_cache_key": null,
  "prompt_cache_retention": null,
  "reasoning": {
    "effort": "none",
    "summary": null
  },
  "safety_identifier": null,
  "service_tier": "default",
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "tool_choice": "auto",
  "tools": [],
  "top_logprobs": 0,
  "top_p": 0.98,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 8,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 15,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 23
  },
  "user": null,
  "metadata": {}
}

event: response.created
data: {"type":"response.created","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"in_progress","background":false,"completed_at":null,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":null,"user":null,"metadata":{}},"sequence_number":0}

event: response.in_progress
data: {"type":"response.in_progress","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"in_progress","background":false,"completed_at":null,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":null,"user":null,"metadata":{}},"sequence_number":1}

event: response.output_item.added
data: {"type":"response.output_item.added","item":{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"in_progress","content":[],"role":"assistant"},"output_index":0,"sequence_number":2}

event: response.content_part.added
data: {"type":"response.content_part.added","content_index":0,"item_id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","output_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":""},"sequence_number":3}

....

event: response.content_part.done
data: {"type":"response.content_part.done","content_index":0,"item_id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","output_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"},"sequence_number":14}

event: response.output_item.done
data: {"type":"response.output_item.done","item":{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"}],"role":"assistant"},"output_index":0,"sequence_number":15}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_042a77d2d41ab60d006961152e573081978cc8166893aead51","object":"response","created_at":1767970094,"status":"completed","background":false,"completed_at":1767970095,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"max_tool_calls":null,"model":"gpt-5.2-2025-12-11","output":[{"id":"msg_042a77d2d41ab60d006961152ece9c8197a754345e48eb2386","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"Hello! How can I help you today?"}],"role":"assistant"}],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"prompt_cache_retention":null,"reasoning":{"effort":"none","summary":null},"safety_identifier":null,"service_tier":"default","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":0.98,"truncation":"disabled","usage":{"input_tokens":8,"input_tokens_details":{"cached_tokens":0},"output_tokens":13,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":21},"user":null,"metadata":{}},"sequence_number":16}

POST https://api.poixe.com/v1/responses

This is OpenAI’s next-generation unified response protocol (recommended as the first choice), designed to replace the traditional Chat Completions protocol. It is better suited to the capabilities of newer models, such as stronger tool calling, more consistent multimodal input and output, and better structured output.

Authentication and request headers

Every API request must include your API key in the HTTP headers.

string

required

Bearer token. The format is Bearer YOUR_API_KEY.

string

required

Must be set to application/json.

Request parameters

The following are the core parameters most commonly used when building a Responses request (covering 80% of use cases).

string

required

The name of the model to use. For example: gpt-4.1, gpt-4.1-mini.

string | array

required

The input content. Most commonly a plain text string; structured input is also supported (for example, an array containing multiple content parts, images, and so on).

string

Optional: system-level instructions (similar to the system message in Chat Completions), used to constrain style and rules.

boolean

default:"false"

Whether to stream the output. When enabled, the server pushes incremental content in real time via SSE (Server-Sent Events).

number

default:"1"

Sampling temperature (0 to 2). Lower values are more stable; higher values are more divergent.

number

default:"1"

Nucleus sampling. In general, adjust either this or temperature, not both.

integer

The maximum number of output tokens (used to control length and cost).

object[]

The list of tools (function calling / built-in tools).

Show tools[] fields

string

required

Commonly: function (custom function tool)

object

Provide the function definition (JSON Schema) when type=function.

Show function fields

string

required

Function name

string

Function description

object

Parameter schema

string | object

Tool-calling strategy: none / auto / required, or force a specific tool.

object

Output format control (for structured output / strict JSON).

Show response_format fields

string

required

Commonly: text / json_object / json_schema

object

When type=json_schema, you can provide a JSON Schema to constrain the output structure.

map

Optional: custom metadata (for tagging and retrieval).

Response structure

The endpoint returns a Response object containing the generated result, status, and token usage.

string

The unique identifier of this request.

string

The object type, usually response.

integer

Creation time (Unix timestamp in seconds).

string

The name of the model that actually processed the request.

string

The request status. Common values: completed (finished) / in_progress (processing) / failed (failed).

object[]

The list of output items. Usually contains model messages and (optionally) tool call results.

Show output[] common shapes

string

Common values: message (model message) or tool-related items (such as tool call / tool result).

string

Usually assistant when the item is a message.

array

An array of content blocks. The most common content block is text (for example, output_text).

object

Token usage statistics (if returned).

Show usage fields

integer

Input tokens consumed

integer

Output tokens consumed

integer

Total tokens consumed

Official docs: Create a model response

View OpenAI’s official parameter descriptions and examples.

API Reference

Text APIs

System APIs

OpenAI Responses Protocol

Authentication and request headers

Request parameters

Response structure

Official docs: Create a model response

​Authentication and request headers

​Request parameters

​Response structure

Official docs: Create a model response

Authentication and request headers

Request parameters

Response structure