colony / api

colony.technology/api

api.colony.technology

public
  GET  /v1/health   open
  GET  /v1/cert/:id
  GET  /v1/registry open
  GET  /v1/keys / public Ed25519 verification key
  GET  /v1/result/sha256:HEX / active source result
  GET  /v1/badge/:sha256 / status of that source
  GET  /v1/revocations open
  GET  /v1/certificates/status open

analyze / no key
  POST /v1/analyze
  body: {format: "r1cs", source_base64, filename?}
binary r1cs, base64, up to 8 MiB. free. returns the verdict and the sha-256 of the submitted bytes.
compile .circom locally with the cli; submit compiled r1cs for hosted analysis.

after a purchase
  POST https://colony.technology/api/receipt
  body: {session_id, email}
  key for a paid checkout

key required
  POST /v1/quotes     price in credits for a source
  POST /v1/jobs       paid exact job / idempotency key
  GET  /v1/jobs/:id   status and settlement
  GET  /v1/jobs/:id/result  result for that source
  GET  /v1/usage
  POST /v1/cert
  body: {format: "r1cs", source_base64, report?}
certificate issuance: independent replay of a certified derivation or broken witness pair against the submitted r1cs. validation attempts free; one credit per signed certificate.
  POST /v1/verify
  authorization: Bearer KEY

signed certificate: 1 credit
math jobs: 18 bounded exact operators
packages: npm + pypi speedrunpapi v0.7.2
examples / source and result, replayed
cli

proofs  packs  demo  colony