Skip to main content
import requests

url = 'https://api.simplex.sh/search_workflows'
headers = {
    'Authorization': 'Bearer your_api_key_here'
}
params = {
    'workflow_name': 'copy'  # Partial name to search for
}

response = requests.get(url, headers=headers, params=params)
result = response.json()
print(f"Found {result['count']} workflows")
for workflow in result['workflows']:
    print(f"  - {workflow['workflow_name']} (ID: {workflow['workflow_id']})")
    print(f"    Variables: {workflow['variables']}")
    print(f"    Metadata: {workflow.get('metadata', 'None')}")
{
  "succeeded": true,
  "workflows": [
    {
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflow_name": "<string>",
      "variables": {},
      "metadata": "<string>"
    }
  ],
  "count": 123
}
Search for workflows by partial name match and/or partial metadata match. You can search by workflow name, metadata, or both. At least one search parameter must be provided. Returns a list of workflows matching the search criteria.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Query Parameters

​
workflow_name
string

Partial workflow name to search for

​
metadata
string

Partial metadata string to search for

Response

Search workflows response

​
succeeded
boolean
required

Whether the search was successful.

​
workflows
object[]
required

List of matching workflows.

​
count
integer
required

Total number of matching workflows.