sitegpt-ai

sitegpt-ai Account API

The Account API from sitegpt-ai — 6 operation(s) for account.

GitHub OpenAPI

Operations 7

GET /api/v2/me Get current user #
GET /api/v2/account Get account #
PATCH /api/v2/account/profile Update profile #
POST /api/v2/account/profile-picture Upload profile picture #
DELETE /api/v2/account/profile-picture Delete profile picture #
GET /api/v2/usage Get Usage #
GET /api/v2/limits Get Limits #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sitegpt-ai/openapi/sitegpt-ai-account-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-conversation-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-chatbot-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-message-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-billing-subscription-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-invoice-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-knowledge-document-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/sitegpt-ai/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sitegpt-ai:sitegpt-ai-account-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sitegpt-ai-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SiteGPT Agent Account 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: Account
paths:
  /api/v2/me:
    get:
      operationId: getMe
      summary: Get current user
      description: 'Get the authenticated user and credential context.


        Requires a valid SiteGPT bearer token.


        On success, `data` contains: `user`, `auth`.'
      tags:
      - Account
      security:
      - bearerAuth: []
      x-sitegpt-auth: bearer
      x-sitegpt-scopes: []
      x-mint:
        title: Get current user
        description: Get the authenticated user and credential context.
      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:
                      user:
                        $ref: '#/components/schemas/AccountUser'
                      auth:
                        type: object
                        description: How this request was authenticated.
                        additionalProperties: true
                        properties:
                          credentialType:
                            type: string
                          tokenId:
                            type:
                            - string
                            - 'null'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  user:
                    id: user-id
                    email: user@example.com
                    name: SiteGPT User
                  auth:
                    type: api-token
                    scopes: []
                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/account:
    get:
      operationId: getAccount
      summary: Get account
      description: 'Get current account user and auth metadata.


        Required scope: `account:read`.


        On success, `data` contains: `user`, `auth`.'
      tags:
      - Account
      security:
      - bearerAuth:
        - account:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - account:read
      x-mint:
        title: Get account
        description: Get current account user and auth metadata.
      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:
                      user:
                        $ref: '#/components/schemas/AccountUser'
                      auth:
                        type: object
                        description: How this request was authenticated.
                        additionalProperties: true
                        properties:
                          credentialType:
                            type: string
                          tokenId:
                            type:
                            - string
                            - 'null'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  user:
                    id: user-id
                    email: user@example.com
                    name: SiteGPT User
                  auth:
                    type: api-token
                    scopes:
                    - account:read
                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/account/profile:
    patch:
      operationId: updateAccountProfile
      summary: Update profile
      description: 'Update the authenticated user profile name.


        Required scope: `account:write`.


        On success, `data` contains: `user`.'
      tags:
      - Account
      security:
      - bearerAuth:
        - account:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - account:write
      x-mint:
        title: Update profile
        description: Update the authenticated user profile name.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              additionalProperties: false
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
      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:
                      user:
                        $ref: '#/components/schemas/AccountUser'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  user:
                    id: user-id
                    email: user@example.com
                    name: SiteGPT User
                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/account/profile-picture:
    post:
      operationId: uploadAccountProfilePicture
      summary: Upload profile picture
      description: 'Upload the authenticated user profile picture.


        Required scope: `account:write`.


        On success, `data` contains: `user`, `profilePicture`.'
      tags:
      - Account
      security:
      - bearerAuth:
        - account:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - account:write
      x-mint:
        title: Upload profile picture
        description: Upload the authenticated user profile picture.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - imageBase64
              additionalProperties: false
              properties:
                imageBase64:
                  type: string
                  description: Base64 image content. Data URLs are accepted.
                fileName:
                  type: string
                mimeType:
                  type: string
                  description: Image MIME type, for example image/png.
      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:
                      user:
                        $ref: '#/components/schemas/AccountUser'
                      profilePicture:
                        type: object
                        additionalProperties: false
                        properties:
                          imageId:
                            type:
                            - string
                            - 'null'
                          imageUrl:
                            type:
                            - string
                            - 'null'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  user:
                    id: user-id
                    email: user@example.com
                    name: SiteGPT User
                  profilePicture:
                    imageId: image-id
                    imageUrl: https://example.com/i
                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: deleteAccountProfilePicture
      summary: Delete profile picture
      description: 'Delete the authenticated user profile picture. Requires confirm=true.


        Required scope: `account:write`.


        On success, `data` contains: `user`, `profilePicture`.'
      tags:
      - Account
      security:
      - bearerAuth:
        - account:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - account:write
      x-mint:
        title: Delete profile picture
        description: Delete the authenticated user profile picture. Requires confirm=true.
      parameters:
      - 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:
                      user:
                        $ref: '#/components/schemas/AccountUser'
                      profilePicture:
                        type: object
                        additionalProperties: false
                        properties:
                          imageId:
                            type:
                            - string
                            - 'null'
                          imageUrl:
                            type:
                            - string
                            - 'null'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  user:
                    id: user-id
                    email: user@example.com
                    name: SiteGPT User
                  profilePicture:
                    imageId: null
                    imageUrl: 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'
  /api/v2/usage:
    get:
      operationId: getUsage
      summary: Get Usage
      description: 'Get account usage.


        Required scope: `account:read`.


        On success, `data` contains: `usageWindow`, `usage`, `quotas`, `remaining`, `history`.'
      tags:
      - Account
      security:
      - bearerAuth:
        - account:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - account:read
      x-mint:
        title: Get Usage
        description: Get account usage.
      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:
                      usageWindow:
                        type: object
                        additionalProperties: false
                        properties:
                          startDate:
                            type: string
                            format: date-time
                          endDate:
                            type: string
                            format: date-time
                      usage:
                        type: object
                        additionalProperties: false
                        properties:
                          chatbots:
                            type: integer
                          pages:
                            type: integer
                          normalMessages:
                            type: integer
                          gpt4Messages:
                            type: integer
                          combinedMessages:
                            type: integer
                          members:
                            type: integer
                      quotas:
                        $ref: '#/components/schemas/AccountQuotas'
                      remaining:
                        type: object
                        additionalProperties: false
                        properties:
                          chatbots:
                            type: integer
                          pages:
                            type: integer
                          normalMessages:
                            type: integer
                          gpt4Messages:
                            type: integer
                          combinedMessages:
                            type: integer
                          members:
                            type: integer
                      history:
                        type: array
                        items:
                          $ref: '#/components/schemas/GenericObject'
                          description: Historical usage entry.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  usageWindow:
                    startDate: '2026-05-01T00:00:00.000Z'
                    endDate: '2026-05-31T23:59:59.999Z'
                  usage:
                    chatbots: 1
                    pages: 120
                    combinedMessages: 45
                  quotas:
                    chatbotsQuota: 3
                    pagesQuota: 1000
                  remaining:
                    chatbots: 2
                    pages: 880
                  history: []
                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/limits:
    get:
      operationId: getLimits
      summary: Get Limits
      description: 'Get account limits and remaining quotas.


        Required scope: `account:read`.


        On success, `data` contains: `total`, `assigned`, `available`, `chatbots`.'
      tags:
      - Account
      security:
      - bearerAuth:
        - account:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - account:read
      x-mint:
        title: Get Limits
        description: Get account limits and remaining quotas.
      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:
                      total:
                        type: object
                        additionalProperties: false
                        properties:
                          pagesQuota:
                            type: integer
                          combinedMessagesQuota:
                            type: integer
                          membersQuota:
                            type: integer
                      assigned:
                        type: object
                        additionalProperties: false
                        properties:
                          pagesQuota:
                            type: integer
                          combinedMessagesQuota:
                            type: integer
                          membersQuota:
                            type: integer
                      available:
                        type: object
                        additionalProperties: false
                        properties:
                          pagesQuota:
                            type: integer
                          combinedMessagesQuota:
                            type: integer
                          membersQuota:
                            type: integer
                      chatbots:
                        type: array
                        items:
                          type: object
                          additionalProperties: true
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            pagesQuota:
                              type:
                              - integer
                              - 'null'
                            combinedMessagesQuota:
                              type:
                              - integer
                              - 'null'
                            membersQuota:
                              type:
                              - integer
                              - 'null'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  total:
                    pagesQuota: 1000
                    combinedMessagesQuota: 500
                    membersQuota: 5
                  assigned:
                    pagesQuota: 400
                    combinedMessagesQuota: 200
                    membersQuota: 2
                  available:
                    pagesQuota: 600
                    combinedMessagesQuota: 300
                    membersQuota: 3
                  chatbots:
                  - id: chatbot-id
                    title: Example chatbot
                    pagesQuota: 400
                    combinedMessagesQuota: 200
                    membersQuota: 2
                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:
    GenericObject:
      type: object
      additionalProperties: true
    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
    AccountQuotas:
      type: object
      description: Account-level quota ceilings.
      additionalProperties: true
      properties:
        chatbotsQuota:
          type: integer
        docsQuota:
          type: integer
        filesQuota:
          type: integer
        pagesQuota:
          type: integer
        maxFileSize:
          type: integer
        combinedMessagesQuota:
          type: integer
        normalMessagesQuota:
          type: integer
          description: Derived; absent from the /api/v2/me variant.
        gpt4MessagesQuota:
          type: integer
          description: Derived; absent from the /api/v2/me variant.
        gpt4Share:
          type: number
        membersQuota:
          type: integer
    AccountUser:
      type: object
      description: The authenticated SiteGPT user.
      additionalProperties: true
      properties:
        id:
          type: string
        email:
          type: string
        name:
          type: string
        profilePicSrcId:
          type:
          - string
          - 'null'
          description: Absent from the /api/v2/me variant.
        globalRole:
          type: string
        brandId:
          type: string
        verified:
          type: boolean
        features:
          $ref: '#/components/schemas/GenericObject'
          description: Feature flags enabled for this account.
        quotas:
          $ref: '#/components/schemas/AccountQuotas'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  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