Skip to main content
The Deployments API lets you push agent-built applications directly to production hosting providers. Once your workspace contains a finished build artifact, a single POST request triggers the full deployment pipeline and returns a live URL when complete.
Before triggering a deployment, you must configure at least one deploy target in the Miteos dashboard. Each target requires you to authorize the relevant hosting provider and select a default project or team.

​
Authentication

All requests require a Bearer token in the Authorization header. 
Authorization: Bearer mt_live_xxx
Use mt_test_xxx tokens to trigger deployments in sandbox mode — no files are pushed to the hosting provider and the returned url is a preview stub.

​
POST /deployments

Trigger a new deployment for a workspace. The API queues a build job, pushes the output to your chosen target, and returns the deployment record immediately with status: pending.

​
Request

​
workspace_id
string
required
The ID of the workspace whose build artifact you want to deploy.
​
target
string
required
The hosting provider to deploy to. Accepted values: vercel, netlify, cloudflare, expo.
​
config_id
string
required
The ID of the deploy configuration to use. Configurations are created and managed in the dashboard under Settings → Deployments.

​
Response

​
id
string
Unique identifier for this deployment record.
​
workspace_id
string
The workspace that was deployed.
​
target
string
The hosting provider the build was pushed to.
​
status
string
Current pipeline status. One of pending, building, deploying, live, or failed.
​
url
string
The public URL for the deployment. Populated once status reaches live; null before that.
​
created_at
string
ISO 8601 timestamp of when the deployment was triggered.
​
completed_at
string
ISO 8601 timestamp of when the pipeline finished (success or failure). null while the deployment is still in progress.

​
Examples

curl --request POST \
  --url https://api.miteos.com/v1/deployments \
  --header 'Authorization: Bearer mt_live_xxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspace_id": "ws_01hx4k2m8n",
    "target": "vercel",
    "config_id": "cfg_9v3pqr7t"
  }'
Example Response
{
  "id": "dep_7z9wq1lc",
  "workspace_id": "ws_01hx4k2m8n",
  "target": "vercel",
  "status": "pending",
  "url": null,
  "created_at": "2024-11-14T10:22:05Z",
  "completed_at": null
}

​
GET /deployments

Return a paginated list of all deployments across your account, ordered by created_at descending.

​
Examples

curl --request GET \
  --url https://api.miteos.com/v1/deployments \
  --header 'Authorization: Bearer mt_live_xxx'
Example Response
{
  "data": [
    {
      "id": "dep_7z9wq1lc",
      "workspace_id": "ws_01hx4k2m8n",
      "target": "vercel",
      "status": "live",
      "url": "https://my-agent-app.vercel.app",
      "created_at": "2024-11-14T10:22:05Z",
      "completed_at": "2024-11-14T10:24:38Z"
    },
    {
      "id": "dep_4a1mn8xp",
      "workspace_id": "ws_02bc9z7r1k",
      "target": "netlify",
      "status": "failed",
      "url": null,
      "created_at": "2024-11-13T08:01:44Z",
      "completed_at": "2024-11-13T08:03:11Z"
    }
  ],
  "has_more": false
}

​
GET /deployments/

Retrieve a single deployment by its ID. Poll this endpoint to track progress through the pipeline stages.

​
Path Parameters

​
id
string
required
The deployment ID returned when the deployment was created.

​
Deployment Status Reference

StatusDescription
pendingJob queued, waiting for a build runner
buildingRunning the build step (install, compile, bundle)
deployingUploading the build artifact to the hosting provider
liveDeployment is publicly accessible at url
failedPipeline encountered an error; check dashboard logs for details
For time-sensitive workflows, poll GET /deployments/{id} every 5 seconds. Typical deployments move from pending to live in under 3 minutes.

​
Examples

curl --request GET \
  --url https://api.miteos.com/v1/deployments/dep_7z9wq1lc \
  --header 'Authorization: Bearer mt_live_xxx'
Example Response
{
  "id": "dep_7z9wq1lc",
  "workspace_id": "ws_01hx4k2m8n",
  "target": "vercel",
  "status": "live",
  "url": "https://my-agent-app.vercel.app",
  "created_at": "2024-11-14T10:22:05Z",
  "completed_at": "2024-11-14T10:24:38Z"
}