Skip to content
SurfaceDocs
FRGet started
DocsGet started

Quickstart

Create a Clients database, add a record and prepare the next step.

Create your account

Open the Surface account portal, enter your name, email address and a password of at least 12 characters, then confirm your address using the emailed link. Sign in to check that your space is ready. Your account starts on Free without a payment card. The tenant connection key stays inside Surface services; you do not need to copy or configure a key.

1. Create your workspace

Sign in to Surface and choose the account you want to open, even if only one account is listed. Then create a Workspace from a Model. Choose a client management app or describe the need to AI: “I want to track clients, their contact details and the next sales actions.” Review the proposed structure before using it.

When your interface offers Describe a need with AI, choose whether to find an app, adapt an authorized Model or create one. Describe your goal and expected outcome. This request opens the conversation without selecting a version or creating a Workspace. Check the choices and consequences in the native review before confirming creation or launch.

Compare the exact versions, inputs, deliverables and access conditions of the available choices. A declaration inspection or preview is not a running Flow; after changing the proposal, review a fresh preview before confirming.

Name the Workspace Clients and place it in your business Portfolio. A Portfolio brings Workspaces and their shared context together. Inside Clients, a Data Space holds records, a Knowledge Space holds procedures, and a Work Space holds follow-ups requiring several steps.

2. Add your first client

Choose New client. The creation form requests the information needed to make a valid record. Context notes and supplementary information remain accessible in the record after creation.

Information Example value Purpose
Company North Studio Record title and search result
Email contact@example.com Contact information
Status Active Filter and visual indicator
Notes Needs a proposal for annual maintenance Editable context in the Surface

Open the new record. Edit notes directly below their heading. Use Settings for Fields that configure the record rather than belong in its main content.

3. Organize the collection

In the table view, display Company, Email, Status and Last updated. Add Status = Active and sort by company name. The Query defines the requested collection; columns determine which information the table presents.

Clients
  Data → Active clients → North Studio
  Knowledge → Qualification procedure
  Work → Prepare North Studio follow-up

4. Connect quotes

Add a Quotes Workspace. In its integration configuration, link clientId to the Client record identifier. A quote can now select North Studio through search, and the North Studio record presents associated quotes in its side panel.

Continue with Fields to adapt the record, integrations for links, and Flows to prepare an AI-assisted proposal.

Applied examples : Create the first client

Connect the creation Form to its Action, then open the North Studio record after confirmation.

Configuration

Fragment placed in forms[]. Properties and accepted values.

{
  "contract": "WorkspaceForm@2",
  "key": "new-client",
  "label": "New client",
  "actionKey": "create-client",
  "targetDefinitionPath": "workspace/clients/surface/client",
  "mode": "create",
  "fields": [
    {
      "contract": "WorkspaceFormControl@2",
      "repeatable": false,
      "key": "company",
      "label": "Company",
      "input": "text",
      "binding": {
        "kind": "field",
        "fieldKey": "company"
      },
      "required": true,
      "ruleKeys": [],
      "options": []
    },
    {
      "contract": "WorkspaceFormControl@2",
      "repeatable": false,
      "key": "status",
      "label": "Status",
      "input": "choice",
      "binding": {
        "kind": "field",
        "fieldKey": "status"
      },
      "required": true,
      "ruleKeys": [],
      "options": [
        "prospect",
        "active"
      ]
    }
  ],
  "ruleKeys": []
}

Variation and connection

Fragment placed in actions[]. Properties and accepted values.

{
  "key": "create-client",
  "label": "Create client",
  "targetDefinitionPaths": [],
  "kind": "semantic-command",
  "operationKey": "create-client",
  "formKey": "new-client",
  "ruleKeys": [],
  "contextPolicyKey": null,
  "minimumRole": "member",
  "confirmation": true
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

  1. Company *
  2. Status *
  3. Notes
  4. Create client
ILLUSTRATIVE LAYOUTClients / Quotes app
SurfaceClients / North StudioExample
QuickstartCreate the first client
Clients
New client
Company *North Studio
Status *Prospect

Add notes to the record after creation.

CancelCreate client
Search for a concept, field or action.Esc