Getting Started
Getting Started
Get up and running with Aikyora in five simple steps. From account creation to launching your first model.
Create an Account
Sign up for a free account and name your organisation. The Free plan starts you with 5 credits a month, one runner and 20 conversations.
Register a Runner
Point a workstation at your workspace so the agent has a machine to execute CadQuery, FreeCAD, Rhino, Blender, PyMeshLab and ParaView on.
Ask for the First Model
Describe the part. The agent writes a modelling script, runs it on the runner, and returns a parametric solid with named dimensions.
Revise and Export
Change a parameter and the model re-runs from source. Ask for STEP, BREP, IGES, STL or a true-scale drawing when it is right.
Watch the Credit Ledger
Every debit is raised from the tokens and runtime seconds the work actually consumed, so the ledger explains each charge.
API Reference
API Reference
All API endpoints are available under /api/v1/. Authentication is via session cookies with CSRF for the dashboard.
Authentication
Session authentication with CSRF for the dashboard. Fetch a token, sign in, and read the current user.
/api/v1/auth/csrf//api/v1/auth/register//api/v1/auth/login//api/v1/auth/me//api/v1/auth/logout/Agent
Send a turn to the agent, resume a conversation, and preview what a turn would do before it runs.
/api/v1/agent/turns//api/v1/agent/conversations/{id}/actions/resume//api/v1/agent/conversations/{id}/actions/cancel//api/v1/agent/conversations/{id}/preview/Conversations
List and read conversations, and apply an action to one.
/api/v1/conversations//api/v1/conversations/{id}//api/v1/conversations/{id}/actions/{action}/Runners
Register a machine, keep it alive, poll for work, and return results and artifacts.
/api/v1/runners/token/api/v1/runners/register/api/v1/runners/heartbeat/api/v1/runners/poll/api/v1/runners/resultArtifacts
Upload, list and download the scripts, solids, meshes and drawings a run produced, and check storage usage.
/api/v1/artifacts//api/v1/artifacts/upload//api/v1/artifacts/usage//api/v1/artifacts/{id}//api/v1/artifacts/download/{token}/Skills and Tools
Read the skill catalog, invoke a tool directly, and answer a question the agent raised mid-run.
/api/v1/skills//api/v1/skills/{name}//api/v1/tools//api/v1/tools/{name}/actions/invoke//api/v1/tools/questions/{id}/actions/answer/Billing
Read the rate card and credit packs, check the balance and ledger, and start a checkout for a plan or a top-up.
/api/v1/billing/rate-card//api/v1/billing/credit-packs//api/v1/billing/credits//api/v1/billing/credits/ledger//api/v1/billing/checkout/plan//api/v1/billing/checkout/credit-pack/Feature Graph
Create and read feature graphs, inspect DFM findings, and confirm a dimension link from a measurement.
/api/v1/feature-graph/graphs//api/v1/feature-graph/graphs/create//api/v1/feature-graph/graphs/{id}//api/v1/feature-graph/graphs/{id}/dfm-findings//api/v1/feature-graph/dimension-links/{id}/actions/confirm-from-measurement/Health
Liveness, readiness and Prometheus metrics endpoints, outside the versioned API prefix.
/health/live//health/ready//health/metrics/Guides
Guides
In-depth tutorials to help you get the most out of Aikyora.
Parametric Modelling
Describe a part and have the agent write, run and revise a CadQuery or FreeCAD script. Covers naming parameters, rebuilding on change, and exporting.
Runner Setup
Register a local workstation or enable a cloud runner so the agent has somewhere to execute the CAD tools. Covers tokens, heartbeat and polling.
Artifacts and Storage
Where scripts, solids, meshes and drawings are kept, how download tokens work, and how per-plan storage ceilings are applied.
Skills Catalog
The fifteen skills the agent can call, from cad_studio and drawing_to_3d to defeature, model_to_2d, vectorize_scan and paraview.
Credits and Billing
How a credit maps to real work, why charging happens after the turn completes, and how on-demand packs differ from a plan allowance.
Authentication
Session auth with CSRF for the dashboard, and runner registration tokens for machines that execute work on your behalf.