> For the complete documentation index, see [llms.txt](https://docs.perkinsfund.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkinsfund.org/readme.md).

# API Docs

<div align="center"><img src="/files/7WKE7sOUP476kaDBb0Nh" alt="" height="250" width="250"></div>

#### Available Tools

* [Traceix](/readme/traceix-endpoints/traceix.md)\
  Upload files for classification, generate CAPA/EXIF/YARA outputs, and retrieve past results by SHA-256. Includes public IPFS dataset listing and lookup.
* [OnlyVulns](/readme/onlyvulns-endpoints/onlyvulns.md) Coming soon...
* [Traceix Cortex Agents](/readme/traceix-endpoints/cortex-agents.md)\
  Agent lifecycle + operations: check-in, fetch agent configuration/metadata, run queued analyses, poll job status, and submit/retrieve endpoint-driven alerts (ownership enforced per API key).
* [AURA](/readme/pcef-public-endpoints/aura.md)\
  Lightweight executable triage API: upload a file for a fast verdict, view the latest scans, or search historical scans by SHA-256 (PE/ELF supported; others return `unknown`).
* [Yara Rule Playground](/readme/pcef-public-endpoints/yara.md)\
  Build and validate YARA rules, test them against an uploaded sample, or scan against built-in benign/malware corpora to see hits and iterate quickly.
* [Ransom Note Comparison](/readme/pcef-public-endpoints/ransom.md)\
  Identify likely ransomware families by ransom note similarity and search for known public decryptor links using keywords.

#### Expected API Response Output

**API BASE URL: `https://ai.perkinsfund.org`**

```json
{
  "copyright": "(c) PCEF all rights reserved", (only shown if no API key is passed)
  "error": {
    "error_message": ... (if an error)
  },
  "request_timestamp": 1743098585.390719,
  "results": {
    ... || null
  },
  "sponsor": { (if invalid or no API key provided in request)
    "link": ...,
    "title": ...
  },
  "success": true || false (if an error)
}
```

**ONLYVULNS API BASE URL: `https://api.onlyvulns.org`**

```json
{
  "error": {
    "error_id": "..." IF ERROR,
    "error_string": "..."
  },
  "metadata": {
    "note": ... (IF FREE REQUEST),
    "request_id": "...",
    "request_timestamp": unix timestamp UTC
  },
  "results": ...,
  "success": true or false
}
```

**Field descriptions**

* `error` – Contains error messages if any occurred. Will be empty dictionary on success.
* `request_timestamp` – UNIX timestamp when the request was received.
* `results` – Contains the results from the received request.
* `sponsor` – A message and link to the sponsor (only shown to users without an API key).
* `success` – A boolean indicating if the request was successfully processed.


---

# 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://docs.perkinsfund.org/readme.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.