OpenAI API

FunctionObject

object
descriptionstring

A description of what the function does, used by the model to choose when and how to call the function.

namestringrequired

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

parametersobject

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

* Additional properties are allowed.
strictboolean

Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.

Default:false

Example

FunctionParameters

object

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

* Additional properties are allowed.

Image

object

Represents the url or the content of an image generated by the OpenAI API.

b64_jsonstring

The base64-encoded JSON of the generated image, if response_format is b64_json.

urlstring

The URL of the generated image, if response_format is url (default).

revised_promptstring

The prompt that was used to generate the image, if there was any revision to the prompt.

Example

ImagesResponse

createdintegerrequired
dataarray[object]required

Represents the url or the content of an image generated by the OpenAI API.

Show Child Parameters
Example

Invite

object

Represents an individual invite to the organization.

objectstringrequired

The object type, which is always organization.invite

Allowed values:organization.invite

idstringrequired

The identifier, which can be referenced in API endpoints

emailstringrequired

The email address of the individual to whom the invite was sent

rolestringrequired

owner or reader

Allowed values:ownerreader

statusstringrequired

accepted,expired, or pending

Allowed values:acceptedexpiredpending

invited_atintegerrequired

The Unix timestamp (in seconds) of when the invite was sent.

expires_atintegerrequired

The Unix timestamp (in seconds) of when the invite expires.

accepted_atinteger

The Unix timestamp (in seconds) of when the invite was accepted.

projectsarray[object]

The projects that were granted membership upon acceptance of the invite.

Show Child Parameters
Example