How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

231 operations 207 paths 185 schemas 10 DELETE97 GET4 PATCH110 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.aoxlabs.com
Resource Areas
31

Paths & Operations 231

Across 207 paths, the API surfaces 231 operations — 10 DELETE, 97 GET, 4 PATCH, 110 POST, 10 PUT. They span 31 resource areas, including accounts, Ai, announcements, artifacts, asset-notifications, assets, payments, board, and 23 more. Each is listed below with its method, path, parameters, and response codes.

accounts 19
POST
/accounts/login/
accounts_login_create body → 200
POST
/accounts/logout/
accounts_logout_create → 200
GET
/accounts/me/
accounts_me_retrieve → 200
DELETE
/accounts/me/
accounts_me_destroy → 204
POST
/accounts/me/force-password-change/
mustchangepassword=True 계정 전용 강제 비밀번호 변경. old-password 검증을 생략하는 대신, mustchangepassword 플래그가 켜진 계정만 허용하는 것으로 보안을 대체한다.
accounts_me_force_password_change_create body → 200
PUT
/accounts/me/password-change/
accounts_me_password_change_update body → 200
POST
/accounts/me/password-verify/
accounts_me_password_verify_create body → 200
GET
/accounts/me/usage/
accounts_me_usage_retrieve 1 param → 200
POST
/accounts/password-reset/
accounts_password_reset_create body → 200
POST
/accounts/password-reset-confirm/
accounts_password_reset_confirm_create body → 200
PUT
/accounts/password_change/
accounts_password_change_update body → 200
POST
/accounts/password_verify/
accounts_password_verify_create body → 200
GET
/accounts/search/
accounts_search_list → 200
POST
/accounts/signup/
accounts_signup_create body → 201
POST
/accounts/social-login/
accounts_social_login_create body → 200
POST
/accounts/social-register/
소셜 신규 가입 — registertoken 으로 계정 생성 후 쿠키 세팅.
accounts_social_register_create → 200
POST
/accounts/team-switch/
accounts_team_switch_create body → 200
GET
/accounts/teams/
accounts_teams_retrieve → 200
POST
/accounts/token/refresh/
accounts_token_refresh_create → 200
Ai 4
POST
/ai/projects/{project_uid}/chat/
ai_projects_chat_create 1 param body → 200
POST
/ai/projects/{project_uid}/diagnose/
ai_projects_diagnose_create 1 param body → 200
POST
/ai/projects/{project_uid}/recommend/
ai_projects_recommend_create 1 param body → 200
GET
/ai/usage/
현재 창의 AI Assist 사용량 — 패널이 열릴 때 표시용으로 읽는다.
ai_usage_retrieve → 200
announcements 1
GET
/announcements/
announcements_retrieve → 200
artifacts 9
GET
/artifacts/
artifacts_list 2 params → 200
POST
/artifacts/
artifacts_create body → 201
GET
/artifacts/{artifact_id}/download/
artifacts_download_retrieve 1 param → 200
GET
/artifacts/{id}/
artifacts_retrieve 1 param → 200
PUT
/artifacts/{id}/
artifacts_update 1 param body → 200
PATCH
/artifacts/{id}/
artifacts_partial_update 1 param body → 200
DELETE
/artifacts/{id}/
artifacts_destroy 1 param → 204
POST
/artifacts/{id}/copy/
artifacts_copy_create 1 param body → 200
GET
/artifacts/{id}/download_url/
artifacts_download_url_retrieve 1 param → 200
asset-notifications 1
POST
/asset-notifications/{notification_id}/read/
asset_notifications_read_create 1 param → 200
assets 11
GET
/assets/
assets_retrieve → 200
GET
/assets/{asset_uid}/
assets_retrieve_2 1 param → 200
POST
/assets/{asset_uid}/acquire/
assets_acquire_create 1 param → 200
POST
/assets/{asset_uid}/approval/
assets_approval_create 1 param → 200
POST
/assets/{asset_uid}/projects/
assets_projects_create 1 param → 200
POST
/assets/{asset_uid}/retry-copy/
assets_retry_copy_create 1 param → 200
POST
/assets/{asset_uid}/save/
assets_save_create 1 param → 200
DELETE
/assets/{asset_uid}/save/
assets_save_destroy 1 param → 204
POST
/assets/{asset_uid}/stop-sale/
assets_stop_sale_create 1 param → 200
GET
/assets/mine/
assets_mine_retrieve → 200
GET
/assets/transactions/
assets_transactions_retrieve → 200
payments 13
POST
/billing-keys/
빌링키 등록 (프론트가 SDK 콜백에서 받은 billingKey 를 팀에 묶어 저장)
billing_keys_create body → 201
GET
/billing-keys/bypass-hint/
빌링키 발급 SDK 호출에 필요한 PG 별 bypass 페이로드 + channelkey. PG 별 추가 파라미터가 필요한 경우 프론트가 SDK 호출 전에 가져간다.
billing_keys_bypass_hint_retrieve 1 param → 200
GET
/billing-keys/current/
현재 활성(ISSUED) 결제수단 1건 조회. 결제 PG사 + 카드 표시 메타만 반환 (raw billingkey 는 보안상 미노출). 한 팀 = 활성 빌링키 1개 정책이라 단일 객체로 응답하며, 없으면 null.
billing_keys_current_retrieve 1 param → 200
POST
/billing-keys/payletter/register-and-charge/
PayLetter requestIssueBillingKeyAndPay 콜백 처리 (빌링키 발급 + 첫결제 동시). 프론트가 SDK 콜백에서 받은 billingKey + paymentId 전달.
billing_keys_payletter_register_and_charge_create body → 201
POST
/billing-keys/swap/
PG 인증 성공 뒤, 서버 트랜잭션에서 청구 프로필과 새 빌링키를 함께 등록한다. 진행 중 구독은 현재 결제주기를 유지하고 다음 갱신부터 새 키를 사용한다.
billing_keys_swap_create body → 201
GET
/payments/
payments_retrieve → 200
GET
/payments/{payment_id}/
payments_retrieve_2 1 param → 200
POST
/payments/{payment_id}/checkout-cancel/
결제창 취소/실패 마킹. FE SDK 의 취소·실패 콜백에서 호출. READY/PAYPENDING → FAILED(CHECKOUTCANCELED). 환불(cancel) 과 다른 액션.
payments_checkout_cancel_create 1 param body → 200
POST
/payments/{payment_id}/verify/
결제 검증 (포트원 GET /payments 로 재조회 후 동기화)
payments_verify_create 1 param → 200
GET
/payments/billing-profile/
Read or update the Team billing profile.
payments_billing_profile_retrieve 1 param → 200
PUT
/payments/billing-profile/
Read or update the Team billing profile.
payments_billing_profile_update 1 param body → 200
GET
/payments/checkout-options/
Team checkout options derived from a saved or temporary billing country.
payments_checkout_options_retrieve 2 params → 200
POST
/payments/prepare/
단건결제 준비 (paymentId 채번). 팀 단위 결제.
payments_prepare_create body → 201
board 2
GET
/board/
board_retrieve → 200
GET
/board/{id}/
board_retrieve_2 1 param → 200
book_demo 1
POST
/book_demo/
데모 예약 신청
book_demo_create body → 201
credits 11
GET
/credits/buckets/
bucket 목록 (active 우선)
credits_buckets_list 2 params → 200
GET
/credits/bundles/
크레딧 번들 목록
credits_bundles_list 2 params → 200
GET
/credits/bundles/{bundle_id}/
크레딧 번들 단건 조회
credits_bundles_retrieve 2 params → 200
POST
/credits/bundles/{bundle_id}/purchase/
번들 구매 시작 (단건결제 paymentId 채번)
credits_bundles_purchase_create 1 param body → 201
GET
/credits/estimate/
예상 소모 크레딧 계산
credits_estimate_retrieve 1 param → 200
GET
/credits/operations/
크레딧 operation 목록 (idempotency 단위, 최신순)
credits_operations_list 2 params → 200
GET
/credits/purchases/
번들 구매 이력
credits_purchases_list 2 params → 200
GET
/credits/transactions/
크레딧 거래 내역 (bucket 단위 row, 최신순)
credits_transactions_list 2 params → 200
GET
/credits/usage/jobs/
팀 Job 목록 + 크레딧 소모 요약 (SQS 실시간 차감 검증용)
credits_usage_jobs_retrieve 2 params → 200
GET
/credits/usage/jobs/{job_uid}/
Job 단건 크레딧 소모 상세 — attempt 요약 + 최근 UsageEvent 스트림
credits_usage_jobs_retrieve_2 3 params → 200
GET
/credits/wallet/
팀 크레딧 지갑 — balance (active buckets 합) + source 별 breakdown
credits_wallet_retrieve 1 param → 200
deletion-executions 1
GET
/deletion-executions/{execution_uid}/
영구 삭제 실행 상태 조회
deletion_executions_retrieve 1 param → 200
error-feedback 1
POST
/error-feedback/
error_feedback_create → 200
feature-feedback 2
GET
/feature-feedback/
feature_feedback_retrieve → 200
PUT
/feature-feedback/{feature_key}/
feature_feedback_update 1 param → 200
health 1
GET
/health/
health_retrieve → 200
improvement_requests 1
POST
/improvement-requests/
Submit an improvement request
improvement_requests_create body → 201
job-notifications 3
GET
/job-notifications/
job_notifications_retrieve → 200
POST
/job-notifications/{notification_id}/read/
job_notifications_read_create 1 param → 200
POST
/job-notifications/read-all/
job_notifications_read_all_create → 200
jobs 24
GET
/job/{id}/
Job 상세 조회
job_retrieve 1 param → 200
POST
/job/{id}/cancel/
Job 취소
job_cancel_create 1 param → 200
POST
/job/{id}/delete/
Job 삭제 (소프트)
job_delete_create 1 param → 200
GET
/job/{id}/deletion-preview/
Job 삭제 예정일 미리보기
job_deletion_preview_retrieve 1 param → 200
GET
/job/{id}/execution-logs/
Result Viewer — 실행 console 로그
job_execution_logs_retrieve 1 param → 200
GET
/job/{id}/history/
Result Viewer — 최적화 history CSV
job_history_retrieve 1 param → 200
GET
/job/{id}/monitor/
Job 모니터링 (대기화면용)
job_monitor_retrieve 1 param → 200
GET
/job/{id}/optimized-stl/
Optimized STL presigned URL(s) — seed a new project
job_optimized_stl_retrieve 1 param → 200
GET
/job/{id}/parameters/
Job view parameters
job_parameters_retrieve 1 param → 200
POST
/job/{id}/purge-now/
Job 즉시 영구 삭제 접수
job_purge_now_create 1 param body → 200
POST
/job/{id}/rename/
Run(Job) 이름 변경
job_rename_create 1 param body → 200
POST
/job/{id}/restart/
G2 Job 단계 재시작 (restart)
job_restart_create 1 param body → 200
GET
/job/{id}/restart-options/
G2 Job restart 단계 옵션
job_restart_options_retrieve 1 param → 200
POST
/job/{id}/restore/
삭제 예정 Job 복구
job_restore_create 1 param → 200
GET
/job/{id}/result-mesh/
Result Viewer — DSN별 mesh presigned URL
job_result_mesh_retrieve 1 param → 200
GET
/job/{id}/streamlines/
Result Viewer — DSN별 flow streamlines presigned URL
job_streamlines_retrieve 1 param → 200
GET
/job/{id}/usage/
Job 실시간 소모 크레딧
job_usage_retrieve 1 param → 200
GET
/job/{id}/valid-dsns/
Result Viewer — 유효 DSN 목록
job_valid_dsns_retrieve 1 param → 200
GET
/jobs/{job_uid}/asset-publish-candidate/
jobs_asset_publish_candidate_retrieve 1 param → 200
POST
/jobs/{job_uid}/asset-submissions/
jobs_asset_submissions_create 1 param → 200
POST
/stl/convert/
STEP - STL conversion — curvature-adaptive tessellation, returns STL + metrics
stl_convert_create → 200
POST
/stl/convert-async/
비동기 STEP - STL 변환 시작 (S3 in → S3 out)
stl_convert_async_create → 200
GET
/stl/convert-async/{task_uid}/
비동기 STEP 변환 상태 조회
stl_convert_async_retrieve 1 param → 200
POST
/stl/repair/
STL watertight repair — weld/fill/pymeshfix, returns repaired STL + metrics
stl_repair_create → 200
job 4
GET
/job/{id}/export-step/
GET /job/{id}/export-step Morphed-CAD export for STEP-imported projects: bakes the optimization result back into the ORIGINAL STEP assembly (moving parts' NURBS poles displaced by the job's own basel…
job_export_step_retrieve 1 param → 200
GET
/job/{id}/flowfield/
GET /job/{id}/flowfield Presigned URL for {output}/flowfield.bin — the compact quantized velocity volume (VFLD) the viewer integrates streamlines from CLIENT-side, so dragging the seed rake costs no…
job_flowfield_retrieve 1 param → 200
GET
/job/by-uid/{uid}/
Job UID 상세 조회
job_by_uid_retrieve 1 param → 200
POST
/job/unified/
POST /job/unified/ — the canonical job submission endpoint. (§0.1-1 / §3.2) 이 엔드포인트의 유일한 인가 수단인 팀 멤버십 게이트를 뷰 서두에서 건다. 멤버십은 반드시 대상 리소스가 실제 속한 팀 (project.teamid) 기준으로 해석한다 — JWT teamid 를 쓰면 팀 A JWT 로 팀…
job_unified_create → 200
les 23
POST
/les/autoconfig/
STL 을 한 번 올려 자동설정 제안을 요청한다. 형상 분석(trimesh)은 500MB 입력에서 수십 초가 걸리므로 여기서는 S3 스테이징만 하고 Celery 로 넘긴다. 프론트는 uid 로 폴링한다.
les_autoconfig_create → 200
GET
/les/autoconfig/{uid}/
les_autoconfig_retrieve 1 param → 200
POST
/les/autoconfig/{uid}/upload/abort/
중단된 업로드의 파트를 지운다 — 두면 스토리지 비용으로 남는다.
les_autoconfig_upload_abort_create 1 param → 200
POST
/les/autoconfig/{uid}/upload/complete/
파트 업로드가 끝나면 객체를 확정하고 분석을 큐에 넣는다.
les_autoconfig_upload_complete_create 1 param body → 202
POST
/les/autoconfig/upload/init/
자동설정 STL 의 멀티파트 업로드를 연다. 파일은 Django 를 통과하지 않는다 — 브라우저가 프리사인 URL 로 S3 에 직접 병렬 전송한다. 500MB STL 이 앱 서버를 통째로 지나가면 업로드 하나에 수 분이 걸리고, 그 동안 워커는 아무것도 할 수 없다.
les_autoconfig_upload_init_create → 200
GET
/les/runs/
les_runs_retrieve → 200
POST
/les/runs/
les_runs_create → 200
GET
/les/runs/{uid}/
les_runs_retrieve_2 1 param → 200
POST
/les/runs/{uid}/cancel/
les_runs_cancel_create 1 param → 200
POST
/les/runs/{uid}/delete/
les_runs_delete_create 1 param → 200
GET
/les/runs/{uid}/deletion-preview/
les_runs_deletion_preview_retrieve 1 param → 200
GET
/les/runs/{uid}/figures/{name}/
les_runs_figures_retrieve 2 params → 200
GET
/les/runs/{uid}/files/{kind}/
les_runs_files_retrieve 2 params → 200
GET
/les/runs/{uid}/flow-visualization/
les_runs_flow_visualization_retrieve 1 param → 200
POST
/les/runs/{uid}/flow-visualization/
les_runs_flow_visualization_create 1 param → 200
GET
/les/runs/{uid}/flow-visualization/image/
les_runs_flow_visualization_image_retrieve 1 param → 200
GET
/les/runs/{uid}/flow-visualization/image/{view_id}/
les_runs_flow_visualization_image_retrieve_2 2 params → 200
POST
/les/runs/{uid}/purge-now/
les_runs_purge_now_create 1 param → 200
POST
/les/runs/{uid}/restore/
les_runs_restore_create 1 param → 200
GET
/les/runs/{uid}/viewer/
les_runs_viewer_retrieve 1 param → 200
POST
/les/uploads/{uid}/abort/
les_uploads_abort_create 1 param → 200
POST
/les/uploads/{uid}/complete/
les_uploads_complete_create 1 param body → 201
POST
/les/uploads/init/
Open an ordinary LES input upload without proxying STL bytes.
les_uploads_init_create → 200
patches 12
PUT
/patches/{id}/
Patch 수정
patches_update 1 param body → 200
DELETE
/patches/{id}/
Patch 삭제
patches_destroy 1 param → 204
GET
/patches/{id}/artifact-download-url/
Patch artifact download URL 발급
patches_artifact_download_url_retrieve 2 params → 200
POST
/patches/{id}/atlas-key/
Atlas sidecar key 저장
patches_atlas_key_create 1 param body → 200
POST
/patches/{id}/proxy-artifacts/
Proxy worker 산출물 메타데이터 갱신
patches_proxy_artifacts_create 1 param body → 200
POST
/patches/{id}/proxy-artifacts/presign/
Source proxy artifact upload URL 발급
patches_proxy_artifacts_presign_create 1 param body → 200
POST
/patches/{id}/proxy-layout-key/
Proxy layout sidecar key 저장
patches_proxy_layout_key_create 1 param body → 200
POST
/patches/{id}/proxy-mask/finalize/
Proxy mask upload completion
patches_proxy_mask_finalize_create 1 param body → 200
POST
/patches/{id}/proxy-mesh-key/
Proxy mesh sidecar key 저장
patches_proxy_mesh_key_create 1 param body → 200
POST
/patches/{id}/source-artifacts/
Source proxy artifact set finalize
patches_source_artifacts_create 1 param body → 200
POST
/patches/{id}/unmerge/
Source patch 병합 해제
patches_unmerge_create 1 param body → 200
POST
/patches/merge/
Source patch 병합
patches_merge_create body → 202
plans 16
GET
/plans/
플랜 목록
plans_list 2 params → 200
GET
/plans/{code}/
플랜 단건 조회
plans_retrieve 2 params → 200
POST
/plans/{code}/downgrade/
플랜 다운그레이드 예약 — 사이클 종료 시 적용
plans_downgrade_create 1 param body → 201
POST
/plans/{code}/subscribe/
구독 시작 — 빌링키 첫 결제 후 ACTIVE 전환 + SUBSCRIPTION credit 발급
plans_subscribe_create 1 param body → 201
POST
/plans/{code}/upgrade/
플랜 업그레이드 — 즉시 권한 + 차액 결제 + 실제 청구 견적 반환
plans_upgrade_create 1 param body → 200
GET
/plans/{code}/upgrade-quote/
플랜 업그레이드 사전 견적 — 백엔드 일할 계산/부가세/청구액 SOT
plans_upgrade_quote_retrieve 3 params → 200
GET
/subscriptions/
팀 구독 조회 — 활성/예약/만료 분리해 반환
subscriptions_list 1 param → 200
POST
/subscriptions/cancel/
구독 해지 예약 — 사이클 종료 시 EXPIRED
subscriptions_cancel_create body → 200
GET
/subscriptions/cycles/
팀의 구독 사이클 이력
subscriptions_cycles_list 2 params → 200
GET
/subscriptions/plan-gate/
팀의 실행 가능 플랜 여부
subscriptions_plan_gate_retrieve 1 param → 200
POST
/subscriptions/resume/
구독 해지 예약 취소 — CANCELLED → ACTIVE
subscriptions_resume_create body → 200
GET
/subscriptions/solver-access/
팀의 현재 Solver 권한 (실시간 조회)
subscriptions_solver_access_retrieve 1 param → 200
GET
/subscriptions/storage-addon/
팀 스토리지 애드온 조회
subscriptions_storage_addon_retrieve 1 param → 200
POST
/subscriptions/storage-addon/change/
팀 스토리지 애드온 감량 또는 해지 예약 (다음 결제 주기 적용)
subscriptions_storage_addon_change_create body → 200
POST
/subscriptions/storage-addon/purchase/
팀 스토리지 애드온 즉시 구매 (현재 구독 주기 종료일까지 일할 청구)
subscriptions_storage_addon_purchase_create body → 201
GET
/subscriptions/storage-addon/quote/
팀 스토리지 애드온 일할 견적
subscriptions_storage_addon_quote_retrieve 3 params → 200
presigned_url 2
POST
/presigned_url/
미리 서명된 URL 발급
presigned_url_create body → 201
GET
/presigned_url/download/
다운로드용 미리 서명된 URL 발급
presigned_url_download_retrieve 1 param → 200
projects 25
GET
/projects/
프로젝트 목록 조회
projects_list 4 params → 200
POST
/projects/
projects_create body → 201
GET
/projects/{id}/
projects_retrieve 1 param → 200
PUT
/projects/{id}/
projects_update 1 param body → 200
DELETE
/projects/{id}/
projects_destroy 1 param → 204
POST
/projects/{id}/activate/
Activate draft project
projects_activate_create 1 param body → 200
DELETE
/projects/{id}/artifacts/{artifact_id}/
projects_artifacts_destroy 2 params → 204
GET
/projects/{id}/deletion-preview/
프로젝트 삭제 영향 미리보기
projects_deletion_preview_retrieve 1 param → 200
POST
/projects/{id}/geometry-rotation/
저장된 group transform의 proxy mesh geometry 계산
projects_geometry_rotation_create 1 param body → 200
GET
/projects/{id}/jobs/
프로젝트의 Job 목록 조회
projects_jobs_list 7 params → 200
GET
/projects/{id}/mesh-predict/
프로젝트 mesh cell 예측
projects_mesh_predict_retrieve 1 param → 200
POST
/projects/{id}/patches/ref/
Create ref patch
projects_patches_ref_create 1 param body → 201
POST
/projects/{id}/purge-now/
프로젝트 즉시 영구 삭제 접수
projects_purge_now_create 1 param body → 200
POST
/projects/{id}/restore/
삭제 예정 프로젝트 복구
projects_restore_create 1 param body → 200
POST
/projects/{id}/thumbnail/
Register project thumbnail
projects_thumbnail_create 1 param body → 200
GET
/projects/{id}/workbench-runtime/
프로젝트 워크벤치 runtime 조회
projects_workbench_runtime_retrieve 1 param → 200
GET
/projects/{id}/workbench-state/
프로젝트 워크벤치 state 조회/저장
projects_workbench_state_retrieve 1 param → 200
PUT
/projects/{id}/workbench-state/
프로젝트 워크벤치 state 조회/저장
projects_workbench_state_update 1 param body → 200
POST
/projects/{project_id}/register-stl/
STL Artifact 등록
projects_register_stl_create 1 param body → 201400404
POST
/projects/{project_id}/source-uploads/abort/
projects_source_uploads_abort_create 1 param body → 200
POST
/projects/{project_id}/source-uploads/complete/
projects_source_uploads_complete_create 1 param body → 201
POST
/projects/{project_id}/source-uploads/init/
projects_source_uploads_init_create 1 param body → 201
GET
/projects/{project_uid}/download-quota/
프로젝트 공유 다운로드 잔여 횟수
projects_download_quota_retrieve 1 param → 200
POST
/projects/{project_uid}/downloads/
프로젝트 결과 다운로드 ticket 발급
projects_downloads_create 1 param body → 200
GET
/projects/by-uid/{uid}/
프로젝트 UID 상세 조회
projects_by_uid_retrieve 1 param → 200
racing 6
POST
/racing/executions/{execution_uid}/
racing_executions_create 1 param → 200
GET
/racing/jobs/
racing_jobs_retrieve → 200
POST
/racing/sessions/
racing_sessions_create body → 201202
GET
/racing/sessions/{session_uid}/
racing_sessions_retrieve 1 param → 200
POST
/racing/sessions/{session_uid}/feedback/
racing_sessions_feedback_create 1 param body → 200
POST
/racing/sessions/{session_uid}/laps/
racing_sessions_laps_create 1 param body → 200201
sample-stls 2
GET
/sample-stls/
Sample STL 목록 조회
sample_stls_list → 200
GET
/sample-stls/{sample_id}/download/
Sample STL 다운로드 URL 발급
sample_stls_download_retrieve 1 param → 200
sketch 14
POST
/sketch/projects/
Create an editable Sketch 2D project
sketch_projects_create body → 201
GET
/sketch/projects/{project_uid}/sessions/
List Sketch 2D sessions for a project
sketch_projects_sessions_retrieve 1 param → 200
GET
/sketch/projects/{project_uid}/state/
sketch_projects_state_retrieve 1 param → 200
PUT
/sketch/projects/{project_uid}/state/
sketch_projects_state_update 1 param body → 200
POST
/sketch/renderings/
선화 한 장을 사실적 렌더로 바꿔 돌려준다. 형상은 클라이언트의 3D 차체가 이미 정했다. 여기서 생성 모델이 하는 일은 재질과 빛을 입히는 것뿐이고, 프롬프트가 실루엣·시점 보존을 강제한다 — 그래야 여러 시점의 렌더가 같은 차를 가리키고, 같은 차체에서 나온 공력 지표와도 어긋나지 않는다.
sketch_renderings_create → 200
POST
/sketch/sessions/
Create a Sketch 2D session
sketch_sessions_create body → 201
GET
/sketch/sessions/{job_uid}/
Get a Sketch 2D session
sketch_sessions_retrieve 1 param → 200
POST
/sketch/sessions/{job_uid}/cancel/
sketch_sessions_cancel_create 1 param → 200
POST
/sketch/sessions/{job_uid}/conditions/
Create a new Sketch Job from a source Job with changed conditions
sketch_sessions_conditions_create 1 param body → 202
GET
/sketch/sessions/{job_uid}/events/
Stream Sketch 2D frames as SSE
sketch_sessions_events_retrieve 2 params → 200
POST
/sketch/sessions/{job_uid}/finish/
sketch_sessions_finish_create 1 param → 200
POST
/sketch/sessions/{job_uid}/geometry/
Create a new Sketch Job from a source Job with changed geometry
sketch_sessions_geometry_create 1 param body → 202
POST
/sketch/sessions/{job_uid}/heartbeat/
sketch_sessions_heartbeat_create 1 param → 204
POST
/sketch/sessions/{job_uid}/stream-ticket/
Issue a short-lived, Job-scoped credential for the binary stream relay.
sketch_sessions_stream_ticket_create 1 param → 200
teams 11
GET
/teams/
teams_retrieve → 200
POST
/teams/
teams_create → 200
PATCH
/teams/{team_id}/
teams_partial_update 1 param → 200
DELETE
/teams/{team_id}/
teams_destroy 1 param → 204
GET
/teams/{team_id}/invitations/
미가입 이메일을 팀에 초대. 가입된 유저는 TeamMemberListCreateView(members API)로 바로 추가하고, 이 API는 아직 계정이 없는 이메일에게 초대장 메일을 보내는 용도다.
teams_invitations_retrieve 1 param → 200
POST
/teams/{team_id}/invitations/
미가입 이메일을 팀에 초대. 가입된 유저는 TeamMemberListCreateView(members API)로 바로 추가하고, 이 API는 아직 계정이 없는 이메일에게 초대장 메일을 보내는 용도다.
teams_invitations_create 1 param → 200
DELETE
/teams/{team_id}/invitations/{id}/
teams_invitations_destroy 2 params → 204
GET
/teams/{team_id}/members/
teams_members_retrieve 1 param → 200
POST
/teams/{team_id}/members/
teams_members_create 1 param → 200
PATCH
/teams/{team_id}/members/{id}/
teams_members_partial_update 2 params → 200
DELETE
/teams/{team_id}/members/{id}/
teams_members_destroy 2 params → 204
subscriptions 2
GET
/teams/{team_uid}/retained-results/
구독 종료 팀의 결과 다운로드 목록
teams_retained_results_retrieve 1 param → 200
POST
/teams/{team_uid}/retained-results/{artifact_uid}/download-url/
구독 종료 팀의 승인된 결과 Artifact 다운로드 URL
teams_retained_results_download_url_create 2 params → 200
tenants 1
POST
/tenants/exists/
tenants_exists_create → 200
uploads 6
GET
/uploads/
uploads_list 2 params → 200
POST
/uploads/
uploads_create body → 201
GET
/uploads/{id}/
uploads_retrieve 1 param → 200
PUT
/uploads/{id}/
uploads_update 1 param body → 200
PATCH
/uploads/{id}/
uploads_partial_update 1 param body → 200
DELETE
/uploads/{id}/
uploads_destroy 1 param → 204
verifier 2
POST
/verifier/email_verifier/
이메일 인증 ---
verifier_email_verifier_create body → 201
POST
/verifier/email_verifier/confirm/
이메일 인증 확인 --- 응답값의 token값으로 회원가입의 emailToken으로 사용
verifier_email_verifier_confirm_create body → 201

Schemas 185

The contract defines 185 schemas that model the data the API accepts and returns. The most detailed are Patch (43 properties), Job (38 properties), JobList (29 properties), Project (28 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adro1b33-aox-openapi.yaml Raw ↑
Where this information came from

This is an independent, third-party profile of AOX Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.