sitegpt-ai Instructions API
The Instructions API from sitegpt-ai — 3 operation(s) for instructions.
The Instructions API from sitegpt-ai — 3 operation(s) for instructions.
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-instructions-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 Instructions 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: Instructions
paths:
/api/v2/chatbots/{chatbotId}/instructions:
get:
operationId: listInstructions
summary: List instructions
description: 'List chatbot instructions.
Required scope: `instructions:read`.
On success, `data` contains: `instructions`, `activeInstructionId`.'
tags:
- Instructions
security:
- bearerAuth:
- instructions:read
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- instructions:read
x-mint:
title: List instructions
description: List chatbot instructions.
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:
instructions:
type: array
items:
$ref: '#/components/schemas/Instruction'
activeInstructionId:
type:
- string
- 'null'
description: ID of the currently active instruction; null when default.
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
instructions:
- id: instruction-id
title: Concise answers
activeInstructionId: null
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: createInstruction
summary: Create instructions
description: 'Create chatbot instructions.
Required scope: `instructions:write`.
On success, `data` contains: `instruction`, `activeInstructionId`.'
tags:
- Instructions
security:
- bearerAuth:
- instructions:write
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- instructions:write
x-mint:
title: Create instructions
description: Create chatbot instructions.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- instructions
additionalProperties: false
properties:
title:
type: string
instructions:
type: string
minLength: 1
temperature:
type: number
minimum: 0
maximum: 2
example:
title: Support instructions
instructions: Answer using the knowledge base. Ask a follow-up when needed.
temperature: 0.4
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:
instruction:
$ref: '#/components/schemas/Instruction'
activeInstructionId:
type:
- string
- 'null'
description: ID of the currently active instruction; null when default.
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
instruction:
id: instruction-id
name: Example instruction
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}/instructions/{instructionId}:
get:
operationId: getInstruction
summary: Get instructions
description: 'Get one chatbot instruction.
Required scope: `instructions:read`.
On success, `data` contains: `instruction`, `activeInstructionId`.'
tags:
- Instructions
security:
- bearerAuth:
- instructions:read
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- instructions:read
x-mint:
title: Get instructions
description: Get one chatbot instruction.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
- name: instructionId
in: path
required: true
description: Instruction 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:
instruction:
$ref: '#/components/schemas/Instruction'
activeInstructionId:
type:
- string
- 'null'
description: ID of the currently active instruction; null when default.
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
instruction:
id: instruction-id
name: Example instruction
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: updateInstruction
summary: Update instructions
description: 'Update custom chatbot instructions.
Required scope: `instructions:write`.
On success, `data` contains: `instruction`, `activeInstructionId`.'
tags:
- Instructions
security:
- bearerAuth:
- instructions:write
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- instructions:write
x-mint:
title: Update instructions
description: Update custom chatbot instructions.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
- name: instructionId
in: path
required: true
description: Instruction ID.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
title:
type: string
instructions:
type: string
minLength: 1
temperature:
type: number
minimum: 0
maximum: 2
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:
instruction:
$ref: '#/components/schemas/Instruction'
activeInstructionId:
type:
- string
- 'null'
description: ID of the currently active instruction; null when default.
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
instruction:
id: instruction-id
name: Example instruction
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'
'409':
$ref: '#/components/responses/AgentError'
delete:
operationId: deleteInstruction
summary: Delete instructions
description: 'Delete custom chatbot instructions. Requires confirm=true.
Required scope: `instructions:delete`.
On success, `data` contains: `deletedInstruction`.'
tags:
- Instructions
security:
- bearerAuth:
- instructions:delete
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- instructions:delete
x-mint:
title: Delete instructions
description: Delete custom chatbot instructions. Requires confirm=true.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
- name: instructionId
in: path
required: true
description: Instruction 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:
deletedInstruction:
type: object
additionalProperties: true
properties:
id:
type: string
title:
type: string
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
deletedInstruction:
id: instruction-id
name: Example instruction
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'
'409':
$ref: '#/components/responses/AgentError'
/api/v2/chatbots/{chatbotId}/instructions/{instructionId}/use:
post:
operationId: useInstruction
summary: Use instructions
description: 'Make instructions active for a chatbot.
Required scope: `instructions:write`.
On success, `data` contains: `instruction`, `activeInstructionId`.'
tags:
- Instructions
security:
- bearerAuth:
- instructions:write
x-sitegpt-auth: bearer
x-sitegpt-scopes:
- instructions:write
x-mint:
title: Use instructions
description: Make instructions active for a chatbot.
parameters:
- name: chatbotId
in: path
required: true
description: Chatbot ID.
schema:
type: string
- name: instructionId
in: path
required: true
description: Instruction 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:
instruction:
$ref: '#/components/schemas/Instruction'
activeInstructionId:
type:
- string
- 'null'
description: ID of the currently active instruction; null when default.
meta:
$ref: '#/components/schemas/AgentResponseMeta'
additionalProperties: false
example:
ok: true
data:
instruction:
id: instruction-id
name: Example instruction
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'
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
Instruction:
type: object
description: A chatbot instruction preset (built-in or custom).
additionalProperties: true
properties:
id:
type: string
title:
type: string
description:
type: string
instructions:
type: string
temperature:
type: number
source:
type: string
enum:
- BUILT_IN
- CUSTOM
isActive:
type: boolean
isEditable:
type: boolean
isDeletable:
type: boolean
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