Switch which document is focused in a multi-document session.

POST

sessions

{session_id}

documents

{document_id}

focus

Switch which document is focused in a multi-document session.

curl --request POST \
  --url https://api.example.com/v1/sessions/{session_id}/documents/{document_id}/focus \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization

string | null

Path Parameters

session_id

string

required

document_id

string

required

Response

Successful Response

Close (remove) a document from a multi-document session.Removes a document from the session's open documents (like closing an editor tab). If it was the focused document, focus moves to `next_focus` when provided and still open, otherwise to the next remaining document; closing the last document leaves the session empty. The close is durable across reconnects and session restores. Returns the updated roster plus the now-focused document's HTML. The session itself stays alive, and nothing is deleted from your storage.

Switch which document is focused in a multi-document session.

curl --request POST \
  --url https://api.example.com/v1/sessions/{session_id}/documents/{document_id}/focus \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}