Retrieve Model

Retrieve Model returns the details of one model, identified by Model Name.

It calls GET https://api.openai.com/v1/models/{model}, where {model} is the Model Name you supply.

The activity has four tabs: Configuration, Headers, Input, and Output.

Configuration

Field	Required	Description
Name	Optional	Name of the step, should be unique within this workflow.
Description	Optional	Describe the purpose or function of this step.
Model Name	Required	The name of the model to be used in the request.

Model Name accepts a mapped value as well as a literal one.

Headers

Field	Required	Description
Headers	Optional	HTTP headers sent with the request.

Supply the OpenAI API key here as an Authorization header.

Input

These activities are built on the REST Client, so the Input tab is the generic HTTP request rather than an OpenAI-shaped payload. The endpoint is already set, so most fields can be left alone.

Field	Required	Data Type	Description
Target	Required	Object	The HTTP request.

Notable fields within it:

Field	Data Type	Description
headers	Object	Standard HTTP headers to include in the request. Content-Type is required and defaults to application/json.
additionalHeaders	Array	Custom request headers, each a header and value pair.
timeout	Integer	Maximum time in milliseconds to wait for a response. Defaults to 15000.

The API key goes in the Authorization header.

Output

The activity returns an httpResponse object.

Field	Data Type	Description
status.code	Integer	Numeric HTTP status code.
status.message	String	Short message associated with the HTTP status.
status.messageType	String	Category or type of status message.
headers	Object	HTTP response headers.
additionalHeaders	Array	Custom response headers returned by the server.
body	Object	Parsed body of the HTTP response — this is where the OpenAI payload appears.