pub.chive.claiming.startClaimFromExternal

chive.pub

Documentation

Start a claim directly from an external search result, importing on demand if needed

main procedure

Start a claim directly from an external search result, importing on demand if needed

Input

Encodingapplication/json
externalId string Required

Source-specific identifier

source string Required

External source (e.g., arxiv, semanticscholar)

maxLength: 50 bytesminLength: 2 bytes

Output

Encodingapplication/json

Errors

AuthenticationRequired
NotFound
InvalidRequest
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "source",
        "externalId"
      ],
      "properties": {
        "source": {
          "type": "string",
          "maxLength": 50,
          "minLength": 2,
          "description": "External source (e.g., arxiv, semanticscholar)"
        },
        "externalId": {
          "type": "string",
          "description": "Source-specific identifier"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "NotFound"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "claim"
      ],
      "properties": {
        "claim": {
          "ref": "#claimRequest",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Start a claim directly from an external search result, importing on demand if needed"
}
claimRequest object

No description available.

Properties

canonicalUri string at-uri Optional

AT-URI of the canonical record in user PDS

claimantDid string did Required

DID of the claimant

createdAt string datetime Required

When the claim was created

expiresAt string datetime Optional

When the claim expires

id integer Required

Claim request ID

importId integer Required

ID of the imported eprint

rejectionReason string Optional

Reason for rejection if rejected

reviewedAt string datetime Optional

When the claim was reviewed

reviewedBy string did Optional

DID of the admin who reviewed

status string Required

Claim status

Known values: pending, approved, rejected, expired
View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "importId",
    "claimantDid",
    "status",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Claim request ID"
    },
    "status": {
      "type": "string",
      "description": "Claim status",
      "knownValues": [
        "pending",
        "approved",
        "rejected",
        "expired"
      ]
    },
    "importId": {
      "type": "integer",
      "description": "ID of the imported eprint"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the claim was created"
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the claim expires"
    },
    "reviewedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the claim was reviewed"
    },
    "reviewedBy": {
      "type": "string",
      "format": "did",
      "description": "DID of the admin who reviewed"
    },
    "claimantDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the claimant"
    },
    "canonicalUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the canonical record in user PDS"
    },
    "rejectionReason": {
      "type": "string",
      "description": "Reason for rejection if rejected"
    }
  }
}

Lexicon Garden

@