Write landing page labels, or check them with dryRun

curl --request POST \
  --url https://stefanbrain.com/api/developers/v1/meta/landing-page-labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "labelVersion": "<string>",
  "taxonomyVersion": 1073741824,
  "model": "<string>",
  "promptVersion": "<string>",
  "sourceArtifactSha256": "<string>",
  "dryRun": true,
  "items": [
    {
      "landingUrl": "<string>",
      "inputDigest": "<string>",
      "industry": "<string>",
      "productForm": "<string>",
      "targetGender": "<string>",
      "targetAge": "<string>",
      "priceBand": "<string>",
      "pageKind": "<string>",
      "evidence": {
        "brand": "<string>",
        "productName": "<string>",
        "categoryText": "<string>",
        "summary": "<string>",
        "proposedIndustry": "<string>",
        "viaHop": 4503599627370495
      }
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    labelVersion: '<string>',
    taxonomyVersion: 1073741824,
    model: '<string>',
    promptVersion: '<string>',
    sourceArtifactSha256: '<string>',
    dryRun: true,
    items: [
      {
        landingUrl: '<string>',
        inputDigest: '<string>',
        industry: '<string>',
        productForm: '<string>',
        targetGender: '<string>',
        targetAge: '<string>',
        priceBand: '<string>',
        pageKind: '<string>',
        evidence: {
          brand: '<string>',
          productName: '<string>',
          categoryText: '<string>',
          summary: '<string>',
          proposedIndustry: '<string>',
          viaHop: 4503599627370495
        }
      }
    ]
  })
};

fetch('https://stefanbrain.com/api/developers/v1/meta/landing-page-labels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://stefanbrain.com/api/developers/v1/meta/landing-page-labels"

payload = {
    "labelVersion": "<string>",
    "taxonomyVersion": 1073741824,
    "model": "<string>",
    "promptVersion": "<string>",
    "sourceArtifactSha256": "<string>",
    "dryRun": True,
    "items": [
        {
            "landingUrl": "<string>",
            "inputDigest": "<string>",
            "industry": "<string>",
            "productForm": "<string>",
            "targetGender": "<string>",
            "targetAge": "<string>",
            "priceBand": "<string>",
            "pageKind": "<string>",
            "evidence": {
                "brand": "<string>",
                "productName": "<string>",
                "categoryText": "<string>",
                "summary": "<string>",
                "proposedIndustry": "<string>",
                "viaHop": 4503599627370495
            }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "results": [
    {
      "outcome": "stored",
      "landingKeySha256": "<string>"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

Write landing page labels, or check them with dryRun

Stores one label card per landing page: industry, product form, target gender, target age, price band and page kind, each a value of the named list version or null. StefanBrain computes the landing key from each raw URL and checks each value against its list. Every item gets its own result, in order: a refused item names its reason and does not stop the others, and an unknown value returns the valid values. Idempotent: the same request sent again answers already_stored. dryRun: true runs every check, returns each landing key, and writes nothing. A stored card is never edited, and it is not shown in benchmarks until StefanBrain activates its label version. 1 to 200 items in a UTF-8 body of at most 32 MB. Rate-limited, never metered. Requires the tools scope and the account’s own landing_page_label_writer grant.

curl --request POST \
  --url https://stefanbrain.com/api/developers/v1/meta/landing-page-labels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "labelVersion": "<string>",
  "taxonomyVersion": 1073741824,
  "model": "<string>",
  "promptVersion": "<string>",
  "sourceArtifactSha256": "<string>",
  "dryRun": true,
  "items": [
    {
      "landingUrl": "<string>",
      "inputDigest": "<string>",
      "industry": "<string>",
      "productForm": "<string>",
      "targetGender": "<string>",
      "targetAge": "<string>",
      "priceBand": "<string>",
      "pageKind": "<string>",
      "evidence": {
        "brand": "<string>",
        "productName": "<string>",
        "categoryText": "<string>",
        "summary": "<string>",
        "proposedIndustry": "<string>",
        "viaHop": 4503599627370495
      }
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    labelVersion: '<string>',
    taxonomyVersion: 1073741824,
    model: '<string>',
    promptVersion: '<string>',
    sourceArtifactSha256: '<string>',
    dryRun: true,
    items: [
      {
        landingUrl: '<string>',
        inputDigest: '<string>',
        industry: '<string>',
        productForm: '<string>',
        targetGender: '<string>',
        targetAge: '<string>',
        priceBand: '<string>',
        pageKind: '<string>',
        evidence: {
          brand: '<string>',
          productName: '<string>',
          categoryText: '<string>',
          summary: '<string>',
          proposedIndustry: '<string>',
          viaHop: 4503599627370495
        }
      }
    ]
  })
};

fetch('https://stefanbrain.com/api/developers/v1/meta/landing-page-labels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://stefanbrain.com/api/developers/v1/meta/landing-page-labels"

payload = {
    "labelVersion": "<string>",
    "taxonomyVersion": 1073741824,
    "model": "<string>",
    "promptVersion": "<string>",
    "sourceArtifactSha256": "<string>",
    "dryRun": True,
    "items": [
        {
            "landingUrl": "<string>",
            "inputDigest": "<string>",
            "industry": "<string>",
            "productForm": "<string>",
            "targetGender": "<string>",
            "targetAge": "<string>",
            "priceBand": "<string>",
            "pageKind": "<string>",
            "evidence": {
                "brand": "<string>",
                "productName": "<string>",
                "categoryText": "<string>",
                "summary": "<string>",
                "proposedIndustry": "<string>",
                "viaHop": 4503599627370495
            }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "results": [
    {
      "outcome": "stored",
      "landingKeySha256": "<string>"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "invalid_request_error",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer stefan_sk_... (API key — bills the API wallet) or stefan_oat_... (OAuth member token — bills your plan pool).

Body

application/json

labelVersion

string

required

The name of this way of reading pages. Its first write binds it to taxonomyVersion, model and promptVersion; a later request under the same name with another of them is refused. A name starts with estate-: StefanBrain keeps every other name for its own readings.

Pattern: ^estate-[a-z0-9._-]{1,57}$

taxonomyVersion

integer

required

The list version the labels are values of.

Required range: 1 <= x <= 2147483647

model

string

required

The model that made the labels.

Required string length: 1 - 200

promptVersion

string

required

The version of the prompt that made the labels.

Required string length: 1 - 200

sourceArtifactSha256

string

required

SHA-256 of the file the items came from.

Pattern: ^[0-9a-f]{64}$

dryRun

boolean

required

true checks every item and returns each landing key, and writes nothing.

items

object[]

required

One item per landing page.

Required array length: 1 - 200 elements

Show child attributes

Response

One result per item, in the order the items were sent.

results

object[]

required

One result per item, in the order the items were sent.

Option 1
Option 2
Option 3
Option 4

Show child attributes

Get started

Build with StefanBrain

Operate safely

REST API reference

Write landing page labels, or check them with dryRun

Authorizations

Body

Response