AGTCloud API Docs
가이드API 레퍼런스통합 및 리소스업데이트 및 도움말

API 레퍼런스

개발 작업별로 AGTCloud API를 찾아 엔드포인트, 매개변수, 응답 및 온라인 테스트를 확인합니다.

AGTCloud API 레퍼런스는 각 API의 요청 주소, 인증 방식, 매개변수 Schema, 응답 구조, 코드 예시 및 온라인 테스트를 제공합니다. 먼저 작업에 맞는 API를 찾은 후 개별 엔드포인트 페이지에서 전체 필드를 확인할 수 있습니다.

첫 API 호출

API 키가 없거나 Base URL과 모델 ID를 아직 결정하지 않았다면 빠른 시작을 먼저 읽으세요. 기본 설정을 완료했다면 아래에서 필요한 API를 바로 선택할 수 있습니다.

주요 기능

텍스트, 이미지 및 비디오는 현재 API 레퍼런스의 주요 진입점입니다. 하나의 기능에서 OpenAI 호환 형식, 공급업체 형식 또는 AGTCloud 비동기 작업 형식을 함께 제공할 수 있습니다. 기존 SDK와 대상 모델에 맞게 선택하세요.

기타 API

API 형식에 따른 선택

기능마다 전송 형식과 결과 조회 방식이 다릅니다. 클라이언트는 엔드포인트 페이지에 표시된 Content-Type과 응답 유형에 따라 데이터를 처리해야 합니다.

API 형식일반적인 사용 사례클라이언트 처리 방식
동기 JSON일반 텍스트, Embedding, Rerank요청 완료 후 JSON 응답 파싱
SSE 스트리밍 응답Chat, Responses, Gemini 스트리밍 생성스트림이 끝날 때까지 이벤트를 계속 읽기
비동기 작업비디오, Midjourney작업 ID를 저장하고 상태 및 결과 조회
Multipart 업로드이미지 편집, 오디오 전사엔드포인트 요구 사항에 따라 파일과 폼 필드 업로드
바이너리 응답비디오 또는 오디오 콘텐츠 다운로드응답 미디어 타입에 따라 파일 저장
WebSocketRealtime지속 연결을 설정하고 이벤트를 계속 송수신

엔드포인트 페이지 읽는 방법

Endpoint 및 인증 확인

Method, Path, API 주소와 엔드포인트가 요구하는 인증 Header를 확인합니다. 공통 규칙은 공통 규약을 참고하세요.

요청 사용 사례 선택

요청 예시에서 현재 작업과 가장 가까운 사용 사례를 선택한 후 Request Body, Path Parameters 또는 Query Parameters에 따라 필드를 조정합니다.

응답 및 오류 확인

HTTP 상태와 응답 미디어 타입에 따라 결과를 파싱합니다. 실패하면 민감 정보를 제거한 오류 정보와 응답에 존재하는 Request ID를 보관하고 오류 및 문제 해결을 확인하세요.

Try It으로 검증

온라인 테스트는 이 페이지에 표시된 API 주소를 사용합니다. 현재 계정의 API 키를 입력하고 모델 목록에서 사용 가능한 모델을 선택하세요. 공유 기기에서는 장기간 사용하는 운영용 키를 사용하지 마세요.

연동 전 공통 규칙

  • 어떤 텍스트 프로토콜을 사용해야 할지 모르겠다면 프로토콜 선택을 먼저 읽으세요.
  • 레퍼런스의 MODEL_ID는 현재 API 키로 실제 사용할 수 있는 모델 ID로 바꿔야 합니다.
  • 같은 이름의 기능이라도 모델과 프로토콜에 따라 지원 필드가 다를 수 있습니다. 현재 엔드포인트, 계정 권한 및 실제 응답을 기준으로 하세요.
  • 운영 애플리케이션에서는 API 키를 브라우저 프런트엔드 또는 클라이언트 패키지에 하드코딩하면 안 됩니다. Try It은 임시 테스트용이며 공개 저장소, 스크린샷 또는 로그에도 키를 기록하지 마세요.

이어서 읽기: 공통 규약 · API 키, Base URL 및 인증

이 페이지의 내용