Get App

Endpoint: Get App

This endpoint retrieves detailed information about a specific app on the RunGen.AI platform. The app is identified by its unique app_id. Use this endpoint to retrieve app details, including its status, configuration, job statistics, and worker states.

URL

GET https://api.rungen.ai/app/{app_id}

Path Parameters

Parameter	Type	Required	Description
app_id	String	Yes	The unique identifier of the app to retrieve.

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, the app is retrieved based on the user's access.

Example Request

curl --location 'https://api.rungen.ai/app/9f5b4ec7-fc6a-4872-a3ef-d0050463c7d9' \
--header 'x-api-key: 12324355'

Response

Success

Status Code: 200 OK

Response Body:

{
    "configuration": {
        "active_workers": 1,
        "gpu_tier": "STANDARD"
    },
    "created_at": "2025-01-09T16:45:34",
    "created_by": "ee4988a7-48e2-44ae-81f5-178a44ebeb58",
    "description": "This is my first app",
    "id": "9f5b4ec7-fc6a-4872-a3ef-d0050463c7d9",
    "jobs": {
        "completed": 10,
        "failed": 1,
        "in_progress": 2,
        "in_queue": 0,
        "retried": 0
    },
    "name": "My first app",
    "owner_team_id": null,
    "owner_user_id": "ee4988a7-48e2-44ae-81f5-178a44ebeb58",
    "status": "RUNNING",
    "updated_at": "2025-01-10T10:30:45",
    "workers": {
        "idle": 0,
        "initializing": 1,
        "ready": 1,
        "running": 0,
        "throttled": 0,
        "unhealthy": 0
    },
    "workflow": {
        "model_url": "https://huggingface.co/black-forest-labs/FLUX.1-schnell",
        "tools": {}
    }
}

Response Fields

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

---

Error Responses

Status Code: 404 Not Found

Example Response Body:

{
    "error": "App with ID '9f5b4ec7-fc6a-4872-a3ef-d0050463c7d9' not found."
}

Status Code: 403 Forbidden

Example Response Body:

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