List Graphs

Every graph the team has. author narrows to one person, search to a name, and creative/task to the ones built on one record — those that read it in a context node and those that export into it. templates decides whether the shelf is included; it is left out by default, so a personal list stays personal.

A filter rather than its own path: /graphs/using would be shadowed by /graphs/{graph_id}, and a route that only works while it is declared in the right order is a trap for whoever file next.

GET/api/v1/graphs

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Query parameters

authorstring | any

Clerk user id of the owner

searchstring | any

Matches the name, case-insensitively

creativestring | any

Only graphs whose Creative or Export node names it

taskstring | any

Only graphs whose Task or Export node names it

forked_fromstring | any

Only the copies of one template

templatesTemplates

Whether template graphs are in the answer

Allowed:excludeonlyall

limitinteger

min 1 · max 100 · default: 50

offsetinteger

min 0 · default: 0

Responses

200Successful Response

successboolean

default: true

dataGraphsList | any

Show properties

Any of:

GraphsList

graphsNodeGraph[]required

Show properties

Array of NodeGraph

idstring

namestringrequired

descriptionstring

default: ""

definitionobject

ui_stateobject

forked_fromstring | any

Show properties

Any of:

string

string

any

any

templateboolean

default: false

owner_idstringrequired

created_atstring<date-time>

updated_atstring<date-time>

deleted_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

authorsobject

previewsobject

runsobject

metaPaginationMetarequired

Show properties

totalintegerrequired

limitintegerrequired

offsetintegerrequired

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/graphs" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/graphs", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/graphs",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "graphs": [
      {
        "id": "string",
        "name": "string",
        "description": "",
        "definition": {},
        "ui_state": {},
        "forked_from": "string",
        "template": false,
        "owner_id": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z"
      }
    ],
    "authors": {
      "property1": "string",
      "property2": "string"
    },
    "previews": {
      "property1": "string",
      "property2": "string"
    },
    "runs": {
      "property1": [
        {
          "id": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "status": "draft",
          "credits_consumed": 0,
          "targets": [
            "string"
          ],
          "exported_at": "2019-08-24T14:15:22Z"
        }
      ],
      "property2": [
        {
          "id": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "status": "draft",
          "credits_consumed": 0,
          "targets": [
            "string"
          ],
          "exported_at": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "meta": {
      "total": 0,
      "limit": 0,
      "offset": 0
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}