Content

Get a content brief

The brief for an opportunity as Markdown: why it matters, the buyer questions to answer, what's wrong with the page today, and what only you can supply. Free — it spends no credit.
GEThttps://api.vidrys.com/v1/projects/{project_id}/content-assets/{asset_id}/brief
Plan
Grow and above
Key
read
Rate cost
1 unit

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.

asset_idstringrequired

The opportunity's id, from List content opportunities.

Response · 200

application/json

asset_idstring

The opportunity briefed.

titlestring

What to make.

deliverablestringnullable

The format, e.g. Pricing page or pitch email.

needs_from_youstring[]

Facts only you have — figures, customer names, dates.

markdownstring

The whole brief as Markdown: why it matters, the questions to answer, what to make.

Errors

404 not_foundThe project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
401 unauthorizedNo 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_requiredThe workspace's plan doesn't include API access. It's included on Grow, Scale and Custom.
403 workspace_not_approvedThe workspace is still waiting for approval, or wasn't approved.
429 rate_limitedToo 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.