# API Key 발급하기

API 라우터를 사용하려면 RunYour AI API 키가 필요합니다. API 키는 RunYour AI 콘솔에서 직접 발급할 수 있습니다.

***

### API 키 발급하기

1. [RunYour AI 콘솔](https://console.runyour.ai/)에 로그인합니다.
2. 좌측 메뉴에서 AI 에이전트 > API 라우터를 클릭합니다.
3. **API Key 생성** 버튼을 클릭합니다.
4. 키 이름(예: `my-service-prod`)과 만료일을 입력하고 **생성하기**를 클릭합니다.
5. 생성된 API 키를 복사합니다.

API 키 형식은 다음과 같습니다.

```
runyour-v1-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-xxxxxxxx
```

{% hint style="warning" %}
API 키는 생성 직후에만 전체 값을 확인할 수 있습니다. 창을 닫으면 다시 볼 수 없으니, 반드시 안전한 곳에 저장해두세요.
{% endhint %}

***

### API 키 목록 확인하기

1. 콘솔 좌측 메뉴에서 **API 라우터** 메뉴를 클릭합니다.
2. 발급된 키 목록이 표시됩니다. 키 이름, 생성일, 최근 사용일, 이용 금액 등을 확인할 수 있습니다.

{% hint style="info" %}
보안상 키의 전체 값은 목록에서 표시되지 않습니다. 키 앞 일부 문자(`runyour-v1-xxxx...`)만 확인 가능합니다.
{% endhint %}

***

### API 키 삭제(비활성화)하기

키가 유출되었거나 더 이상 사용하지 않는 키는 즉시 삭제(비활성화)하세요.

1. **API 키 관리** 페이지에서 삭제할 키 우측의 더보기 아이콘을 클릭합니다.
2. **드롭다운 메뉴에서 삭제** 메뉴를 클릭합니다.
3. 확인 팝업에서 **삭제하기를** 눌러 완료합니다.

{% hint style="warning" %}
삭제된 API 키는 즉시 비활성화되며 복구할 수 없습니다. 해당 키를 사용 중인 서비스가 있다면 새 키를 먼저 발급하여 교체한 뒤 삭제하세요.
{% endhint %}

***

### API 키 안전하게 관리하기

API 키가 외부에 노출되면 크레딧이 무단으로 사용될 수 있습니다. 아래 사항을 꼭 지켜주세요.

* API 키는 반드시 **서버 측 환경 변수**에 저장합니다.
* GitHub, 블로그 등 공개된 곳에 키를 업로드하지 마세요.
* 프론트엔드(브라우저) 코드에 키를 직접 입력하지 마세요.
* 키가 유출된 것으로 의심된다면 즉시 삭제하고 새 키를 발급하세요.

**환경 변수 설정 예시**

{% tabs %}
{% tab title="Linux / macOS" %}

```bash
export RUNYOUR_API_KEY="runyour-v1-YOUR_API_KEY"
```

{% endtab %}

{% tab title=".env 파일" %}

```
RUNYOUR_API_KEY=runyour-v1-YOUR_API_KEY
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
 `.env` 파일을 사용하는 경우 `.gitignore`에 `.env`를 추가하여 Git에 커밋되지 않도록 반드시 설정하세요.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://runyourai.gitbook.io/userguide/api/guide/get.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.