Skip to content

docs: document stateless Responses API - #47

Merged
PierreLeGuen merged 2 commits into
mainfrom
docs/stateless-responses-api
Aug 21, 2026
Merged

docs: document stateless Responses API#47
PierreLeGuen merged 2 commits into
mainfrom
docs/stateless-responses-api

Conversation

@PierreLeGuen

Copy link
Copy Markdown
Contributor

Summary

  • add a complete guide for stateless POST /v1/responses, caller-managed history, and client-managed custom functions
  • remove Files, Conversations, response-history, and built-in Responses tool guidance from the hand-authored docs
  • update the generated API Reference to the exact public contract implemented by feat(api): restrict stateful APIs for migration cloud-api#943
  • keep Chat Completions web search documented as a separate supported flow

Dependency

This PR documents the contract in nearai/cloud-api#934 and nearai/cloud-api#943. It should merge with or after that API contract is deployed. It does not claim that historical data has been deleted, and it does not cover the separate data export, retention, Private Chat, or /mcp workstreams.

The generated OpenAPI change applies only the #943 delta to the currently published spec: 20 retiring operations are removed and no unrelated operations are added.

Validation

  • npx --yes mint validate
  • npx --yes mint broken-links
  • git diff --check
  • structural OpenAPI assertions: only POST /v1/responses remains; Conversations, Files, and response-history paths are absent; store defaults to false; stateful fields and built-in tools are absent from the request schema
  • public-disclosure review: no private links, customer identities, usage data, or internal operational evidence

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f8454d4380

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread api-reference/openapi.json Outdated
Comment thread cloud/guides/openai-compatibility.mdx
Comment thread cloud/guides/stateless-responses.mdx
@PierreLeGuen
PierreLeGuen merged commit f6bb834 into main Aug 21, 2026
2 checks passed
@PierreLeGuen
PierreLeGuen deleted the docs/stateless-responses-api branch August 21, 2026 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants