Generated by API Evangelist
Written by API Evangelist tooling for Drata's API. It is a proposal applied on top of the contract, not a document Drata publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for SafeBase API documentation Knowledge Base API
version: 1.0.0
extends: openapi/drata-knowledge-base-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/kb/search'].get
update:
x-apievangelist-phrasing:
intent: Search the knowledge base
effect: read
questions:
- Do we already have an approved answer about data encryption?
- Can I search knowledge base answers for a specific product?
instructions:
- text: Search the knowledge base for {query}.
slots:
query: query.query
- text: Find knowledge base answers about {query} for product {products}.
slots:
query: query.query
products: query.products
method: generated
generated: '2026-09-26'
- target: $.paths['/kb/entries'].post
update:
x-apievangelist-phrasing:
intent: Add a knowledge base entry
effect: write
questions:
- How do I add a new question and answer to our knowledge base?
- Can I set who is allowed to see a knowledge base entry?
instructions:
- text: Add knowledge base entry {question} with answer {answer}.
slots:
question: requestBody.question
answer: requestBody.answer
- text: Create a KB entry for {question} with access level {access_level}.
slots:
question: requestBody.question
access_level: requestBody.accessLevel
method: generated
generated: '2026-09-26'
- target: $.paths['/kb/entries/{id}/'].patch
update:
x-apievangelist-phrasing:
intent: Update a knowledge base entry
effect: write
questions:
- Can I change the answer on an existing knowledge base entry?
- Is it possible to change a KB entry's access level?
instructions:
- text: Update knowledge base entry {entry} with answer {answer}.
slots:
entry: path.id
answer: requestBody.answer
- text: Set the access level of KB entry {entry} to {access_level}.
slots:
entry: path.id
access_level: requestBody.accessLevel
method: generated
generated: '2026-09-26'
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.