VitePress OpenAPI

Appearance

v1.0.0

Multiple response types​

Example of an OpenAPI document with multiple response types.

Contact​

OpenAI

License​

MIT

Servers​

https://cdn.openai.com/API
ID: getAudio

Get audio​

Default
GET
/docs/audio/alloy.wav

Example of a response with an audio file.

Responses​

Successful response
audio/wav
JSON
"string"

Samples​

cURL
curl https://cdn.openai.com/API/docs/audio/alloy.wav \
  --header 'Content-Type: application/json'
JavaScript
fetch('https://cdn.openai.com/API/docs/audio/alloy.wav', {
  headers: {
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cdn.openai.com/API/docs/audio/alloy.wav",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "https://cdn.openai.com/API/docs/audio/alloy.wav"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())
ID: getImage

Get image​

Default
GET
/images/guides/simple-cat-image-dall-e-3.webp

Example of a response with an image file.

Responses​

Successful response
image/webp
JSON
"string"

Samples​

cURL
curl https://cdn.openai.com/API/images/guides/simple-cat-image-dall-e-3.webp \
  --header 'Content-Type: application/json'
JavaScript
fetch('https://cdn.openai.com/API/images/guides/simple-cat-image-dall-e-3.webp', {
  headers: {
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cdn.openai.com/API/images/guides/simple-cat-image-dall-e-3.webp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "https://cdn.openai.com/API/images/guides/simple-cat-image-dall-e-3.webp"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())
Powered by VitePress OpenAPI