API 참조

채팅 완성 생성

POST/v1/chat/completions

OpenAI Chat Completions 호환 텍스트/도구 엔드포인트입니다. image_url은 이미지 입력 지원 모델에서만 사용할 수 있습니다. 출력은 텍스트/도구이며 기능, 선택 필드와 가격은 선택한 모델에 따라 달라집니다. stream=true는 SSE를 반환하고 최종 사용량을 포함할 수 있으며 data: [DONE]으로 끝납니다.

인증과 권한

현재 GloopAPI 키를 사용하세요. 사용 가능한 모델, 기능과 권한은 해당 카탈로그와 엔드포인트 문서에 따라 달라집니다.

Authorization: Bearer $GLOOP_API_KEY

인증 방식: BearerAuth

요청

요청 본문 · application/json

유형
object
필수 필드
modelmessages

요청 본문 필수

  • modelstring필수

    모델 ID

  • messagesarray필수

    대화 메시지 목록

    messages 하위 필드(1)
    • []object선택 사항
      [] 하위 필드(6)
      • rolestring필수

        메시지 역할

        열거형
        ["system","user","assistant","tool","developer"]
      • contentunion필수

        메시지 콘텐츠

        oneOf 분기 1

        유형: string

        oneOf 분기 2

        유형: array

        • []object선택 사항
          [] 하위 필드(6)
          • typestring선택 사항
            열거형
            ["text","image_url","input_audio","file","video_url"]
          • textstring선택 사항
          • image_urlunion선택 사항

            문자열 URL/Base64 또는 객체 {url, detail} 전송 입력을 지원합니다. 이미지 입력 지원 모델에서만 사용할 수 있으며 모든 모델의 비전 지원을 보장하지 않습니다.

            oneOf 분기 1

            이미지 URL 또는 Base64 데이터 URL입니다.

            유형: string

            oneOf 분기 2

            객체 입력에는 최소한 url이 있어야 합니다. Message.ParseContent는 생략된 detail을 high로 정규화하며 지원은 선택한 비전 모델에 따라 다릅니다.

            유형: object

            이 분기의 필수 항목: url

            • urlstring필수

              이미지 URL 또는 base64

            • detailstring선택 사항
              열거형
              ["low","high","auto"]
          • input_audioobject선택 사항
            input_audio 하위 필드(2)
            • datastring선택 사항

              Base64로 인코딩된 오디오 데이터

            • formatstring선택 사항
              열거형
              ["wav","mp3"]
          • fileobject선택 사항
            file 하위 필드(3)
          • video_urlstring선택 사항

            Message.ParseContent가 실제로 읽는 전송 입력은 동영상 URL 문자열이며 동영상 입력 지원 모델에서만 사용할 수 있습니다. {url: ...} 객체는 이 파서의 콘텐츠/사용량 결과에 포함되지 않으며 사용 가능한 계약으로 공개하지 않습니다.

      • namestring선택 사항

        발신자 이름

      • tool_callsarray선택 사항
        tool_calls 하위 필드(1)
        • []object선택 사항
          [] 하위 필드(3)
          • idstring선택 사항
          • typestring선택 사항
          • functionobject선택 사항
            function 하위 필드(2)
      • tool_call_idstring선택 사항

        도구 호출 ID(tool 역할 메시지용)

      • reasoning_contentstring선택 사항

        추론 콘텐츠

  • temperaturenumber선택 사항

    샘플링 온도입니다. 구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • top_pnumber선택 사항

    핵 샘플링 매개변수입니다. 구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • ninteger선택 사항

    생성 수량입니다. 구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • streamboolean선택 사항

    응답 스트리밍 여부

    기본값
    false
  • stream_optionsobject선택 사항

    Chat 스트리밍 사용량 옵션입니다. 지원 여부와 사용량 반환 여부는 선택한 모델에 따라 달라집니다.

    stream_options 하위 필드(1)
  • stopunion선택 사항

    중단 시퀀스

    oneOf 분기 1

    유형: string

    oneOf 분기 2

    유형: array

    • []string선택 사항
  • max_tokensinteger선택 사항

    최대 생성 토큰 수입니다. 구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • max_completion_tokensinteger선택 사항

    최대 완성 토큰 수입니다. 구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • presence_penaltynumber선택 사항

    구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • frequency_penaltynumber선택 사항

    구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • logit_biasobject선택 사항
    logit_bias 하위 필드(1)
  • userstring선택 사항
  • toolsarray선택 사항
    tools 하위 필드(1)
    • []object선택 사항
      [] 하위 필드(2)
      • typestring선택 사항
      • functionobject선택 사항
        function 하위 필드(3)
  • tool_choiceunion선택 사항
    oneOf 분기 1

    유형: string

    열거형: ["none","auto","required"]

    oneOf 분기 2

    유형: object

    • typestring선택 사항
    • functionobject선택 사항
      function 하위 필드(1)
      • namestring선택 사항
  • response_formatobject선택 사항
    response_format 하위 필드(2)
    • typestring선택 사항
      열거형
      ["text","json_object","json_schema"]
    • json_schemaobject선택 사항

      JSON Schema 정의

  • seedinteger선택 사항

    구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • reasoning_effortstring선택 사항

    추론 강도(추론 지원 모델용)입니다. 구체적인 지원과 제한은 선택한 모델에 따라 다르며 공통 기본값은 보장되지 않습니다.

  • modalitiesarray선택 사항
    modalities 하위 필드(1)
    • []string선택 사항
      열거형
      ["text","audio"]
  • audioobject선택 사항
    audio 하위 필드(2)
  • parallel_tool_callsboolean선택 사항

    병렬 도구 호출 허용 여부는 선택한 모델에 따라 달라집니다. Chat은 불리언을, Responses는 호환 프로토콜의 JSON 값을 받습니다.

  • storeboolean선택 사항

    요청과 응답의 저장 허용 여부는 선택한 모델과 서비스 지원 범위에 따라 달라집니다. 일반적인 대화 저장 API를 제공한다는 의미는 아닙니다.

  • prompt_cache_keystring선택 사항

    서비스 프롬프트 캐시 연결 식별자입니다. 모델에 따라 다르며 캐시 적중이나 지원을 보장하지 않습니다. Chat은 문자열을, Responses는 서비스 프로토콜 JSON 값을 허용합니다.

  • prompt_cache_retentionunknown선택 사항

    JSON 값인 서비스 프롬프트 캐시 보관 제어입니다. 모델에 따라 다르며 플랫폼은 공통 열거형, 기본값이나 캐시 보관을 보장하지 않습니다.

  • service_tierunknown선택 사항

    요청할 서비스 등급으로 요금에 영향을 줄 수 있습니다. 기본적으로 무시되며 지원하는 경우에만 적용됩니다. 허용 값은 선택한 모델에 따라 달라집니다.

응답과 오류

HTTP 200

응답 생성 성공

application/json

유형
object
추가 속성
false

text/event-stream

유형
string
설명
SSE 이벤트 스트림입니다. 프로토콜 이벤트, 사용량과 종료 표시는 현재 엔드포인트에 따라 다르며 스트림 내부에서 오류가 발생할 수 있습니다.
{
  "type": "string",
  "description": "SSE 事件流,协议事件/用量/结束符取当前接口,错误可能在流内。"
}

HTTP 400

유효하지 않은 요청 매개변수

application/json

유형
object
  • errorobject선택 사항
    error 하위 필드(4)
    • messagestring선택 사항

      오류 메시지

    • typestring선택 사항

      오류 유형

    • paramstring선택 사항null 허용

      관련 매개변수

    • codestring선택 사항null 허용

      오류 코드

HTTP 401

키가 없거나 유효하지 않거나 만료 또는 폐기되었습니다.

application/json

유형
object
필수 필드
error

HTTP 403

IP, 계정, 모델 또는 도구 권한이 부족합니다.

application/json

유형
object
필수 필드
error

HTTP 429

요청 속도 제한

application/json

유형
object
  • errorobject선택 사항
    error 하위 필드(4)
    • messagestring선택 사항

      오류 메시지

    • typestring선택 사항

      오류 유형

    • paramstring선택 사항null 허용

      관련 매개변수

    • codestring선택 사항null 허용

      오류 코드

HTTP 500

내부 인증 또는 데이터 저장 오류입니다.

application/json

유형
object
필수 필드
error
개발할 준비가 되셨나요? 열기: 콘솔 API 키를 생성하거나 살펴보기: 기능.