Skip to content
Menu
SilktideDevelopers

Build on Silktide

Add and test websites, read their scores and checks, and keep Silktide in step with your own systems. JSON over HTTPS, in your account's region.

QuickstartAPI reference
List your websites
curl "https://api.eu.silktide.com/v1/websites" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response
{
  "websites": [
    {
      "subsiteId": "2-0",
      "websiteId": 2,
      "sectionId": 0,
      "name": "Example",
      "homeUrl": "https://example.com/",
      "created": 1790216529,
      "websiteName": "Example",
      "websiteStatus": "live",
      "numPages": 812,
      "numDocuments": 40,
      "thumbnailUrl": "https://example-bucket.s3.amazonaws.com/websites/2/screenshots/desktop-thumb.webp",
      "tags": [
        {
          "tagId": "marketing",
  …

Start in three steps

  1. 1

    Create a key

    An account admin creates one in Silktide, under Settings, then API.

    How to create a key
  2. 2

    Find your region

    Your account lives in the EU, the US or Australia. Each region has its own API host.

    Regions
  3. 3

    Send a request

    Put the key in the Authorization header and ask for your websites.

    Quickstart

Reference

Platform

What belongs to the whole account rather than to one app, such as how much of its allowance is left.

Governance

Add and test websites, then read their scores and checks for accessibility, content quality, SEO and more.

Analytics

Read visits, sources, pages, events and goals from Analytics, for any view and date range.

For tools and agents

  • OpenAPI 3.1

    The whole API as one document, for code generators, Postman and Insomnia.

  • llms.txt

    An index of these docs for AI assistants, and every page in one file.

  • Markdown everywhere

    Add .md to any page's address, or copy it from the page, to paste it into an assistant.