Workflow Search

client.search.workflowSearch(, ?): SearchHitsOffset<SearchWorkflowSearchResponse { id, authorId, collectionIds, 14 more } >

POST/search/workflows

Search for workflows. At least one of the following fields must have a value: query or filter.

ParametersExpand Collapse

params: SearchWorkflowSearchParams { originalAssets, projectId, filter, 8 more }

originalAssets?: boolean

Query param: If set to true, returns the original asset without transformation

projectId?: string

Query param: The projectId used for ownership resource management. Either to assert ownership or to set the owner of the resource(s)

filter?: string

Body param: Filter queries by an attribute’s value

hitsPerPage?: number

Body param: Maximum number of documents returned for a page. Must be used with page.

maximum100

minimum1

limit?: number

Body param: Maximum number of documents returned. Must be used with offset.

maximum100

minimum1

offset?: number

Body param: Number of documents to skip. Must be used with limit. Starts from 0.

minimum0

page?: number

Body param: Request a specific page of results. Must be used with hitsPerPage.

minimum1

_public?: boolean

Body param: Search for public workflows not necessarily belonging to the current ownerId

query?: string

Body param: A string used for querying search results.

querySemanticRatio?: number

Body param: Query embedding for hybrid search, if possible

maximum1

minimum0

sortBy?: Array<string>

Body param: Sort the search results by the given attributes. Each attribute in the list must be followed by a colon (:) and the preferred sorting order: either ascending (asc) or descending (desc).

Example: ['createdAt:desc']

ReturnsExpand Collapse

SearchWorkflowSearchResponse { id, authorId, collectionIds, 14 more }

id: string

Unique identifier for the workflow (e.g., “workflow_abc123”)

authorId: string

User ID of the workflow creator/author

collectionIds: Array<string>

Array of collection IDs this workflow belongs to

createdAt: string

Creation timestamp in ISO 8601 format (e.g., “2025-01-16T11:19:41.579Z”)

description: string

Full description of the workflow

name: string

Display name of the workflow

ownerId: string

Project ID of the workflow owner

privacy: string

Privacy setting of the workflow (“public”, “private”, or “unlisted”)

status: string

Status of the workflow (e.g., “ready”, “draft”, “deleted”)

tags: Array<string>

Array of user-assigned tags for categorization

teamId: string

Team ID of the workflow owner

updatedAt: string

Last modification timestamp in ISO 8601 format (e.g., “2025-01-16T11:19:41.579Z”)

after?: After { assetId, url }

After image information for the workflow

assetId: string

ID of the asset used as after image

url: string

Signed URL of the after image

before?: Before { assetId, url }

Before image information for the workflow

assetId: string

ID of the asset used as before image

url: string

Signed URL of the before image

score?: number

Score assigned to the workflow based on usage and popularity

shortDescription?: string

Short description of the workflow

thumbnail?: Thumbnail { assetId, url }

Thumbnail image information for the workflow

assetId: string

ID of the asset used as thumbnail

url: string

Signed URL of the thumbnail

Workflow Search

import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const searchWorkflowSearchResponse of client.search.workflowSearch()) {
  console.log(searchWorkflowSearchResponse.id);
}

{
  "hits": [
    {
      "id": "id",
      "authorId": "authorId",
      "collectionIds": [
        "string"
      ],
      "createdAt": "createdAt",
      "description": "description",
      "name": "name",
      "ownerId": "ownerId",
      "privacy": "privacy",
      "status": "status",
      "tags": [
        "string"
      ],
      "teamId": "teamId",
      "updatedAt": "updatedAt",
      "after": {
        "assetId": "assetId",
        "url": "url"
      },
      "before": {
        "assetId": "assetId",
        "url": "url"
      },
      "score": 0,
      "shortDescription": "shortDescription",
      "thumbnail": {
        "assetId": "assetId",
        "url": "url"
      }
    }
  ],
  "limit": 0,
  "offset": 0,
  "estimatedTotalHits": 0,
  "hitsPerPage": 0,
  "page": 0,
  "totalHits": 0,
  "totalPages": 0
}

Returns Examples

{
  "hits": [
    {
      "id": "id",
      "authorId": "authorId",
      "collectionIds": [
        "string"
      ],
      "createdAt": "createdAt",
      "description": "description",
      "name": "name",
      "ownerId": "ownerId",
      "privacy": "privacy",
      "status": "status",
      "tags": [
        "string"
      ],
      "teamId": "teamId",
      "updatedAt": "updatedAt",
      "after": {
        "assetId": "assetId",
        "url": "url"
      },
      "before": {
        "assetId": "assetId",
        "url": "url"
      },
      "score": 0,
      "shortDescription": "shortDescription",
      "thumbnail": {
        "assetId": "assetId",
        "url": "url"
      }
    }
  ],
  "limit": 0,
  "offset": 0,
  "estimatedTotalHits": 0,
  "hitsPerPage": 0,
  "page": 0,
  "totalHits": 0,
  "totalPages": 0
}