고급
서버 API 직접 호출
전용 명령·도구가 없는 기능(폴더 관리, 공지, 관리자 기능 등)은 서버 API 를 직접 부를 수 있습니다. 로그인·확인 정책은 그대로 적용됩니다.
공개 API 가 아닙니다
웹·앱 화면이 쓰는 내부 API 입니다. 경로와 응답 모양이 예고 없이 바뀔 수 있으니, 같은 일을 하는 전용 명령·도구가 있으면 그쪽을 쓰세요.
엔드포인트 찾기
aimz endpoints folders
aimz endpoints credits --method GET
aimz endpoints --admin # 관리자 전용만 (관리자 계정에서만 실제로 호출됩니다)각 항목에는 메서드·경로·필요 권한(guard)·요약·쿼리와 본문 필드가 나옵니다. --json 으로 전체를 볼 수 있습니다. MCP: api_endpoints.
호출하기
aimz api GET /api/generations -q modality=image -q limit=5
aimz api GET "/api/generations?modality=image&limit=5" # 쿼리를 경로에 붙여도 됩니다
aimz api POST /api/generations/folders -d '{"name":"11월 캠페인"}'
aimz api PATCH /api/generations/123/title -d @title.json| 옵션 | 설명 |
|---|---|
-q 키=값 | 쿼리 문자열 (반복 가능) |
-d JSON | JSON 본문. @파일이름 이면 파일 내용 |
-y, --yes | 확인이 필요한 요청을 진행 (사용자가 승인한 경우에만) |
MCP: api_request(method, path, query, body). 경로는 반드시 /api/ 로 시작하고, 경로의 {변수} 는 실제 값으로 바꿉니다.
확인이 필요한 요청
| 종류 | 예 | 확인 |
|---|---|---|
| 조회 | GET 전부 | 묻지 않음 |
| 내 데이터 변경 | 폴더 만들기, 제목 바꾸기, 업로드 | 묻지 않음 |
| 크레딧 사용 | POST /api/generate/jobs, /api/agent/chat | 모드에 따라 (기본: 처음 한 번) |
| 위험 | DELETE 전부, 관리자 전용 변경, 결제, 계정·인증 변경 | yolo 가 아니면 매번 |
자세한 규칙은 크레딧 사용 확인을 보세요.
자주 쓰는 엔드포인트
| 메서드·경로 | 설명 |
|---|---|
GET /api/auth/me | 내 계정 |
GET /api/credits/balance | 크레딧 잔액 |
GET /api/models | 모델 목록 (modality 쿼리) |
GET /api/models/estimate | 예상 크레딧 (model_id, count, duration …) |
POST /api/generate/jobs | 생성 접수 → job_id (idempotency_key 는 CLI 가 자동으로 붙입니다) |
GET /api/generate/jobs/{job_id} | 작업 상태·결과 |
GET /api/generations | 라이브러리 (modality, q, limit, offset, folder) |
GET /api/generations/folders | 내 폴더 |
POST /api/uploads | 파일 업로드 (data URL) |
GET /api/workflows | Labs 워크플로우 |
인증 방식
CLI 는 로그인 때 받은 세션을 웹과 같은 세션 쿠키로 보냅니다. 토큰을 직접 꺼내 다른 프로그램에서 쓰는 방식은 지원하지 않습니다 — 다른 프로그램에서 쓰려면 aimz api … --json 의 출력을 이어 쓰세요.