Get Apps

Endpoint: Get Apps

This endpoint retrieves a list of all apps associated with the authenticated user or team. Each app contains its configuration, workflow, status, job statistics, and other metadata.

URL

GET https://api.rungen.ai/app

Headers

Header	Type	Required	Description
x-api-key	String	Yes	Your API key for authentication.
x-team-id	String	No	The unique identifier for the team. If omitted, only user-specific apps are retrieved.

Example Request

curl --location 'https://api.rungen.ai/app' \
--header 'x-api-key: 12324234'

Response

Success

Status Code: 200 OK

Response Body:

{
    "data": [
        {
            "configuration": {
                "active_workers": 0,
                "gpu_tier": "STANDARD"
            },
            "created_at": "2025-01-09T16:45:34",
            "created_by": "ee4988a7-48e2-44ae-81f5-178a44ebeb58",
            "description": "This is my first app",
            "id": "745f7dc0-cd5a-488e-98ce-7d48c624060a",
            "jobs": {
                "completed": 0,
                "failed": 0,
                "in_progress": 0,
                "in_queue": 0,
                "retried": 0
            },
            "name": "My first app",
            "owner_team_id": null,
            "owner_user_id": "ee4988a7-48e2-44ae-81f5-178a44ebeb58",
            "status": "STOPPED",
            "updated_at": "2025-01-09T16:45:34",
            "workers": {
                "idle": 0,
                "initializing": 0,
                "ready": 0,
                "running": 0,
                "throttled": 0,
                "unhealthy": 0
            },
            "workflow": {
                "model_url": "https://huggingface.co/black-forest-labs/FLUX.1-schnell",
                "tools": {}
            }
        }
    ]
}

Response Fields

Field	Type	Description
data	Array	A list of apps associated with the user or team.
data[].configuration	Object	Configuration details for the app.
data[].configuration.active_workers	Integer	Number of active workers.
data[].configuration.gpu_tier	String	GPU identifiers for the app.
data[].created_at	String	ISO timestamp when the app was created.
data[].created_by	String	User ID of the creator.
data[].description	String	Description of the app.
data[].id	String	Unique identifier for the app.
data[].jobs	Object	Statistics about jobs associated with the app.
data[].jobs.completed	Integer	Number of completed jobs.
data[].jobs.failed	Integer	Number of failed jobs.
data[].jobs.in_progress	Integer	Number of jobs currently in progress.
data[].jobs.in_queue	Integer	Number of jobs in the queue.
data[].jobs.retried	Integer	Number of retried jobs.
data[].name	String	Name of the app.
data[].owner_team_id	String	ID of the team owning the app (if applicable).
data[].owner_user_id	String	ID of the user owning the app.
data[].status	String	Current status of the app (e.g., STOPPED).
data[].updated_at	String	ISO timestamp when the app was last updated.
data[].workers	Object	Details about the workers associated with the app.
data[].workers.idle	Integer	Number of idle workers.
data[].workers.initializing	Integer	Number of workers initializing.
data[].workers.ready	Integer	Number of workers ready for jobs.
data[].workers.running	Integer	Number of workers currently running.
data[].workers.throttled	Integer	Number of workers throttled due to resource limits.
data[].workers.unhealthy	Integer	Number of workers marked as unhealthy.
data[].workflow	Object	Workflow details for the app.
data[].workflow.model_url	String	URL of the model used in the workflow.
data[].workflow.tools	Object	Additional tools configured for the workflow.

---

Error Responses

Status Code: 403 Forbidden

Example Response Body:

{
    "error": "Unauthorized access. Invalid API key."
}

---

Notes

• jobs and workers provide insights into the operational state of the app and its execution history.