Kairon

Kairon Settings API

The settings API from Kairon — 9 operation(s) for settings.

GitHub OpenAPI

Operations 14

GET /api/settings/value-proposition Settings controller get value proposition #
PUT /api/settings/value-proposition Settings controller set value proposition #
GET /api/settings/lead-magnet Settings controller get lead magnet #
PUT /api/settings/lead-magnet Settings controller set lead magnet #
GET /api/settings/learnings Settings controller get learnings #
PUT /api/settings/learnings Settings controller set learnings #
GET /api/settings/brief-instructions Settings controller get brief instructions #
PUT /api/settings/brief-instructions Settings controller set brief instructions #
GET /api/settings/setup Settings controller get setup #
PUT /api/settings/setup Settings controller complete setup #
PUT /api/settings/timezone Settings controller set timezone #
PUT /api/settings/locale Settings controller set locale #
PUT /api/settings/whatsapp Settings controller set whatsapp number #
PUT /api/settings/default-language Settings controller set default language #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/heykairon-com/openapi/heykairon-com-settings-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-campaign-draft-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-agent-campaign-chat-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-agent-icp-chat-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-create-icp-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-update-icp-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-set-source-body-dto-schema.json

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/heykairon-com:heykairon-com-settings-api"
All apis 
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.

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

heykairon-com-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Kairon Settings API
  description: B2B agentic go-to-market platform
  version: 0.0.0
  contact: {}
servers: []
security:
- api-key: []
tags:
- name: Settings
paths:
  /api/settings/value-proposition:
    get:
      operationId: SettingsController_getValueProposition
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller get value proposition
      x-summary-source: derived
    put:
      operationId: SettingsController_setValueProposition
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValuePropositionInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set value proposition
      x-summary-source: derived
  /api/settings/lead-magnet:
    get:
      operationId: SettingsController_getLeadMagnet
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller get lead magnet
      x-summary-source: derived
    put:
      operationId: SettingsController_setLeadMagnet
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadMagnetInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set lead magnet
      x-summary-source: derived
  /api/settings/learnings:
    get:
      operationId: SettingsController_getLearnings
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller get learnings
      x-summary-source: derived
    put:
      operationId: SettingsController_setLearnings
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LearningsInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set learnings
      x-summary-source: derived
  /api/settings/brief-instructions:
    get:
      operationId: SettingsController_getBriefInstructions
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller get brief instructions
      x-summary-source: derived
    put:
      operationId: SettingsController_setBriefInstructions
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BriefInstructionsInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set brief instructions
      x-summary-source: derived
  /api/settings/setup:
    get:
      operationId: SettingsController_getSetup
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller get setup
      x-summary-source: derived
    put:
      operationId: SettingsController_completeSetup
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller complete setup
      x-summary-source: derived
  /api/settings/timezone:
    put:
      operationId: SettingsController_setTimezone
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserTimezoneInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set timezone
      x-summary-source: derived
  /api/settings/locale:
    put:
      operationId: SettingsController_setLocale
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserLocaleInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set locale
      x-summary-source: derived
  /api/settings/whatsapp:
    put:
      operationId: SettingsController_setWhatsappNumber
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhatsappNumberInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set whatsapp number
      x-summary-source: derived
  /api/settings/default-language:
    put:
      operationId: SettingsController_setDefaultLanguage
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultLanguageInputDto'
      responses:
        '200':
          description: ''
      tags:
      - Settings
      summary: Settings controller set default language
      x-summary-source: derived
components:
  schemas:
    ValuePropositionInputDto:
      type: object
      properties:
        valueProposition:
          type: string
          maxLength: 5000
        expected:
          type: string
      required:
      - valueProposition
    DefaultLanguageInputDto:
      type: object
      properties:
        language:
          anyOf:
          - type: string
            enum:
            - aa
            - ab
            - ae
            - af
            - ak
            - am
            - an
            - ar
            - as
            - av
            - ay
            - az
            - ba
            - be
            - bg
            - bh
            - bi
            - bm
            - bn
            - bo
            - br
            - bs
            - ca
            - ce
            - ch
            - co
            - cr
            - cs
            - cu
            - cv
            - cy
            - da
            - de
            - dv
            - dz
            - ee
            - el
            - en
            - eo
            - es
            - et
            - eu
            - fa
            - ff
            - fi
            - fj
            - fo
            - fr
            - fy
            - ga
            - gd
            - gl
            - gn
            - gu
            - gv
            - ha
            - he
            - hi
            - ho
            - hr
            - ht
            - hu
            - hy
            - hz
            - ia
            - id
            - ie
            - ig
            - ii
            - ik
            - io
            - is
            - it
            - iu
            - ja
            - jv
            - ka
            - kg
            - ki
            - kj
            - kk
            - kl
            - km
            - kn
            - ko
            - kr
            - ks
            - ku
            - kv
            - kw
            - ky
            - la
            - lb
            - lg
            - li
            - ln
            - lo
            - lt
            - lu
            - lv
            - mg
            - mh
            - mi
            - mk
            - ml
            - mn
            - mr
            - ms
            - mt
            - my
            - na
            - nb
            - nd
            - ne
            - ng
            - nl
            - nn
            - 'no'
            - nr
            - nv
            - ny
            - oc
            - oj
            - om
            - or
            - os
            - pa
            - pi
            - pl
            - ps
            - pt
            - qu
            - rm
            - rn
            - ro
            - ru
            - rw
            - sa
            - sc
            - sd
            - se
            - sg
            - si
            - sk
            - sl
            - sm
            - sn
            - so
            - sq
            - sr
            - ss
            - st
            - su
            - sv
            - sw
            - ta
            - te
            - tg
            - th
            - ti
            - tk
            - tl
            - tn
            - to
            - tr
            - ts
            - tt
            - tw
            - ty
            - ug
            - uk
            - ur
            - uz
            - ve
            - vi
            - vo
            - wa
            - wo
            - xh
            - yi
            - yo
            - za
            - zh
            - zu
          - type: 'null'
          x-nestjs_zod-uses-3-point-1-syntax: true
          x-nestjs_zod-empty-type: true
      required:
      - language
    BriefInstructionsInputDto:
      type: object
      properties:
        briefInstructions:
          type: string
          maxLength: 5000
        expected:
          type: string
      required:
      - briefInstructions
    WhatsappNumberInputDto:
      type: object
      properties:
        number:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          x-nestjs_zod-uses-3-point-1-syntax: true
          x-nestjs_zod-empty-type: true
        country:
          type: string
          pattern: ^[A-Z]{2}$
          x-nestjs_zod-uses-3-point-1-syntax: true
      required:
      - number
    UserTimezoneInputDto:
      type: object
      properties:
        tz:
          type: string
          minLength: 1
          maxLength: 64
      required:
      - tz
    LearningsInputDto:
      type: object
      properties:
        learnings:
          type: string
          maxLength: 20000
        expected:
          type: string
      required:
      - learnings
    UserLocaleInputDto:
      type: object
      properties:
        locale:
          type: string
          maxLength: 35
      required:
      - locale
    LeadMagnetInputDto:
      type: object
      properties:
        leadMagnet:
          type: string
          maxLength: 5000
        expected:
          type: string
      required:
      - leadMagnet
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: 'A Kairon API key (Settings → Integrations → API access), sent as `x-api-key`. NOT an `Authorization: Bearer` token — that header belongs to the separate /mcp door and is ignored here.'
    session:
      type: apiKey
      in: cookie
      name: better-auth.session_token