API 연동하기

RunYour AI API를 서비스에 연동하는 방법을 안내합니다. OpenAI SDK를 사용하는 방법과 REST API를 직접 호출하는 방법, 두 가지 중 편한 방식을 선택하세요.

---

OpenAI SDK로 연동하기 (권장)

기존에 OpenAI SDK를 사용 중이라면 Base URL과 API 키 두 가지만 변경하면 됩니다.

1단계. SDK 설치하기

Python

pip install openai

JavaScript

2단계. 클라이언트 설정하기

Python

from openai import OpenAI

client = OpenAI(
    api_key="runyour-v1-YOUR_API_KEY",   # ← RunYour AI API 키
    base_url="https://api.runyour.ai/v1"  # ← Base URL 변경
)

JavaScript

기존 OpenAI 코드에서 api_key와 base_url(또는 baseURL) 두 줄만 교체하면 됩니다. 나머지 코드는 그대로 사용할 수 있습니다.

3단계. 첫 번째 API 호출 테스트하기

Python

completion = client.chat.completions.create(
    model="openai/gpt-5.2",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "안녕하세요!"}
    ],
    temperature=0.7,
    max_tokens=300
)

print(completion.choices[0].message.content)

JavaScript

응답에서 AI의 답변은 choices[0].message.content에서 확인할 수 있습니다.

---

REST API로 직접 연동하기

SDK 없이 curl, Postman, 또는 자체 HTTP 클라이언트로 직접 호출할 수도 있습니다.

기본 호출 예시

curl https://api.runyour.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer runyour-v1-YOUR_API_KEY" \
  -d '{
    "model": "openai/gpt-5.2",
    "messages": [
      { "role": "user", "content": "안녕하세요!" }
    ],
    "temperature": 0.7,
    "max_tokens": 300
  }'

주요 엔드포인트

메서드	엔드포인트	설명
POST	https://api.runyour.ai/v1/chat/completions	AI 응답 생성 (주요 엔드포인트)
POST	https://api.runyour.ai/v1/responses	OpenAI Responses API 형식 호출
GET	https://api.runyour.ai/v1/models	사용 가능한 모델 목록 조회

요청 시 사용할 수 있는 주요 파라미터

Chat Completions API

파라미터	필수	설명
model	✅	호출할 모델 ID. provider/model 형식 (예: openai/gpt-5.2)
messages	✅	대화 메시지 배열. role(system·user·assistant)과 content로 구성
temperature		응답의 창의성 조절. 0(결정적) ~ 2(창의적), 기본값 1.0
max_tokens		생성할 최대 토큰 수. 미설정 시 모델 기본값 적용
stream		true로 설정하면 스트리밍 응답 활성화. 기본값 false
response_format		응답 형식 지정. { "type": "text" } 또는 { "type": "json_object" }
enable_web_search		true로 설정하면 실시간 웹 검색 결과를 반영한 답변 생성 (지원 모델에 한함)
reasoning_config		OpenAI 추론 모델 전용. effort(none·low·medium·high·xhigh), summary(auto·none·concise·detailed)

Responses API

응답 예시

{
  "id": "chatcmpl-2f3e0c18-...",
  "object": "chat.completion",
  "created": 1760000000,
  "model": "openai/gpt-5.2",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "안녕하세요! 무엇을 도와드릴까요?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 12,
    "completion_tokens": 18,
    "total_tokens": 30
  }
}

AI의 답변은 choices[0].message.content에서 확인할 수 있으며, usage에서 이번 호출에 사용된 토큰 수를 확인할 수 있습니다.