agent-swarm.devagent-swarm.dev

Apps

Apps API endpoints

GET
/api/apps

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

curl -X GET "http://localhost:3013/api/apps"
{
  "apps": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
POST
/api/apps

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/apps" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "app": {
    "id": "string",
    "name": "string",
    "description": "string",
    "definition": {
      "property1": null,
      "property2": null
    },
    "definitionError": [
      {
        "path": "string",
        "message": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE
/api/apps/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/apps/string"
{
  "ok": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/apps/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/apps/string"
{
  "app": {
    "id": "string",
    "name": "string",
    "description": "string",
    "definition": {
      "property1": null,
      "property2": null
    },
    "definitionError": [
      {
        "path": "string",
        "message": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  },
  "syncStatus": {
    "property1": {
      "lastStartedAt": "string",
      "lastFinishedAt": "string",
      "ok": true,
      "created": 0,
      "updated": 0,
      "refreshed": 0,
      "markedStale": 0,
      "error": "string"
    },
    "property2": {
      "lastStartedAt": "string",
      "lastFinishedAt": "string",
      "ok": true,
      "created": 0,
      "updated": 0,
      "refreshed": 0,
      "markedStale": 0,
      "error": "string"
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PATCH
/api/apps/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3013/api/apps/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "app": {
    "id": "string",
    "name": "string",
    "description": "string",
    "definition": {
      "property1": null,
      "property2": null
    },
    "definitionError": [
      {
        "path": "string",
        "message": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  },
  "migration": {
    "scanned": 0,
    "backfilled": 0,
    "coerced": 0,
    "mapped": 0,
    "elsed": 0,
    "purgedValues": 0,
    "idxRebuilt": 0,
    "detachedRows": 0,
    "orphanFields": [
      "string"
    ],
    "userConfigChanged": [
      "string"
    ]
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PUT
/api/apps/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3013/api/apps/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "app": {
    "id": "string",
    "name": "string",
    "description": "string",
    "definition": {
      "property1": null,
      "property2": null
    },
    "definitionError": [
      {
        "path": "string",
        "message": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  },
  "migration": {
    "scanned": 0,
    "backfilled": 0,
    "coerced": 0,
    "mapped": 0,
    "elsed": 0,
    "purgedValues": 0,
    "idxRebuilt": 0,
    "detachedRows": 0,
    "orphanFields": [
      "string"
    ],
    "userConfigChanged": [
      "string"
    ]
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/apps/{id}/actions/{name}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
name*string
Match^[a-z][a-zA-Z0-9_]{0,39}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/apps/string/actions/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "ok": true,
  "result": null,
  "stdout": "string",
  "error": "string",
  "durationMs": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/apps/{id}/models/{model}/rows

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
model*string
Match^[a-z][a-zA-Z0-9_]{0,39}$

Query Parameters

sort?string
limit?integer
Range0 < value <= 1000

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/apps/string/models/string/rows"
{
  "rows": [
    {
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "property1": null,
      "property2": null
    }
  ],
  "total": 0
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/apps/{id}/models/{model}/rows

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
model*string
Match^[a-z][a-zA-Z0-9_]{0,39}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/apps/string/models/string/rows" \  -H "Content-Type: application/json" \  -d '{    "values": {      "property1": null,      "property2": null    }  }'
{
  "row": {
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE
/api/apps/{id}/models/{model}/rows/{rowId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
model*string
Match^[a-z][a-zA-Z0-9_]{0,39}$
rowId*string
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/apps/string/models/string/rows/string"
{
  "ok": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/apps/{id}/models/{model}/rows/{rowId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
model*string
Match^[a-z][a-zA-Z0-9_]{0,39}$
rowId*string
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/apps/string/models/string/rows/string"
{
  "row": {
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PATCH
/api/apps/{id}/models/{model}/rows/{rowId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
model*string
Match^[a-z][a-zA-Z0-9_]{0,39}$
rowId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3013/api/apps/string/models/string/rows/string" \  -H "Content-Type: application/json" \  -d '{    "values": {      "property1": null,      "property2": null    }  }'
{
  "row": {
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/apps/{id}/models/{model}/rows/bulk

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
model*string
Match^[a-z][a-zA-Z0-9_]{0,39}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/apps/string/models/string/rows/bulk" \  -H "Content-Type: application/json" \  -d '{    "rows": [      {        "values": {          "property1": null,          "property2": null        }      }    ]  }'
{
  "rows": [
    {
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "property1": null,
      "property2": null
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/apps/{id}/queries/{name}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
name*string
Match^[a-z][a-zA-Z0-9_]{0,39}$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/apps/string/queries/string"
{
  "rows": [
    {
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "property1": null,
      "property2": null
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/apps/{id}/rollback

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/apps/string/rollback" \  -H "Content-Type: application/json" \  -d '{    "version": 0  }'
{
  "app": {
    "id": "string",
    "name": "string",
    "description": "string",
    "definition": {
      "property1": null,
      "property2": null
    },
    "definitionError": [
      {
        "path": "string",
        "message": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  },
  "migration": {
    "scanned": 0,
    "backfilled": 0,
    "coerced": 0,
    "mapped": 0,
    "elsed": 0,
    "purgedValues": 0,
    "idxRebuilt": 0,
    "detachedRows": 0,
    "orphanFields": [
      "string"
    ],
    "userConfigChanged": [
      "string"
    ]
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/apps/{id}/sync

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/apps/string/sync" \  -H "Content-Type: application/json" \  -d '{}'
{
  "ok": true,
  "passes": [
    {
      "model": "string",
      "source": "string",
      "connector": "script",
      "pulled": 0,
      "created": 0,
      "updated": 0,
      "refreshed": 0,
      "unchanged": 0,
      "markedStale": 0,
      "staleSweepSkipped": true,
      "warnings": [
        "string"
      ],
      "durationMs": 0,
      "invokedBy": "string",
      "error": "string",
      "skipped": true,
      "alreadyRunning": true
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/apps/{id}/user-config

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/apps/string/user-config"
{
  "values": {
    "property1": "string",
    "property2": "string"
  },
  "schema": {
    "property1": {
      "kind": "string",
      "default": "string",
      "enum": [
        "string"
      ],
      "label": "string"
    },
    "property2": {
      "kind": "string",
      "default": "string",
      "enum": [
        "string"
      ],
      "label": "string"
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
PUT
/api/apps/{id}/user-config

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3013/api/apps/string/user-config" \  -H "Content-Type: application/json" \  -d '{    "values": {      "property1": null,      "property2": null    }  }'
{
  "values": {
    "property1": "string",
    "property2": "string"
  },
  "schema": {
    "property1": {
      "kind": "string",
      "default": "string",
      "enum": [
        "string"
      ],
      "label": "string"
    },
    "property2": {
      "kind": "string",
      "default": "string",
      "enum": [
        "string"
      ],
      "label": "string"
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/apps/{id}/versions

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/apps/string/versions"
{
  "versions": [
    {
      "id": "string",
      "appId": "string",
      "version": 0,
      "snapshot": null,
      "changedByAgentId": "string",
      "createdAt": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/apps/{id}/versions/{version}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length
version*integer
Range0 < value

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/apps/string/versions/0"
{
  "version": {
    "id": "string",
    "appId": "string",
    "version": 0,
    "snapshot": null,
    "changedByAgentId": "string",
    "createdAt": "string"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}

ApprovalRequests

Human-in-the-loop approval requests — review and respond to agent-escalated decisions

Assets

Assets API endpoints