API reference

API reference · Account

Share a saved conversation as a read only page

POST/api/sharesSigned in session

Takes a snapshot of the thread now: later messages never reach the page. The snapshot carries each turn's role, text and answering model and nothing else. At most 400 messages and 512 KiB, 200 live shares per account, rate limited per account. The page is /share/{id}, never indexed.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
conversationIdrequiredinteger
titlestring

Example

{
  "conversationId": 0,
  "title": "string"
}

Answer 201

The share, with its path.

Fields of the 201 answer
FieldTypeWhat it is
shareany
share.idstring
share.titlestring
share.modelstringThe first world that answered.
share.conversationIdinteger or null
share.messageCountinteger
share.bytesinteger
share.createdAtinteger
share.urlstring

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.
  • 413OpenAI shaped error.
  • 429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter