Results

Get a reasoning card

Why one answer went the way it did, and what would change it.

GEThttps://api.vidrys.com/v1/projects/{project_id}/results/{result_id}/reasoning

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

Takes the result id, not the card id: read id from a result whose reasoning_card_id is set. A card can be shared by several results of the same prompt and engine while the outcome doesn't change.

curl --request GET \
  --url "https://api.vidrys.com/v1/projects/{project_id}/results/{result_id}/reasoning" \
  --header "Authorization: Bearer $VIDRYS_API_KEY"

200 · success

{
  "id": "a3c9e1f0-4b2d-4e8a-9f1c-7d6b5a4e3c2b",
  "prompt": "best invoicing software for freelancers in India",
  "platform": "Perplexity",
  "card_type": "weak_mention",
  "winner": "Northwind Billing",
  "loser": "Acme Invoicing",
  "reasons": [
    {
      "category": "comparison page",
      "detail": "Northwind Billing has a page comparing the two products, and the answer quoted it.",
      "impact": "high"
    },
    {
      "category": "review presence",
      "detail": "Three of the six cited sources are review sites you're absent from.",
      "impact": "medium"
    }
  ],
  "recommended_actions": [
    "Publish a comparison page for \"Acme Invoicing vs Northwind Billing\" with a feature table and pricing.",
    "Get listed on the two review sites the answer cited."
  ],
  "recommendation_id": "c1d2e3f4-5a6b-47c8-99d0-1e2f3a4b5c6d"
}

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.

result_idstringrequired

A result id from List results.

Response · 200

application/json

idstring

Card id.

promptstring

The prompt that was asked.

platformstring

Engine label.

Values:ChatGPTPerplexityGeminiCopilotAI OverviewsClaude

card_typestring

win: the brand won. weak_mention: named, but not well enough to win. loss: absent while a competitor was named.

Values:winweak_mentionloss

winnerstring

Who the answer favoured: the brand on a win, otherwise a competitor (or empty).

loserstring

The runner-up on a win (or empty), otherwise the brand.

reasonsobject[]

Why the answer went this way, up to four.

+Show child attributes

categorystring

A short label for the reason, e.g. comparison page.

detailstring

The explanation.

impactstring

How much it mattered.

Values:highmediumlow

recommended_actionsstring[]

What would change the answer, up to four.

recommendation_idstringnullable

The content-queue task already created for this, if any — a ticket id from the queue.

Errors

404 not_found	The project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
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.