workflows — SpiderIQ

GET/api/v1/workflows/types

List Workflow Types

List available workflow types.

Returns all workflow configurations that can be used for campaigns. Each workflow type has different stages and capabilities.

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/workflows/types' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/workflows/types",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/workflows/types", {
  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/workflows/types", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response

GET/api/v1/workflows/{job_id}/status

Get Workflow Status

Get the status of a workflow job.

Args: job_id: WindMill job UUID

Returns: Workflow job status including current step and progress.

Parameters

Name	In	Type	Required	Description
`job_id`	path	string	true

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/workflows/{job_id}/status' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/workflows/{job_id}/status",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/workflows/{job_id}/status", {
  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/workflows/{job_id}/status", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

GET/api/v1/workflows/{job_id}/result

Get Workflow Result

Get the result of a completed workflow job.

Args: job_id: WindMill job UUID

Returns: Workflow job result including aggregated data.

Parameters

Name	In	Type	Required	Description
`job_id`	path	string	true

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/workflows/{job_id}/result' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/workflows/{job_id}/result",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/workflows/{job_id}/result", {
  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/workflows/{job_id}/result", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

GET/api/v1/workflows/selection

Get Workflow Selection Info

Get which workflow would be selected based on configuration.

This endpoint helps users understand which workflow will be used for their campaign configuration.

Args: spidersite_enabled: Whether website crawling is enabled spiderverify_enabled: Whether email verification is enabled

Returns: Selected workflow information and reasoning.

Parameters

Name	In	Type	Required	Description
`spidersite_enabled`	query	boolean	false	Whether SpiderSite is enabled
`spiderverify_enabled`	query	boolean	false	Whether SpiderVerify is enabled

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/workflows/selection' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/workflows/selection",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/workflows/selection", {
  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/workflows/selection", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error