Responses API

In the Ultra Transcenders books

AI-901AI-103

Each book explains Responses API in context, with comparison tables and the common traps.

Terms in this definition

• API

  Short for application programming interface: a contract that client code calls programmatically, for example a web API secured with tokens or the Files, Images or Responses APIs.

• Azure OpenAI

  Use of OpenAI models in Azure, including GPT, o-series, embeddings, image and Whisper, through either a Foundry resource or an Azure OpenAI resource. Content Understanding isn't available from a standalone Azure OpenAI resource.

• Agents (classic) API

  First-generation Foundry Agent Service API, based on threads, messages and runs. It is deprecated, replaced by conversations and responses, and retires on 31 March 2027.

Related terms

• Chat Completions API

  Azure OpenAI interface built around a messages array of roles, plus response_format and tools that nest a function object; it remains supported, though the Responses API is advised for new applications.

• input_image

  The Responses API content item representing an image. Its image_url holds a base64 data URI or public URL, or a file_id can point to a Files API upload, and detail may be set optionally.

• input_text

  The Responses API content item that holds the prompt text in its text field. A single user message can combine it with input_image items.

• output_text

  Shortcut property on a Responses API result containing the text the model generated.

• Response compaction

  Operation in the Responses API that condenses the context of a lengthy conversation into compaction items, leaving room in the context window for further turns.