List apps
Lists apps in a project, sorted by name by default.
Organization or project Access Key created in the Dynamiq console. Used for deployed-app (Runs API), AI Gateway, traces collector, and management API requests. Send as Authorization: Bearer <access-key>.
In: header
Query Parameters
Project UUID (required).
Return only archived apps.
Include archived apps alongside active ones.
Filter by workflow UUID.
Page number (1-based).
Number of items per page.
Comma-separated sort fields. Prefix a field with - for descending order, e.g. sort=-started_at.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/apps?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"hostname": "string",
"runtime_id": "cb6c5dda-251e-4b64-ab75-e6c8247ffa87",
"workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe",
"workflow_version_id": "60bab57e-9f59-448d-bef4-a6fd602db8a4",
"deployment_config": {},
"access_control": {
"access_type": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"archived_at": "2019-08-24T14:15:22Z",
"archived_by": "string",
"latest_deployment_id": "bbc8a2ea-9f00-4ee5-8217-1e5745cc93d5",
"runtime": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": "string",
"label": "string"
},
"workflow": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"status": "string",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"workflow_version": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"version": 0,
"description": "string",
"workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
],
"pagination": {
"page": 0,
"page_size": 0,
"page_count": 0,
"total_count": 0
}
}{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}Stream run events (SSE)
Streams the run's events over Server-Sent Events in strict sequence order, starting from the beginning or from `after_sequence`. The stream closes after a terminal event (`run.completed`, `run.failed`, `run.canceled`). A `: heartbeat` comment is emitted every 15 seconds of inactivity.
Get an app
Returns a single app, including its hostname — the base URL for the app's Runs API.