SSpiderIQ
SSpiderIQ

Docs / api-reference/dashboard-gate-studio

Dashboard Gate Studio

14 endpoints from the published OpenAPI import.

GET/api/v1/gate/studio/projects

List Projects

List the brand's projects, newest-touched first.

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalse
offsetqueryintegerfalse
Try it
Query

Examples

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

resp = httpx.get(
    "https://spideriq.ai/api/v1/gate/studio/projects",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects", {
  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/gate/studio/projects", 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/gate/studio/projects

Create Project

Create a Studio project for the caller's brand.

Try it

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/gate/studio/projects' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/gate/studio/projects",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string"})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string"}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/gate/studio/projects", 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
GET/api/v1/gate/studio/projects/{project_id}

Get Project

A single project + its sessions + asset gallery.

Parameters

NameInTypeRequiredDescription
project_idpathstringtrue
Try it
Query

Examples

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

resp = httpx.get(
    "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects/{project_id}", {
  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/gate/studio/projects/{project_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
PATCH/api/v1/gate/studio/projects/{project_id}

Rename Project

Rename a project.

Parameters

NameInTypeRequiredDescription
project_idpathstringtrue
Try it
Query

Examples

cURL
curl -X PATCH 'https://spideriq.ai/api/v1/gate/studio/projects/{project_id}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
Python
import httpx

resp = httpx.patch(
    "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects/{project_id}", {
  method: "PATCH",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string"})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string"}`)
	req, _ := http.NewRequest("PATCH", "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}", 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
200Successful Response
422Validation Error
DELETE/api/v1/gate/studio/projects/{project_id}

Delete Project

Delete a project (cascades to its sessions + assets).

Parameters

NameInTypeRequiredDescription
project_idpathstringtrue
Try it
Query

Examples

cURL
curl -X DELETE 'https://spideriq.ai/api/v1/gate/studio/projects/{project_id}' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

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

import (
	"net/http"
)

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

Responses

StatusDescription
204Successful Response
422Validation Error
POST/api/v1/gate/studio/projects/{project_id}/sessions

Create Session

Open a conversation inside a project.

Parameters

NameInTypeRequiredDescription
project_idpathstringtrue
Try it
Query

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/sessions' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "mode": "single"
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/sessions",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"title": "string", "project_id": "00000000-0000-0000-0000-000000000000", "mode": "single"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/sessions", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"title": "string", "project_id": "00000000-0000-0000-0000-000000000000", "mode": "single"})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"title": "string", "project_id": "00000000-0000-0000-0000-000000000000", "mode": "single"}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/sessions", 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
GET/api/v1/gate/studio/sessions

List Sessions

Cross-project session list for the History picker (incl. Scratch).

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalse
offsetqueryintegerfalse
Try it
Query

Examples

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

resp = httpx.get(
    "https://spideriq.ai/api/v1/gate/studio/sessions",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/sessions", {
  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/gate/studio/sessions", 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/gate/studio/sessions

Create Session Standalone

Open a conversation. project_id optional — omit for a project-less Scratch conversation. 404 if a given project is not this brand's.

Try it

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/gate/studio/sessions' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "mode": "single"
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/gate/studio/sessions",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"title": "string", "project_id": "00000000-0000-0000-0000-000000000000", "mode": "single"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/sessions", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"title": "string", "project_id": "00000000-0000-0000-0000-000000000000", "mode": "single"})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"title": "string", "project_id": "00000000-0000-0000-0000-000000000000", "mode": "single"}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/gate/studio/sessions", 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
GET/api/v1/gate/studio/sessions/{session_id}

Get Session

Reopen a conversation — the session + its ordered messages. 404 if not this brand's.

Parameters

NameInTypeRequiredDescription
session_idpathstringtrue
Try it
Query

Examples

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

resp = httpx.get(
    "https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}", {
  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/gate/studio/sessions/{session_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
PATCH/api/v1/gate/studio/sessions/{session_id}

Rename Session

Rename a session (editable header title).

Parameters

NameInTypeRequiredDescription
session_idpathstringtrue
Try it
Query

Examples

cURL
curl -X PATCH 'https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string"
}'
Python
import httpx

resp = httpx.patch(
    "https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"title": "string"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}", {
  method: "PATCH",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"title": "string"})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"title": "string"}`)
	req, _ := http.NewRequest("PATCH", "https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}", 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
200Successful Response
422Validation Error
DELETE/api/v1/gate/studio/sessions/{session_id}

Delete Session

Delete a session (cascades to its chat messages).

Parameters

NameInTypeRequiredDescription
session_idpathstringtrue
Try it
Query

Examples

cURL
curl -X DELETE 'https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

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

import (
	"net/http"
)

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

Responses

StatusDescription
204Successful Response
422Validation Error
POST/api/v1/gate/studio/sessions/{session_id}/messages

Save Session Messages

Append a batch of chat messages to a session (persist-on-send). 404 if the session is not this brand's.

Parameters

NameInTypeRequiredDescription
session_idpathstringtrue
Try it
Query

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}/messages' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "string",
      "content": "",
      "model": "string",
      "meta": {}
    }
  ]
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}/messages",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"messages": [{"role": "string", "content": "", "model": "string", "meta": {}}]},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}/messages", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"messages": [{"role": "string", "content": "", "model": "string", "meta": {}}]})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"messages": [{"role": "string", "content": "", "model": "string", "meta": {}}]}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/gate/studio/sessions/{session_id}/messages", 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
POST/api/v1/gate/studio/projects/{project_id}/assets

Link Asset

Attach a generated media asset (SpiderMedia URL) to the project gallery.

Parameters

NameInTypeRequiredDescription
project_idpathstringtrue
Try it
Query

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "media_url": "string",
  "kind": "image",
  "title": "string",
  "session_id": "00000000-0000-0000-0000-000000000000",
  "meta": {}
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"media_url": "string", "kind": "image", "title": "string", "session_id": "00000000-0000-0000-0000-000000000000", "meta": {}},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"media_url": "string", "kind": "image", "title": "string", "session_id": "00000000-0000-0000-0000-000000000000", "meta": {}})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"media_url": "string", "kind": "image", "title": "string", "session_id": "00000000-0000-0000-0000-000000000000", "meta": {}}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets", 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
DELETE/api/v1/gate/studio/projects/{project_id}/assets/{asset_id}

Unlink Asset

Remove an asset from the project gallery.

Parameters

NameInTypeRequiredDescription
project_idpathstringtrue
asset_idpathstringtrue
Try it
Query

Examples

cURL
curl -X DELETE 'https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets/{asset_id}' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.delete(
    "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets/{asset_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets/{asset_id}", {
  method: "DELETE",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/assets/{asset_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
204Successful Response
422Validation Error