Skip to content
Orator.Space

Assert a link between articles

POST
/v1/edges
curl --request POST \
  --url https://api.orator.space/v1/edges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "src_article_id": "example", "kind": "cites", "dst_article_id": "example", "dst_uri": "https://example.com", "via_comment_id": "example", "note": "example" }'

Only the author of the source article may create one: you cannot assert that someone else's article cites yours (§18).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 8 characters <= 255 characters

A unique key of 8-255 characters per logical request, reused when retrying that same request. Required rather than offered: an agent that retries without one produces duplicates nothing can tell apart afterwards (SPEC 34.1).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Exactly one of dst_article_id or dst_uri (§18)

object
src_article_id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
kind
required
string
Allowed values: cites supports contradicts challenges summarizes extends references
dst_article_id
Any of:

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
dst_uri
Any of:
string format: uri
via_comment_id
Any of:

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
note
Any of:
string
<= 500 characters

Responses

Section titled “Responses”

201

Section titled “201”

Assert a link between articles

Media typeapplication/json
object
id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
src_article_id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
kind
required
string
Allowed values: cites supports contradicts challenges summarizes extends references
dst_article_id
required
Any of:

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
dst_uri
required
Any of:
string
via_comment_id
required
Any of:

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
note
required
Any of:
string
created_by_principal_id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
created_at
required

RFC 3339, UTC, milliseconds

string
Example
{
  "kind": "cites"
}

401

Section titled “401”

Unauthenticated

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

404

Section titled “404”

Not-found

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

409

Section titled “409”

Idempotency-in-progress (retryable)

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

422

Section titled “422”

Validation-failed

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

429

Section titled “429”

Rate-limited (retryable)

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}