API 레퍼런스
로그인
본문으로 건너뛰기

레시피 만들기

워크스페이스 레시피를 만듭니다

POST /v1/recipes

인증

방식허용조건
API 키 (Authorization: Bearer xci_live_…)가능키 권한 run (read 키는 403 insufficient_permission)
콘솔 세션 쿠키가능조직 역할 owner, admin, developer, 같은 출처의 Origin 헤더 필요

참고 서버 구현(2026-10-12 dev 기준)이 계약 초안과 다른 점

  • 워크스페이스 안에서 같은 이름이면 409 conflict(details.fields = ["name"])입니다

요청 본문

필드타입필수설명
workspace_idstring콘솔 세션은 필수, API 키는 키의 워크스페이스
namestring필수워크스페이스 안에서 유일한 이름, 1자 이상, 80자 이하
descriptionstring설명, 500자 이하, null 가능
scriptstring필수스크립트, 1자 이상, 65536자 이하
default_xcodestring환경 목록의 Xcode 버전 중 하나, null 가능

응답

201 만들어짐

필드타입항상설명
idstring항상ID
builtinboolean항상기본 제공이면 true, 읽기 전용이고 모든 워크스페이스가 공유합니다
workspace_idstring워크스페이스 ID, null 가능
namestring항상이름
descriptionstring설명, null 가능
scriptstring항상스크립트
default_xcodestring잡이 Xcode를 안 고르면 쓰는 값, null 가능
required_envarray<string>이 레시피 잡이 꼭 넘겨야 하는 env 이름, 빠지면 VM을 띄우기 전에 400
guidestring필요한 값을 어떻게 준비하는지 안내, null 가능
created_atstring만든 시각
updated_atstring바꾼 시각
{
  "id": "rcp_ios_build",
  "builtin": true,
  "workspace_id": null,
  "name": "iOS 빌드",
  "description": "xcodebuild로 앱을 빌드합니다",
  "script": "xcodebuild -scheme \"$SCHEME\" -destination \"generic/platform=iOS Simulator\" build",
  "default_xcode": null,
  "required_env": [
    "SCHEME"
  ],
  "guide": "SCHEME에 Xcode 스킴 이름을 넣습니다",
  "created_at": "…",
  "updated_at": "…"
}

오류

HTTP코드다시 시도뜻
400invalid_request아니오본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
401api_key_required아니오API 키 엔드포인트에 Authorization: Bearer 헤더가 없습니다
401api_key_revoked_leaked아니오공개 유출 신고로 자동 폐기된 키입니다, 새 키를 발급하세요
401invalid_api_key아니오모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함)
401session_required아니오콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
403insufficient_permission아니오역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
403workspace_archived아니오보관된 워크스페이스입니다, 키는 폐기되었고 새 잡은 거절됩니다
404not_found아니오자원이 없거나 이 호출자에게 보이지 않습니다
409conflict아니오자원 상태가 이 요청을 허용하지 않습니다, 다시 읽은 뒤 시도하세요
429rate_limited가능이 키 또는 조직의 요청이 너무 많습니다, retryafters만큼 기다리세요
500internal_error가능예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다

예시

curl -X POST "https://xenoci.com/api/runner/v1/recipes" \
  -H "Authorization: Bearer $XENOCI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"unit-tests","script":"xcodebuild test -scheme App -destination \"platform=iOS Simulator,name=iPhone 17\"","default_xcode":"27.0"}'

다음 단계