FLflorafauna-ai
Canvas

Get a project graph

Changed on

Returns the full state of a project canvas: every node's short id, node UUID, type, label, prompt, model, parameters, absolute position, generation status, current output and, for document-bearing nodes such as timelines and decks, a summary of its authored content with the document revision, plus the edges between them and a revision marker. Full documents are read per node from the node document endpoint. Short ids are persisted as part of the read, so the id reported for a node is the same on every subsequent read and is the id canvas write operations accept. The revision is opaque: an identical value means nothing this endpoint reports has changed, a different value means something has, and no ordering can be inferred from two values.

get/workspaces/{workspaceId}/projects/{projectId}/graph

Request

  • Base URL
    https://app.flora.ai/api/v1
  • URL
    https://app.flora.ai/api/v1/workspaces/{workspaceId}/projects/{projectId}/graph
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Workspace identifier

Example:ws_abc123
projectIdstring required

Project identifier

Example:prj_abc123

Response

Project graph returned.

project_idstring required

Project identifier

canvas_urlstring uri required

Project canvas URL

revisionstring required

Opaque change-detection marker for the reported graph. An identical value means nothing this endpoint reports has changed; a different value means something has. It is not a counter, so no ordering can be inferred from two values.

Example response

{
  "project_id": "prj_abc123",
  "revision": "4f2c8ab19e3d7c05",
  "nodes": [
    {
      "id": "n1",
      "node_id": "7f6ae6da-4a0e-4a2f-9c6a-2c1c6b8d1f21",
      "type": "image"
    }
  ],
  "edges": [
    {
      "from": "n1",
      "to": "n2"
    }
  ]
}

Changes

  • a8351619f225Revision changes
    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

  • e54130373b10Revision changes
    • info

      endpoint added