Spider Silk
Help & documentation

Spider Silk help docs

Learn the core model, author content, publish hosts, and use the Agent API. This guide is written for product teams and AI agents operating live sites.

Core concepts

Spider Silk organizes websites in a simple hierarchy:

Organization
  └── Site (a version of a website)
        ├── Content (Page, Article, Template, Page-Part, Redirect)
        └── Files (media library)
  └── Bindings (host → published site)
  • Organization — client/company boundary for sites and bindings.
  • Site — one version of a website with its own content and files.
  • Binding — hostname that points at the site currently served publicly.
  • Access key — URL slug for content (e.g. about → /about).
Special access keys: {home-page} is the site root /. {error-404} and {error} are fallback pages.

Content types

TypePurpose
PageRoutable page with body/css/script and SEO/OG fields. Optional template.
ArticleLike a page, plus author, categories, summary, publish date, title image.
TemplateLayout shell with [:body:] and nested part placeholders.
Page-PartReusable fragment included as [:access-key:].
RedirectHTTP redirect with optional path/query passthrough.

Templates & page-parts

Shared chrome lives in page-parts (for example site-nav and site-footer). A template composes them around the page body:

<div class="site-shell">
  [:site-nav:]
  <main>[:body:]</main>
  [:site-footer:]
</div>

Pages reference a template by its public id. Prefer editing a page-part once instead of duplicating nav/footer HTML on every page.

SEO & sitemap

Each page/article can set:

  • title, description, htmlLang
  • Open Graph: og_title, og_description, og_image, og_url, og_type, og_site_name
  • Sitemap: includeInSiteMap, siteMapPriority, siteMapChangeFrequency

og_url is also emitted as the canonical link. Patch SEO fields without rewriting the full body. Robots rules are managed per site and served at /robots.txt.

Files & media

Upload assets to the site media library. Public URLs use /file/{publicKey}. Special case: set publicKey to favicon.ico to serve the site favicon at /favicon.ico.

Domain bindings

A binding maps a host (or host regex) to a published site. Creating a site can include a nested binding to go live immediately. Later you can repoint the same host at a different site version without deleting content.

After binding changes, if Agent content exists but the public host still 404s, the web runtime host cache may need a reload.

Agent API overview

The Spider Silk app and Agent API live at spider-silk.orkboo.com.

Agent API base: https://spider-silk.orkboo.com

  • Auth header: X-Spider-Api-Key (or Bearer token)
  • Discovery (no key): GET /Agent/help
  • List orgs: GET /Agent/orgs
  • Sites: GET/POST /Agent/orgs/{orgId}/sites
  • Content: .../sites/{siteId}/content, .../pages, .../articles
  • Field patch: PATCH .../content/{id}/fields
  • SEO patch: PATCH .../content/{id}/seo
  • Bindings: .../bindings
  • Files: .../files

API keys are created in Silker under Manage → API Keys. Keys may be org-scoped or platform-wide.

Common recipes

Edit page HTML only

  1. GET content by key or id
  2. PATCH .../fields with { "fields": { "body": "...html..." } }

Prefer field patches over full replace so SEO keys are not dropped.

Add a new page

  1. POST .../pages with name, accessKey, title, description, body, optional template
  2. Use accessKey {home-page} for the site root

Create a site and go live

  1. POST .../sites with name/notes and optional nested binding: { host, name }
  2. Or create the site, then POST a binding with publishedSitePublicId

Shared menu / footer

  1. Create page-parts for nav and footer
  2. Include them in a template with [:access-key:] placeholders
  3. Attach the template to pages

Safety notes

  • Treat API keys as secrets; do not paste them into public repos or public page bodies.
  • Confirm the target site before writing—orgs often host many properties.
  • Do not delete production sites or bindings without explicit confirmation.
  • Use SEO and field patches for small edits to avoid wiping unrelated keys.

Need help applying this to your org? Contact the Spider Silk team.