Browse all documentation

Get article

Read one article with its Markdown, HTML, structured data and check.

GET/api/v1/brands/{brandId}/articles/{articleId}read

Call the corresponding get_article MCP tool with JSON arguments. Supply brandId and other path values as named arguments when the endpoint has them.

Request details

Required scope: A valid read or write token.

Request example
curl --request GET \
  --url "https://searchseal.com/api/v1/brands/b7e4c2a0-5d1f-4c8e-9a3b-2f6d8e1c4a70/articles/d8b3f1c6-4a2e-4d9b-8c7f-3e1a5b9d2c64" \
  --header "Authorization: Bearer $SEARCHSEAL_TOKEN"

AI drafts the text from AI answers and cited pages. Fill in every [bracketed placeholder] before publishing.

Request parameters

NameLocationRequiredTypeDescription
brandIdpathYesuuidAn active brand ID returned by the brand list.
articleIdpathYesuuidArticle ID.

Response fields

Response body example
{
  "id": "d8b3f1c6-4a2e-4d9b-8c7f-3e1a5b9d2c64",
  "brandId": "b7e4c2a0-5d1f-4c8e-9a3b-2f6d8e1c4a70",
  "fixId": "f5c2e8a1-9d3b-4e7f-a0c6-1b4d7e9f2a38",
  "questionId": "e3a9d1e2-7b4c-4f60-8e2a-9c1d5b7f3e21",
  "kind": "new_page",
  "pageUrl": null,
  "language": "en",
  "status": "ready",
  "title": "Best villa rentals in Bali for families",
  "checkScore": 83,
  "edited": false,
  "error": null,
  "source": "api",
  "createdAt": "2026-09-26T08:14:51.402Z",
  "finishedAt": "2026-09-26T08:16:20.118Z",
  "format": "guide",
  "length": "standard",
  "phase": null,
  "phaseAt": null,
  "publishedAt": "2026-09-27T03:10:00.000Z",
  "publishedUrl": "https://example.com/family-villas-bali",
  "publishCheck": {
    "id": "c4d7a2e9-1b5f-4a8c-9e3d-6f2b8a1c7d45",
    "status": "done",
    "score": 83,
    "error": null
  },
  "proof": {
    "status": "waiting",
    "metric": "visibility",
    "before": 0.2,
    "after": null,
    "change": null,
    "dueAt": "2026-10-11T03:10:00.000Z",
    "reason": "waiting_for_after",
    "beforeAnswers": {
      "named": 2,
      "total": 10
    },
    "afterAnswers": null
  },
  "metaDescription": "Family villas in Bali with private pools, cooks on request and [number] bedrooms.",
  "notes": null,
  "markdown": "Example Villas rents [number] family villas in Bali, each with a private pool and a cook on request.\n\n## What families need in a villa\n\n…\n\n## Frequently asked questions\n\n### Do the villas have cots?\n\nYes. [Say how many and how to book them.]",
  "html": "<p>Example Villas rents [number] family villas in Bali…</p>\n<h2>What families need in a villa</h2>…",
  "jsonld": {
    "@context": "https://schema.org",
    "@graph": [
      {
        "@type": "Organization",
        "name": "Example Villas",
        "url": "https://example.com/"
      },
      {
        "@type": "Article",
        "headline": "Best villa rentals in Bali for families"
      },
      {
        "@type": "FAQPage",
        "mainEntity": [
          "…"
        ]
      }
    ]
  },
  "check": {
    "score": 83,
    "checks": [
      {
        "id": "og",
        "label": "Social card",
        "state": "missing",
        "detail": "No og:image"
      }
    ],
    "todo": [
      {
        "checkId": "og",
        "title": "Add a social card image",
        "impact": "Low",
        "why": "Set a preview image for links you share in chat apps and social posts."
      }
    ],
    "autoFixed": [
      "Added Article and FAQ structured data"
    ]
  },
  "meta": {
    "generatedAt": "2026-09-26T08:15:02.114Z",
    "timeZone": "Asia/Jakarta"
  }
}
FieldTypeDescription
iduuidArticle ID.
fixIduuid | nullThe fix it was written from.
questionIduuid | nullThe tracked question it answers.
kind"new_page" | "rewrite"A new page, or a rewrite of pageUrl on the brand site.
status"queued" | "writing" | "ready" | "failed"Writing takes a minute or two. A failed article counts toward your monthly limit only if AI processing already ran; error explains why it failed.
titlestring | nullThe page title once ready.
checkScoreinteger | nullThe draft page check score, 0 to 100.
editedbooleanWhether the owner has edited the draft.
format"guide" | "comparison" | "faq" | "how_to"Optional page format: guide, comparison, faq or how_to, chosen from the fix or question if omitted.
length"short" | "standard" | "long"Optional length: short (about 600 words), standard (about 1,000, default) or long (about 1,600).
phase"reading" | "writing" | "checking" | nullCurrent phase while queued or writing: reading_sources, writing or checking; null when finished or failed.
phaseAtstring | nullWhen the current phase started, in ISO 8601 format.
publishedAtstring | nullWhen the owner marked it published.
publishedUrlstring | nullWhere the page went live.
publishCheckobject | nullLive page check when marked published, outside your limit: { id, status, score, error }.
proofobject | nullBefore-and-after results for the completed fix: status (waiting, measured, not_comparable, not_measured), metric, before, after, change, dueAt, reason, and beforeAnswers/afterAnswers as { named, total }.
metaDescriptionstring | nullThe meta description.
notesstring | nullOptional owner instructions for the writer, up to 500 characters, such as facts to include or avoid.
markdownstring | nullPage Markdown, with owner edits when saved. Fill in every [bracketed placeholder] before publishing.
htmlstring | nullThe Markdown rendered, with no raw HTML.
jsonldobject | nullOrganization, Article and FAQPage structured data as one @graph.
checkobject | nullDraft page check: score, checks, todo (changes to make yourself) and autoFixed.

Successful REST responses from this endpoint include the shown meta fields. Read about data-through dates.

Possible errors

  • 400 invalid_request — An input failed validation. Field details may appear in errors.
  • 401 unauthorized — Authentication failed because the token is absent, unrecognized or revoked.
  • 403 forbidden — Account access or token permissions do not allow this request. Check the message for the cause.
  • 404 not_found — The resource is missing or unavailable to this account, including inactive brands.
  • 429 rate_limited — A quota was reached or could not be checked. Wait the Retry-After delay before retrying.
  • 500 server_error — The server failed to complete the operation.

For the shared error format, see status codes, quotas and retries.