This article details using the Carbon Editor API, including authentication, available views and actions and the hierarchy of information.
The Carbon Editor API is a restful representation of the information presented through the Carbon Editor User Interface (UI).
The API primarily uses JSON to respond to requests.
Some features available in the Carbon Editor UI are not yet supported by the API. Currently, the API includes the basic information required to navigate the information hierarchy of Carbon Editor, and to import and export content. The API does not yet include functionality for administrative configuration, or the editing of page content. |
Identifiers
Each object in Carbon Editor and the API has a number of identifiers which are visible either in the Carbon Editor UI or the Carbon Editor API. These identifiers each have different uses and properties as detailed below.
Identifier | Unique? | Use | |
---|---|---|---|
Name | No | The human friendly name that is displayed throughout the Carbon Editor UI. | |
Slug | Yes* | An identifier generated from the object name. Slugs are used throughout the Carbon Editor UI to generate URLs. If a conflict occurs between slugs, a numerical suffix will be generated for the new slug.
| |
UUID | Yes | A global identifier for this object, which is unique throughout the entire system. Uses UUID Version 4. All identifiers used within the API URLs use the UUID identifier. | |
Embedding ID | Yes | An identifier that allows a page, section, or field to be embedded within other documents. Can be set as a custom value, or will otherwise be automatically generated based on the object's title. |
* Slugs are unique within their parent object - not throughout the entire Carbon Editor system. For example, Space slugs are unique per Organisation, while Document slugs are unique per Space. If you require a globally unique identifier use the relevant UUID.
The Carbon Editor API supports token-based authentication when making requests via HTTPS.
Each API request is authenticated against a single user using your API token, which should be passed in the Authorization header of your request.
Your API token is available by navigating to the import document page. For more information, see Importing Content with the API.
Authorization: Token {Your API Token} |
curl --header "Authorization: Token 52a1e6a5-9a18-4905-9d39-d31133c9c2dc" https://carbon.example.com/api/v1/organisations/ |
The following endpoints are used to list and view information about Organisations.
Example Response:
[ { "name": "My organisation", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/", "uuid": "bfc90580-e436-4cdb-a3d2-38340bb1ed57", "slug": "my-organisation", "spaces": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/" } ] |
Example Response:
{ "slug": "my-organisation", "name": "My organisation", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/", "spaces": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/", "uuid": "bfc90580-e436-4cdb-a3d2-38340bb1ed57" } |
The following endpoints are used to list and view information about Spaces.
Example Response:
[ { "slug": "default-space", "documents": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/", "uuid": "af145166-b079-4cab-b140-b34d60c52a84", "categories": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/categories/", "name": "Default Space", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/", "automated_documents": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/automated_documents/" }, { "slug": "this-is-a-new-space", "documents": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/cae75d2c-1212-46da-b98d-22f444dae7de/documents/", "uuid": "cae75d2c-1212-46da-b98d-22f444dae7de", "categories": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/cae75d2c-1212-46da-b98d-22f444dae7de/categories/", "name": "This is a new space", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/cae75d2c-1212-46da-b98d-22f444dae7de/", "automated_documents": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/cae75d2c-1212-46da-b98d-22f444dae7de/automated_documents/" } ] |
Example Response:
{ "slug": "default-space", "documents": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/", "uuid": "af145166-b079-4cab-b140-b34d60c52a84", "categories": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/categories/", "name": "Default Space", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/", "automated_documents": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/automated_documents/" } |
Example Response:
[ { "url": "https://carbon.example.com/api/v1/organisations/cc4dbb87-3e6a-4aeb-b194-60083a2f6cb2/spaces/d7cfb0ff-899c-47f0-976e-e018647b098a/categories/f92b8018-e819-48cc-a914-58e994ec83a4/", "slug": "all-documents", "name": "All Documents", "uuid": "f92b8018-e819-48cc-a914-58e994ec83a4", "documents": "https://carbon.example.com/api/v1/organisations/cc4dbb87-3e6a-4aeb-b194-60083a2f6cb2/spaces/d7cfb0ff-899c-47f0-976e-e018647b098a/categories/f92b8018-e819-48cc-a914-58e994ec83a4/documents/" } ] |
Example Response
{ "url": "https://carbon.example.com/api/v1/organisations/cc4dbb87-3e6a-4aeb-b194-60083a2f6cb2/spaces/d7cfb0ff-899c-47f0-976e-e018647b098a/categories/f92b8018-e819-48cc-a914-58e994ec83a4/", "slug": "all-documents", "name": "All Documents", "uuid": "f92b8018-e819-48cc-a914-58e994ec83a4", "documents": "https://carbon.example.com/api/v1/organisations/cc4dbb87-3e6a-4aeb-b194-60083a2f6cb2/spaces/d7cfb0ff-899c-47f0-976e-e018647b098a/categories/f92b8018-e819-48cc-a914-58e994ec83a4/documents/" } |
Example Response
[ { "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/be347cca-b682-4e04-b6ca-1740792445b2/", "uuid": "be347cca-b682-4e04-b6ca-1740792445b2", "name": "My Api Test Document", "slug": "my-api-test-document" } ] |
Example Response:
{ "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/be347cca-b682-4e04-b6ca-1740792445b2/", "uuid": "be347cca-b682-4e04-b6ca-1740792445b2", "name": "My Api Test Document", "slug": "my-api-test-document" } |
Example Response:
HTTP 204 No Content |
Example Response
[{ "last_run_started": "2017-03-28T03:23:21Z", "is_automated": false, "search": null, "saved_search": "https://carbon.example.com/api/v1/organisations/bcadc4e7-211c-41ed-a1e9-3740d55e4269/spaces/be764da9-f81c-45be-ac1b-d9c1397d903f/saved_searches/1de6bb09-dd92-486f-b069-ea3403835775/", "last_run_ended": "2017-03-28T03:23:32Z", "ordering": "original_order", "slug": "test-2", "name": "Test", "status": "ready", "uuid": "aa46b2e1-c726-4852-bf90-cac1abeb257c", "url": "https://carbon.example.com/api/v1/organisations/bcadc4e7-211c-41ed-a1e9-3740d55e4269/spaces/be764da9-f81c-45be-ac1b-d9c1397d903f/automated_documents/aa46b2e1-c726-4852-bf90-cac1abeb257c/", "document": "https://carbon.example.com/api/v1/organisations/bcadc4e7-211c-41ed-a1e9-3740d55e4269/spaces/be764da9-f81c-45be-ac1b-d9c1397d903f/documents/2921caa1-2dd6-4d5f-9e1b-63f676158b9e/" }] |
Example Response:
{ "last_run_started": "2017-03-28T03:23:21Z", "is_automated": false, "search": null, "saved_search": "https://carbon.example.com/api/v1/organisations/bcadc4e7-211c-41ed-a1e9-3740d55e4269/spaces/be764da9-f81c-45be-ac1b-d9c1397d903f/saved_searches/1de6bb09-dd92-486f-b069-ea3403835775/", "last_run_ended": "2017-03-28T03:23:32Z", "ordering": "original_order", "slug": "test-2", "name": "Test", "status": "ready", "uuid": "aa46b2e1-c726-4852-bf90-cac1abeb257c", "url": "https://carbon.example.com/api/v1/organisations/bcadc4e7-211c-41ed-a1e9-3740d55e4269/spaces/be764da9-f81c-45be-ac1b-d9c1397d903f/automated_documents/aa46b2e1-c726-4852-bf90-cac1abeb257c/", "document": "https://carbon.example.com/api/v1/organisations/bcadc4e7-211c-41ed-a1e9-3740d55e4269/spaces/be764da9-f81c-45be-ac1b-d9c1397d903f/documents/2921caa1-2dd6-4d5f-9e1b-63f676158b9e/" } |
Example Response:
[ { "categories": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/dc96cff6-6538-490c-8357-e8392e7f1e08/categories/", "slug": "test-doc", "uuid": "dc96cff6-6538-490c-8357-e8392e7f1e08", "language": "en-gb", "imports": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/dc96cff6-6538-490c-8357-e8392e7f1e08/imports/", "name": "Test Doc", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/dc96cff6-6538-490c-8357-e8392e7f1e08/", "versions": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/dc96cff6-6538-490c-8357-e8392e7f1e08/versions/", "pages": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/dc96cff6-6538-490c-8357-e8392e7f1e08/pages/", "embedding_id": "my-embedding-id" } ] |
Example Response:
{ "categories": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/categories/", "slug": "test-new-doc-name", "uuid": "0491e992-2de8-4da3-a8da-c0f95f624bf0", "language": "en-gb", "imports": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/imports/", "name": "Test New Doc Name", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/", "versions": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/versions/", "pages": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/pages/", "embedding_id": "my-embedding-id" } |
Example Response:
{ "categories": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/categories/", "slug": "test-new-doc-name", "uuid": "0491e992-2de8-4da3-a8da-c0f95f624bf0", "language": "en-gb", "imports": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/imports/", "name": "Test New Doc Name", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/", "versions": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/versions/", "pages": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/0491e992-2de8-4da3-a8da-c0f95f624bf0/pages/", "embedding_id": "my-embedding-id" } |
Example Response:
{ "is_locked": false } |
Example Response:
{ "is_locked": true } |
Example Response:
{ "is_locked": false } |
Example Response:
[ { "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/categories/be347cca-b682-4e04-b6ca-1740792445b2/", "uuid": "be347cca-b682-4e04-b6ca-1740792445b2" } ] |
Example Response:
{ "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/categories/be347cca-b682-4e04-b6ca-1740792445b2/", "uuid": "be347cca-b682-4e04-b6ca-1740792445b2" } |
Example Response:
HTTP 204 No Content |
Example Response:
[ { "total_pages": 253, "failure_message": null, "modified_at": "2015-08-28T05:11:06.872Z", "created_pages": 1, "status": "complete", "uuid": "056df238-4041-4aed-b558-f5e75808748b", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/ab6ffc3a-08fe-4e66-9aee-c13452a1c14e/imports/056df238-4041-4aed-b558-f5e75808748b/" } ] |
id
attribute onto page
XML elements. See "id Attributes" in the Carbon Editor XML Format documentation.Example Response:
{ "total_pages": 253, "failure_message": null, "modified_at": "2015-08-28T05:11:06.872Z", "created_pages": 1, "status": "complete", "uuid": "056df238-4041-4aed-b558-f5e75808748b", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/ab6ffc3a-08fe-4e66-9aee-c13452a1c14e/imports/056df238-4041-4aed-b558-f5e75808748b/" } |
id
attribute onto page
XML elements. See "id Attributes" in the Carbon Editor XML Format documentation.Example Response:
{ "total_pages": 2, "failure_message": null, "modified_at": "2015-08-28T05:11:06.872Z", "created_pages": 1, "status": "complete", "uuid": "056df238-4041-4aed-b558-f5e75808748b", "url": "http://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/ab6ffc3a-08fe-4e66-9aee-c13452a1c14e/imports/056df238-4041-4aed-b558-f5e75808748b/", "page_previews": [ "https://editor-example-com.s3.amazonaws.com/organisations/.../pages/page-1-uuid/index.html", "https://editor-example-com.s3.amazonaws.com/organisations/.../pages/page-2-uuid/index.html" ], "import_data": [] } |
Example Response:
{ "total_pages": 1, "failure_message": null, "modified_at": "2015-08-28T05:11:06.872Z", "created_pages": 1, "status": "complete", "uuid": "056df238-4041-4aed-b558-f5e75808748b", "url": "https://carbon.example.com/api/v1/organisations/bfc90580-e436-4cdb-a3d2-38340bb1ed57/spaces/af145166-b079-4cab-b140-b34d60c52a84/documents/ab6ffc3a-08fe-4e66-9aee-c13452a1c14e/imports/056df238-4041-4aed-b558-f5e75808748b/" } |
Document versions are permanent frozen versions of a document as it was at the time they were created. They are used to create document exports.
Example Response:
[ { "uuid": "19a0405d-59ae-490c-a386-11c80d6ff236", "created_at": "2015-12-09T00:29:42.705Z", "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/", "exports": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/exports/", "version": 1, "status": "ready" } ] |
Example Response:
{ "uuid": "19a0405d-59ae-490c-a386-11c80d6ff236", "created_at": "2015-12-09T00:29:42.705Z", "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/", "exports": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/exports/", "version": 1, "status": "ready" } |
Example Response:
{ "uuid": "19a0405d-59ae-490c-a386-11c80d6ff236", "created_at": "2015-12-09T00:29:42.705Z", "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/", "exports": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/exports/", "version": 1, "status": "ready" } |
Example Response:
[ { "modified_at": "2015-12-09T00:46:47.146Z", "pages_exported": 1, "failure_message": null, "uuid": "7ae7fa77-22f7-416a-90ef-590721b22865", "total_pages": 1, "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/exports/7ae7fa77-22f7-416a-90ef-590721b22865/", "export_type": "xml", "theme": "", "file": "https://editor-example-com.s3.amazonaws.com/organisations/....", "status": "complete" } ] |
Example Response:
{ "modified_at": "2015-12-09T00:46:47.146Z", "pages_exported": 1, "failure_message": null, "uuid": "7ae7fa77-22f7-416a-90ef-590721b22865", "total_pages": 1, "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/exports/7ae7fa77-22f7-416a-90ef-590721b22865/", "format": "xml", "theme": "", "file": "https://editor-example-com.s3.amazonaws.com/organisations/....", "status": "complete" } |
Example Response:
{ "modified_at": "2015-12-09T00:46:47.146Z", "pages_exported": 1, "failure_message": null, "uuid": "7ae7fa77-22f7-416a-90ef-590721b22865", "total_pages": 1, "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/98141531-f2cf-4a75-8310-c24d0b88f811/versions/19a0405d-59ae-490c-a386-11c80d6ff236/exports/7ae7fa77-22f7-416a-90ef-590721b22865/", "format": "xml", "theme": "", "file": "https://editor-example-com.s3.amazonaws.com/organisations/....", "status": "complete" } |
Example Response:
[ { "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/f2d66edd-eb8f-4caf-a57e-8f080af5dfbd/pages/d2097867-bf93-4e99-b257-43f9e86470a9/", "name": "Procalcitonin", "uuid": "d2097867-bf93-4e99-b257-43f9e86470a9", "slug": "procalcitonin", "embedding_id": "procalcitonin" }, { "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/f2d66edd-eb8f-4caf-a57e-8f080af5dfbd/pages/b26a7986-e370-440c-ad4e-9091bfd8879e/", "name": "Iron deficiency", "uuid": "b26a7986-e370-440c-ad4e-9091bfd8879e", "slug": "iron-deficiency", "embedding_id": "iron-deficiency" } ] |
Example Response:
HTTP 204 No Content |
GET /api/v1/organisations/{organisation}/spaces/{space}/documents/{document}/pages/{page}/
Example Response:
{ "url": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/f2d66edd-eb8f-4caf-a57e-8f080af5dfbd/pages/d2097867-bf93-4e99-b257-43f9e86470a9/", "name": "Procalcitonin", "uuid": "d2097867-bf93-4e99-b257-43f9e86470a9", "slug": "procalcitonin", "preview_url": "https://editor-example-com.s3.amazonaws.com/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/f2d66edd-eb8f-4caf-a57e-8f080af5dfbd/pages/d2097867-bf93-4e99-b257-43f9e86470a9/index.html", "generate_preview": "https://carbon.example.com/api/v1/organisations/9887a8f6-4d84-41d6-b72e-1df94d465120/spaces/470b237e-2bea-4124-9358-a17647a12eac/documents/f2d66edd-eb8f-4caf-a57e-8f080af5dfbd/pages/d2097867-bf93-4e99-b257-43f9e86470a9/generate_preview/", "embedding_id": "procalcitonin" } |
Example Response:
HTTP 204 No Content |