Pattern Endpoint

Use the Pattern endpoint to retrieve fully parameterised pattern files in JSON or DXF, optionally locked to a specific version and variable set.

Endpoint

POST /api/v1/patterns/{patternId}

Authentication: Bearer token
URL parameter: patternId (UUID, required)
Version selector: Optionally provide versionId or versionNumber. Do not send both. If neither is provided, the latest version is used.

Body (JSON, optional). variables may only override editable pattern variables:

{
  "versionId": "OPTIONAL_VERSION_UUID",
  "format": "json" | "dxf",
  "variables": {
    "VARIABLE_KEY": "VALUE"
  }
}

{
  "versionNumber": 12,
  "format": "json" | "dxf",
  "variables": {
    "VARIABLE_KEY": "VALUE"
  }
}

Responses

200 OK: Returns patternVersionId and patternVersionNumber plus errors, variables, and data in requested format. Numeric variables are returned as JSON numbers.
401 Unauthorized: Missing or invalid API key.
404 Not Found: Pattern does not exist or access denied.
422 Unprocessable Entity: Invalid body parameters, unknown variables, or attempts to override read-only variables.
500 Internal Server Error: Unexpected backend error.

Pattern Endpoint Test Console

Send authenticated requests to retrieve pattern payloads with optional version selection, format switching, and variable overrides.

API Key (Bearer Token)

Pattern ID *

Version ID

Version Number

Format

Variables

Optional overrides for formula variables when generating parameterised patterns.

Example Curl Request:

curl -X POST 'https://seamscape.com/api/v1/patterns/{patternId}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "format": ""
}'

Sample Success Response:

{
  "patternVersionId": "cf65fce7-9fca-4275-86fe-cf8154a2f0b7",
  "patternVersionNumber": 12,
  "errors": [],
  "variables": {
    "WAIST": 78
  },
  "data": {
    "name": "Pattern Name",
    "description": "Detailed description...",
    "pieces": [
      {
        "name": "Front",
        "boundary": [[0, 0], [0, 10], [10, 10], [10, 0]]
      }
    ]
  }
}

Sample Error Response:

{
  "status": 404,
  "message": "Pattern not found"
}

< API v1 Reference Nest Endpoint >