API
ArchibotChat API 키
생성된 API 키를 만들고, 복사하고, 교체하고, 취소하며, 외부 동료 도구를 공개 Archibot 엔드포인트에 연결합니다.
마지막 업데이트
API 키를 사용하면 스크립트, 로컬 에이전트 도구, 그리고 관리형 워크스페이스 외부에서 실행되는 연동에서 공개 Archibot 엔드포인트를 호출할 수 있습니다. 이는 브라우저 채팅 화면을 구동하는 숨겨진 자격 증명과는 별개이며, 그 자격 증명은 사용자에게 절대 표시되지 않습니다.
관리형 Archibot 워크스페이스는 이미 자체 키를 자동으로 프로비저닝합니다. 생성된 API 키는 로컬 에이전트 도구, 에디터 확장, 또는 Archibot을 외부 동료로 호출해야 하는 고객 소유의 하니스에만 사용하십시오.
API 키를 사용할 때
다음이 필요할 때 생성된 키를 만듭니다.
- 스크립트 또는 예약된 작업에서 Archibot을 호출할 때.
- 로컬 에이전트 도구 또는 에디터 확장을 엔드포인트에 연결할 때.
- OpenAI 호환 클라이언트를 Archibot 엔드포인트에 대해 실행할 때.
- 워크스페이스 외부의 고객 소유 하니스를 Archibot에 연결할 때.
대화형 질문에는 대신 브라우저 채팅 화면을 사용하십시오. ArchibotChat 사용하기를 참조하십시오.
API 키 탭 열기
- 왼쪽 탐색에서 설정을 엽니다.
Archibot account뷰를 선택합니다.API Keys탭을 엽니다.
이 탭은 Setup, Git access, CI & Review, Support, Activity, Billing과 같은 행에 있습니다. 계정에 대해 API 액세스가 활성화되어 있지 않으면 탭에 API access is not enabled for this account. 메시지가 표시되고 Create key 버튼이 비활성화됩니다. 먼저 고객 관리자 또는 ISM에게 API 제품 게이트를 활성화하도록 요청하십시오. ArchibotChat 설정을 참조하십시오.

키 만들기
API Keys탭에서Create key를 선택합니다.- 새 키가 목록 상단에 나타나고, 그 전체 값이
Copy this key now. It will not be shown again.라고 표시된 강조 표시 콜아웃에 한 번만 표시됩니다. - 키 값 옆의
Copy를 선택합니다. - 승인된 비밀 관리자 또는 런타임 환경에 저장합니다.

키에는 자동으로 이름이 지정되며(예: Console generated key 1) api 범위가 부여됩니다. 원시 값은 이 콜아웃에서만 표시됩니다. 탭을 떠나거나 다른 키를 만들면 키 접두사와 메타데이터만 계속 표시됩니다.
복사 버튼이 클립보드에 접근할 수 없으면 탭에 Clipboard copy unavailable이 표시됩니다. 이동하기 전에 키 텍스트를 수동으로 선택하여 복사하십시오.
외부 동료 도구 연결하기
External coworker access 카드는 즉시 실행 가능한 설정 스크립트를 작성해 주므로, 환경 변수를 손으로 조합할 필요가 없습니다.
카드에는 두 개의 참조 필드가 표시됩니다.
| 필드 | 표시 내용 |
|---|---|
| Public endpoint | 연동이 호출해야 하는 기본 URL입니다. 예: https://chat.archibot.cloud/v1. |
| Key source | 키를 만들거나 교체한 직후에는 New one-time key included, 그 외에는 Generate or rotate a key. |
이러한 필드 아래의 미리 보기에는 엔드포인트와 키 환경 변수를 내보내고 샘플 동료 명령을 실행하는 셸 스크립트가 표시됩니다. 키를 막 만들거나 교체했을 때 스크립트에는 해당 일회성 키 값이 포함됩니다. 그 외에는 <new-api-key> 자리 표시자를 사용합니다.
Key source필드가New one-time key included로 표시되도록 키를 만들거나 교체합니다.External coworker access카드에서Copy setup을 선택합니다.- 스크립트를 로컬 셸, 비밀 관리자 또는 도구 구성에 붙여넣습니다.
이 스크립트는 표준 OpenAI 호환 변수(OPENAI_BASE_URL, OPENAI_API_KEY)를 Archibot 동료 변수와 함께 설정하므로, OpenAI 호환 클라이언트와 Archibot 동료 도구가 모두 동일한 엔드포인트와 키를 사용합니다. 로컬 예제에서 추론하지 말고 ISM이 계정에 제공한 프로덕션 엔드포인트 URL을 사용하십시오.
키 사용하기
키를 Archibot OpenAI 호환 엔드포인트에 대한 베어러 토큰으로 사용합니다.
curl https://chat.example.archibot.cloud/v1/responses \
-H "Authorization: Bearer $ARCHIBOT_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "archibot",
"input": "Summarize this Archibus request queue export."
}'
엔드포인트는 API 키 및 크레딧 확인을 통과한 후 tools, tool_choice, reasoning, metadata, 구조화된 input 콘텐츠와 같은 OpenAI 호환 Responses API 필드를 Archibot 엔드포인트로 전달합니다.
스트리밍 응답의 경우 stream: true를 보냅니다.
curl -N https://chat.example.archibot.cloud/v1/responses \
-H "Authorization: Bearer $ARCHIBOT_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "archibot",
"input": "Draft a short work plan for this Archibus data cleanup.",
"stream": true
}'
스트리밍 응답은 모든 이벤트 청크를 다시 쓰는 대신 X-Archibot-* 응답 헤더로 청구 증거를 반환합니다.
OpenAI 호환 모델 검색은 동일한 베어러 키를 사용합니다.
curl https://chat.example.archibot.cloud/v1/models \
-H "Authorization: Bearer $ARCHIBOT_API_KEY"
모델 검색은 사용 허용량을 소비하지 않습니다.
속도 제한
생성된 API 키에는 키별 요청 제한이 있습니다. 응답에는 X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset 헤더가 포함됩니다. 제한을 초과하면 엔드포인트는 Retry-After 헤더와 함께 429를 반환합니다.
만료
생성된 API 키는 생성 후 1년이 지나면 만료됩니다. 각 키 행에는 키 접두사 옆에 생성, 만료, 마지막 사용 날짜가 표시됩니다.
만료된 키는 이름, 접두사, 메타데이터로 계속 표시되어 오래된 연동을 감사할 수 있지만, 더 이상 모델 검색이나 응답 엔드포인트를 호출할 수 없습니다. 만료된 키 거부는 사용량이 집계되기 전에 발생합니다. 만료된 키를 교체하여 동일한 이름과 범위로 대체 키를 발급하거나, 연동이 폐기된 경우 취소하십시오.
키 교체하기
연동이 동일한 이름과 범위로 계속 실행되어야 하지만 비밀 값을 변경해야 할 때 키를 교체합니다.
API Keys탭에서 이름 또는 접두사로 활성 키를 찾습니다.- 해당 키 행에서
Rotate를 선택합니다. - 일회성 콜아웃에서 대체 값을 복사합니다.
- 영향을 받는 스크립트, 비밀 관리자 항목 또는 런타임 환경을 업데이트합니다.
교체는 이전 키를 취소하고 동일한 이름과 범위로 대체 키를 만듭니다. 대체 값은 새 키에 사용되는 것과 동일한 콜아웃에 한 번만 표시됩니다. 교체는 즉시 적용되며 별도의 확인 대화 상자가 없으므로, 이전 트래픽이 실패하기 전에 연동을 업데이트할 준비를 하십시오.
키 취소하기
다음 경우에 키를 취소합니다.
- 더 이상 사용되지 않을 때.
- 채팅, 이메일, 티켓, 리포지토리 또는 공유 문서에 붙여넣어졌을 때.
- 소유자가 팀을 떠날 때.
- 연동이 교체될 때.
API Keys탭에서 이름 또는 접두사로 키를 찾습니다.- 해당 키 행에서
Revoke를 선택합니다. - 그것에 의존했던 스크립트나 연동을 업데이트하거나 제거합니다.
취소는 즉시 적용되며 별도의 확인 대화 상자가 없으므로, Revoke를 선택하기 전에 키가 올바른지 확인하십시오.
청구
생성된 API 키는 Billing에 표시되는 동일한 공유 채팅 및 API 사용 허용량에서 차감됩니다. 실패한 사전 점검과 거부된 업스트림 요청은 크레딧을 소비하지 않아야 합니다. 스트리밍 요청은 Archibot 엔드포인트가 스트림을 수락하면 청구 대상이 됩니다. ArchibotChat 청구 및 크레딧을 참조하십시오.
보안 규칙
- API 키를 소스 제어에 절대 커밋하지 마십시오.
- API 키를 지원 티켓이나 공유 문서에 절대 붙여넣지 마십시오.
- 인라인 값이 아니라 환경 변수나 비밀 관리자를 사용하십시오.
- 가능하면 연동마다 하나의 키를 사용하십시오.
- 장기간 실행되는 연동의 경우 키를 정기적으로 교체하십시오.
- 노출이 의심되면 즉시 키를 취소하십시오.
채팅 자격 증명과 API 키 비교
| 자격 증명 | 사용자에게 표시 | 용도 |
|---|---|---|
| 숨겨진 채팅 자격 증명 | 아니요 | 브라우저 채팅 화면 |
| 생성된 API 키 | 예, 한 번 | 스크립트, 로컬 에이전트 도구, 엔드포인트 연동 |
숨겨진 채팅 자격 증명을 공개하도록 ISM 지원에 요청하지 마십시오. 이는 의도적으로 사용자에게 표시되지 않습니다.
관련 가이드
완료 기준
- 계정에 대해 API 액세스가 활성화되어 있습니다.
- 탭을 떠나기 전에 생성된 키 값을 복사하여 저장했습니다.
- 연동은 계정에 제공된 ArchibotChat 엔드포인트 URL을 가리킵니다.