Create knowledge base

POST

/api/v1/knowledge-base

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/knowledge-base \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "body_html": "example", "category": "example", "tags": [ "example" ], "is_public": true, "is_ai_context": true, "sort_order": 1, "status": "draft", "locale": "example", "translation_of": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

title

required

string

>= 1 characters <= 500 characters

body_html

required

string

>= 1 characters

category

string

<= 200 characters

tags

Array<string>

<= 50 items

is_public

boolean

is_ai_context

boolean

sort_order

integer

status

string

Allowed values: draft in_review published archived

locale

string

<= 16 characters

translation_of

Any of:

string

string

/^[0-9a-fA-F]{24}$/

null

null

Responses

201

Created

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}