Microsoft Foundry Models REST API 미리 보기 참조의 Azure OpenAI

이 글은 Azure OpenAI용 추론 REST API 엔드포인트에 대한 자세한 내용을 제공합니다.

API 사양

Azure OpenAI 모델과 자원을 관리하고 상호작용하는 것은 세 가지 주요 API 표면으로 나뉩니다:

• 컨트롤 플레인
• 데이터 평면 - 저작
• 데이터 평면 - 추론

각 API 서피스/명세는 서로 다른 Azure OpenAI 기능 집합을 캡슐화합니다. 각 API는 고유한 미리보기와 안정적/일반 제공(GA) API 릴리스 세트를 가지고 있습니다. 현재 미리보기 릴리스는 보통 월간 일정을 따르는 경향이 있습니다.

Authentication

Azure OpenAI는 두 가지 인증 방법을 제공합니다. API 키나 Microsoft Entra ID 중 하나를 사용할 수 있습니다.

• API 키 인증: 이 유형의 인증에서는 모든 API 요청이 HTTP 헤더에 api-key API 키를 포함해야 합니다. 퀵스타트는 이러한 인증 방식으로 전화를 걸는 방법에 대한 안내를 제공합니다.

• Microsoft Entra ID 인증: Microsoft Entra 토큰을 사용해 API 호출을 인증할 수 있습니다. 인증 토큰은 요청 시 헤더로 Authorization 포함됩니다. 제공된 토큰은 앞에 Bearer, 예를 Bearer YOUR_AUTH_TOKEN들어 로 로 붙어야 한다. Microsoft Entra ID로 인증하는 방법에 관한 저희 사용 가이드를 읽어보실 수 있습니다.

REST API 버전 관리

서비스 API는 쿼리 매개변수를 사용하여 api-version 버전이 지정됩니다. 모든 버전은 YYYY-MM-DD 날짜 구조를 따릅니다. 다음은 그 예입니다.

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

데이터 평면 추론

나머지 글은 Azure OpenAI 데이터 평면 추론 명세의 2025-04-01-preview 미리보기 릴리스를 다룹니다.

최신 GA API 릴리스에 대한 문서를 찾고 있다면, 최신 GA 데이터 플레인 추론 API를 참고하세요

완성 - 생성

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

제공된 프롬프트, 매개변수, 선택한 모델에 대한 완성 과정을 생성합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

상태 코드: 기본 상태

설명: 서비스 불가

Examples

Example

제공된 프롬프트, 매개변수, 선택한 모델에 대한 완성 과정을 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

응답: 상태 코드: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

임베딩 - 만들기

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

기계 학습 모델과 알고리즘이 쉽게 사용할 수 있는 주어진 입력의 벡터 표현을 얻으세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

주어진 프롬프트에 임베딩을 반환하세요.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "input": [
  "this is a test"
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

채팅 완료 - 만들기

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

채팅 메시지의 완료 생성

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

상태 코드: 기본 상태

설명: 서비스 불가

Examples

Example

제공된 프롬프트, 매개변수, 선택한 모델에 대한 완성 과정을 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Azure 검색 데이터와 시스템 할당 관리 신원을 기반으로 완료 파일을 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Azure Search 이미지 벡터 데이터를 기반으로 완료 파일을 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Azure Search 벡터 데이터, 이전 어시스턴트 메시지, 사용자 지정 관리 신원을 기반으로 완료 파일을 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

제공된 Azure Cosmos DB에 대한 완성 파일을 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

제공된 Mongo DB에 대한 완성 생성.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

제공된 Elasticsearch에 대한 완성 결과를 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

제공된 Pinecone 자원에 대한 완성 생성.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

전사 - 만들기

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

오디오를 입력 언어로 전사합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Responses

상태 코드: 200

설명: 확인

Examples

Example

제공된 음성 데이터로부터 텍스트와 관련 메타데이터를 받아냅니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

제공된 음성 데이터로부터 텍스트와 관련 메타데이터를 받아냅니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

응답: 상태 코드: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

번역 - 창조

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

입력된 오디오를 영어 텍스트로 전사하고 번역합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Responses

상태 코드: 200

설명: 확인

Examples

Example

제공된 음성 데이터로부터 영어 전사된 텍스트와 관련 메타데이터를 제공합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

응답: 상태 코드: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

제공된 음성 데이터로부터 영어 전사된 텍스트와 관련 메타데이터를 제공합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

응답: 상태 코드: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

스피치 - 창작

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

입력된 텍스트에서 오디오를 생성합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Responses

상태 코드: 200

설명: 확인

Examples

Example

제공된 텍스트에서 오디오를 합성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

응답: 상태 코드: 200

{
  "body": "101010101"
}

이미지 생성 - 생성

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

주어진 이미지 생성 모델 배포에서 텍스트 캡션으로부터 이미지 배치를 생성합니다

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

상태 코드: 기본 상태

설명: 오류가 발생했습니다.

Examples

Example

프롬프트가 주어진 이미지를 생성합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

응답: 상태 코드: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

이미지 생성 - 편집

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

주어진 gpt-image-1 모델 배포에서 텍스트 캡션에서 이미지를 편집합니다

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

콘텐츠 형식: multipart/form-data

Responses

상태 코드: 200

설명: 확인

상태 코드: 기본 상태

설명: 오류가 발생했습니다.

명단 - 조교

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

조수 명단을 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

조수 명단을 반환합니다.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

생성 - 어시스턴트

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

모델과 지침이 있는 어시스턴트를 만들어 보세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

모델과 지침이 있는 어시스턴트를 만들어 보세요.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

응답: 상태 코드: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

받기 - 조수

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

조수를 데려온다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

조수를 데려온다.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

수정 - 조수

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

조수를 수정한다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

조수를 수정한다.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

응답: 상태 코드: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

삭제 - 어시스턴트

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

조수를 삭제하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

비서도 삭제합니다.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

만들기 - 스레드

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

스레드를 만들어 보세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

스레드가 생깁니다.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

받기 - 스레드

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

스레드를 꺼낸다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

스레드를 꺼낸다.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

수정 - 스레드

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

스레드를 수정합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

스레드를 수정합니다.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

응답: 상태 코드: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

삭제 - 스레드

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

스레드를 삭제하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

스레드를 삭제합니다.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

목록 - 메시지

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

주어진 스레드에 대한 메시지 목록을 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

메시지 나열

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

생성 - 메시지

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

메시지를 작성하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

메시지를 작성하세요.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

응답: 상태 코드: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

받기 - 메시지

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

메시지를 회수하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

메시지를 회수하세요.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

수정 - 메시지

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

메시지를 수정합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

메시지를 수정하세요.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

응답: 상태 코드: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

만들기 - 스레드 앤 런

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

스레드를 만들어서 한 번의 요청으로 실행하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

스레드를 만들어서 한 번의 요청으로 실행하세요.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

응답: 상태 코드: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

목록 - 득점

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

스레드에 속한 실행 목록을 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

스레드에 속한 실행 목록을 반환합니다.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

창작 - 달리기

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

런을 만들어.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

런을 만들어.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

응답: 상태 코드: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

받아 - 도망쳐

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

득점.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

득점.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

수정 - 달리기

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

런을 수정합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

런을 수정합니다.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

응답: 상태 코드: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

제출 - 실행 도구 출력

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

런이 와 가 status: "requires_action"있을 required_action.typesubmit_tool_outputs 때, 이 엔드포인트는 도구 호출이 모두 완료된 후 출력을 제출하는 데 사용할 수 있습니다. 모든 출력은 한 번에 제출해야 합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

런이 와 가 status: "requires_action"있을 required_action.typesubmit_tool_outputs 때, 이 엔드포인트는 도구 호출이 모두 완료된 후 출력을 제출하는 데 사용할 수 있습니다. 모든 출력은 한 번에 제출해야 합니다.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

취소 - 도망

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

이 이 이벤트 in_progress를 실행하는 것을 취소합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

이 이 이벤트 in_progress를 실행하는 것을 취소합니다.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

목록 - 런 스텝

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

런에 속하는 런 스텝 목록을 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

런에 속하는 런 스텝 목록을 반환합니다.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

받기 - 달리기 스텝

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

런 스텝을 회수합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

런 스텝을 회수합니다.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

목록 - 벡터 저장소

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

벡터 저장소 목록을 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 저장소 목록을 반환합니다.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Create - 벡터 스토어

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

벡터 스토어를 만들어 보세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 저장소를 만듭니다.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get - 벡터 스토어

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

벡터 스토어를 가져옵니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어를 가져옵니다.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

수정 - 벡터 스토어

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

벡터 스토어를 수정합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어를 수정합니다.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

응답: 상태 코드: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

삭제 - 벡터 스토어

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

벡터 스토어를 삭제하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어를 삭제합니다.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

목록 - 벡터 스토어 파일

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

벡터 스토어 파일 목록을 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어 파일 목록을 반환합니다.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

생성 - 벡터 스토어 파일

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

벡터 스토어에 파일을 첨부하여 벡터 스토어 파일을 만듭니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어에 파일을 첨부하여 벡터 스토어 파일을 만듭니다.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

응답: 상태 코드: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - 벡터 스토어 파일

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

벡터 스토어 파일을 가져옵니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어 파일을 가져옵니다.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

삭제 - 벡터 스토어 파일

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

벡터 스토어 파일을 삭제하세요. 이렇게 하면 벡터 저장소에서 파일이 삭제되지만, 파일 자체는 삭제되지 않습니다. 파일을 삭제하려면 delete file 엔드포인트를 사용하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어 파일을 삭제하세요. 이렇게 하면 벡터 저장소에서 파일이 삭제되지만, 파일 자체는 삭제되지 않습니다. 파일을 삭제하려면 delete file 엔드포인트를 사용하세요.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

벡터 스토어 파일의 속성을 업데이트하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

벡터 스토어 파일 콘텐츠 조회하기

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

벡터 저장소 파일의 파싱된 내용을 가져옵니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

탐색 벡터 저장소

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

쿼리와 파일 속성 필터를 기반으로 관련 청크를 벡터 스토어에서 검색하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Create - 벡터 스토어 파일 배치

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

벡터 스토어 파일 배치를 생성하세요.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어 파일 배치를 생성하세요.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

응답: 상태 코드: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get - 벡터 스토어 파일 배치

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

벡터 스토어 파일 배치를 가져옵니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어 파일 배치를 가져옵니다.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

취소 - 벡터 스토어 파일 배치

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

벡터 스토어 파일 배치를 취소하세요. 이 배치의 파일 처리를 가능한 한 빨리 취소하려는 시도입니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어 파일 배치를 취소하세요. 이 배치의 파일 처리를 가능한 한 빨리 취소하려는 시도입니다.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

목록 - 벡터 스토어 파일 배치 파일

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

벡터 스토어 파일 목록을 배치로 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

Examples

Example

벡터 스토어 파일 목록을 반환합니다.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

응답: 상태 코드: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

생성 - 실시간 세션

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Realtime API를 사용하여 클라이언트 측 애플리케이션에서 사용할 임시 API 토큰을 생성하세요. 클라이언트 이벤트와 session.update 동일한 세션 매개변수로 구성할 수 있습니다. 이 프로토콜은 세션 객체와 client_secret 함께 실시간 API용 브라우저 클라이언트를 인증하는 데 사용할 수 있는 사용 가능한 임시 API 토큰을 포함하는 키를 제공합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 세션이 성공적으로 생성되었습니다.

만들기 - Transcriptionrealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

실시간 전사를 위해 Realtime API를 이용해 클라이언트 측 애플리케이션에서 사용할 임시 API 토큰을 생성하세요. 클라이언트 이벤트와 transcription_session.update 동일한 세션 매개변수로 구성할 수 있습니다. 이 프로토콜은 세션 객체와 client_secret 함께 실시간 API용 브라우저 클라이언트를 인증하는 데 사용할 수 있는 사용 가능한 임시 API 토큰을 포함하는 키를 제공합니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 세션이 성공적으로 생성되었습니다.

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

모델 반응을 만듭니다.

요청 본문

Content-Type: application/json

Responses

상태 코드: 200

설명: 확인

상태 코드: 기본 상태

설명: 서비스 불가

응답 API - 입력 항목

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

주어진 ID를 가진 모델 응답을 가져옵니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

상태 코드: 기본 상태

설명: 서비스 불가

응답 삭제

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

주어진 ID로 모델 응답을 삭제합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

상태 코드: 404

설명: 찾을 수 없음

상태 코드: 기본 상태

설명: 서비스 불가

Responses API - 응답 항목 목록

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

주어진 응답에 대한 입력 항목 목록을 반환합니다.

URI 매개 변수

요청 헤더

토큰 기반 인증이나 API 키를 사용하세요. 토큰 기반 인증을 사용하는 것이 권장되며 더 안전합니다.

Responses

상태 코드: 200

설명: 확인

구성 요소

errorResponse

오류베이스