Skip to main content

List Models

List Models returns every model the OpenAI account can use.

It calls GET https://api.openai.com/v1/models. There is nothing to identify, so unlike Retrieve Model and Delete Model it has no Model Name field.

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

Configuration

FieldRequiredDescription
NameOptionalName of the step, should be unique within this workflow.
DescriptionOptionalDescribe the purpose or function of this step.

Headers

FieldRequiredDescription
HeadersOptionalHTTP 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.

FieldRequiredData TypeDescription
TargetRequiredObjectThe HTTP request.

Notable fields within it:

FieldData TypeDescription
headersObjectStandard HTTP headers to include in the request. Content-Type is required and defaults to application/json.
additionalHeadersArrayCustom request headers, each a header and value pair.
timeoutIntegerMaximum 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.

FieldData TypeDescription
status.codeIntegerNumeric HTTP status code.
status.messageStringShort message associated with the HTTP status.
status.messageTypeStringCategory or type of status message.
headersObjectHTTP response headers.
additionalHeadersArrayCustom response headers returned by the server.
bodyObjectParsed body of the HTTP response — this is where the OpenAI payload appears.