본문으로 건너뛰기

플레이그라운드 실행

POST/v1/organizations/{org_id}/workspaces/{workspace_id}/playground/runs

브라우저 플레이그라운드에서 잡 하나를 실행합니다, 보통 잡과 같이 과금되고 source_kind는 playground입니다

콘솔 세션 전용입니다, 조직 역할 owner, admin, developer만 부를 수 있고 API 키로 부르면 403 console_only입니다

  • 콘솔 세션 전용입니다, 잡은 보통 잡과 같은 승인, 요율, 정산, 로그 경로를 탑니다

Headers

  • Cookie: string
    콘솔 로그인 세션 쿠키, 콘솔 전용 엔드포인트라 API 키로 부르면 403 console_only입니다
  • Origin: string
    콘솔 세션으로 상태를 바꿀 때 같은 출처(https://xenoci.com)여야 합니다, API 키 요청에는 필요 없습니다

Path Parameters

  • org_id: string
    조직 ID
    형식 ^org_[A-Za-z0-9]+$
  • workspace_id: string
    워크스페이스 ID
    형식 ^wrk_[A-Za-z0-9]+$

Body

  • script: string
    실행할 스크립트
    65,536자 이하
  • xcode: optional string
    환경 목록의 Xcode 버전 중 하나
  • runner: optional string
    macos-m4
    기본값 "macos-m4"
  • timeout_minutes: optional integer
    제한 시간(분), 기본 30
    기본값 30, 최소 1, 최대 360
  • env: optional object
    환경 변수
  • artifacts: optional array of string
    결과물 글로브
    최대 50개

Returns

201 만들어짐 application/json

  • Job: object
    • id: string
      ID
      형식 ^job_[A-Za-z0-9]+$
    • organization_id: optional string
      조직 ID
    • workspace_id: string
      워크스페이스 ID
    • api_key_id: optional string or null
      제출에 쓴 키, 콘솔에서 제출했으면 null
    • status: "queued" or "preparing" or "running" or "succeeded" or "failed" or "cancelled" or "credit_exhausted" or "platform_error" or "timed_out" or "stopped"
      잡 상태
    • queued_reason: optional "tier_concurrency_limit" or "capacity" or null
      대기 이유, 동시 실행 한도면 tier_concurrency_limit
    • end_reason: optional "succeeded" or "failed" or "cancelled" or "credit_exhausted" or "platform_error" or "timed_out" or "abuse_suspected" or "traffic_limit_exceeded" or "organization_suspended" or "workspace_archived" or "api_key_revoked" or "api_key_expired" or "api_key_scope_changed" or "member_removed" or null
      succeeded, failed, cancelled, credit_exhausted, platform_error, timed_out 중 하나, 끝나기 전엔 null
    • error: optional Error { code, message, retryable, … } or null
      끝낸 오류(코드, 메시지), 없으면 null
      • code: "invalid_request" or "invalid_amount" or "api_key_required" or "invalid_api_key" or "api_key_revoked_leaked" or "session_required" or "insufficient_permission" or "console_only" or "workspace_archived" or "not_found" or "conflict" or "idempotency_conflict" or "last_owner" or "default_workspace_protected" or "invite_expired" or "payment_amount_mismatch" or "payment_reference_reused" or "payment_not_paid" or "topup_expired" or "withdrawal_window_closed" or "insufficient_credit" or "credit_exhausted" or "workspace_spend_limit" or "tier_monthly_limit" or "tier_concurrency_limit" or "traffic_limit_exceeded" or "abuse_suspected" or "rate_limited" or "fx_rate_unavailable" or "payments_unavailable" or "capacity_unavailable" or "internal_error"
        기계가 읽는 오류 코드, 아래 오류 표 참고
      • message: string
        사람이 읽는 오류 설명
      • retryable: boolean
        같은 요청을 다시 보내도 되는지
      • retry_after_s: optional integer or null
        다시 보내기 전에 기다릴 초
        최소 0
      • fault: "client" or "payment" or "platform"
        오류 책임 쪽, 요청(client) 또는 서버(server)
      • request_id: string
        요청 ID, 문의할 때 알려 주세요
      • docs_url: optional string
        이 오류를 설명하는 문서 주소
      • details: optional object
        코드별 추가 필드, insufficient_credit와 credit_exhausted는 balance_micro_usd, balance_usd, required_micro_usd, required_usd, topup_url, workspace_spend_limit는 limit_, spent_, tier_* 코드는 tier, limit, resets_at, invalid_request는 fields[]
    • exit_code: optional integer or null
      스크립트 종료 코드
    • created_at: string
      만든 시각
      RFC 3339 UTC 시각
    • started_at: optional string or null
      과금 시작 시각(VM 준비 뒤)
    • ended_at: optional string or null
      끝난 시각
    • run_seconds: optional integer or null
      실행 초
    • billed_minutes: optional integer or null
      과금 분, ceil(billed_seconds / 60)이고 0초면 0분, 금액은 초 단위로 계산
    • rate_micro_usd_per_min: optional integer
      잡 시작 때 고정된 분당 요율(µUSD, 부가세 포함)
    • rate_usd_per_min: optional string
      같은 요율의 USD 문자열
      형식 ^-?[0-9]+\.[0-9]{4}$
    • amount_micro_usd: optional integer
      이 잡의 금액(µUSD)
      최소 0
    • amount_usd: optional string
      같은 금액의 USD 문자열
      형식 ^-?[0-9]+\.[0-9]{2}$
    • credit_low: optional object { balance_micro_usd, balance_usd, topup_url } or null
      잡이 끝났을 때 잔액이 낮으면 잔액과 충전 링크, 아니면 null
      • balance_micro_usd: optional integer
        금액(µUSD 정수)
        최소 0
      • balance_usd: optional string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
      • topup_url: optional string
        충전 링크
    • log_url: optional string
      로그 URL
    • repository: optional string or null
      제출 때 적은 owner/name
    • source_kind: optional string
      제출 경로
    • runner: optional string
      잡이 도는 러너 ID
    • billed_seconds: optional integer or null
      과금 초, 0초면 0, 아니면 max(60, 실행 초)
    • billable_started_at: optional string or null
      과금 구간 시작, VM이 준비되고 사용자 작업(소스 받기나 git clone)이 시작된 시각, 요청 접수와 대기와 VM 준비는 무료
      RFC 3339 UTC 시각
    • billable_ended_at: optional string or null
      과금 구간의 끝(잡 종료 시각), 실행 중이거나 과금이 없으면 null
      RFC 3339 UTC 시각
    • net_rx_bytes: optional integer
      첫 측정 뒤 호스트 vmenet 카운터 차이로 모은 VM 다운로드 바이트
      최소 0
    • net_tx_bytes: optional integer
      첫 측정 뒤 호스트 vmenet 카운터 차이로 모은 VM 업로드 바이트
      최소 0
    • commit_sha: optional string or null
      잡이 빌드한 커밋, 제출 때 보낸 값(16진수 7~64자, 소문자로 저장), 분쟁 증거
    • request_ip: optional string or null
      제출 요청의 클라이언트 주소(프록시 뒤에서는 실제 클라이언트), 분쟁 증거
    • user_agent: optional string or null
      제출 요청의 User-Agent(CLI, MCP, Action 버전), 분쟁 증거

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • runner_not_available: HTTP 400
    준비 중인 러너입니다, status가 available인 러너를 고르세요
  • unknown_runner: HTTP 400
    없는 러너 ID입니다, details.available에 쓸 수 있는 ID가 있습니다
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • insufficient_credit: HTTP 402
    사용 가능 잔액이 현재 요율의 1분어치보다 적습니다, 본문에 잔액과 topup_url이 있습니다
  • tier_monthly_limit: HTTP 402
    조직이 티어 월 사용 한도에 닿았습니다, 다음 달 1일 00:00 UTC 또는 티어 상향 때 풀립니다
  • workspace_spend_limit: HTTP 402
    워크스페이스 월 지출 한도에 닿았습니다, 소유자나 관리자가 올릴 수 있습니다
  • console_only: HTTP 403
    콘솔 세션 전용 엔드포인트입니다, API 키로는 결제, 키, 멤버 관리를 할 수 없습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • workspace_archived: HTTP 403
    보관된 워크스페이스입니다, 키는 폐기되었고 새 잡은 거절됩니다
  • not_found: HTTP 404
    자원이 없거나 이 호출자에게 보이지 않습니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • tier_concurrency_limit: HTTP 429, 다시 시도 가능
    실행 중인 잡이 티어 동시 실행 한도에 닿았고 조직 대기열도 가득 찼습니다, retry_after_s 뒤에 다시 보내세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요
  • capacity_unavailable: HTTP 503, 다시 시도 가능
    설정된 맥 풀 용량이 없습니다, 잡을 받지 않았습니다

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