List published Apps

GET/openapi/v1/apps

GET /openapi/v1/apps?projectId={projectId}&pageNo=1&pageSize=20
Authorization: Bearer <API_KEY>

Request parameters

Parameter	Location	Type	Required	Description
`projectId`	Query	`string`	Yes	Project ID; the current account must be able to edit this project
`pageNo`	Query	`integer`	No	Page number, default `1`, range `1`–`10000`
`pageSize`	Query	`integer`	No	Items per page, default `20`, range `1`–`100`

The endpoint returns active, accessible Apps with a published version in the specified project. Results include both online and offline Apps. A missing, unavailable, or non-editable project returns PROJECT_NOT_FOUND. Pagination values outside the allowed range return INVALID_REQUEST.

The success status is HTTP 200.

Success response example

{

"code": 200,

"message": "success",

"data": {

"total": 1,

"pageNo": 1,

"pageSize": 20,

"items": [

{

"projectId": "PROJECT_ID",

"appId": "APP_ID",

"name": "Fashion Video Generator",

"description": "Generate a video from a character reference and prompt",

"assetMode": "public_copy",

"publishStatus": "online",

"publishFlag": 1,

"coverImage": "https://example.com/cover.jpg"

}

]

}

integerProtocol field, currently fixed at 200

stringFixed at success on success

objectPaginated result

integerTotal number of matching Apps

integerCurrent page number

integerCurrent page size

arrayApp summaries on the current page

stringProject ID that owns the App

stringApp ID, used to get App details and create Runs

stringApp name

stringDescription of the App's purpose

stringAccess mode: project_only, public_copy, or public_run_only

stringPublication status: online or offline

integerPublished flag, always 1 for items returned by this endpoint

stringApp cover URL; omitted when no cover is available

When the current page has no data, the API returns data.items: []. No fixed sort order is guaranteed, so clients must not identify an App by its list position. Store and use appId. Before creating a Run, call Get App details and follow its current parameter definitions and availability.

assetMode values

Value	Meaning
`project_only`	Only project members can view, run, and manage the App and its workflow
`public_copy`	Publicly listed; other users can run and copy the App and its workflow
`public_run_only`	Publicly listed; external users can submit inputs and view their own results, but cannot view or copy the workflow

Code examples

The examples below use the MAXDAY_API_KEY and MAXDAY_PROJECT_ID environment variables.

curl --fail-with-body \
  "https://api.maxday.ai/bio/dramas/v1/openapi/v1/apps?projectId=${MAXDAY_PROJECT_ID}&pageNo=1&pageSize=20" \
  --header "Authorization: Bearer ${MAXDAY_API_KEY}"

// API URL, credentials, and target Project ID.
const baseUrl = "https://api.maxday.ai/bio/dramas/v1";
const apiKey = process.env.MAXDAY_API_KEY;
const projectId = process.env.MAXDAY_PROJECT_ID;

// Encode the paginated query with URLSearchParams.
const query = new URLSearchParams({
  projectId,
  pageNo: "1",
  pageSize: "20",
});
// Response containing the current project's published Apps.
const response = await fetch(`${baseUrl}/openapi/v1/apps?${query}`, {
  headers: {
    Authorization: `Bearer ${apiKey}`,
  },
});
// Parsed response envelope.
const body = await response.json();

if (!response.ok || body.message !== "success") {
  throw new Error(body.data?.error?.message || body.message || `HTTP ${response.status}`);
}
console.log(body.data.items);

import json
import os
from urllib.parse import urlencode
from urllib.request import Request, urlopen

# Encode the Project ID and pagination as a query string.
query = urlencode(
    {
        "projectId": os.environ["MAXDAY_PROJECT_ID"],
        "pageNo": 1,
        "pageSize": 20,
    }
)
# Build an authenticated query request.
request = Request(
    "https://api.maxday.ai/bio/dramas/v1/openapi/v1/apps?" + query,
    headers={"Authorization": "Bearer " + os.environ["MAXDAY_API_KEY"]},
)

with urlopen(request, timeout=60) as response:
    # Parsed response envelope.
    body = json.load(response)

if body.get("message") != "success":
    error = body.get("data", {}).get("error", {})
    raise RuntimeError(error.get("message") or body.get("message"))
print(json.dumps(body["data"]["items"], ensure_ascii=False, indent=2))

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public final class ListPublishedAppsExample {
  /** Lists the current page of published Apps in the target project. */
  public static void main(String[] args) throws Exception {
    // JSON parser, API Key, and target Project ID.
    ObjectMapper json = new ObjectMapper();
    String apiKey = System.getenv("MAXDAY_API_KEY");
    String projectId = System.getenv("MAXDAY_PROJECT_ID");
    // URL-encoded Project ID.
    String encodedProjectId = URLEncoder.encode(projectId, StandardCharsets.UTF_8);
    // Request URL containing pagination parameters.
    URI uri = URI.create(
        "https://api.maxday.ai/bio/dramas/v1/openapi/v1/apps?projectId="
            + encodedProjectId
            + "&pageNo=1&pageSize=20"
    );
    // Authenticated query request.
    HttpRequest request = HttpRequest.newBuilder(uri)
        .header("Authorization", "Bearer " + apiKey)
        .GET()
        .build();
    // Response containing the current project's published Apps.
    HttpResponse<String> response = HttpClient.newHttpClient().send(
        request,
        HttpResponse.BodyHandlers.ofString()
    );
    // Parsed response envelope.
    JsonNode body = json.readTree(response.body());

    if (response.statusCode() < 200 || response.statusCode() >= 300
        || !"success".equals(body.path("message").asText())) {
      throw new IllegalStateException(
          body.path("data").path("error").path("message").asText(
              body.path("message").asText("HTTP " + response.statusCode())
          )
      );
    }
    System.out.println(body.path("data").path("items").toPrettyString());
  }
}