본문으로 건너뛰기
Skynet문서
페이지

연동

API

HTTP API로 인증하고, 실행을 시작하고, 결과를 읽습니다.

Skynet HTTP API를 사용하면 스크립트와 도구가 웹 앱과 같은 일을 할 수 있습니다. 실행을 시작하고, 지켜보고, 결과를 읽을 수 있습니다. 이 페이지는 요청에 서명하는 방법, 전체 레퍼런스의 위치, 그리고 완전한 예제 하나를 보여 줍니다.

기본 URL

모든 요청을 다음 주소로 보냅니다.

https://api.skynetml.com

인증

API는 API 토큰을 사용합니다.

  1. Skynet에서 설정을 열고 API 탭을 엽니다.
  2. 토큰 생성을 클릭합니다.
  3. 토큰을 바로 복사합니다. Skynet은 전체 토큰을 한 번만 보여 줍니다.

모든 요청의 Authorization 헤더에 토큰을 넣어 보냅니다.

Authorization: Bearer skyd_...
  • 토큰은 skyd_로 시작합니다.
  • 사용자마다 유효한 토큰은 최대 하나입니다. 새 토큰을 만들면 이전 토큰은 더 이상 작동하지 않습니다.
  • 토큰을 중지하려면 토큰 해지를 클릭합니다.

대화형 레퍼런스

전체 레퍼런스는 api.skynetml.com/scalar에 있습니다. 각 공개 엔드포인트와 필드, 응답을 나열합니다. 이 페이지에서 테스트 요청을 보낼 수도 있습니다.

레퍼런스는 https://api.skynetml.com/openapi.public.json의 OpenAPI 문서를 읽습니다. 이 파일로 원하는 언어의 클라이언트를 생성하세요.

주요 엔드포인트

메서드와 경로하는 일
GET /models사용할 수 있는 모델을 나열합니다.
GET /optimizers설정에 맞는 옵티마이저를 나열합니다.
GET /blackbox/engines네이티브 엔진과 각 엔진의 사용 가능 여부를 나열합니다.
POST /optimize프롬프트, 코드, 텍스트 또는 DSPy 프로그램의 실행을 시작합니다.
POST /blackbox/runGitHub 리포지토리에서 실행을 시작합니다.
GET /optimizations내 실행을 나열합니다.
GET /optimizations/{optimization_id}실행 하나의 상태, 진행 상황, 로그, 결과를 반환합니다.
GET /optimizations/{optimization_id}/artifact실행이 찾은 최고 버전을 반환합니다.
POST /optimizations/{optimization_id}/cancel실행을 중지합니다.
POST /serve/{optimization_id}새 입력에서 최고 버전을 실행합니다.
GET /health서비스가 작동 중인지 보여 줍니다.

실행 시작하기

POST /optimize는 제출 마법사와 같은 설정을 받습니다. 이 예제는 지원 메시지를 라벨로 분류하는 프롬프트를 개선합니다.

curl https://api.skynetml.com/optimize \
  -H "Authorization: Bearer $SKYNET_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: support-labels-001" \
  -d @run.json

중요한 필드:

  • task.artifact.kind는 prompt, code, text 또는 dspy_program입니다.
  • data.mode는 pairs(기대 출력이 있는 입력) 또는 single(정확히 하나의 케이스)입니다.
  • optimizer.choice는 auto 또는 GET /optimizers가 반환한 옵티마이저 이름 하나입니다.
  • max_cost_cents는 이 실행의 지출 한도이며 단위는 미국 센트입니다.
  • is_private의 기본값은 false입니다. 실행을 비공개로 유지하려면 true로 설정합니다.

run_code와 metric_code의 규칙은 지표와 채점기를 읽어 보세요.

응답

상태의미
201Skynet이 실행을 대기열에 넣었습니다. 본문에 optimization_id와 status가 있습니다.
202설정 검사가 아직 진행 중입니다. Retry-After 헤더에 있는 초만큼 기다린 다음, 같은 본문을 같은 Idempotency-Key로 다시 보냅니다.
402잔액이 너무 적습니다.
409할당량에 도달했거나 설정 검사가 최신 상태가 아닙니다.
422요청이나 작업 공간 코드가 옵티마이저와 맞지 않습니다.

실행 지켜보기

상태가 최종 상태가 될 때까지 실행을 폴링합니다.

curl https://api.skynetml.com/optimizations/$RUN_ID \
  -H "Authorization: Bearer $SKYNET_TOKEN"

status 필드는 다음 중 하나입니다.

상태최종 여부
pending, validating, running아니요
paused아니요
success예
failed, cancelled, stopped예

10~30초마다 폴링하세요. 실행은 몇 분에서 몇 시간까지 걸릴 수 있습니다.

실행 응답의 모든 필드는 API 레퍼런스에 나와 있습니다.

결과 사용하기

상태가 success이면 최고 버전을 가져옵니다.

curl https://api.skynetml.com/optimizations/$RUN_ID/artifact \
  -H "Authorization: Bearer $SKYNET_TOKEN"

새 입력에서 최고 버전을 실행하려면 POST /serve/{optimization_id}를 보냅니다. 각 점수의 의미는 결과 읽기를 읽어 보세요.

제한

API는 웹 앱과 같은 할당량, 요청 속도 제한, 청구 방식을 사용합니다. 제한과 예산과 결제를 읽어 보세요.