Krea Node Apps API

openapi: 3.2.0
info:
  title: Krea Node Apps API
  version: v1
  description: Executing custom node apps built in our nodes tool
servers:
- url: https://api.krea.ai
  description: Krea API
security:
- bearerAuth: []
tags:
- name: Node Apps
  description: Executing custom node apps built in our nodes tool
paths:
  /node-apps:
    get:
      tags:
      - Node Apps
      summary: List runnable node apps
      description: List node apps visible to the authenticated user that can be executed through the public API.
      parameters:
      - in: query
        name: limit
        schema:
          description: 'Number of items to return (1-1000, default: 100)'
          type: integer
          minimum: 1
          maximum: 1000
        description: 'Number of items to return (1-1000, default: 100)'
      - in: query
        name: cursor
        schema:
          description: Cursor for pagination
          type: string
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
        description: Cursor for pagination
      - in: query
        name: owner
        schema:
          description: Filter node apps by owner. Use "workspace" to return only node apps shared with the current workspace.
          default: all
          type: string
          enum:
          - all
          - workspace
        description: Filter node apps by owner. Use "workspace" to return only node apps shared with the current workspace.
      responses:
        '200':
          description: Runnable node apps
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the node app
                        author_id:
                          type: string
                          description: ID of the node app author
                        workspace_id:
                          type: string
                          description: ID of the workspace that owns the node app
                        name:
                          type: string
                          description: Name of the node app
                        slug:
                          type: string
                          description: URL-friendly identifier for the node app
                        description:
                          type: string
                          description: Description of the node app
                        scope:
                          type: string
                          description: 'Visibility scope: "public", "user", or "workspace"'
                        created_at:
                          description: Creation timestamp
                          type: string
                        updated_at:
                          description: Last update timestamp
                          type: string
                        version:
                          type: number
                          description: Selected node app version number
                        version_created_at:
                          description: Creation timestamp of this version
                          type: string
                        username:
                          type: string
                          description: Username of the node app creator
                        example_outputs:
                          anyOf:
                          - type: array
                            items:
                              type: string
                          - type: 'null'
                          description: Example output URLs
                        input_openapi_schema:
                          anyOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: object
                              properties:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                  required:
                                  - type
                                  additionalProperties: {}
                              required:
                                type: array
                                items:
                                  type: string
                            required:
                            - type
                            - properties
                            additionalProperties: false
                            description: OpenAPI 3.1 JSON Schema
                          - type: 'null'
                          description: OpenAPI 3.1 JSON Schema for input parameters
                        output_openapi_schema:
                          anyOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: object
                              properties:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                  required:
                                  - type
                                  additionalProperties: {}
                              required:
                                type: array
                                items:
                                  type: string
                            required:
                            - type
                            - properties
                            additionalProperties: false
                            description: OpenAPI 3.1 JSON Schema
                          - type: 'null'
                          description: OpenAPI 3.1 JSON Schema for output values
                        node_app_version_id:
                          type: string
                          description: Node app version ID to pass to /node-apps/{id}/execute
                      required:
                      - id
                      - author_id
                      - workspace_id
                      - name
                      - slug
                      - description
                      - scope
                      - created_at
                      - updated_at
                      - version
                      - version_created_at
                      - username
                      - example_outputs
                      - input_openapi_schema
                      - output_openapi_schema
                      - node_app_version_id
                      additionalProperties: false
                  next_cursor:
                    type:
                    - string
                    - 'null'
                required:
                - items
                - next_cursor
                additionalProperties: false
        '400':
          description: Invalid pagination parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
      operationId: getNodeApps
      x-operation-id-source: derived
  /node-apps/{node_app_id}/versions:
    get:
      tags:
      - Node Apps
      summary: List runnable node app versions
      description: List versions of a node app visible to the authenticated user that can be executed through the public API.
      parameters:
      - in: path
        name: node_app_id
        schema:
          type: string
          description: Node app ID
        required: true
        description: Node app ID
      - in: query
        name: limit
        schema:
          description: 'Number of items to return (1-1000, default: 100)'
          type: integer
          minimum: 1
          maximum: 1000
        description: 'Number of items to return (1-1000, default: 100)'
      - in: query
        name: cursor
        schema:
          description: Cursor for pagination
          type: string
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
        description: Cursor for pagination
      responses:
        '200':
          description: Runnable node app versions
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the node app
                        author_id:
                          type: string
                          description: ID of the node app author
                        workspace_id:
                          type: string
                          description: ID of the workspace that owns the node app
                        name:
                          type: string
                          description: Name of the node app
                        slug:
                          type: string
                          description: URL-friendly identifier for the node app
                        description:
                          type: string
                          description: Description of the node app
                        scope:
                          type: string
                          description: 'Visibility scope: "public", "user", or "workspace"'
                        created_at:
                          description: Creation timestamp
                          type: string
                        updated_at:
                          description: Last update timestamp
                          type: string
                        version:
                          type: number
                          description: Selected node app version number
                        version_created_at:
                          description: Creation timestamp of this version
                          type: string
                        username:
                          type: string
                          description: Username of the node app creator
                        example_outputs:
                          anyOf:
                          - type: array
                            items:
                              type: string
                          - type: 'null'
                          description: Example output URLs
                        input_openapi_schema:
                          anyOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: object
                              properties:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                  required:
                                  - type
                                  additionalProperties: {}
                              required:
                                type: array
                                items:
                                  type: string
                            required:
                            - type
                            - properties
                            additionalProperties: false
                            description: OpenAPI 3.1 JSON Schema
                          - type: 'null'
                          description: OpenAPI 3.1 JSON Schema for input parameters
                        output_openapi_schema:
                          anyOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                const: object
                              properties:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                  required:
                                  - type
                                  additionalProperties: {}
                              required:
                                type: array
                                items:
                                  type: string
                            required:
                            - type
                            - properties
                            additionalProperties: false
                            description: OpenAPI 3.1 JSON Schema
                          - type: 'null'
                          description: OpenAPI 3.1 JSON Schema for output values
                        node_app_version_id:
                          type: string
                          description: Node app version ID to pass to /node-apps/{id}/execute
                      required:
                      - id
                      - author_id
                      - workspace_id
                      - name
                      - slug
                      - description
                      - scope
                      - created_at
                      - updated_at
                      - version
                      - version_created_at
                      - username
                      - example_outputs
                      - input_openapi_schema
                      - output_openapi_schema
                      - node_app_version_id
                      additionalProperties: false
                  next_cursor:
                    type:
                    - string
                    - 'null'
                required:
                - items
                - next_cursor
                additionalProperties: false
        '400':
          description: Invalid pagination parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '404':
          description: Node app not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
      operationId: getNodeAppsByNodeAppIdVersions
      x-operation-id-source: derived
  /node-apps/{id}:
    get:
      tags:
      - Node Apps
      summary: Get a node app by version ID
      description: Get a single node app by version ID. Returns the node app details including input/output schemas.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          description: Node app version ID
        required: true
        description: Node app version ID
      responses:
        '200':
          description: Node app details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Unique identifier for the node app
                  author_id:
                    type: string
                    description: ID of the node app author
                  workspace_id:
                    type: string
                    description: ID of the workspace that owns the node app
                  name:
                    type: string
                    description: Name of the node app
                  slug:
                    type: string
                    description: URL-friendly identifier for the node app
                  description:
                    type: string
                    description: Description of the node app
                  scope:
                    type: string
                    description: 'Visibility scope: "public", "user", or "workspace"'
                  created_at:
                    description: Creation timestamp
                    type: string
                  updated_at:
                    description: Last update timestamp
                    type: string
                  version:
                    type: number
                    description: Selected node app version number
                  version_created_at:
                    description: Creation timestamp of this version
                    type: string
                  username:
                    type: string
                    description: Username of the node app creator
                  example_outputs:
                    anyOf:
                    - type: array
                      items:
                        type: string
                    - type: 'null'
                    description: Example output URLs
                  input_openapi_schema:
                    anyOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          const: object
                        properties:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: object
                            properties:
                              type:
                                type: string
                            required:
                            - type
                            additionalProperties: {}
                        required:
                          type: array
                          items:
                            type: string
                      required:
                      - type
                      - properties
                      additionalProperties: false
                      description: OpenAPI 3.1 JSON Schema
                    - type: 'null'
                    description: OpenAPI 3.1 JSON Schema for input parameters
                  output_openapi_schema:
                    anyOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          const: object
                        properties:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: object
                            properties:
                              type:
                                type: string
                            required:
                            - type
                            additionalProperties: {}
                        required:
                          type: array
                          items:
                            type: string
                      required:
                      - type
                      - properties
                      additionalProperties: false
                      description: OpenAPI 3.1 JSON Schema
                    - type: 'null'
                    description: OpenAPI 3.1 JSON Schema for output values
                  node_app_version_id:
                    type: string
                    description: Node app version ID to pass to /node-apps/{id}/execute
                required:
                - id
                - author_id
                - workspace_id
                - name
                - slug
                - description
                - scope
                - created_at
                - updated_at
                - version
                - version_created_at
                - username
                - example_outputs
                - input_openapi_schema
                - output_openapi_schema
                - node_app_version_id
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '404':
          description: Node app not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
      operationId: getNodeAppsById
      x-operation-id-source: derived
  /node-apps/{id}/execute:
    post:
      tags:
      - Node Apps
      summary: Execute a node app
      description: Execute a node app by version ID. The request body should contain the input data as a JSON object matching the node app's input schema. Returns a job that can be tracked using /jobs/{id}.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          description: Node app version ID
        required: true
        description: Node app version ID
      requestBody:
        content:
          application/json:
            schema:
              type: object
              propertyNames:
                type: string
              additionalProperties: {}
              description: Input data for the node app execution, matching the node app's input schema
      responses:
        '200':
          description: Execution job created successfully. The job will be in a processing state until completed. Use /jobs/{id} to check progress.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    job_id:
                      type: string
                      format: uuid
                      pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    status:
                      type: string
                      enum:
                      - backlogged
                      - queued
                      - scheduled
                      - processing
                      - sampling
                      - intermediate-complete
                      - completed
                      - failed
                      - cancelled
                    created_at:
                      type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                    completed_at:
                      type: string
                      format: date-time
                      pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                    result:
                      type: object
                      properties:
                        urls:
                          anyOf:
                          - type: array
                            items:
                              type: string
                              format: uri
                          - type: array
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                  - model
                                  - preview
                                url:
                                  type: string
                                  format: uri
                              required:
                              - type
                              - url
                              additionalProperties: false
                          - type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: string
                              format: uri
                        style_id:
                          type: string
                      additionalProperties: false
                    error:
                      type: object
                      properties:
                        code:
                          type: string
                        message:
                          type: string
                      required:
                      - code
                      additionalProperties: false
                    progress:
                      anyOf:
                      - type: number
                        minimum: 0
                        maximum: 1
                      - type: 'null'
                  required:
                  - job_id
                  - status
                  - created_at
                  additionalProperties: false
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '402':
          description: You have run out of credits.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '403':
          description: This node app cannot be used via the API.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '404':
          description: Node app version not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
        '429':
          description: You have reached the maximum number of concurrent jobs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
                additionalProperties: false
      operationId: postNodeAppsByIdExecute
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      scheme: bearer
      bearerFormat: Bearer
      type: http
x-provenance:
  method: harvested
  publisher: Krea
  source: https://api.krea.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)