Skip to content

Added pin and save limits and the missing message operations to the o… - #517

Open
pranavkamble-cometchat wants to merge 8 commits into
mainfrom
docs/restapi-chatapi-ENG-39107
Open

pranavkamble-cometchat wants to merge 8 commits into
mainfrom
docs/restapi-chatapi-ENG-39107

Conversation

@pranavkamble-cometchat

@pranavkamble-cometchat pranavkamble-cometchat commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

…verview.

Description

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

@mintlify

mintlify Bot commented Sep 10, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
cometchat 🟢 Ready View Preview Sep 17, 2026, 2:38 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

siva-cometchat
siva-cometchat previously approved these changes Sep 10, 2026
…rows, rename example UIDs to cometchat-uid-N
siva-cometchat
siva-cometchat previously approved these changes Sep 10, 2026
States all four limits as fixed values wherever a reader looks: 100 pinned
messages per conversation with user and app pins sharing that limit, 100 saved
messages per user, 5 pinned conversations per user, and 5 globally pinned
conversations per app.

- rest-api/messages.mdx: correct the pin bullet, which said a conversation
  holds 100 pinned messages and then that app and user pins each have their
  own limit of 100, implying 200. Adds the error codes to the limit bullets
  and to the page's error table. Operations table: rename the row to
  "Mark Message As Interacted" to match the page title, reword "Remove a
  pinned message" to "Unpin a message", and note the five operations that
  require the onBehalfOf header.
- rest-api/conversations.mdx: add the two conversation pin limits.
- articles/properties-and-constraints.mdx: add all four as rows, which the
  messages page already linked to for system limits.
- articles/error-guide.mdx: give the four limit errors their actual values
  instead of "the maximum number allowed".
- Re-sync chat-apis.json and data-import-apis.json from the chat-api OAS.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Adds a Get Call Transcriptions page driven by the new
/calls/{sessionId}/transcriptions operation, wires it into the Calls group in
docs.json, and refreshes calls.json from the regenerated OAS output.

The overview gains the endpoint row, the hasTranscription and transcriptions
call properties, and a Transcription Properties table. List Calls gains the
hasTranscription=true filter use case and the updated description.

Also documents behaviour that was already live but undocumented: calls flagged
with hasTranscription embed their 5 newest transcripts directly in the List
Calls and Get Call responses, so the paginated endpoint is only needed beyond
that cap.

Verified against a local mint dev preview -- all four pages render and the
transcriptions array resolves through transcriptionSchema.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…s (ENG-36224)

Refreshes calls.json from the regenerated OAS output. The List Calls and Get
Call examples now set hasTranscription to true and carry the transcriptions
array it gates, which the schema described but no payload demonstrated.

Verified against a local mint dev preview. Note that mint reads the OpenAPI
spec at boot, so a restart is required for calls.json changes to appear.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants