sitegpt-ai Conversation Starters API
The Conversation Starters API from sitegpt-ai — 3 operation(s) for conversation starters.
The Conversation Starters API from sitegpt-ai — 3 operation(s) for conversation starters.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sitegpt-ai:sitegpt-ai-conversation-starters-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: SiteGPT Agent Conversation Starters API
version: 2.0.0
description: Agent-facing API for managing SiteGPT chatbots, dashboard summaries, appearance media, knowledge, settings, conversations, leads, members, account profiles, usage, billing reads, and API tokens.
servers:
- url: https://sitegpt.ai
security:
- bearerAuth: []
tags:
- name: Conversation Starters
paths:
/api/v2/chatbots/{chatbotId}/starters:
get:
operationId: listStarters
summary: List starters
description: 'List conversation starters.
Required scope: `starters:read`.
On success, `data` contains: `starters`.'
tags:
- Conversation Starters
security:
- bearerAuth:
- starters:read
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- starters:read
x-mint:
title: List starters
description: List conversation starters.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
responses:
'200':
description: Successful SiteGPT API v2 response.
content:
application/json:
schema:
type: object
required:
- ok
- data
- meta
properties:
ok:
type: boolean
const: true
data:
type: object
additionalProperties: true
properties:
starters:
type: array
items:
$ref: '#/components/schemas/PromptButton'
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
starters:
- id: starter-id
title: Example starter
meta:
requestId: request-id
'400':
$ref: '#/components/responses/AgentError'
'401':
$ref: '#/components/responses/AgentError'
'403':
$ref: '#/components/responses/AgentError'
'404':
$ref: '#/components/responses/AgentError'
'405':
$ref: '#/components/responses/AgentError'
post:
operationId: createStarter
summary: Create starter
description: 'Create a conversation starter.
Required scope: `starters:write`.
On success, `data` contains: `starter`.'
tags:
- Conversation Starters
security:
- bearerAuth:
- starters:write
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- starters:write
x-mint:
title: Create starter
description: Create a conversation starter.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- title
additionalProperties: false
properties:
title:
type: string
minLength: 1
message:
type: string
description:
type: string
link:
type:
- string
- 'null'
format: uri
type:
type: string
enum:
- PROMPT
- LINK
promptType:
type: string
enum:
- PROMPT
- LINK
description: Alias of type; type wins when both are sent.
isEscalationPrompt:
type: boolean
functionId:
type:
- string
- 'null'
order:
type: integer
minimum: 0
paths:
type:
- array
- 'null'
items:
type: string
description: 'Page paths where this starter shows, like /pricing or /docs/* (the Excluded Pages grammar; at most 20). Empty or null shows it on every page — the default. Web widget only: channels always show every starter.'
example:
title: Pricing
message: What plans do you offer?
type: PROMPT
responses:
'201':
description: Successful SiteGPT API v2 response.
content:
application/json:
schema:
type: object
required:
- ok
- data
- meta
properties:
ok:
type: boolean
const: true
data:
type: object
additionalProperties: true
properties:
starter:
$ref: '#/components/schemas/PromptButton'
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
starter:
id: starter-id
name: Example starter
createdAt: '2026-05-13T00:00:00.000Z'
meta:
requestId: request-id
'400':
$ref: '#/components/responses/AgentError'
'401':
$ref: '#/components/responses/AgentError'
'403':
$ref: '#/components/responses/AgentError'
'404':
$ref: '#/components/responses/AgentError'
'405':
$ref: '#/components/responses/AgentError'
/api/v2/chatbots/{chatbotId}/starters/{starterId}:
get:
operationId: getStarter
summary: Get starter
description: 'Get one conversation starter.
Required scope: `starters:read`.
On success, `data` contains: `starter`.'
tags:
- Conversation Starters
security:
- bearerAuth:
- starters:read
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- starters:read
x-mint:
title: Get starter
description: Get one conversation starter.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
- name: starterId
in: path
required: true
description: Conversation starter ID.
schema:
type: string
responses:
'200':
description: Successful SiteGPT API v2 response.
content:
application/json:
schema:
type: object
required:
- ok
- data
- meta
properties:
ok:
type: boolean
const: true
data:
type: object
additionalProperties: true
properties:
starter:
$ref: '#/components/schemas/PromptButton'
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
starter:
id: starter-id
name: Example starter
createdAt: '2026-05-13T00:00:00.000Z'
meta:
requestId: request-id
'400':
$ref: '#/components/responses/AgentError'
'401':
$ref: '#/components/responses/AgentError'
'403':
$ref: '#/components/responses/AgentError'
'404':
$ref: '#/components/responses/AgentError'
'405':
$ref: '#/components/responses/AgentError'
patch:
operationId: updateStarter
summary: Update starter
description: 'Update a conversation starter.
Required scope: `starters:write`.
On success, `data` contains: `starter`.'
tags:
- Conversation Starters
security:
- bearerAuth:
- starters:write
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- starters:write
x-mint:
title: Update starter
description: Update a conversation starter.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
- name: starterId
in: path
required: true
description: Conversation starter ID.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
title:
type: string
minLength: 1
message:
type: string
description:
type: string
link:
type:
- string
- 'null'
format: uri
type:
type: string
enum:
- PROMPT
- LINK
promptType:
type: string
enum:
- PROMPT
- LINK
description: Alias of type; type wins when both are sent.
isEscalationPrompt:
type: boolean
functionId:
type:
- string
- 'null'
order:
type: integer
minimum: 0
paths:
type:
- array
- 'null'
items:
type: string
description: 'Page paths where this starter shows, like /pricing or /docs/* (the Excluded Pages grammar; at most 20). Empty or null shows it on every page — the default. Web widget only: channels always show every starter.'
responses:
'200':
description: Successful SiteGPT API v2 response.
content:
application/json:
schema:
type: object
required:
- ok
- data
- meta
properties:
ok:
type: boolean
const: true
data:
type: object
additionalProperties: true
properties:
starter:
$ref: '#/components/schemas/PromptButton'
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
starter:
id: starter-id
name: Example starter
createdAt: '2026-05-13T00:00:00.000Z'
meta:
requestId: request-id
'400':
$ref: '#/components/responses/AgentError'
'401':
$ref: '#/components/responses/AgentError'
'403':
$ref: '#/components/responses/AgentError'
'404':
$ref: '#/components/responses/AgentError'
'405':
$ref: '#/components/responses/AgentError'
delete:
operationId: deleteStarter
summary: Delete starter
description: 'Delete a conversation starter. Requires confirm=true.
Required scope: `starters:delete`.
On success, `data` contains: `deletedStarter`.'
tags:
- Conversation Starters
security:
- bearerAuth:
- starters:delete
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- starters:delete
x-mint:
title: Delete starter
description: Delete a conversation starter. Requires confirm=true.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
- name: starterId
in: path
required: true
description: Conversation starter ID.
schema:
type: string
- name: confirm
in: query
required: false
description: Required true for destructive actions.
schema:
type: boolean
responses:
'200':
description: Successful SiteGPT API v2 response.
content:
application/json:
schema:
type: object
required:
- ok
- data
- meta
properties:
ok:
type: boolean
const: true
data:
type: object
additionalProperties: true
properties:
deletedStarter:
type: object
additionalProperties: true
properties:
id:
type: string
title:
type: string
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
deletedStarter:
id: starter-id
name: Example starter
createdAt: '2026-05-13T00:00:00.000Z'
meta:
requestId: request-id
'400':
$ref: '#/components/responses/AgentError'
'401':
$ref: '#/components/responses/AgentError'
'403':
$ref: '#/components/responses/AgentError'
'404':
$ref: '#/components/responses/AgentError'
'405':
$ref: '#/components/responses/AgentError'
/api/v2/chatbots/{chatbotId}/starters/reorder:
post:
operationId: reorderStarters
summary: Reorder starters
description: 'Reorder conversation starters.
Required scope: `starters:write`.
On success, `data` contains: `starters`.'
tags:
- Conversation Starters
security:
- bearerAuth:
- starters:write
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- starters:write
x-mint:
title: Reorder starters
description: Reorder conversation starters.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- orderedIds
additionalProperties: false
properties:
orderedIds:
type: array
minItems: 1
items:
type: string
responses:
'200':
description: Successful SiteGPT API v2 response.
content:
application/json:
schema:
type: object
required:
- ok
- data
- meta
properties:
ok:
type: boolean
const: true
data:
type: object
additionalProperties: true
properties:
starters:
type: array
items:
$ref: '#/components/schemas/PromptButton'
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
starters:
- id: starter-id
title: Example starter
order: 0
meta:
requestId: request-id
'400':
$ref: '#/components/responses/AgentError'
'401':
$ref: '#/components/responses/AgentError'
'403':
$ref: '#/components/responses/AgentError'
'404':
$ref: '#/components/responses/AgentError'
'405':
$ref: '#/components/responses/AgentError'
components:
schemas:
AgentError:
type: object
required:
- ok
- error
- meta
properties:
ok:
type: boolean
const: false
error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
details: {}
additionalProperties: false
meta:
type: object
required:
- requestId
properties:
requestId:
type: string
additionalProperties: true
additionalProperties: false
AgentResponseMeta:
type: object
required:
- requestId
properties:
requestId:
type: string
warnings:
type: array
items:
type: string
nextCursor:
type:
- string
- 'null'
additionalProperties: true
PromptButton:
type: object
description: A conversation starter or follow-up prompt button shown in the widget.
additionalProperties: true
properties:
id:
type: string
title:
type: string
description:
type: string
message:
type: string
link:
type:
- string
- 'null'
isEscalationPrompt:
type: boolean
functionId:
type:
- string
- 'null'
order:
type:
- number
- 'null'
type:
type: string
enum:
- ESCALATION
- LINK
- PROMPT
paths:
type:
- array
- 'null'
items:
type: string
description: Per-page scoping; starters only (followups never carry this field). Null means every page.
responses:
AgentError:
description: SiteGPT agent API error response.
content:
application/json:
schema:
$ref: '#/components/schemas/AgentError'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: SiteGPT API token