github-starred/ollama
2
0
Fork 0
mirror of https://github.com/ollama/ollama.git synced 2026-05-07 00:22:43 -05:00
Code Issues 14.5k Packages Projects Releases 120 Wiki Activity

[PR #14457] docs: clarify streaming format as JSONL and document error responses #61379

New Issue
Open
opened 2026-04-29 16:27:21 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-29 16:27:21 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/ollama/ollama/pull/14457
Author: @Anandesh-Sharma
Created: 2/26/2026
Status: 🔄 Open

Base: main ← Head: docs-api-improvements

📝 Commits (1)

  • 0f900c1 docs: clarify streaming format as JSONL and document error responses

📊 Changes

1 file changed (+20 additions, -1 deletions)

View changed files

📝 docs/api.md (+20 -1)

📄 Description

Summary

  • Specify that streaming endpoints return JSON Lines (JSONL) format where each JSON object is separated by a newline
  • Add error response documentation with example JSON body and common HTTP status codes table

Details

The API documentation previously stated streaming returns "a stream of JSON objects" without specifying the exact wire format. This clarifies it as JSONL, making it easier for client implementors to use line-buffered parsing.

Additionally, the API documentation had no section explaining how errors are reported. This adds documentation for the error JSON format and common HTTP status codes.

Test plan

  • Verified error format matches actual server behavior
  • Verified streaming format description is accurate

Fixes #7703
Fixes #9905

🤖 Generated with Claude Code

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/ollama/ollama/pull/14457 **Author:** [@Anandesh-Sharma](https://github.com/Anandesh-Sharma) **Created:** 2/26/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs-api-improvements` --- ### 📝 Commits (1) - [`0f900c1`](https://github.com/ollama/ollama/commit/0f900c1ec5c106b91ea271433321e7c5fbc4fdd6) docs: clarify streaming format as JSONL and document error responses ### 📊 Changes **1 file changed** (+20 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/api.md` (+20 -1) </details> ### 📄 Description ## Summary - Specify that streaming endpoints return [JSON Lines (JSONL)](https://jsonlines.org/) format where each JSON object is separated by a newline - Add error response documentation with example JSON body and common HTTP status codes table ## Details The API documentation previously stated streaming returns "a stream of JSON objects" without specifying the exact wire format. This clarifies it as JSONL, making it easier for client implementors to use line-buffered parsing. Additionally, the API documentation had no section explaining how errors are reported. This adds documentation for the error JSON format and common HTTP status codes. ## Test plan - [x] Verified error format matches actual server behavior - [x] Verified streaming format description is accurate Fixes #7703 Fixes #9905 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-29 16:27:21 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
amd
api
app
bug
build
cli
cloud
compatibility
context-length
create
docker
documentation
embeddings
feature request
feedback wanted
good first issue
gpt-oss
gpu
harmony
help wanted
image
install
intel
js
launch
linux
macos
memory
mlx
model
needs more info
networking
nvidia
ollama.com
performance
pull-request
Mirrored from GitHub Pull Request
 python
question
registry
rendering
thinking
tools
top
vulkan
windows
wsl
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/ollama#61379
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?