-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
541 lines (506 loc) · 37.7 KB
/
Copy pathdocs.html
File metadata and controls
541 lines (506 loc) · 37.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Docs · Observer Protocol</title>
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@300;400;500;600&family=IBM+Plex+Sans:wght@300;400;500;600&family=Fraunces:ital,wght@0,300;0,600;0,900;1,300;1,600&display=swap" rel="stylesheet" />
<style>
:root {
--bg: #0a0a08;
--bg2: #111110;
--bg3: #1a1a18;
--border: #2a2a26;
--amber: #f5a623;
--amber-dim: #b8791a;
--amber-glow:#f5a62322;
--green: #4ade80;
--green-dim: #166534;
--text: #e8e8e0;
--text-dim: #888880;
--text-faint:#444440;
--blue: #7eb8f7;
--teal: #5eead4;
--purple: #a78bfa;
}
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
html { scroll-behavior: smooth; }
body { background: var(--bg); color: var(--text); font-family: 'IBM Plex Sans', sans-serif; font-size: 16px; line-height: 1.6; overflow-x: hidden; }
/* NAV */
nav { position: fixed; top: 0; left: 0; right: 0; z-index: 100; display: flex; align-items: center; justify-content: space-between; padding: 0 2.5rem; height: 56px; background: rgba(10,10,8,0.92); backdrop-filter: blur(12px); border-bottom: 1px solid var(--border); }
.nav-logo { font-family: 'IBM Plex Mono', monospace; font-size: 0.8rem; font-weight: 500; color: var(--amber); letter-spacing: 0.12em; text-transform: uppercase; text-decoration: none; }
.nav-links { display: flex; gap: 2rem; list-style: none; }
.nav-links a { font-family: 'IBM Plex Mono', monospace; font-size: 0.72rem; color: var(--text-dim); text-decoration: none; letter-spacing: 0.06em; transition: color 0.2s; }
.nav-links a:hover { color: var(--text); }
.nav-links a.active { color: var(--amber); }
.pulse { width: 6px; height: 6px; border-radius: 50%; background: var(--green); box-shadow: 0 0 6px var(--green); animation: pulse 2s infinite; display: inline-block; }
@keyframes pulse { 0%,100%{opacity:1} 50%{opacity:0.4} }
.nav-status { display: flex; align-items: center; gap: 0.5rem; font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--text-dim); }
/* PAGE HEADER */
.page-header { padding: 9rem 2.5rem 4rem; border-bottom: 1px solid var(--border); position: relative; overflow: hidden; }
.page-header::before { content: ''; position: absolute; inset: 0; background: radial-gradient(ellipse 50% 60% at 75% 40%, rgba(126,184,247,0.05) 0%, transparent 70%); pointer-events: none; }
.page-header-inner { max-width: 1100px; position: relative; display: grid; grid-template-columns: 1fr auto; gap: 3rem; align-items: start; }
@media (max-width: 768px) { .page-header-inner { grid-template-columns: 1fr; } }
.breadcrumb { font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--text-faint); letter-spacing: 0.1em; margin-bottom: 1.5rem; }
.breadcrumb span { color: var(--amber); }
.page-tag { display: inline-flex; align-items: center; gap: 0.5rem; font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--blue); letter-spacing: 0.12em; text-transform: uppercase; border: 1px solid #7eb8f744; padding: 0.3rem 0.8rem; margin-bottom: 1.5rem; background: #7eb8f711; }
h1 { font-family: 'Fraunces', serif; font-size: clamp(2.2rem, 4vw, 3.2rem); font-weight: 900; line-height: 1.08; letter-spacing: -0.02em; margin-bottom: 1.25rem; }
.page-sub { font-size: 1rem; color: var(--text-dim); max-width: 580px; line-height: 1.75; font-weight: 300; }
/* ON-PAGE NAV */
.doc-nav { background: var(--bg2); border: 1px solid var(--border); padding: 1.5rem; min-width: 200px; }
.doc-nav-title { font-family: 'IBM Plex Mono', monospace; font-size: 0.62rem; color: var(--text-faint); letter-spacing: 0.12em; text-transform: uppercase; margin-bottom: 1rem; }
.doc-nav-links { display: flex; flex-direction: column; gap: 0.5rem; }
.doc-nav-links a { font-family: 'IBM Plex Mono', monospace; font-size: 0.7rem; color: var(--text-dim); text-decoration: none; transition: color 0.2s; display: flex; align-items: center; gap: 0.5rem; }
.doc-nav-links a:hover { color: var(--amber); }
.doc-nav-links a::before { content: '→'; color: var(--text-faint); font-size: 0.6rem; }
/* SECTIONS */
section { padding: 4rem 2.5rem; border-bottom: 1px solid var(--border); }
section:last-of-type { border-bottom: none; }
.section-inner { max-width: 1100px; margin: 0 auto; }
.section-label { font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; letter-spacing: 0.16em; text-transform: uppercase; color: var(--amber); margin-bottom: 1rem; }
h2 { font-family: 'Fraunces', serif; font-size: clamp(1.5rem, 2.5vw, 2.2rem); font-weight: 600; line-height: 1.15; margin-bottom: 1rem; color: var(--text); }
.section-intro { font-size: 0.95rem; color: var(--text-dim); max-width: 680px; line-height: 1.8; margin-bottom: 2.5rem; font-weight: 300; }
/* QUICKSTART CARDS */
.qs-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(240px,1fr)); gap: 1px; background: var(--border); }
.qs-card { background: var(--bg2); padding: 1.5rem; text-decoration: none; display: block; transition: background 0.2s; }
.qs-card:hover { background: var(--bg3); }
.qs-icon { font-size: 1.4rem; margin-bottom: 0.6rem; }
.qs-tag { font-family: 'IBM Plex Mono', monospace; font-size: 0.6rem; color: var(--amber); letter-spacing: 0.1em; margin-bottom: 0.35rem; }
.qs-name { font-family: 'Fraunces', serif; font-size: 1rem; font-weight: 600; color: var(--text); margin-bottom: 0.3rem; }
.qs-meta { font-family: 'IBM Plex Mono', monospace; font-size: 0.6rem; color: var(--text-faint); margin-bottom: 0.6rem; }
.qs-desc { font-size: 0.82rem; color: var(--text-dim); line-height: 1.65; font-weight: 300; }
/* API REFERENCE */
.api-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 1.5rem; margin-bottom: 2.5rem; }
@media (max-width: 768px) { .api-grid { grid-template-columns: 1fr; } }
.api-group { background: var(--bg2); border: 1px solid var(--border); }
.api-group-header { padding: 0.85rem 1.25rem; border-bottom: 1px solid var(--border); font-family: 'IBM Plex Mono', monospace; font-size: 0.65rem; color: var(--amber); letter-spacing: 0.1em; text-transform: uppercase; }
.api-endpoint { display: flex; align-items: center; gap: 0.75rem; padding: 0.65rem 1.25rem; border-bottom: 1px solid var(--bg3); font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; transition: background 0.15s; }
.api-endpoint:hover { background: var(--bg3); }
.api-endpoint:last-child { border-bottom: none; }
.method { font-size: 0.58rem; font-weight: 600; padding: 0.15rem 0.4rem; border-radius: 2px; flex-shrink: 0; }
.method.get { background: #166534; color: #4ade80; }
.method.post { background: #1e3a5f; color: #7eb8f7; }
.method.patch { background: #44310a; color: #f5a623; }
.endpoint-path { color: var(--text-dim); flex: 1; }
.endpoint-desc { color: var(--text-faint); font-size: 0.6rem; }
.new-tag { font-size: 0.5rem; background: #7eb8f722; color: var(--blue); padding: 0.1rem 0.3rem; border: 1px solid #7eb8f744; }
/* SDK */
.sdk-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 2rem; }
@media (max-width: 768px) { .sdk-grid { grid-template-columns: 1fr; } }
.code-block { background: var(--bg); border: 1px solid var(--border); border-left: 2px solid var(--amber-dim); padding: 1.25rem; font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--text-dim); line-height: 1.9; overflow-x: auto; }
.code-comment { color: var(--text-faint); }
.code-key { color: var(--blue); }
.code-val { color: var(--green); }
.code-fn { color: var(--amber); }
.sdk-note { font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--text-faint); border: 1px solid var(--border); padding: 0.75rem 1rem; background: var(--bg2); margin-top: 1rem; display: flex; gap: 0.75rem; align-items: flex-start; }
.sdk-note-icon { color: var(--amber); flex-shrink: 0; }
/* DID RESOLVER */
.resolver-wrap { background: var(--bg2); border: 1px solid var(--border); padding: 2rem; }
.resolver-input-row { display: flex; gap: 0.75rem; margin-bottom: 1.5rem; flex-wrap: wrap; }
.resolver-input { font-family: 'IBM Plex Mono', monospace; font-size: 0.72rem; background: var(--bg); border: 1px solid var(--border); color: var(--text); padding: 0.6rem 0.9rem; flex: 1; min-width: 280px; outline: none; }
.resolver-input:focus { border-color: var(--blue); }
.btn-resolve { font-family: 'IBM Plex Mono', monospace; font-size: 0.72rem; padding: 0.65rem 1.25rem; background: var(--blue); color: #0a0a08; border: none; cursor: pointer; font-weight: 600; transition: all 0.2s; white-space: nowrap; }
.btn-resolve:hover { background: #a8d4fb; }
.resolver-output { background: var(--bg); border: 1px solid var(--border); padding: 1.25rem; font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--text-dim); line-height: 1.8; min-height: 160px; white-space: pre-wrap; word-break: break-all; }
/* DID RESOLUTION DOC */
.did-doc { display: grid; grid-template-columns: 1fr 1fr; gap: 2rem; }
@media (max-width: 768px) { .did-doc { grid-template-columns: 1fr; } }
.did-pattern { background: var(--bg2); border: 1px solid var(--border); padding: 1.5rem; }
.did-pattern-label { font-family: 'IBM Plex Mono', monospace; font-size: 0.62rem; color: var(--text-faint); letter-spacing: 0.1em; margin-bottom: 0.75rem; }
.did-pattern-value { font-family: 'IBM Plex Mono', monospace; font-size: 0.72rem; color: var(--teal); line-height: 1.8; margin-bottom: 0.5rem; }
.did-pattern-example { font-family: 'IBM Plex Mono', monospace; font-size: 0.65rem; color: var(--text-faint); line-height: 1.8; }
.did-table { width: 100%; border-collapse: collapse; margin-top: 1.5rem; }
.did-table th { font-family: 'IBM Plex Mono', monospace; font-size: 0.62rem; letter-spacing: 0.1em; text-transform: uppercase; color: var(--text-faint); text-align: left; padding: 0.65rem 1rem; border-bottom: 1px solid var(--border); }
.did-table td { font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--text-dim); padding: 0.65rem 1rem; border-bottom: 1px solid var(--bg3); }
.did-table td:first-child { color: var(--teal); }
.did-table tr:hover td { background: var(--bg2); }
/* SPEC LINKS */
.spec-cards { display: grid; grid-template-columns: repeat(auto-fit, minmax(220px,1fr)); gap: 1px; background: var(--border); margin-top: 1rem; }
.spec-card { background: var(--bg2); padding: 1.5rem; text-decoration: none; display: block; transition: background 0.2s; }
.spec-card:hover { background: var(--bg3); }
.spec-card-tag { font-family: 'IBM Plex Mono', monospace; font-size: 0.6rem; color: var(--amber); letter-spacing: 0.1em; margin-bottom: 0.5rem; }
.spec-card h3 { font-family: 'Fraunces', serif; font-size: 1rem; font-weight: 600; color: var(--text); margin-bottom: 0.4rem; }
.spec-card p { font-size: 0.82rem; color: var(--text-dim); line-height: 1.65; font-weight: 300; margin-bottom: 0.75rem; }
.spec-card-cta { font-family: 'IBM Plex Mono', monospace; font-size: 0.65rem; color: var(--amber); }
/* FOOTER */
footer { border-top: 1px solid var(--border); padding: 2.5rem 2.5rem 2rem; background: var(--bg); }
.footer-inner { max-width: 1100px; margin: 0 auto; display: flex; justify-content: space-between; align-items: center; flex-wrap: wrap; gap: 1rem; }
.footer-brand { font-family: 'IBM Plex Mono', monospace; font-size: 0.72rem; color: var(--amber); letter-spacing: 0.12em; text-transform: uppercase; }
.footer-links { display: flex; gap: 2rem; flex-wrap: wrap; }
.footer-links a { font-family: 'IBM Plex Mono', monospace; font-size: 0.68rem; color: var(--text-faint); text-decoration: none; transition: color 0.2s; }
.footer-links a:hover { color: var(--text-dim); }
.footer-note { font-family: 'IBM Plex Mono', monospace; font-size: 0.62rem; color: var(--text-faint); margin-top: 1.5rem; max-width: 1100px; margin-left: auto; margin-right: auto; padding-top: 1rem; border-top: 1px solid var(--border); }
.divider { width: 40px; height: 1px; background: var(--amber-dim); margin-bottom: 2rem; }
</style>
</head>
<body>
<nav>
<a class="nav-logo" href="/">Observer Protocol</a>
<ul class="nav-links">
<li><a href="./architecture.html">Architecture</a></li>
<li><a href="./docs.html" class="active">Docs</a></li>
<li><a href="./agentic-terminal.html">Agentic Terminal</a></li>
<li><a href="./registry.html">Registry</a></li>
</ul>
<div class="nav-status"><div class="pulse"></div>PUBLIC BETA · V1.3</div>
</nav>
<!-- PAGE HEADER -->
<div class="page-header">
<div class="page-header-inner">
<div>
<div class="breadcrumb">OBSERVER PROTOCOL · <span>DOCS</span></div>
<div class="page-tag">Developer Documentation · v1.3</div>
<h1>Documentation</h1>
<p class="page-sub">
Everything you need to register agents, issue credentials, verify identity, and integrate Observer Protocol into your stack. Open protocol, MIT licensed, self-hostable.
</p>
</div>
<div class="doc-nav">
<div class="doc-nav-title">On This Page</div>
<div class="doc-nav-links">
<a href="#getting-started">Getting Started</a>
<a href="#api-reference">API Reference</a>
<a href="#sdk">SDK</a>
<a href="#did-resolver">DID Resolver</a>
<a href="#spec-aip">Spec & AIP</a>
<a href="#did-resolution">DID Resolution</a>
</div>
</div>
</div>
</div>
<!-- GETTING STARTED -->
<section id="getting-started" style="background: var(--bg);">
<div class="section-inner">
<div class="section-label">Getting Started</div>
<h2>Choose your path.</h2>
<p class="section-intro">
Get started with Observer Protocol. Full developer documentation, SDK reference, and working examples on GitHub.
</p>
<div class="qs-grid">
<a href="https://github.com/observer-protocol/observer-protocol-spec/tree/master/docs/developer-guide" target="_blank" class="qs-card">
<div class="qs-icon">📖</div>
<div class="qs-tag">START HERE</div>
<div class="qs-name">Developer Guide</div>
<div class="qs-meta">Architecture · API Reference · Chain Verification</div>
<div class="qs-desc">Complete developer documentation on GitHub. Covers agent registration, chain-agnostic verification, trust scoring, VAC extensions, and sandbox testing.</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/blob/master/docs/developer-guide/agent-quickstart.md" target="_blank" class="qs-card">
<div class="qs-icon">⚡</div>
<div class="qs-tag">60 SECONDS</div>
<div class="qs-name">Agent Quickstart</div>
<div class="qs-meta">Python · pip install observer-protocol</div>
<div class="qs-desc">Register an agent, prove key ownership, retrieve your VAC, and check your trust score, all in 60 seconds. Working code you can run immediately.</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/blob/master/docs/developer-guide/chain-verification.md" target="_blank" class="qs-card">
<div class="qs-icon">🔗</div>
<div class="qs-tag">CHAIN-AGNOSTIC</div>
<div class="qs-name">Chain Verification</div>
<div class="qs-meta">x402 / USDC · Lightning · TRON · Solana · ERC-8004</div>
<div class="qs-desc">Verify transactions on any supported rail. x402 dual verification (Coinbase facilitator + Base RPC). Lightning three-tier model. TRON TronGrid verification. Solana Ed25519. ERC-8004 / TRC-8004 on-chain registry integration.</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/tree/master/sdk/typescript" target="_blank" class="qs-card">
<div class="qs-icon">📦</div>
<div class="qs-tag">NPM INSTALL · v0.2.0</div>
<div class="qs-name">TypeScript SDK</div>
<div class="qs-meta">npm install @observer-protocol/sdk</div>
<div class="qs-desc">Full TypeScript SDK: agent identity, delegation, x402 verification, magic link authorization, chargeback prevention, ERC-8004 integration. Zero dependencies. Browser + Node.js.</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/tree/master/sdk/python" target="_blank" class="qs-card">
<div class="qs-icon">🐍</div>
<div class="qs-tag">PIP INSTALL · v0.2.0</div>
<div class="qs-name">Python SDK</div>
<div class="qs-meta">pip install observer-protocol</div>
<div class="qs-desc">Full Python SDK: agent identity, delegation, x402 verification, magic link authorization, chargeback prevention, ERC-8004 integration. Type-hinted throughout.</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/blob/master/docs/developer-guide/network-operator-guide.md" target="_blank" class="qs-card">
<div class="qs-icon">🏗️</div>
<div class="qs-tag">FOR NETWORKS</div>
<div class="qs-name">Network Operator Guide</div>
<div class="qs-meta">Platforms · Marketplaces · Networks</div>
<div class="qs-desc">Integration path for platforms wanting to verify agent transactions, write to the audit trail, and register VAC extensions for their reputation data.</div>
</a>
</div>
</div>
</section>
<!-- API REFERENCE -->
<section id="api-reference" style="background: var(--bg2);">
<div class="section-inner">
<div class="section-label">API Reference</div>
<h2>API v1.3 · Base URL: api.observerprotocol.org</h2>
<p class="section-intro">
All non-DID endpoints use the <code style="font-family:'IBM Plex Mono',monospace; font-size:0.85em; color:var(--amber); background:var(--bg); padding:0.1rem 0.4rem;">/api/v1/</code> prefix. DID document paths follow the W3C did:web resolution standard and are documented separately below. Full interactive documentation available via Swagger UI.
</p>
<div style="margin-bottom: 1.5rem; display: flex; gap: 1rem; flex-wrap: wrap;">
<a href="https://api.observerprotocol.org/docs" target="_blank" style="font-family:'IBM Plex Mono',monospace; font-size:0.72rem; color:var(--amber); text-decoration:none; border:1px solid var(--amber-dim); padding:0.5rem 1rem; background:var(--amber-glow);">Interactive Swagger UI ↗</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/blob/master/docs/developer-guide/api-reference.md" target="_blank" style="font-family:'IBM Plex Mono',monospace; font-size:0.72rem; color:var(--text-dim); text-decoration:none; border:1px solid var(--border); padding:0.5rem 1rem;">OpenAPI YAML ↗</a>
</div>
<div class="api-grid">
<!-- AGENT IDENTITY -->
<div class="api-group">
<div class="api-group-header">Agent Identity</div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/observer/register-agent</span><span class="endpoint-desc">Register agent</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/observer/challenge</span><span class="endpoint-desc">Get challenge</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/observer/verify-agent</span><span class="endpoint-desc">Verify identity</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/observer/agents/{agent_id}</span><span class="endpoint-desc">Agent profile</span></div>
<div class="api-endpoint"><span class="method patch">PATCH</span><span class="endpoint-path">/api/v1/agents/{agent_id}</span><span class="endpoint-desc">Update agent</span></div>
</div>
<!-- DID RESOLUTION -->
<div class="api-group">
<div class="api-group-header">DID Resolution</div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/api/v1/resolve/{did}</span><span class="endpoint-desc">Resolve any did:web <span class="new-tag">NEW</span></span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/observer/consolidate-identity</span><span class="endpoint-desc">Cross-rail consolidation</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/vp/verify</span><span class="endpoint-desc">Verify VP <span class="new-tag">NEW</span></span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/vp/submit</span><span class="endpoint-desc">Submit VP <span class="new-tag">NEW</span></span></div>
</div>
<!-- VAC -->
<div class="api-group">
<div class="api-group-header">Verifiable Agent Credentials</div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/vac/{agent_id}</span><span class="endpoint-desc">Get VAC</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/vac/{agent_id}/refresh</span><span class="endpoint-desc">Refresh VAC</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/vac/{agent_id}/history</span><span class="endpoint-desc">VAC history</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/vac/partners/{id}/attest</span><span class="endpoint-desc">Issue attestation <span class="new-tag">NEW</span></span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/vac/partners</span><span class="endpoint-desc">Partner registry</span></div>
</div>
<!-- AIP -->
<div class="api-group">
<div class="api-group-header">AIP v0.5 <span class="new-tag" style="margin-left:0.5rem;">NEW</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/aip/credentials/delegation</span><span class="endpoint-desc">Issue delegation VC</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/aip/credentials/kyb</span><span class="endpoint-desc">Issue KYB VC</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/aip/chain/verify/{id}</span><span class="endpoint-desc">Verify chain</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/aip/revoke</span><span class="endpoint-desc">Revoke + cascade</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/aip/remediation/build</span><span class="endpoint-desc">Build remediation</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/aip/type-registry/{category}</span><span class="endpoint-desc">Type registry</span></div>
</div>
<!-- PROTOCOL ACTIVITY -->
<div class="api-group">
<div class="api-group-header">Protocol Activity</div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/api/v1/health</span><span class="endpoint-desc">Health check</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/api/v1/stats</span><span class="endpoint-desc">Aggregate stats</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/observer/feed</span><span class="endpoint-desc">Verified event feed</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/observer/trends</span><span class="endpoint-desc">Protocol trends</span></div>
<div class="api-endpoint"><span class="method post">POST</span><span class="endpoint-path">/observer/submit-transaction</span><span class="endpoint-desc">Submit transaction</span></div>
</div>
<!-- ORGANIZATIONS -->
<div class="api-group">
<div class="api-group-header">Organizations</div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/api/v1/protocols</span><span class="endpoint-desc">List protocols</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/api/v1/metrics</span><span class="endpoint-desc">Time-series metrics</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/api/v1/signals</span><span class="endpoint-desc">Protocol signals</span></div>
<div class="api-endpoint"><span class="method get">GET</span><span class="endpoint-path">/observer/badge/{agent_id}.svg</span><span class="endpoint-desc">Agent badge SVG</span></div>
</div>
</div>
<!-- DID RESOLVER TRY IT -->
<div id="did-resolver" style="margin-top: 1rem;">
<div class="section-label" style="margin-bottom: 1rem;">Try It Live · DID Resolution</div>
<div class="resolver-wrap">
<div class="resolver-input-row">
<input class="resolver-input" type="text" id="did-input" placeholder="did:web:observerprotocol.org:agents:maxi-0001" />
<button class="btn-resolve" onclick="resolveDID()">Resolve DID →</button>
</div>
<div class="resolver-output" id="resolver-output"># Enter a DID above and click Resolve.
# Endpoint: GET https://api.observerprotocol.org/api/v1/resolve/{did}
#
# Example DIDs:
# did:web:observerprotocol.org:agents:maxi-0001
# did:web:observerprotocol.org:agents:vicky-0002</div>
</div>
<div style="margin-top:0.75rem; background:var(--bg); border:1px solid var(--border); border-left:2px solid var(--blue); padding:1.25rem; font-family:'IBM Plex Mono',monospace; font-size:0.68rem; color:var(--text-dim); line-height:1.9; overflow-x:auto;">
<span style="color:var(--text-faint)"># Resolve any did:web DID document</span><br/>
curl <span style="color:var(--amber)">https://api.observerprotocol.org/api/v1/resolve/did:web:observerprotocol.org:agents:maxi-0001</span><br/><br/>
<span style="color:var(--text-faint)"># Returns W3C DID Document with verification methods and service endpoints</span>
</div>
</div>
</div>
</section>
<!-- SDK -->
<section id="sdk" style="background: var(--bg);">
<div class="section-inner">
<div class="section-label">SDK</div>
<h2>@observerprotocol/sdk</h2>
<p class="section-intro">
JavaScript SDK for cryptographically verifiable agent identity. Node 16+, MIT license.
</p>
<div class="sdk-grid">
<div>
<div class="code-block">
<span class="code-comment"># Install</span>
pip install observer-protocol
# or
npm install @observer-protocol/sdk
<span class="code-comment"># Register your agent</span>
<span class="code-key">const</span> { ObserverProtocol } = <span class="code-fn">require</span>(<span class="code-val">'@observerprotocol/sdk'</span>);
<span class="code-key">const</span> observer = <span class="code-key">new</span> <span class="code-fn">ObserverProtocol</span>();
<span class="code-key">const</span> agent = <span class="code-key">await</span> observer.<span class="code-fn">registerAgent</span>({
publicKey: <span class="code-val">'02a1b2...'</span>,
alias: <span class="code-val">'MyAgent'</span>
});
<span class="code-comment">// Returns agent_did, badge_url, did_document_url</span>
</div>
<div class="sdk-note">
<div class="sdk-note-icon">⚠</div>
<div></div>
</div>
</div>
<div>
<div class="code-block">
<span class="code-comment"># Verify agent identity</span>
<span class="code-key">const</span> verified = <span class="code-key">await</span> observer.<span class="code-fn">verifyAgent</span>(
agent.id, challenge, signature
);
<span class="code-comment"># Record a transaction</span>
<span class="code-key">await</span> observer.<span class="code-fn">recordTransaction</span>({
senderId: agent.id,
paymentHash: hash,
proof: preimage
});
<span class="code-comment"># Get VAC</span>
<span class="code-key">const</span> vac = <span class="code-key">await</span> observer.<span class="code-fn">getVAC</span>(agent.id);
</div>
<div style="margin-top:1rem; display:flex; gap:0.75rem; flex-wrap:wrap;">
<a href="https://github.com/observer-protocol/observer-protocol-spec/tree/master/sdk" target="_blank" style="font-family:'IBM Plex Mono',monospace; font-size:0.68rem; color:var(--amber); text-decoration:none; border:1px solid var(--amber-dim); padding:0.4rem 0.85rem; background:var(--amber-glow);">GitHub → sdk-js ↗</a>
<a href="https://www.npmjs.com/package/@observerprotocol/sdk" target="_blank" style="font-family:'IBM Plex Mono',monospace; font-size:0.68rem; color:var(--text-dim); text-decoration:none; border:1px solid var(--border); padding:0.4rem 0.85rem;">npm ↗</a>
</div>
</div>
</div>
</div>
</section>
<!-- SPEC & AIP -->
<section id="spec-aip" style="background: var(--bg2);">
<div class="section-inner">
<div class="section-label">Spec & AIP</div>
<h2>Open standards. Versioned specs.</h2>
<p class="section-intro">
Observer Protocol is governed by open specifications maintained on GitHub. AIP v0.5.1 is deployed as of April 27, 2026. It includes chargeback prevention, x402 support, and magic-link authorization.
</p>
<div class="spec-cards">
<a href="https://github.com/observer-protocol/observer-protocol-spec" target="_blank" class="spec-card">
<div class="spec-card-tag">PROTOCOL SPEC · CC BY 4.0</div>
<h3>Observer Protocol Spec</h3>
<p>The canonical specification for OP: identity model, event schema, verification logic, VAC structure, and API reference. Version controlled on GitHub.</p>
<div class="spec-card-cta">github.com/observer-protocol/observer-protocol-spec ↗</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/blob/master/docs/AIP_v0.5.md" target="_blank" class="spec-card">
<div class="spec-card-tag">AIP v0.5.1 · UPDATED APRIL 27, 2026</div>
<h3>Agent Interaction Protocol</h3>
<p>AIP governs how agents interact: delegation credentials, magic-link authorization, authorization proofs, chargeback prevention, and type registry.</p>
<div class="spec-card-cta">Read AIP v0.5.1 spec ↗</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/blob/master/docs/developer-guide/api-reference.md" target="_blank" class="spec-card">
<div class="spec-card-tag">OPENAPI · OAS 3.0</div>
<h3>API OpenAPI Spec</h3>
<p>Machine-readable API specification in OpenAPI 3.0 format. Use to generate client SDKs, validate requests, or power your own Swagger UI instance.</p>
<div class="spec-card-cta">API-SPEC-OPENAPI.yaml ↗</div>
</a>
<a href="./architecture.html" class="spec-card">
<div class="spec-card-tag">CANONICAL REFERENCE · PERMANENT URL</div>
<h3>Architecture Document</h3>
<p>The permanent citable reference for grants, investor materials, developer documentation, and academic reference. Updated April 2026.</p>
<div class="spec-card-cta">observerprotocol.org/architecture ↗</div>
</a>
<a href="https://observerprotocol.org/schemas/x402/v1.json" target="_blank" class="spec-card">
<div class="spec-card-tag">W3C JSON SCHEMAS · LIVE URLS</div>
<h3>Credential Schemas</h3>
<p>X402PaymentCredential, Delegation v2 (three-level authorization), Settlement Receipt v1 (chargeback prevention). All $id URLs resolve.</p>
<div class="spec-card-cta">observerprotocol.org/schemas/ ↗</div>
</a>
<a href="https://github.com/observer-protocol/observer-protocol-spec/tree/master/rails/erc8004" target="_blank" class="spec-card">
<div class="spec-card-tag">ON-CHAIN REGISTRY · LIVE</div>
<h3>ERC-8004 / TRC-8004 Integration</h3>
<p>On-chain agent identity and reputation registry integration. Indexers for Base and TRON mainnet, cross-registry DID resolution, registration file pinning, and OP validator on Base.</p>
<div class="spec-card-cta">rails/erc8004/ on GitHub ↗</div>
</a>
<a href="https://observerprotocol.org/chargeback-prevention" target="_blank" class="spec-card">
<div class="spec-card-tag">DEMO · THOUGHT LEADERSHIP</div>
<h3>Chargeback Prevention Demo</h3>
<p>End-to-end demo: agent purchase, magic-link authorization, authorization proof, cryptographic dispute prevention. For AI infrastructure companies.</p>
<div class="spec-card-cta">observerprotocol.org/chargeback-prevention ↗</div>
</a>
</div>
</div>
</section>
<!-- DID RESOLUTION -->
<section id="did-resolution" style="background: var(--bg);">
<div class="section-inner">
<div class="section-label">DID Resolution · Reference</div>
<h2>How did:web resolution works on OP.</h2>
<p class="section-intro">
Observer Protocol uses the W3C <code style="font-family:'IBM Plex Mono',monospace; font-size:0.85em; color:var(--teal); background:var(--bg2); padding:0.1rem 0.4rem;">did:web</code> method. DID Documents are served at standard URL patterns, not through the API. This is intentional: DID resolution is a protocol-level concern, not an API endpoint.
</p>
<div class="did-doc">
<div>
<div class="did-pattern">
<div class="did-pattern-label">AGENT DID PATTERN</div>
<div class="did-pattern-value">did:web:observerprotocol.org:agents:{agent_id}</div>
<div class="did-pattern-example">→ resolves to:<br/>https://observerprotocol.org/agents/{agent_id}/did.json</div>
</div>
<div class="did-pattern" style="margin-top: 1px;">
<div class="did-pattern-label">ORG DID PATTERN</div>
<div class="did-pattern-value">did:web:{org-domain}:op-identity</div>
<div class="did-pattern-example">→ resolves to:<br/>https://{org-domain}/op-identity/did.json</div>
</div>
<div class="did-pattern" style="margin-top: 1px;">
<div class="did-pattern-label">ROOT DID PATTERN</div>
<div class="did-pattern-value">did:web:observerprotocol.org</div>
<div class="did-pattern-example">→ resolves to:<br/>https://observerprotocol.org/.well-known/did.json</div>
</div>
</div>
<div>
<p style="font-size:0.88rem; color:var(--text-dim); line-height:1.8; font-weight:300; margin-bottom:1.5rem;">
The W3C did:web method transforms a DID into an HTTPS URL by replacing colons with forward slashes. Anyone with HTTPS access can resolve an OP DID without querying the OP API. This is what makes agent identity truly portable.
</p>
<p style="font-size:0.88rem; color:var(--text-dim); line-height:1.8; font-weight:300; margin-bottom:1.5rem;">
The <strong style="color:var(--text);">domain mismatch rule</strong>: an agent's DID domain must match its organization's DID domain. A mismatch is treated as a fraud signal by AIP-compliant implementations.
</p>
<table class="did-table">
<thead>
<tr>
<th>DID Component</th>
<th>Resolves To</th>
</tr>
</thead>
<tbody>
<tr><td>did:web:example.com</td><td>https://example.com/.well-known/did.json</td></tr>
<tr><td>did:web:example.com:agents:abc</td><td>https://example.com/agents/abc/did.json</td></tr>
<tr><td>did:web:example.com:op-identity</td><td>https://example.com/op-identity/did.json</td></tr>
</tbody>
</table>
<div style="margin-top:1rem; font-family:'IBM Plex Mono',monospace; font-size:0.65rem; color:var(--text-faint);">
Compatible with DIF Universal Resolver · W3C DID Core spec · did:web method spec
</div>
</div>
</div>
</div>
</section>
<footer>
<div class="footer-inner">
<div class="footer-brand">Observer Protocol</div>
<div class="footer-links">
<a href="/">Home</a>
<a href="./architecture.html">Architecture</a>
<a href="./docs.html">Docs</a>
<a href="./agentic-terminal.html">Agentic Terminal</a>
<a href="./registry.html">Registry</a>
<a href="https://github.com/observer-protocol" target="_blank">GitHub ↗</a>
</div>
</div>
<div class="footer-note">
Observer Protocol v1.3 · MIT License · CC BY 4.0 · Open source, self-hostable, rail-agnostic. · observerprotocol.org
</div>
</footer>
<script>
function resolveDID() {
const input = document.getElementById('did-input').value.trim();
const output = document.getElementById('resolver-output');
const did = input || 'did:web:observerprotocol.org:agents:maxi-0001';
output.textContent = '# Resolving ' + did + '...\n# GET https://api.observerprotocol.org/api/v1/resolve/' + encodeURIComponent(did);
fetch('https://api.observerprotocol.org/api/v1/resolve/' + encodeURIComponent(did))
.then(r => r.json())
.then(data => { output.textContent = JSON.stringify(data, null, 2); })
.catch(() => {
output.textContent = '# DID Document for: ' + did + '\n\n{\n "@context": [\n "https://www.w3.org/ns/did/v1",\n "https://w3id.org/security/suites/ed25519-2020/v1"\n ],\n "id": "' + did + '",\n "verificationMethod": [{\n "id": "' + did + '#key-1",\n "type": "Ed25519VerificationKey2020",\n "controller": "' + did + '",\n "publicKeyMultibase": "z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"\n }],\n "authentication": ["' + did + '#key-1"],\n "assertionMethod": ["' + did + '#key-1"]\n}\n\n# Connect to the live API to resolve real DID documents.';
});
}
</script>
</body>
</html>