Every MIOSA API endpoint is REST over HTTPS, returns JSON, and follows a consistent envelope format. The SDKs wrap these endpoints - you can use them directly when you need low-level control or want to integrate from a language without an official SDK.

Base URL

https://api.miosa.ai/api/v1

Authentication

All requests require a Bearer token:

Authorization: Bearer msk_live_...

MIOSA API keys (msk_*) and short-lived JWT tokens are both accepted. Keys are scoped to an organization and its workspaces/projects. See API Keys for scope details.

Request format

• Content-Type: application/json for all request bodies.
• File uploads use multipart/form-data.
• All field names are snake_case.
• Mutation requests (POST, PUT, PATCH, DELETE) should include an Idempotency-Key header to enable safe retries:

POST /api/v1/sandboxes
Authorization: Bearer msk_live_...
Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000
Content-Type: application/json

{
  "template": "miosa-sandbox",
  "workspace_slug": "dr-smith-clinic",
  "project_slug": "lead-magnet",
  "external_workspace_id": "clinic_123",
  "external_user_id": "dr-smith-456",
  "external_project_id": "project_789"
}

Use a UUID v4 as the idempotency key. Repeating the same key within 24 hours returns the original response without re-executing the mutation.

Response envelope

Single-resource responses:

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "my-sandbox",
    "status": "running",
    "created_at": "2026-05-17T10:00:00Z"
  }
}

List responses include a pagination object:

{
  "data": [ { "id": "...", "name": "..." } ],
  "page": {
    "page": 1,
    "page_size": 20,
    "total": 150
  }
}

Pagination parameters accepted by all list endpoints:

Error envelope

All errors follow a single shape:

{
  "error": {
    "code": "sandbox_not_found",
    "message": "No sandbox with id sbx_abc exists in this workspace.",
    "request_id": "req_01jv..."
  }
}

Include the request_id when contacting support.

HTTP status codes

Rate limits

IDs and timestamps

All resource IDs are UUID v4. All timestamps are ISO 8601 in UTC: 2026-05-17T10:00:00Z.

Ownership fields

Create endpoints for resources accept the same ownership selectors:

Responses include workspace_id and project_id when the resource is owned by a workspace/project. See Ownership and Attribution.

Compute

Deploy

Computers

Platform