Developer APIResourcesAgent Studio

Get knowledge base recipes

Returns the recipes associated with the knowledge base ID you specify.

Path parameters

idstringRequired
The ID of the knowledge base for which you plan to retrieve associated recipes.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystringOptional
Search query.
pageintegerOptional>=1

Page number of the recipes to fetch. Minimum value is 1.

per_pageintegerOptional>=1<=50

Number of recipes to return in a single page. Minimum value is 1. Maximum value is 50.

sort_termstringOptional

The field or term to sort results by. For example: name or latest_activity.

Response

Knowledge base recipes retrieved successfully
idinteger or null
The unique identifier of the recipe.
namestring or null
The name of the recipe.
descriptionstring or null
A description of what the recipe does.
knowledge_base_idstring or null
The ID of the associated knowledge base.

Errors