Create a new Knowledge Base entry

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/knowledge-bases/add

Adds a new entry to the Knowledge Base. This is typically done by converting a 'proven' or 'disproven' hypothesis, but can also be used to manually add other experimental learnings. Requires a name, summary, and status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project into which the knowledge base is to be stored

Query Params

expand

array of objects

Specifies the list of objects which would be expanded in the response. Otherwise, only their id would be returned.

Read more in the section related to Expanding Fields

expand

Body Params

name

string

required

length ≤ 100

A concise title for the Knowledge Base entry, often derived from the original hypothesis name or a summary of the key learning (e.g., "Green CTA Button Increased Signups by 10%", "Simplified Navigation Did Not Improve Task Completion").

status

string

enum

Defaults to active

The status of a Knowledge Base entry:

active: The entry is current and relevant.
archived: The entry is kept for historical purposes but may no longer be considered current best practice or has been superseded by newer learnings.

Allowed:

summary

string

required

length ≤ 500

A detailed summary of the findings, insights, and conclusions derived from the tested hypothesis that led to this Knowledge Base entry. This should articulate what was learned, whether the hypothesis was proven or disproven, and any actionable takeaways.

url

string | null

Url reference for the knowledge base

objective

string

length ≤ 5000

A given description for the knowledge base to easily identify it later

start_date

date | null

The date in format YYYY-MM-DD

end_date

date | null

The date in format YYYY-MM-DD

prioritization_score_type

string | null

A given description of prioritizing model

prioritization_score_attributes

object | null

Prioritization score attributes

experiences

array of objects | null

The list of experiences connected to this knowledge base

experiences

description

string

length ≤ 5000

Detailed description of the knowledge base

files

array of objects | null

Files attached to the knowledge base

files

201Detailed information for a single Knowledge Base entry, including its name, summary of findings, status (active/archived), creator, and associated tags.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.