Skip to content
Speccy

List a run's factual claims and their labels (REQ-031).

GET
/runs/{runId}/claims
curl --request GET \
  --url https://example.com/api/v1/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/claims

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
runId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

The claims, in document order.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
text
required
string
label
required
string
Allowed values: verified contradicted unverified
reason
required
string
class
required

The claim class the profile gave the section, or unclassified.

string
sources
required
Array<object>

One source of a claim, with what the metadata resolver learned about it.

object
url
required

The address the search returned.

string
final_url

The address that answered, after the redirects. Empty when the resolver did not run.

string
chain

Every address Speccy requested, in order.

Array<string>
status
integer
retrieved_at
string format: date-time
modified
string format: date-time
tier
string
Allowed values: primary secondary
dropped

The source policy refused the source.

boolean
reason
string
anchor
required

A range of text with context (SDD §8.8).

object
file
required
string
heading_path
required
Array<string>
quote
required
string
prefix
required
string
suffix
required
string
start
required

Byte offset of the quote in the file.

integer
end
required
integer
detached

The text changed, and Speccy cannot find the quote in the current version (SDD §8.8).

boolean
Example
{
  "items": [
    {
      "label": "verified",
      "sources": [
        {
          "tier": "primary"
        }
      ]
    }
  ]
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}