> For the complete documentation index, see [llms.txt](https://codex.desci.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codex.desci.com/data-layer-definition/entities/relational-information/reference.md).

# Reference

Relates a research object with another, indicating that the result depend on or is related to the target publication. The exact meaning of this relation depends on the author intention, in the same way as a reference in a classical paper does.

Having dedicated entities for references, instead of text based equivalents in the paper, enables querying the scientific record based on direct or transient reference relations.

<figure><img src="/files/4fWDb0MJ1PzIyvbfjWMn" alt="" width="342"><figcaption><p>Reference relations, showing transient references between three publications</p></figcaption></figure>

{% hint style="info" %}
Since any actor can create these relations, a gateway operator may choose to only show such indications created by the publication author or an otherwise trustworthy actor.
{% endhint %}

## Schema

<table><thead><tr><th width="180.33333333333331">Field</th><th width="137">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>fromID</code></td><td><code>ID</code></td><td>Research object at the source of the reference</td></tr><tr><td><code>fromVersion</code></td><td><code>Commit</code></td><td>Version indicator of the same</td></tr><tr><td><code>toID</code></td><td><code>ID</code></td><td>Research object at the target of the reference</td></tr><tr><td><code>toVersion</code></td><td><code>Commit</code></td><td>Version indicator of the same</td></tr><tr><td><code>revoked</code></td><td><code>Boolean</code></td><td>Revokation status</td></tr></tbody></table>

### Revocation

Since entity instances can be updated, but not deleted, the way to recall a contributor indication is by updating this field to `true`. Gateways should respect this and mark it as revoked from the version where it happened.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://codex.desci.com/data-layer-definition/entities/relational-information/reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.