Dashboard Gate Prompts

GET/api/v1/gate/studio/projects/{project_id}/prompts

List Project Prompts

List a project's saved prompts, newest-touched first.

Parameters

Name	In	Type	Required
`project_id`	path	string	true
`limit`	query	integer	false
`offset`	query	integer	false

Try it

Examples

cURL

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

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/prompts",
    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}/prompts", {
  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}/prompts", 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

POST/api/v1/gate/studio/projects/{project_id}/prompts

Create Prompt

Create a saved prompt inside a project. 404 if the project is not this brand's; 409 if the name already exists in the project.

Parameters

Name	In	Type	Required	Description
`project_id`	path	string	true

Try it

Examples

cURL

curl -X POST 'https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/prompts' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "system_prompt": "string",
  "model": "string",
  "settings": {},
  "reference_media_ids": [
    null
  ]
}'

Python

import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/prompts",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string", "description": "string", "system_prompt": "string", "model": "string", "settings": {}, "reference_media_ids": [null]},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/prompts", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string", "description": "string", "system_prompt": "string", "model": "string", "settings": {}, "reference_media_ids": [null]})
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string", "description": "string", "system_prompt": "string", "model": "string", "settings": {}, "reference_media_ids": [null]}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/gate/studio/projects/{project_id}/prompts", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

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

GET/api/v1/gate/studio/prompts

Search Prompts

Search the brand's saved prompts (name/description ILIKE), optionally narrowed to one project. Omit query to list all.

Parameters

Name	In	Type	Required
`query`	query	any	false
`project_id`	query	any	false
`limit`	query	integer	false
`offset`	query	integer	false

Try it

Examples

cURL

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

Python

import httpx

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

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/prompts", {
  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/prompts", 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/gate/studio/prompts/{prompt_id}

Get Prompt

Fetch one prompt by internal id (uuid) or prompt_… public_id.

Parameters

Name	In	Type	Required	Description
`prompt_id`	path	string	true

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_id}' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

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

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_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/prompts/{prompt_id}", 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

PATCH/api/v1/gate/studio/prompts/{prompt_id}

Update Prompt

Partial update. Only supplied fields change; settings / reference_media_ids REPLACE (not deep-merge). 409 on a name collision.

Parameters

Name	In	Type	Required	Description
`prompt_id`	path	string	true

Try it

Examples

cURL

curl -X PATCH 'https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_id}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "system_prompt": "string",
  "model": "string",
  "settings": {},
  "reference_media_ids": [
    null
  ]
}'

Python

import httpx

resp = httpx.patch(
    "https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_id}",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string", "description": "string", "system_prompt": "string", "model": "string", "settings": {}, "reference_media_ids": [null]},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_id}", {
  method: "PATCH",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string", "description": "string", "system_prompt": "string", "model": "string", "settings": {}, "reference_media_ids": [null]})
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string", "description": "string", "system_prompt": "string", "model": "string", "settings": {}, "reference_media_ids": [null]}`)
	req, _ := http.NewRequest("PATCH", "https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_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

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

DELETE/api/v1/gate/studio/prompts/{prompt_id}

Delete Prompt

Delete a prompt by id or public_id.

Parameters

Name	In	Type	Required	Description
`prompt_id`	path	string	true

Try it

Examples

cURL

curl -X DELETE 'https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_id}' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.delete(
    "https://spideriq.ai/api/v1/gate/studio/prompts/{prompt_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

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

Responses

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