Growth Studio OpenAPI Integration Guide · 文件夹管理

Folders are scoped to the workspace bound to the API key. Callers cannot provide or override workspace_id. Duplicate names are allowed; every create call returns a distinct folder_id.

Create a Folder

POST /openapi/v1/folders
Content-Type: application/json
Authorization: Bearer <API_KEY>
curl --request POST \
  "${BASE_URL}/openapi/v1/folders" \
  --header "Authorization: Bearer ${API_KEY}" \
  --header 'Content-Type: application/json' \
  --data-raw '{"name":"September campaign"}'

HTTP status: 201 Created

{"folder_id":"627410861853514292","request_id":"create-folder-001"}

name is the folder name. folder_id is a 64-bit ID and must be stored and transmitted as a string.

List Folders

GET /openapi/v1/folders
Authorization: Bearer <API_KEY>
curl --request GET \
  "${BASE_URL}/openapi/v1/folders" \
  --header "Authorization: Bearer ${API_KEY}"

HTTP status: 200 OK

{"folders":[{"folder_id":"627410861853514292","name":"September campaign"}],"request_id":"list-folders-001"}

folders is an array of non-deleted folder objects in the API key workspace. Each item contains folder_id and name; an empty result returns []. Results are newest first, but callers must not rely on the order.

Folder Errors and Rate Limits

FOLDER_NOT_FOUND: HTTP 404 when a folder used for video creation is absent, deleted, or outside the current workspace. FOLDER_LIMIT_EXCEEDED: HTTP 409 when a workspace reaches 500 folders.

POST /openapi/v1/folders: 200 requests/minute. GET /openapi/v1/folders: 60 requests/minute. Both limits are per API key and endpoint.