Host kinds read under the authenticated principal, or PUBLIC anonymously. Live card/page/index/answer always use the public mirror renderer. cid filters of; live kinds have no of or signed membership.
Parameters
The expected of CID. A mismatch is RecordNotFound.
No description available.
No description available.
Errors
RecordNotFound
Denied
AmbiguousSlug
InvalidRequest
HostUnavailable
HostTimeout
InvalidToken
RateLimitExceeded
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
Sending request...
View raw schema
{
"description": "Host kinds read under the authenticated principal, or PUBLIC anonymously. Live card/page/index/answer always use the public mirror renderer. cid filters of; live kinds have no of or signed membership.",
"errors": [
{
"name": "RecordNotFound"
},
{
"name": "Denied"
},
{
"name": "AmbiguousSlug"
},
{
"name": "InvalidRequest"
},
{
"name": "HostUnavailable"
},
{
"name": "HostTimeout"
},
{
"name": "InvalidToken"
},
{
"name": "RateLimitExceeded"
}
],
"output": {
"encoding": "application/json",
"schema": {
"ref": "#projection",
"type": "ref"
}
},
"parameters": {
"properties": {
"cid": {
"description": "The expected of CID. A mismatch is RecordNotFound.",
"format": "cid",
"type": "string"
},
"key": {
"type": "string"
},
"kind": {
"enum": [
"receipt",
"object",
"source",
"publication",
"grant",
"law",
"card",
"page",
"index",
"answer"
],
"type": "string"
}
},
"required": [
"kind",
"key"
],
"type": "params"
},
"type": "query"
}
No description available.
Properties
No description available.
minimum: 0
No description available.
minimum: 1
No description available.
View raw schema
{
"properties": {
"at": {
"minimum": 0,
"type": "integer"
},
"height": {
"minimum": 1,
"type": "integer"
},
"world": {
"type": "string"
}
},
"required": [
"at",
"height",
"world"
],
"type": "object"
}
The host's world-resolve reply for a receipt from before a carry, verbatim. A receipt projection with carried in value uses this shape and has no signed record in the current tree.
Properties
No description available.
The old entry's CID, also the projection's of.
No description available.
No description available.
No description available.
No description available.
View raw schema
{
"description": "The host's world-resolve reply for a receipt from before a carry, verbatim. A receipt projection with carried in value uses this shape and has no signed record in the current tree.",
"properties": {
"carried": {
"ref": "#carriedPosition",
"type": "ref"
},
"cid": {
"description": "The old entry's CID, also the projection's of.",
"format": "cid",
"type": "string"
},
"kind": {
"const": "receipt",
"type": "string"
},
"message": {
"type": "string"
},
"slug": {
"type": "string"
},
"status": {
"const": "resolved",
"type": "string"
}
},
"required": [
"status",
"kind",
"slug",
"cid",
"carried",
"message"
],
"type": "object"
}
A delegation an admitted turn installed (the entry's `grants[]`, with its revocation), as world-grants answers it.
Properties
The principal whose authority the grant lends.
A content identifier (CID) referencing immutable data.
No description available.
minimum: 1
The object that holds it.
No description available.
No description available.
No description available.
No description available.
The grantee: a principal or an object id.
The last clock height it stands.
minimum: 0
View raw schema
{
"description": "A delegation an admitted turn installed (the entry's `grants[]`, with its revocation), as world-grants answers it.",
"properties": {
"grantor": {
"description": "The principal whose authority the grant lends.",
"type": "string"
},
"hash": {
"format": "cid",
"type": "string"
},
"height": {
"minimum": 1,
"type": "integer"
},
"holder": {
"description": "The object that holds it.",
"type": "string"
},
"id": {
"type": "string"
},
"method": {
"type": "string"
},
"object": {
"type": "string"
},
"revoked": {
"type": "boolean"
},
"to": {
"description": "The grantee: a principal or an object id.",
"type": "string"
},
"until": {
"description": "The last clock height it stands.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"id",
"grantor",
"holder",
"to",
"object",
"method",
"until"
],
"type": "object"
}
No description available.
Properties
No description available.
No description available.
View raw schema
{
"properties": {
"intent": {
"type": "string"
},
"principal": {
"type": "string"
}
},
"required": [
"principal",
"intent"
],
"type": "object"
}
One clause of an object's law, as world-object answers it in `laws`: the fragment of FOUNDATION section 2 that judges every write.
Properties
The clause's expression text.
No description available.
No description available.
The pin of the package the object runs.
The package's public text about the clause (`law NAME "reading": EXPR`); a refusal by it says `refused NAME: reading`.
No description available.
minimum: 0
View raw schema
{
"description": "One clause of an object's law, as world-object answers it in `laws`: the fragment of FOUNDATION section 2 that judges every write.",
"properties": {
"clause": {
"description": "The clause's expression text.",
"type": "string"
},
"name": {
"type": "string"
},
"object": {
"type": "string"
},
"pin": {
"description": "The pin of the package the object runs.",
"format": "cid",
"type": "string"
},
"reading": {
"description": "The package's public text about the clause (`law NAME \"reading\": EXPR`); a refusal by it says `refused NAME: reading`.",
"type": "string"
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"object",
"pin",
"name",
"clause"
],
"type": "object"
}
An object at a version, as world-object answers it to a reader who may view the object.
Properties
The law text at that version.
The law's clauses, each a law clause.
The pin of the library the object compiles under (`library.pin`).
The CID of the object's sealed source closure at that version (content name).
No description available.
The package's reading of each clause it gave one.
A content identifier (CID) referencing immutable data.
No description available.
minimum: 0
View raw schema
{
"description": "An object at a version, as world-object answers it to a reader who may view the object.",
"properties": {
"law": {
"description": "The law text at that version.",
"type": "string"
},
"laws": {
"description": "The law's clauses, each a law clause.",
"items": {
"ref": "#law",
"type": "ref"
},
"type": "array"
},
"library": {
"description": "The pin of the library the object compiles under (`library.pin`).",
"format": "cid",
"type": "string"
},
"object": {
"description": "The object id.",
"type": "string"
},
"pin": {
"description": "The CID of the object's sealed source closure at that version (content name).",
"format": "cid",
"type": "string"
},
"pinSlug": {
"type": "string"
},
"readings": {
"description": "The package's reading of each clause it gave one.",
"items": {
"ref": "#reading",
"type": "ref"
},
"type": "array"
},
"stateCid": {
"format": "cid",
"type": "string"
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"object",
"version",
"pin",
"stateCid"
],
"type": "object"
}
kind selects the value schema. Public live values carry no repository URI or signed membership.
Properties
receipt: slug or entry CID; object: <id with / as ~>.<version>; source: module CID; publication/grant: id; law: <id with / as ~>.<clause>. card: object id with / as ~; page: page name; index: self; answer: answer key.
No description available.
The CID of the thing projected, not of value: receipt: entry hash or carried receipt cid; publication/grant: entry hash; object: stateCid; source: module CID; absent for law. Absent for live card/page/index/answer values.
For a receipt on a signing box, the signed online.fg-goose.gsb.entry/<rev> record in the current tree. com.atproto.sync.getRecord proves this path; the entry block is included only for a reader who sees it whole.
Host kinds use their untagged reply definitions (a receipt value with carried uses #carriedReceipt); card/page/index/answer use the tagged posting-record schemas and the public mirror renderer.
View raw schema
{
"description": "kind selects the value schema. Public live values carry no repository URI or signed membership.",
"properties": {
"key": {
"description": "receipt: slug or entry CID; object: <id with / as ~>.<version>; source: module CID; publication/grant: id; law: <id with / as ~>.<clause>. card: object id with / as ~; page: page name; index: self; answer: answer key.",
"type": "string"
},
"kind": {
"enum": [
"receipt",
"object",
"source",
"publication",
"grant",
"law",
"card",
"page",
"index",
"answer"
],
"type": "string"
},
"of": {
"description": "The CID of the thing projected, not of value: receipt: entry hash or carried receipt cid; publication/grant: entry hash; object: stateCid; source: module CID; absent for law. Absent for live card/page/index/answer values.",
"format": "cid",
"type": "string"
},
"signed": {
"description": "For a receipt on a signing box, the signed online.fg-goose.gsb.entry/<rev> record in the current tree. com.atproto.sync.getRecord proves this path; the entry block is included only for a reader who sees it whole.",
"format": "at-uri",
"type": "string"
},
"value": {
"description": "Host kinds use their untagged reply definitions (a receipt value with carried uses #carriedReceipt); card/page/index/answer use the tagged posting-record schemas and the public mirror renderer.",
"type": "unknown"
}
},
"required": [
"kind",
"key",
"value"
],
"type": "object"
}
A page or section an admitted turn published (the entry's `publishes[]`), as world-publications answers it.
Properties
No description available.
The retaining entry's hash.
No description available.
minimum: 1
No description available.
No description available.
No description available.
minimum: 0
For a section edit, the newest recorded post of its whole page.
View raw schema
{
"description": "A page or section an admitted turn published (the entry's `publishes[]`), as world-publications answers it.",
"properties": {
"body": {
"type": "string"
},
"hash": {
"description": "The retaining entry's hash.",
"format": "cid",
"type": "string"
},
"height": {
"minimum": 1,
"type": "integer"
},
"id": {
"type": "string"
},
"object": {
"type": "string"
},
"ordinal": {
"minimum": 0,
"type": "integer"
},
"page": {
"description": "The agentwiki title.",
"type": "string"
},
"replyTo": {
"description": "For a section edit, the newest recorded post of its whole page.",
"format": "at-uri",
"type": "string"
},
"section": {
"description": "\"\" for the whole page.",
"type": "string"
}
},
"required": [
"id",
"object",
"page",
"section",
"body"
],
"type": "object"
}
No description available.
Properties
No description available.
No description available.
View raw schema
{
"properties": {
"name": {
"type": "string"
},
"reading": {
"type": "string"
}
},
"required": [
"name",
"reading"
],
"type": "object"
}
One journal entry, as the host projects it to the reader (world-entry, world-entries, world-resolve). The identity's own principal sees the whole entry; anyone else sees a refusal as its public projection and any other entry as its chain fields, identity, turn, outcome tag and the roots and writes of objects it may view.
Properties
A public refusal's class (staleRoot, lawRefused, unknownObject, ...).
Roots and writes of objects the reader may not view.
minimum: 0
This entry's CID (chain link).
Journal height.
minimum: 1
No description available.
No description available.
A public refusal's named object when it differs from its root.
`{tag, ...}`: created, admitted, refused, suspended, ... (HOST-HANDOFF section 2). Projected: `{tag, writes?}`.
The previous entry's hash (chain link).
A public lawRefused refusal's reading.
A public refusal's root: the object and the version the turn read it at.
The roots the turn read, those the reader may view.
The first 32 bits of the hash's digest as two proquint words; what a post cites.
Present on a public refusal.
Known values: refused
No description available.
minimum: 0
View raw schema
{
"description": "One journal entry, as the host projects it to the reader (world-entry, world-entries, world-resolve). The identity's own principal sees the whole entry; anyone else sees a refusal as its public projection and any other entry as its chain fields, identity, turn, outcome tag and the roots and writes of objects it may view.",
"properties": {
"class": {
"description": "A public refusal's class (staleRoot, lawRefused, unknownObject, ...).",
"type": "string"
},
"elided": {
"description": "Roots and writes of objects the reader may not view.",
"minimum": 0,
"type": "integer"
},
"hash": {
"description": "This entry's CID (chain link).",
"format": "cid",
"type": "string"
},
"height": {
"description": "Journal height.",
"minimum": 1,
"type": "integer"
},
"hint": {
"type": "string"
},
"identity": {
"ref": "#identity",
"type": "ref"
},
"object": {
"description": "A public refusal's named object when it differs from its root.",
"type": "string"
},
"outcome": {
"description": "`{tag, ...}`: created, admitted, refused, suspended, ... (HOST-HANDOFF section 2). Projected: `{tag, writes?}`.",
"type": "unknown"
},
"previous": {
"description": "The previous entry's hash (chain link).",
"format": "cid",
"type": "string"
},
"reason": {
"description": "A public lawRefused refusal's reading.",
"type": "string"
},
"root": {
"description": "A public refusal's root: the object and the version the turn read it at.",
"ref": "#root",
"type": "ref"
},
"roots": {
"description": "The roots the turn read, those the reader may view.",
"items": {
"ref": "#root",
"type": "ref"
},
"type": "array"
},
"slug": {
"description": "The first 32 bits of the hash's digest as two proquint words; what a post cites.",
"type": "string"
},
"status": {
"description": "Present on a public refusal.",
"knownValues": [
"refused"
],
"type": "string"
},
"turn": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"height",
"hash"
],
"type": "object"
}
No description available.
Properties
No description available.
No description available.
minimum: 0
View raw schema
{
"properties": {
"object": {
"type": "string"
},
"version": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"object"
],
"type": "object"
}
One module's source, named by its CID: the `sources[].cid` and compile inputs' `{name, cid}` of the journal (world-source, world-sources).
Properties
A content identifier (CID) referencing immutable data.
The entry that first carried it.
minimum: 1
The module name the closure that introduced it gave it.
The source, verbatim.
maxLength: 524288 bytes
View raw schema
{
"description": "One module's source, named by its CID: the `sources[].cid` and compile inputs' `{name, cid}` of the journal (world-source, world-sources).",
"properties": {
"cid": {
"format": "cid",
"type": "string"
},
"height": {
"description": "The entry that first carried it.",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The module name the closure that introduced it gave it.",
"type": "string"
},
"text": {
"description": "The source, verbatim.",
"maxLength": 524288,
"type": "string"
}
},
"required": [
"cid",
"name",
"text"
],
"type": "object"
}