PLATFORM ACCESS · FOR DEVELOPERS & INTEGRATORS

Structured data. Scoped access.

Every specification and datasheet on SynC is addressable data behind a REST API. API keys carry exactly the permissions you grant, and reads can be pinned to a published revision. The reference is public, no login needed.

Scoped keys · JSON export · Revision-pinned reads

PART 1 · GENERAL

Documents for humans are dead ends for software

  1. 1.01

    Construction requirements are published as documents for people, so anything downstream starts with a person extracting the data by hand.

  2. 1.02

    Most integrations want an all-or-nothing credential. To read one project, a tool gets the keys to the whole account.

  3. 1.03

    Send a PDF out for bid and you have no say over who has access to it or what tools read it.

  4. 1.04

    On SynC you decide who has access and whether export is allowed. Software reads the record through the API with the permissions of the key you issued.

A specification is a database. SynC treats it like one.

PART 2 · PRODUCTS

What developers get

2.01

Scoped API keys

Issue a key with exactly the permissions a tool needs. Read-only stays read-only. Revoke or rotate any key without touching the rest, and read its usage log.

A looping demonstration of creating an API key. On the Profile page, the Integrations section shows no API keys on file. Create API key opens a two-step dialog. The name “Claude Code on my laptop” and the description “Reads Building 400 and the company library.” are typed in, then Next. What this key may do opens on Read only: Projects at Read and Library at Read, with each area’s high-impact permissions unticked. The summary reads This key can, 14 of 55 permissions, none high impact. Create API key shows the new key once, beginning sync_, with a Copy button that changes to Copied and the notice “Copy the key now. It won’t be shown again.” After Done, the section shows one key on file: Claude Code on my laptop, Active, 14 permissions, used never, created Oct 24, 2026.

2.02

Full API coverage

Projects, standards, datasheets, revisions, comments: what you do to a project’s record in the browser, you can do over the API. The same model the application runs on, with a public reference. The API is still growing, and the reference is current.

Read the API reference
A looping demonstration of converting a folder of specifications into SynC with your own AI agent, four files at once. In a terminal, the person opens the folder harbor-specs, which holds four Word files: Domestic Water Booster Pumps, Exterior Lighting, Fire Alarm and Panelboards. They start their agent and ask it to convert every specification in the folder into their SynC company library Harbor Engineering, one agent per file, in parallel, pasting the conversion prompt from the SynC help page. The agent reads the markup guide and the conversion guide, calls GET /api/whoami, which names the company Harbor Engineering, and starts four agents for pass 1 only. Each agent reads its source, writes the markup, checks it with validate-markdown, fixes any errors it reports, and saves revision 1.0.0 with POST /api/standards/id/publish and severity major. Exterior Lighting had 2 errors and Fire Alarm 1 error, fixed before saving; Fire Alarm finishes last. The agent reports that pass 1 is saved for all four, with counts checked against the sources: Panelboards, 112 clauses, 9 notes, 2 tables; Exterior Lighting, 138 clauses, 11 notes, 1 table; Domestic Water Booster Pumps, 96 clauses, 6 notes, 0 tables; Fire Alarm, 204 clauses, 17 notes, 4 tables. It asks the person to review them in SynC and to say go to start pass 2, the datasheet fields. The files, counts and standard ids are sample values. The API key holds the Write standards template.

2.03

Structured export

Pull a project, or one datasheet, as JSON: field names, selected values, units, and the source revision’s fingerprint. Compact for machines, verbose for full provenance. Clause prose stays in the PDF, not the JSON.

2.04

Revision-pinned reads

Request data as of any published revision, not only the latest. A quote or a bid stays tied to the document set it was built against.

A looping demonstration of the SynC AI Assistant window for the project Building 400. Someone types into the composer: Which refrigerant did we select for the Building 400 chillers, and is it in a permitted safety group? After sending, the assistant shows Thinking, then two steps: searching standard content for chillers refrigerant safety group, and reading the standard Chillers. It then shows Writing answer, and the whole answer appears at once: R-1233zd(E). The project's datasheet selects it under Chillers 8.1.1, and Chillers 8.2.1 permits safety groups A1 and A2L, which R-1233zd(E) falls within. Both clause references are citation links. The credits line reads: this answer 0.2 credits, this chat 0.2 credits, 96 starter credits left. The pointer clicks the first citation and a citation dialog opens over the chat: Chillers, clause 8.1.1, revision 3. It shows part 8 Refrigerant, section 8.1 Refrigerant Selection, and clause 8.1.1: The refrigerant shall be as indicated in the datasheet, with its datasheet field Refrigerant as a selection list. A note says the citation is pinned and reads as written, and that the SynC page shows the current revision, which may differ. A button reads Open in SynC. The pointer closes the dialog and the finished answer stays in view.

2.05

Agents under the same rules

Your own tools read specs and pull scope through the API with the permissions of the key you gave them.

A looping demonstration of using your own AI agent with SynC through the API. In a terminal, the person starts the agent with the command claude and tells it: “Here is my SynC API key and the site: https://synergyinconstruction.com, Authorization: Bearer and the key. What can you do for me?” The agent calls GET /api/help?format=index, which returns a guide and one short row per endpoint, then GET /api/whoami, which confirms the request came with an API key and lists the permissions the key was granted, starting with category:read. It answers that the key is read only, so it can look things up and change nothing. Through the API it can list projects and their latest revisions, read specifications and datasheets clause by clause, search the standards library and cite the clause, and compare what a datasheet selects with the standard’s defaults. Asked for “My projects.”, it calls GET /api/projects and answers that the person holds three projects: Building 400, Rev 3.0.0 published Oct 21, 2026, draft open; Harbor Point Lift Station, Rev 1.0.0 published Sep 2, 2026; and Pine Street Depot, no revision published yet. The API key, the projects and the dates are sample values. The key is read only.

2.06

Limits you can plan for

Rate limits are reported on X-RateLimit headers. A key whose owner belongs to a company gets a higher limit than a free account. Write the retry logic once.

PART 3 · EXECUTION

From key to integration

  1. STEP 01

    Issue a key

    Create an API key from your account and grant only the scopes the tool needs.

  2. STEP 02

    Pull structured data

    Read projects, standards, and datasheets as JSON, pinned to the revision you name.

  3. STEP 03

    Close the round trip

    Post line-item responses back through the same API, on the exact requirement.

Build against the record

Sign up free and issue your first key, or read the reference first. No login needed.

Back to home