Skip to content
FLORA FLORA API
FLORA DocsGo to app
API Reference

Projects

List workspace projects
client.projects.list(ProjectListParams { workspace_id, cursor, limit, query } query, RequestOptionsoptions?): ProjectsCursorPage<ProjectListResponse { created_at, last_modified, name, 3 more } >
GET/projects
Create a project
client.projects.create(ProjectCreateParams { name, workspace_id } body, RequestOptionsoptions?): ProjectCreateResponse { created_at, last_modified, name, 3 more }
POST/projects
Get a project
client.projects.retrieve(stringprojectID, RequestOptionsoptions?): ProjectRetrieveResponse { created_at, last_modified, name, 3 more }
GET/projects/{projectId}
List project canvas nodes
client.projects.listNodes(stringprojectID, ProjectListNodesParams { cursor, limit } query?, RequestOptionsoptions?): CanvasNodesCursorPage<ProjectListNodesResponse { node_id, type, asset_id, 4 more } >
GET/projects/{projectId}/nodes
ModelsExpand Collapse
ProjectListResponse { created_at, last_modified, name, 3 more }
created_at: number
last_modified: number | null
name: string

Project name

origin: string | null

Project origin

project_id: string

Project identifier

workspace_id: string

Workspace identifier

ProjectCreateResponse { created_at, last_modified, name, 3 more }
created_at: number
last_modified: number | null
name: string

Project name

origin: string | null

Project origin

project_id: string

Project identifier

workspace_id: string

Workspace identifier

ProjectRetrieveResponse { created_at, last_modified, name, 3 more }
created_at: number
last_modified: number | null
name: string

Project name

origin: string | null

Project origin

project_id: string

Project identifier

workspace_id: string

Workspace identifier

ProjectListNodesResponse { node_id, type, asset_id, 4 more }
node_id: string

Canvas node identifier

minLength1
type: "image" | "video" | "audio" | "text"

Canvas node media type

One of the following:
"image"
"video"
"audio"
"text"
asset_id?: string | null

Asset identifier

height?: number | null
label?: string | null

Canvas node label

url?: string | null

Canvas node output URL or text content

minLength1
width?: number | null

ProjectsAssets

Project canvas endpoints.

Attach an asset to a canvas
client.projects.assets.attachAsset(stringassetID, AssetAttachAssetParams { projectId } params, RequestOptionsoptions?): AssetAttachAssetResponse { asset_id, canvas_url, node_id, project_id }
POST/projects/{projectId}/assets/{assetId}/attach
ModelsExpand Collapse
AssetAttachAssetResponse { asset_id, canvas_url, node_id, project_id }
asset_id: string

Asset identifier

canvas_url: string

Project canvas URL

formaturi
node_id: string

Canvas node identifier

minLength1
project_id: string

Project identifier