HighLevel: Knowledge base schemas

32 HighLevel schemas with complete fields and constraints.

← Knowledge base operations · All schemas

Create a new FAQ inside knowledge base — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`answer`	string	Required within parent	faq answer as a string
`knowledgeBaseId`	string	Required within parent	knowledge base ID as string
`locationId`	string	Required within parent	location ID as string
`question`	string	Required within parent	faq question as a string

Create a new FAQ inside knowledge base — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`faq`	JSON	Required within parent	Created FAQ details
`faq (allOf 1)`	Model	All variants apply	Expand Get all FA Qs by knowledge base with pagination support — response body — faqs item
`success`	boolean	Required within parent	Success status of the operation

Referenced models: Get all FA Qs by knowledge base with pagination support — response body — faqs item

Create a new knowledge base (max 15 knowledge bases per location) — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	string	Optional
`locationId`	string	Required within parent
`name`	string	Required within parent

Create a new knowledge base (max 15 knowledge bases per location) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`data`	JSON	Required within parent	Created knowledge base details
`data (allOf 1)`	Model	All variants apply	Expand Create a new knowledge base (max 15 knowledge bases per location) — response body — data created At, deleted, id, kb Metadata, location Id, name, name Lower Case, updated At
`success`	boolean	Required within parent	Success status of the operation

Referenced models: Create a new knowledge base (max 15 knowledge bases per location) — response body — data created At, deleted, id, kb Metadata, location Id, name, name Lower Case, updated At

Create a new knowledge base (max 15 knowledge bases per location) — response body — data created At, deleted, id, kb Metadata, location Id, name, name Lower Case, updated At

Field	Type	Presence	Description and constraints
`$`	object	Root
`createdAt`	string	Required within parent	Date when knowledge base was created
`deleted`	boolean	Required within parent	Whether the knowledge base is deleted
`id`	string	Required within parent	Knowledge base ID
`kbMetadata`	object	Required within parent	Knowledge base metadata
`locationId`	string	Required within parent	Location ID
`name`	string	Required within parent	Knowledge base name
`nameLowerCase`	string	Required within parent	Knowledge base name in lowercase
`updatedAt`	string	Required within parent	Date when knowledge base was last updated

Delete a knowledge base — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`success`	boolean	Required within parent

Delete an existing knowledge base FAQ — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`success`	boolean	Required within parent	Success status of the delete operation

Delete trained pages — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`knowledgeBaseId`	string	Required within parent	knowledge base ID as string
`locationId`	string	Required within parent	location ID as string
`urlIds`	array	Required within parent	List of trained urls ids ( fetched from the Get all trained page links by knowledge base endpoint)
`urlIds[]`	string	Each item

Delete trained pages — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`success`	boolean	Required within parent	Indicates if the operation was successful

Get all FA Qs by knowledge base with pagination support — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`count`	JSON	Required within parent
`count (anyOf 1)`	number	Alternative	Total count of all FAQs in the knowledge base
`count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`faqs`	array	Required within parent	Array of FAQ objects
`faqs[]`	Model	Each item	Expand Get all FA Qs by knowledge base with pagination support — response body — faqs item
`hasMore`	boolean	Optional	Whether there are more FAQs available
`lastFaqId`	string	Optional	Last FAQ ID for pagination (use as lastFaqId in next request)

Referenced models: Get all FA Qs by knowledge base with pagination support — response body — faqs item

Get all FA Qs by knowledge base with pagination support — response body — faqs item

Field	Type	Presence	Description and constraints
`$`	object	Root
`answer`	string	Required within parent	FAQ answer
`createdAt`	string	Required within parent	Date when FAQ was created
`deleted`	boolean	Required within parent	Whether the FAQ is deleted
`id`	string	Required within parent	FAQ ID as string
`knowledgeBaseId`	string	Required within parent	Knowledge base ID
`locationId`	string	Required within parent	Location ID
`question`	string	Required within parent	FAQ question
`questionLowerCase`	string	Required within parent	FAQ question in lowercase
`trainedUrlId`	string	Required within parent	Trained URL ID
`updatedAt`	string	Required within parent	Date when FAQ was last updated

Get all knowledge bases for a location by location Id (paginated) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`data`	JSON	Required within parent	Paginated knowledge bases data
`data (allOf 1)`	Model	All variants apply	Expand Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id
`success`	boolean	Required within parent	Success status of the operation

Referenced models: Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id

Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id

Field	Type	Presence	Description and constraints
`$`	object	Root
`activeCount`	JSON	Required within parent
`activeCount (anyOf 1)`	number	Alternative	Total count of all active knowledge bases
`activeCount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hasMore`	boolean	Required within parent	Whether there are more knowledge bases available
`knowledgeBases`	array	Required within parent	Array of knowledge bases
`knowledgeBases[]`	Model	Each item	Expand Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id knowledge Bases item
`lastKnowledgeBaseId`	string	Optional	ID of the last knowledge base in this page (use for next page request)

Referenced models: Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id knowledge Bases item

Get all knowledge bases for a location by location Id (paginated) — response body — data active Count, has More, knowledge Bases, last Knowledge Base Id knowledge Bases item

Field	Type	Presence	Description and constraints
`$`	object	Root
`createdAt`	string	Required within parent	Date when knowledge base was created
`id`	string	Required within parent	Knowledge base ID
`name`	string	Required within parent	Knowledge base name

Get all trained page links by knowledge base — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`count`	JSON	Required within parent
`count (anyOf 1)`	number	Alternative	Total count of URLs in the knowledge base
`count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`urls`	array	Required within parent	Array of crawled URLs with their details
`urls[]`	Model	Each item	Expand Get all trained page links by knowledge base — response body — urls item

Referenced models: Get all trained page links by knowledge base — response body — urls item

Get all trained page links by knowledge base — response body — urls item

Field	Type	Presence	Description and constraints
`$`	object	Root
`content`	string	Required within parent	URL to the stored content file
`contentEditedByUser`	boolean	Required within parent	Whether the content was edited by user
`id`	string	Required within parent	Unique identifier for the URL
`knowledgeBaseId`	string	Required within parent	Knowledge base ID this URL belongs to
`locationId`	string	Required within parent	Location ID associated with this URL
`status`	string	Required within parent	Current processing status of the URL Known values: Pending, Processing, Successful, Failed, Existing, Restricted, Cancelled, Aborted, Training
`title`	string	Required within parent	Title of the webpage
`updatedAt`	string	Required within parent	Last updated timestamp
`url`	string	Required within parent	The actual URL that was crawled

Get crawling status for the latest operation — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`data`	JSON	Required within parent	Detailed crawling status data
`data (allOf 1)`	Model	All variants apply	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details
`success`	boolean	Required within parent	Indicates if the operation was successful

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details

Get crawling status for the latest operation — response body — data / aggregate, operationDetails / operationDetails / mode: Exact, Path, Domain

Field	Type	Presence	Description and constraints
`$`	object	Root
`__v`	JSON	Required within parent
`__v (anyOf 1)`	number	Alternative	Version field
`__v (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`_id`	string	Required within parent	Operation unique identifier
`createdAt`	string	Required within parent	Operation creation timestamp
`discoveredUrlsCount`	JSON	Required within parent
`discoveredUrlsCount (anyOf 1)`	number	Alternative	Number of URLs discovered
`discoveredUrlsCount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`knowledgeBaseId`	string	Required within parent	Knowledge base ID
`locationId`	string	Required within parent	Associated location ID
`mode`	string	Required within parent	Crawling mode used Known values: Exact, Path, Domain
`robotsFileData`	string	Optional	Robots.txt file content
`status`	string	Required within parent	Current operation status Known values: Pending, Processing, Successful, Failed, Existing, Restricted, Cancelled, Aborted, Training
`trainedUrlsCount`	JSON	Required within parent
`trainedUrlsCount (anyOf 1)`	number	Alternative	Number of URLs successfully trained
`trainedUrlsCount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`updatedAt`	string	Required within parent	Last update timestamp
`url`	string	Required within parent	Base URL being crawled

Get crawling status for the latest operation — response body — data aggregate, operation Details

Field	Type	Presence	Description and constraints
`$`	object	Root
`aggregate`	array	Required within parent	Aggregated crawling results by status
`aggregate[]`	Model	Each item	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item
`operationDetails`	JSON	Required within parent	Detailed operation information
`operationDetails (allOf 1)`	Model	All variants apply	Expand Get crawling status for the latest operation — response body — data / aggregate, operationDetails / operationDetails / mode: Exact, Path, Domain

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item, Get crawling status for the latest operation — response body — data / aggregate, operationDetails / operationDetails / mode: Exact, Path, Domain

Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item

Field	Type	Presence	Description and constraints
`$`	object	Root
`_id`	string	Required within parent	Status grouping identifier Known values: Pending, Processing, Successful, Failed, Existing, Restricted, Cancelled, Aborted, Training
`records`	array	Required within parent	Array of records for this status
`records[]`	Model	Each item	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item

Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item

Field	Type	Presence	Description and constraints
`$`	object	Root
`error`	JSON	Optional	Error details (for failed records)
`error (allOf 1)`	Model	All variants apply	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item error message, name, options, response, stack, status
`id`	string	Required within parent	Unique record identifier
`title`	string	Optional	Page title (for successful/pending records)
`url`	string	Required within parent	URL being crawled

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item error message, name, options, response, stack, status

Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item error message, name, options, response, stack, status

Field	Type	Presence	Description and constraints
`$`	object	Root
`message`	string	Required within parent	Error message
`name`	string	Required within parent	Error name/type
`options`	object	Optional	Additional options (nullable)
`response`	string	Required within parent	Error response message
`stack`	string	Required within parent	Error stack trace
`status`	JSON	Required within parent
`status (anyOf 1)`	number	Alternative	HTTP status code
`status (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get knowledge base by ID — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`data`	JSON	Required within parent	Knowledge base details
`data (allOf 1)`	Model	All variants apply	Expand Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At
`success`	boolean	Required within parent	Success status of the operation

Referenced models: Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At

Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At

Field	Type	Presence	Description and constraints
`$`	object	Root
`createdAt`	string	Required within parent	Date when knowledge base was created
`deleted`	boolean	Required within parent	Whether the knowledge base is deleted
`id`	string	Required within parent	Knowledge base ID
`isDefault`	boolean	Optional	Whether the knowledge base is default or not
`kbMetadata`	JSON	Required within parent	Knowledge base metadata with content counts
`kbMetadata (allOf 1)`	Model	All variants apply	Expand Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At kb Metadata faqs, files, rich Text, tables, urls, web Searches
`locationId`	string	Required within parent	Location ID
`name`	string	Required within parent	Knowledge base name
`nameLowerCase`	string	Required within parent	Knowledge base name in lowercase
`updatedAt`	string	Required within parent	Date when knowledge base was last updated

Referenced models: Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At kb Metadata faqs, files, rich Text, tables, urls, web Searches

Get knowledge base by ID — response body — data created At, deleted, id, is Default, kb Metadata, location Id, name, name Lower Case, updated At kb Metadata faqs, files, rich Text, tables, urls, web Searches

Field	Type	Presence	Description and constraints
`$`	object	Root
`faqs`	JSON	Required within parent
`faqs (anyOf 1)`	number	Alternative	Number of FAQs in the knowledge base
`faqs (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`files`	JSON	Required within parent
`files (anyOf 1)`	number	Alternative	Number of files in the knowledge base
`files (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`richText`	JSON	Required within parent
`richText (anyOf 1)`	number	Alternative	Number of rich text documents in the knowledge base
`richText (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`tables`	JSON	Required within parent
`tables (anyOf 1)`	number	Alternative	Number of tables in the knowledge base
`tables (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`urls`	JSON	Required within parent
`urls (anyOf 1)`	number	Alternative	Number of URLs in the knowledge base
`urls (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`webSearches`	JSON	Required within parent
`webSearches (anyOf 1)`	number	Alternative	Number of web searche configs in the knowledge base
`webSearches (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Start crawling and discover pages for training — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`knowledgeBaseId`	string	Required within parent	knowledge base ID as string
`locationId`	string	Required within parent	Location ID as string
`option`	string	Required within parent	Mode as string One of: Exact, Path, Domain
`url`	string	Required within parent	Website URL as string

Start crawling and discover pages for training — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`data`	JSON	Required within parent	Data containing operation details
`data (allOf 1)`	Model	All variants apply	Expand Start crawling and discover pages for training — response body — data operation Id, status, url
`success`	boolean	Required within parent	Indicates if the operation was successful

Referenced models: Start crawling and discover pages for training — response body — data operation Id, status, url

Start crawling and discover pages for training — response body — data operation Id, status, url

Field	Type	Presence	Description and constraints
`$`	object	Root
`operationId`	string	Required within parent	Operation ID for tracking the discovery process
`status`	string	Required within parent	Current status of the website discovery operation Known values: Pending, Processing, Successful, Failed, Existing, Restricted, Cancelled, Aborted, Training
`url`	string	Required within parent	The URL being discovered/crawled

Train discovered website pages and ingest into the knowledge base — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`knowledgeBaseId`	string	Required within parent	knowledge base id
`locationId`	string	Required within parent	Location ID as string
`operationId`	string	Required within parent	operation id as string
`urlIds`	array	Required within parent	List of Object ids of the discovered urls
`urlIds[]`	string	Each item

Update a knowledge base — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	string	Optional	field to update the description of the knowledge base
`name`	string	Optional	field to update the name of the knowledge base

Update an existing knowledge base FAQ — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`answer`	string	Required within parent	faq answer as a string
`question`	string	Required within parent	faq question as a string

Update an existing knowledge base FAQ — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`success`	boolean	Required within parent	Success status of the update operation

Report an issue with this page