Repository navigation
docs: custom KB uuid must be a UUID v4; direct response is a custom-message - #1321
Merged
stephenvapiai merged 2 commits intoOct 14, 2026
Merged
Conversation
…essage
The API accepts only a UUID v4 in documents[].uuid and discards a response
that fails validation. The direct response field is a custom message
({ type: 'custom-message', content }), not a role/content chat message.
Example servers no longer map arbitrary IDs or titles into uuid.
chiranjeet-vapi
force-pushed
the
docs/custom-kb-response-shape
branch
from
October 14, 2026 04:09
f1c9c1e to
4bac90f
Compare
chiranjeet-vapi
marked this pull request as ready for review
October 14, 2026 16:41
Lightsage docs evalsWaiting for the staging docs URL before running evals. Lightsage will start the selected PR evals automatically when GitHub reports a successful docs deployment for this PR. This usually happens within 15 minutes. Commit: |
stephenvapiai
approved these changes
Oct 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
"uuid": "doc-return-policy-1". Vapi only accepts a UUID v4 inuuid, and a response that fails validation is discarded as a whole, so a customer copying the example gets no documents at all.uuidvalues are now real UUID v4s, with a warning to omituuidwhen IDs are not UUIDs. The sample servers no longer map arbitrary IDs or titles intouuid.{ "message": { "role": "assistant", "content": ... } }. The field is a custom message:{ "type": "custom-message", "content": ... }.Evidence
https://api.vapi.ai/api-json, 2026-10-14):CustomMessage.typeenum is["custom-message"]andCustomMessage.contenthasmaxLength: 1000; there is noroleproperty.KnowledgeBaseResponseDocument.uuidas a plain string, so the API reference understates the constraint.Testing Steps
fern check(pinned 5.151.1) passes locally