Responses - DeerAPI Documentation

POST

responses

cURL

curl https://api.deerapi.com/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DEERAPI_KEY" \
  -d '{
    "model": "gpt-5.4",
    "input": "Write a short welcome message."
  }'

{
  "id": "<string>",
  "object": "<string>",
  "created_at": 123,
  "status": "<string>",
  "background": true,
  "content_filters": null,
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "max_tool_calls": null,
  "model": "<string>",
  "output": [
    {
      "id": "<string>",
      "type": "<string>",
      "status": "<string>",
      "content": [
        {
          "type": "<string>",
          "annotations": [
            "<string>"
          ],
          "logprobs": [
            "<string>"
          ],
          "text": "<string>"
        }
      ],
      "role": "<string>",
      "phase": "<string>"
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "prompt_cache_key": null,
  "reasoning": {
    "effort": "<unknown>",
    "summary": "<unknown>"
  },
  "safety_identifier": null,
  "service_tier": "<string>",
  "store": true,
  "temperature": 123,
  "text": {
    "format": {
      "type": "<string>"
    },
    "verbosity": "<string>"
  },
  "tool_choice": "<string>",
  "tools": [
    "<string>"
  ],
  "top_logprobs": 123,
  "top_p": 123,
  "truncation": "<string>",
  "usage": {
    "input_tokens": 123,
    "input_tokens_details": {
      "cached_tokens": 123
    },
    "output_tokens": 123,
    "output_tokens_details": {
      "reasoning_tokens": 123
    },
    "total_tokens": 123
  },
  "user": "<unknown>",
  "metadata": {},
  "output_text": "<string>"
}

Overview

Use this endpoint to call the Responses workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.

Before you start

Use the DeerAPI base URL and pass your API Key in the Authorization header:

https://api.deerapi.com

Authorization: Bearer $DEERAPI_KEY

Model selection

Choose a current model ID from the live pricing page. Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.

Implementation notes

Use the OpenAPI playground for the exact request fields accepted by this endpoint.
Keep API Keys on the server side when you build production applications.
Log the request ID from failed calls so support can investigate the request.
Retry 429, 500, and 503 responses with exponential backoff.

Authorizations

Authorization

string

header

required

Use a DeerAPI API Key as a Bearer token.

Body

application/json

Use this field according to the endpoint schema.

input

default:Sample value

required

Use this field according to the endpoint schema.

model

string

default:gpt-5.4

Use this field according to the endpoint schema.

instructions

string

Use this field according to the endpoint schema.

stream

boolean

Use this field according to the endpoint schema.

background

boolean

Use this field according to the endpoint schema.

previous_response_id

string

Use this field according to the endpoint schema.

conversation

any

Use this field according to the endpoint schema.

temperature

number

Use this field according to the endpoint schema.

Required range: 0 <= x <= 2

max_output_tokens

integer

Use this field according to the endpoint schema.

top_p

number

Use this field according to the endpoint schema.

Required range: 0 <= x <= 1

reasoning

object

Use this field according to the endpoint schema.

Show child attributes

text

object

Use this field according to the endpoint schema.

Show child attributes

tools

object[]

Use this field according to the endpoint schema.

Show child attributes

tool_choice

any

Use this field according to the endpoint schema.

parallel_tool_calls

boolean

Use this field according to the endpoint schema.

include

string[]

Use this field according to the endpoint schema.

metadata

object

Use this field according to the endpoint schema.

truncation

enum<string>

Use this field according to the endpoint schema.

Available options:

auto,

disabled

store

boolean

Use this field according to the endpoint schema.

prompt_cache_key

string

Use this field according to the endpoint schema.

prompt_cache_retention

enum<string>

Use this field according to the endpoint schema.

Available options:

in-memory,

24h

max_tool_calls

integer

Use this field according to the endpoint schema.

top_logprobs

integer

Use this field according to the endpoint schema.

Required range: 0 <= x <= 20

stream_options

object

Use this field according to the endpoint schema.

Show child attributes

prompt

object

Use this field according to the endpoint schema.

Show child attributes

safety_identifier

string

Use this field according to the endpoint schema.

service_tier

enum<string>

Use this field according to the endpoint schema.

Available options:

auto,

default,

flex,

priority

user

string

deprecated

Use this field according to the endpoint schema.

Response

200 - application/json

Use this field according to the endpoint schema.

string

required

Use this field according to the endpoint schema.

object

string

required

Use this field according to the endpoint schema.

created_at

integer

required

status

string

required

background

boolean

required

content_filters

null

required

error

null

required

incomplete_details

null

required

instructions

null

required

max_output_tokens

null

required

max_tool_calls

null

required

model

string

required

Use this field according to the endpoint schema.

output

object[]

required

Use this field according to the endpoint schema.

Show child attributes

parallel_tool_calls

boolean

required

previous_response_id

null

required

prompt_cache_key

null

required

reasoning

object

required

Show child attributes

safety_identifier

null

required

service_tier

string

required

store

boolean

required

temperature

integer

required

text

object

required

Show child attributes

tool_choice

string

required

tools

string[]

required

top_logprobs

integer

required

top_p

integer

required

truncation

string

required

usage

object

required

Use this field according to the endpoint schema.

Show child attributes

user

any

required

Use this field according to the endpoint schema.

metadata

object

required

output_text

string | null

Use this field according to the endpoint schema.

Chat

Embeddings

cURL

curl https://api.deerapi.com/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $DEERAPI_KEY" \
  -d '{
    "model": "gpt-5.4",
    "input": "Write a short welcome message."
  }'

{
  "id": "<string>",
  "object": "<string>",
  "created_at": 123,
  "status": "<string>",
  "background": true,
  "content_filters": null,
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "max_tool_calls": null,
  "model": "<string>",
  "output": [
    {
      "id": "<string>",
      "type": "<string>",
      "status": "<string>",
      "content": [
        {
          "type": "<string>",
          "annotations": [
            "<string>"
          ],
          "logprobs": [
            "<string>"
          ],
          "text": "<string>"
        }
      ],
      "role": "<string>",
      "phase": "<string>"
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "prompt_cache_key": null,
  "reasoning": {
    "effort": "<unknown>",
    "summary": "<unknown>"
  },
  "safety_identifier": null,
  "service_tier": "<string>",
  "store": true,
  "temperature": 123,
  "text": {
    "format": {
      "type": "<string>"
    },
    "verbosity": "<string>"
  },
  "tool_choice": "<string>",
  "tools": [
    "<string>"
  ],
  "top_logprobs": 123,
  "top_p": 123,
  "truncation": "<string>",
  "usage": {
    "input_tokens": 123,
    "input_tokens_details": {
      "cached_tokens": 123
    },
    "output_tokens": 123,
    "output_tokens_details": {
      "reasoning_tokens": 123
    },
    "total_tokens": 123
  },
  "user": "<unknown>",
  "metadata": {},
  "output_text": "<string>"
}

​Overview

​Before you start

​Model selection

​Implementation notes

Authorizations

Body

Response

Overview

Before you start

Model selection

Implementation notes