Documents

#Library documents

Address

https://<your-org>.brambleit.cloud/atlas/api/documents

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Response 200

{
  "documents": []
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Get a document

Address

https://<your-org>.brambleit.cloud/atlas/api/documents/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "document": null,
  "versions": 1
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents/42', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Add a library document

Address

https://<your-org>.brambleit.cloud/atlas/api/documents

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents', {
  method: 'POST',
  credentials: 'include',
});
const data = await res.json();

#Save a document

Address

https://<your-org>.brambleit.cloud/atlas/api/documents/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Request body JSON

Response 200

{
  "ok": true,
  "updated_at": "2026-11-12T09:30:00.000Z"
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents/42', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"base_updated_at":"2026-11-12T09:30:00.000Z"}),
});
const data = await res.json();

#Archive a document

Address

https://<your-org>.brambleit.cloud/atlas/api/documents/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "ok": true
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#A document's versions

Address

https://<your-org>.brambleit.cloud/atlas/api/documents/:id/versions

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "versions": [
    {
      "id": 42,
      "title": "Example title",
      "saved_name": "Example saved name",
      "saved_at": "2026-11-12T09:30:00.000Z"
    }
  ]
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents/42/versions', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Get a document version

Address

https://<your-org>.brambleit.cloud/atlas/api/documents/:id/versions/:vid

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "version": {
    "id": 42,
    "document_id": 7,
    "title": "Example title",
    "body": "<p>…</p>",
    "saved_by": 1,
    "saved_name": "Example saved name",
    "saved_at": "2026-11-12T09:30:00.000Z"
  }
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents/42/versions/1', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Restore a document version

Address

https://<your-org>.brambleit.cloud/atlas/api/documents/:id/versions/:vid/restore

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents/42/versions/1/restore', {
  method: 'POST',
  credentials: 'include',
});
const data = await res.json();

#Copy a library document (e.g

Address

https://<your-org>.brambleit.cloud/atlas/api/documents/:id/copy

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Atlas.

Path parameters

Request body JSON

Response 200

{
  "document": {
    "id": 42
  }
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/documents/42/copy', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"org":"…"}),
});
const data = await res.json();