> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neuro-tech.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

Open Intelligence is a federated reputation and threat-intelligence system built into the Neuron platform. It allows accounts to publish, share, and query structured intelligence records about network endpoints — IP addresses, XMPP addresses, and other protocol-specific identifiers.

Records include metadata such as threat vectors, protocols, classifications, geo-location, WHOIS data, block status, and custom tags. Each record has an expiry time, after which it is automatically purged.

All endpoints require a valid JWT bearer token.

## Endpoints

| Endpoint                                                                     | Description                                                                                                                        |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| [Check endpoint](/neuron-api/api-reference/open-intelligence/check-endpoint) | Look up existing open intelligence for a given endpoint, including block status, geo-location, WHOIS info, and last protocol used. |
| [Get](/neuron-api/api-reference/open-intelligence/get)                       | Retrieve a specific intelligence record by its object ID.                                                                          |
| [Add](/neuron-api/api-reference/open-intelligence/add)                       | Publish a new intelligence record about an endpoint, with optional tags, classification, threat vector, and agent properties.      |
| [Update](/neuron-api/api-reference/open-intelligence/update)                 | Update an existing intelligence record (e.g. extend expiry or change classification).                                              |
| [Delete](/neuron-api/api-reference/open-intelligence/delete)                 | Delete a specific intelligence record by its object ID.                                                                            |

## Record fields

| Field            | Description                                                            |
| ---------------- | ---------------------------------------------------------------------- |
| `endpoint`       | The target endpoint (IP, XMPP JID, etc.). Format depends on protocol.  |
| `expires`        | When the record will be automatically purged. Must be in the future.   |
| `vector`         | Threat vector string (e.g. attack type).                               |
| `protocol`       | Protocol associated with the endpoint.                                 |
| `classification` | Classification label for the record.                                   |
| `code`           | Machine-readable code for the record type.                             |
| `message`        | Human-readable description.                                            |
| `Tag`            | Named key-value metadata tags, with optional XML type.                 |
| `AgentProperty`  | Agent identity properties attached to the record for trust assessment. |

## Block status

[Check endpoint](/neuron-api/api-reference/open-intelligence/check-endpoint) returns block information if the endpoint has been flagged:

| Field            | Description                                         |
| ---------------- | --------------------------------------------------- |
| `permanentBlock` | If the endpoint is permanently blocked.             |
| `temporaryBlock` | DateTime until the endpoint is temporarily blocked. |
| `reason`         | Reason for the block.                               |

## Related

* [Authentication & sessions](/neuron-api/api-reference/authentication-and-sessions/overview) — required JWT for all open intelligence calls.
* [Legal identities](/neuron-api/api-reference/legal-identities/overview) — agent properties attached to records reference Legal Identity attributes.