AOX Platform API
The REST API behind AOX, ADRO's aerodynamic optimization platform. A Django REST Framework backend serving a public, machine-readable OpenAPI 3.0.3 document (drf-spectacular) with 231 operations across 207 paths: accounts and team management, projects, jobs, LES runs, sketch sessions, geometry patches, artifacts, an asset marketplace, STL conversion and repair, credits and credit bundles, plans, subscriptions and payments. Nineteen operations are explicitly unauthenticated (login, signup, social login, token refresh, plans, credit bundles, board announcements, health, tenant existence, email verification); the remainder require an authenticated session.
This API exposes
231 operations
across 207 paths,
organized into 31 resource areas,
and defines 185 schemas.
It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against the base URL https://api.aoxlabs.com.
The identity and technical contract details declared by the specification.
AccountTeam
object
9 properties
2 required
AiAssistRequest
object
1 property
AiChatHistoryItem
object
2 properties
2 required
AiChatRequest
object
6 properties
1 required
AiChatResponse
object
12 properties
12 required
AiDiagnosisResponse
object
4 properties
4 required
AiFinding
object
4 properties
4 required
AiRecommendationChange
object
4 properties
4 required
AiRecommendationResponse
object
7 properties
7 required
AiUsageResponse
object
3 properties
3 required
Artifact
object
12 properties
8 required
ArtifactCreate
object
7 properties
3 required
ArtifactList
object
7 properties
7 required
BatchCompute
object
11 properties
BillingKey
object
16 properties
5 required
BillingKeyBypassResponse
object
빌링키 발급 SDK 호출 전 프론트가 가져갈 bypass 페이로드. 별도 prepare 단계가 없는 PG 가 SDK 호출에 추가 파라미터를 요구할 때 사용한다.
2 properties
2 required
BillingKeyRegisterAndChargePayletterRequest
object
PayLetter requestIssueBillingKeyAndPay 콜백 처리용. 프론트는 사전에 /payments/prepare/?provider=payletter 로 paymentId 를 채번해 SDK 호출에 사용하고, 콜백에서 받은 billingKey + paymentId 를…
3 properties
3 required
BillingKeyRegisterRequest
object
4 properties
2 required
BillingKeySwapRequest
object
결제수단 변경(swap) 요청. 프론트 흐름: - PayLetter : /payments/prepare/?provider=payletter 로 소액 paymentId 채번 → requestIssueBillingKeyAndPay 로 발급+소액결제 → 콜백 billingKey + paym…
9 properties
5 required
BillingMethodSwap
object
결제수단 변경(swap) 결과. 새 빌링키 + 후속(환불/폐기) 결과 플래그. refundfailed / olddeletefailed 가 true 면 발급은 성공했으나 후속이 일부 실패한 것 (status=COMPLETEDWITHWARNINGS) — note 에 사유. CS/재시도 대…
13 properties
8 required
BookDemoCreate
object
11 properties
7 required
BundlePurchase
object
9 properties
9 required
BundlePurchaseStartRequest
object
6 properties
2 required
CancelRequest
object
1 property
1 required
CanonicalJobSpec
object
Validates the ADAPTER-INPUT canonical submission dict (in-flight only). NOT applied to the Job.runconfig envelope. The adapter pops operationMode - Job column…
12 properties
7 required
CheckoutCancelRequest
object
결제창 취소/실패 마킹 요청. FE SDK 의 취소·실패 콜백에서 받은 메시지를 그대로 전달. PG/SDK 별 문구(Galaxia '[1111, 00] 사용자 결제취소', PayLetter/PayPal '사용자가 결제를 취소하였습니다.' 등)는 FE 가 원문을 그대로 넣고, 백엔드는…
1 property
CheckoutOptions
object
4 properties
4 required
ClientExportRequest
object
2 properties
2 required
ComputeSpec
object
3 properties
1 required
ConstraintsSpec
object
8 properties
CreditBucket
object
11 properties
7 required
CreditBundle
object
10 properties
6 required
CreditEstimateResponse
object
3 properties
3 required
CreditEstimateTotals
object
1 property
1 required
CreditEstimateVariables
object
11 properties
11 required
CreditEstimateWarning
object
4 properties
4 required
CreditOperation
object
8 properties
6 required
CreditTransaction
object
10 properties
10 required
CreditWallet
object
8 properties
8 required
CurrentBillingMethod
object
현재 활성 결제수단 — 표시용 메타만 노출. 보안: raw billingkey 는 PortOne 결제 호출용 credential 이므로 브라우저에 절대 내려주지 않는다 (노출 시 결제 abuse 표면 증가). 구독/결제/교체 호출은 서버가 팀의 활성 빌링키를 직접 resolve 하므로…
5 properties
DeletionExecutionStatus
object
Team-safe execution progress. Storage targets and errors stay private.
13 properties
13 required
DetailResponse
object
1 property
1 required
DiagnoseRequest
object
2 properties
1 required
DomainGrid
object
3 properties
3 required
DomainSpec
object
1 property
DownloadItemRequest
object
3 properties
DownloadQuota
object
5 properties
5 required
EmailVerifierConfirm
object
3 properties
3 required
EmailVerifierCreate
object
회원가입 이메일 인증 메일 발송 (6자리 인증번호 방식) request: email, purpose(emailverification 한정) flow: 1. 가입된 이메일 중복 체크 2. EmailVerifier 레코드 생성 + 인증번호 메일 발송 비밀번호 재설정(passwordrese…
2 properties
2 required
FileUploadTracker
object
16 properties
10 required
FlowSpec
object
13 properties
G2JobRestart
object
G2 Job 단계 재시작(restart) 시리얼라이저. 원본 Job 의 mesh/CFD 체크포인트를 재사용해 특정 단계부터 재실행한다. 원본 geometry/STL/patch 를 그대로 재사용하므로 입력은 단계 + 일부 runconfig override 만 받는다 (예: opt 단계의…
2 properties
1 required
GeometryRotationResponse
object
5 properties
5 required
GeometrySpec
object
13 properties
1 required
GeometryTransformSpec
object
Workbench scene rotation, expressed with the Three.js XYZ convention.
2 properties
HpcCompute
object
7 properties
1 required
ImprovementRequest
object
17 properties
17 required
ImprovementRequestCreate
object
4 properties
3 required
Job
object
Job 상세 시리얼라이저. 응답 형태: - artifacts: {role: artifactpayload} 딕셔너리 (리스트가 아님) - canceledat: 미국식 철자 (모델 필드는 cancelledat — 영국식) - executions / events: 중첩 리스트 비즈니스 로직…
38 properties
30 required
JobDailyUsage
object
5 properties
3 required
JobExecution
object
Job 상세 응답의 executions[] 블록을 구성하는 실행 상세 정보.
15 properties
5 required
JobList
object
Job 목록용 경량 시리얼라이저.
29 properties
18 required
JobMonitorConsoleLog
object
Monitor API console log 엔트리.
5 properties
4 required
JobMonitorIter
object
Monitor API iteration 정보.
2 properties
2 required
JobMonitorMetrics
object
Monitor API metrics 정보.
5 properties
5 required
JobMonitorResponse
object
Job Monitor API 전체 응답 스키마.
8 properties
8 required
JobMonitorRuntime
object
Monitor API runtime 정보.
2 properties
2 required
JobMonitorValueLabel
object
Monitor API value-label 페어.
2 properties
2 required
JobParameterItem
object
5 properties
4 required
JobParametersResponse
object
6 properties
6 required
JobRename
object
Run(Job) 이름 변경 요청 바디.
1 property
1 required
JobRunConfigEnvelope
object
2 properties
2 required
JobStatusEvent
object
Job 상세 응답의 events[] 블록을 구성하는 상태 이벤트.
7 properties
3 required
JobUsageSummary
object
Job 실시간 소모 크레딧 응답 스키마. consumedCredits 는 정수로 확정 차감된 누적분. 1 미만 잔여는 아직 차감 전이라 포함되지 않는다.
1 property
1 required
LesAutoconfig
object
9 properties
9 required
LesAutoconfigUploadComplete
object
3 properties
3 required
LesInputUpload
object
5 properties
5 required
LesInputUploadComplete
object
3 properties
3 required
LoginRequest
object
2 properties
2 required
LoginResponse
object
5 properties
1 required
MeResponse
object
15 properties
13 required
MergedSourcePatch
object
4 properties
4 required
MeshPredictResponse
object
6 properties
4 required
NextBilling
object
다음 사이클에 청구될 플랜 + 금액. price 는 플랜 리스트의 가격 객체와 동일 구조.
2 properties
2 required
NextBillingPlan
object
다음 결제될 플랜 식별 정보.
3 properties
3 required
ObjectiveSpec
object
6 properties
OneTimePrepareRequest
object
7 properties
3 required
OneTimePrepareResponse
object
단건결제 준비 응답. PaymentSerializer 의 모든 필드 + bypass. bypass: PG 별로 프론트 SDK 호출에 필요한 추가 페이로드 (예: Galaxia ITEMCODE). Galaxia/PayLetter/PayPal 각각 백엔드가 채워 보내므로 프론트는 그대로…
27 properties
15 required
OptimizationSpec
object
11 properties
PaginatedArtifactListList
object
4 properties
2 required
PaginatedFileUploadTrackerList
object
4 properties
2 required
PaginatedJobListList
object
3 properties
PaginatedProjectListList
object
3 properties
ParameterizationSpec
object
3 properties
2 required
Patch
object
43 properties
13 required
PatchCreate
object
10 properties
1 required
PatchMerge
object
1 property
1 required
PatchMergeResponse
object
5 properties
5 required
PatchProxyArtifact
object
19 properties
PatchProxyArtifactPresign
object
6 properties
2 required
PatchProxyMaskFinalize
object
1 property
1 required
PatchUnmergeResponse
object
4 properties
4 required
PatchedArtifact
object
12 properties
PatchedFileUploadTracker
object
16 properties
Payment
object
26 properties
14 required
PaymentCancellation
object
5 properties
3 required
Plan
object
17 properties
8 required
PlanChangeRequest
object
3 properties
2 required
PlanGateResponse
object
/subscriptions/plan-gate/ 응답 — 실행 진입용 구독 판정.
2 properties
2 required
PlaneConstraint
object
5 properties
1 required
Presigned
object
9 properties
6 required
PriceDisplay
object
5 properties
3 required
PriceEntry
object
5 properties
5 required
Project
object
28 properties
21 required
ProjectCreate
object
15 properties
6 required
ProjectDownloadFile
object
4 properties
4 required
ProjectDownloadTicket
object
8 properties
8 required
ProjectDownloadTicketRequest
object
4 properties
1 required
ProjectList
object
23 properties
19 required
ProjectThumbnail
object
3 properties
3 required
ProjectThumbnailRequest
object
6 properties
5 required
ProviderCheckoutOption
object
2 properties
2 required
RaceFeedback
object
3 properties
2 required
RaceJobListResponse
object
2 properties
2 required
RaceJobResponse
object
10 properties
6 required
RaceLapCreate
object
9 properties
3 required
RaceSessionCreate
object
3 properties
2 required
RaceSessionResponse
object
7 properties
7 required
STLArtifactRegister
object
4 properties
2 required
SampleStl
object
4 properties
4 required
SampleStlDownload
object
2 properties
2 required
Signup
object
5 properties
2 required
SignupResponse
object
5 properties
5 required
SimpleProject
object
Job 응답에 포함될 간단한 Project 정보.
4 properties
2 required
SketchCancelResponse
object
2 properties
2 required
SketchConditions
object
Reject retired client controls instead of silently accepting them.
1 property
1 required
SketchFinishResponse
object
2 properties
2 required
SketchGeometry
object
Reject retired client controls instead of silently accepting them.
3 properties
1 required
SketchInput
object
Reject retired client controls instead of silently accepting them.
5 properties
4 required
SketchProjectCreate
object
Reject retired client controls instead of silently accepting them.
2 properties
1 required
SketchProjectState
object
6 properties
6 required
SketchProjectStateUpdate
object
Reject retired client controls instead of silently accepting them.
2 properties
2 required
SketchSession
object
18 properties
18 required
SketchSessionCreate
object
Reject retired client controls instead of silently accepting them.
1 property
1 required
SketchSessionList
object
1 property
1 required
SolverAccessResponse
object
/subscriptions/solver-access/ 응답 — 실시간 조회 결과.
4 properties
4 required
SourceFile
object
sourcefiles 항목 하나. POST(생성) / PUT(수정) 공용.
7 properties
4 required
SourceUploadAbort
object
3 properties
3 required
SourceUploadComplete
object
9 properties
5 required
SourceUploadInit
object
3 properties
2 required
StorageAddonChange
object
2 properties
2 required
StorageAddonCycle
object
13 properties
11 required
StorageAddonPrice
object
5 properties
5 required
StorageAddonPurchase
object
3 properties
2 required
StorageAddonQuote
object
16 properties
16 required
StorageAddonQuoteDisplay
object
Backend-formatted UI strings for a storage add-on quote.
6 properties
6 required
StorageUsage
object
2 properties
2 required
StorageUsageProject
object
4 properties
4 required
StorageUsageSummary
object
5 properties
3 required
SubscribeRequest
object
4 properties
1 required
Subscription
object
21 properties
15 required
SubscriptionCycle
object
11 properties
8 required
TeamBillingProfile
object
7 properties
1 required
TeamCapabilities
object
role→액션 매핑으로 계산한 capability boolean 7종. app.teams.permissions.getteamcapabilities 반환 dict 스키마와 1:1 대응한다 (설계 문서 §3.6). 필드명은 스네이크로 두되 camel-case 렌더러가 응답에서 canMan…
7 properties
7 required
TeamStorageAddon
object
15 properties
9 required
TeamStorageUsage
object
13 properties
13 required
TeamSwitchRequest
object
1 property
1 required
TeamsResponse
object
1 property
1 required
TenantFeatureAccess
object
6 properties
6 required
UpgradeQuote
object
업그레이드 견적 — 결제에 사용되는 백엔드 계산 결과를 그대로 노출.
21 properties
21 required
UpgradeQuotePlan
object
3 properties
3 required
UpgradeQuoteResponse
object
1 property
1 required
UpgradeResponse
object
22 properties
15 required
UserForcePasswordChange
object
mustchangepassword=True 계정 전용 강제 변경 시리얼라이저. 기존 password-verify 2단계 흐름과 달리 old-password 검증을 생략한다 — 대신 View 에서 mustchangepassword 플래그로 접근을 제한한다.
2 properties
2 required
UserMeUsage
object
3 properties
3 required
UserPasswordChange
object
3 properties
3 required
UserPasswordReset
object
1 property
1 required
UserPasswordResetConfirm
object
4 properties
4 required
UserPasswordVerify
object
2 properties
2 required
UserSearchResult
object
3 properties
3 required
UserSocialLogin
object
7 properties
5 required
WorkbenchRuntime
object
12 properties
12 required
WorkbenchState
object
5 properties
4 required
WorkbenchStateUpdate
object
PUT /projects/{id}/workbench-state/ unifiedconfig: solver-independent project configuration (전체 덮어쓰기) expectedrevision: 마지막으로 읽은 WorkbenchState revision
2 properties
_CompletedPart
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.