Quick Start

1. Register at https://contentworkspace.com or by going to https://app.contentworkspace.com/register

2. Provide a name for your Organization

3. Create a Workspace

1. Provide a name
2. Description (optional)

4. Create your first Model by clicking on the Models menu option of the left side menu and then clicking New

1. Name your Model, this name will be used to generate the API name of your model. (Save this for later)
2. Provide a description for your model
3. Check the Localized checkbox to be able to add translations to the content of this model
4. Save your model

5. Once saved click on the Add Fields button to create a new field for your model

6. Create a new Field

1. Give your field a name
2. Choose a Type of Text
3. Save your field

7. You have now created your first Model

8. On the left hand menu click on Content, you can now start creating content for your model

9. Click on New

10. Fill out the field you created with some text and click Save

11. Publish your content by clicking Publish and Confirm. You have now published your first piece of content.

12. Enable API access to your Workspace

1. Click on Setting on the left hand menu
2. Click on the API option in the Developers Submenu
3. In the Developer page, click on Generate New API Key
4. REST API access to your workspace is now enabled

13. Access your date via the API

1. You will need
   1. Your API Key
   2. Organization ID
   3. Workspace ID
   4. Model API name
2. GET Request

Endpoint: https://api.contentworkspace.com/<Model API Name>

Headers:

api_key: <Your API Key>

organization_id: <Your Organization ID>

workspace_id: <Your Workspace ID>

3. The response should be and array of results with a single element representing the Content Record you created in the previous steps. In the example below you can see the response for a Content record with a field called “my_text_field” and a localizatopm of English

[

    {

        “_id”: “67b64675fe2c76ac4c3f5e7a”,

        “sys_created”: “02/19/2025 21:00:37 PM”,

        “sys_updated”: “02/19/2025 21:01:15 PM”,

        “sys_status”: {

            “value”: “published”,

            “display_value”: “Published”

        },

        “sys_locale”: {

            “_id”: “6792aaf3c949d479de195bd4”,

            “value”: “6792aaf3c949d479de195bd4”,

            “code”: “en”,

            “display_value”: “English”

        },

        “sys_version_number”: “1”,

        “sys_number”: “REC0000001”,

        “my_text_field”: “test”

    },

]

Organization Dashboard

This is your Organization’s main dashboard, where you can view the current stats for all the workspaces in your org

1. API Calls per month – This is the number of API a calls made to all of your workspaces for the current month
2. Total Content Records – The total number of Content Records across all your workspaces
3. AI Token Usage – The total number of AI tokens used for content generation and auto translation in your org.
4. Total Content Models – The total number of Content Models across all your workspaces
5. Total Assets – Total number of uploaded assets in your org
6. All Users – Total number of team members across your org.
7. API Request Per Workspace per month – This is the number of API calls made to each specific workspace per month this year.
8. API Token Usage Per Workspace per month – This is the number of AI token usage per per workspace per month this year

Organization Workspaces

In the Workspaces tab of your Organization you can view your existing workspaces and create new ones

1. Add Workspace – Click here to create a new workspace
2. This is what an existing workspace looks like, click on the tile to access the workspace
3. Click tile to create a new workspace

Name your workspace and provide a description, then click Create Workspace. You will be taken to your new Workspace after a few seconds.