Content

List content opportunities

What to write or fix, ranked: pages to build on your own site, and third-party pages to get onto — each with the prompts it would answer and why it ranks where it does.

GEThttps://api.vidrys.com/v1/projects/{project_id}/content-assets

Plan: Grow and above
Key: read
Rate cost: 1 unit
MCP tool: list_content_assets

Highest score first. This month's content credits come back with the list.

curl --request GET \
  --url "https://api.vidrys.com/v1/projects/{project_id}/content-assets?category=onsite&state=ready" \
  --header "Authorization: Bearer $VIDRYS_API_KEY"

200 · success

{
  "assets": [
    {
      "id": "d4e5f6a7-8b9c-40d1-92e3-4f5a6b7c8d9e",
      "title": "Comparison page — Acme Invoicing vs Northwind Billing",
      "category": "onsite",
      "state": "ready",
      "asset_type": "comparison",
      "audience_segment": "freelancers|india",
      "bullets": [
        "One step from winning — quality 0.43 against the 0.50 threshold on Perplexity",
        "6 competitor pages cited across 9 losing answers; none of yours",
        "Losing on 3 of 4 engines"
      ],
      "cluster_size": 3,
      "cluster_version": 2,
      "needs_review": false,
      "blocked": false,
      "draftable": true,
      "deliverable_label": null,
      "not_draftable_reason": null,
      "suggested_action": null,
      "suggested_source": null,
      "suggested_source_url": null,
      "suggested_target": null,
      "target_url": null,
      "prompt_ids": [
        "0e9a7c55-2b3d-4c1e-8f6a-9d0b1c2e3f4a",
        "b7c3d1e9-4a52-4f8b-91c6-3e5d7a9f2b10",
        "1f2e3d4c-5b6a-4790-8123-456789abcdef"
      ]
    }
  ],
  "page": {
    "page": 1,
    "page_size": 25,
    "total": 7
  },
  "prompts_covered": 18,
  "credits_saved": 11,
  "credits": {
    "used": 12,
    "quota": 80,
    "remaining": 68,
    "project_used": 5
  }
}

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.

Path parameters

project_idstringrequired

The project's id, from List projects.

Query parameters

categoryenum<string>

Your own site, or the wider web.

Values:onsiteoffsite

statestring

Keep only opportunities in this state, e.g. ready or generated.

Values:detectedreadyblockedgeneratinggeneratedverifyingwonstalledunaddressabledismissedarchivedmergedsplit

pageintegerdefault 1

Page number, from 1.

page_sizeintegerdefault 25

Rows per page, 1–100.

Response · 200

application/json

assetsobject[]

Opportunities, highest score first.

+Show child attributes

idstring

Content-opportunity id.

titlestring

What to make, as the board shows it.

categorystring

onsite is a page to write or fix on your own site. offsite is a third-party page to get onto.

Values:onsiteoffsite

statestring

Where it is: ready to draft, blocked by a technical problem, generating, generated (a draft is waiting), verifying (published, being measured), won, stalled (published, nothing moved), dismissed, or one of the internal and terminal states.

Values:detectedreadyblockedgeneratinggeneratedverifyingwonstalledunaddressabledismissedarchivedmergedsplit

asset_typestring

The kind of page or asset to produce.

Values:comparisonpricingfaqdefinitiondocumentationintegrationhow-touse-caseproductcase-studytrust-signalsresearch

audience_segmentstringnullable

Who the prompts come from, e.g. startups or startups|india.

bulletsstring[]

Why it ranks here, strongest reason first. Up to three.

cluster_sizeinteger

Tracked prompts this one asset would answer.

cluster_versioninteger

Rises whenever the prompts in the cluster change.

needs_reviewboolean

True when the grouping is uncertain and worth a human glance.

blockedboolean

True while a hard technical problem on the site would waste the draft.

draftableboolean

Whether a draft can be written for it at all — research briefs and some off-site sources can't be drafted.

deliverable_labelstringnullable

What one credit buys here, e.g. page fixes, pitch email, review request. Null when it's a brand-new page.

not_draftable_reasonstringnullable

Why there's nothing to draft.

suggested_actionstringnullable

Off-site: what to do about the cited source.

suggested_sourcestringnullable

Off-site: the domain to get onto.

suggested_source_urlstringnullable

Off-site: the exact page cited.

suggested_targetstringnullable

Off-site: a readable name for that page.

target_urlstringnullable

On-site: the page being fixed, when it's an existing one.

prompt_idsstring[]

The tracked prompts in the cluster.

pageobject

Where these rows sit in the full list.

+Show child attributes

pageinteger

This page's number, from 1.

page_sizeinteger

Rows per page.

totalinteger

Rows across every page.

prompts_coveredinteger

Prompt memberships across the opportunities still in play.

credits_savedinteger

Prompts covered beyond one per draft — what clustering saves you.

creditsobject

Content credits this month, across the workspace.

+Show child attributes

usedinteger

Credits spent this month.

quotaintegernullable

The month's allowance. Null means unlimited.

remainingintegernullable

What's left. Null when unlimited.

project_usedintegernullable

Of used, what this project spent.

Errors

404 not_found	The project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
422 invalid_request	A parameter or body field is missing or has the wrong type or value. The message names the field. Also returned when a write would pass the plan's prompt limit.
401 unauthorized	No key was sent, or the key is unknown, revoked or expired, or the member who created it has left the workspace or been deactivated.
402 plan_required	The workspace's plan doesn't include API access. It's included on Grow, Scale and Custom.
403 workspace_not_approved	The workspace is still waiting for approval, or wasn't approved.
429 rate_limited	Too many requests this minute. Wait for the number of seconds in the `Retry-After` header, then retry.

Every code, and what to retry, is in Errors.