SSpiderIQ
SSpiderIQ

Docs / api-reference/flows

Flows

3 endpoints from the published OpenAPI import.

GET/api/v1/flows

List Flows

List flows in the marketplace. Filters: category, search (name+description).

Parameters

NameInTypeRequiredDescription
categoryqueryanyfalse
searchqueryanyfalse
Try it
Query

Examples

cURL
curl -X GET 'https://spideriq.ai/api/v1/flows' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/flows",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/flows", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/flows", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
GET/api/v1/flows/{slug}

Get Flow

Parameters

NameInTypeRequiredDescription
slugpathstringtrue
Try it
Query

Examples

cURL
curl -X GET 'https://spideriq.ai/api/v1/flows/{slug}' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/flows/{slug}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/flows/{slug}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/flows/{slug}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
POST/api/v1/flows/{slug}/run

Run Flow

Dispatch a flow run. Body shape determines mode (see FlowRunRequest).

Parameters

NameInTypeRequiredDescription
slugpathstringtrue
Try it
Query

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/flows/{slug}/run' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {},
  "inputs": [
    {}
  ],
  "scope": {},
  "priority": 0
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/flows/{slug}/run",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"input": {}, "inputs": [{}], "scope": {}, "priority": 0},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/flows/{slug}/run", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"input": {}, "inputs": [{}], "scope": {}, "priority": 0})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"input": {}, "inputs": [{}], "scope": {}, "priority": 0}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/flows/{slug}/run", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
201Successful Response
422Validation Error