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

# FAQ

> Frequently asked questions about the OathNet API

## Account & Access

<AccordionGroup>
  <Accordion title="Where do I get my API key?">
    Generate it in [Dashboard > Account](https://oathnet.org/dashboard?tab=account).
  </Accordion>

  <Accordion title="Do all endpoints use the same API key auth?">
    Yes. Public customer-facing endpoints use the `x-api-key` header.
  </Accordion>

  <Accordion title="Are some endpoints plan-gated?">
    Yes. File search, exports, bulk search, archive downloads, AI filter creation, and scanner quotas depend on your plan.
  </Accordion>
</AccordionGroup>

## Search & Results

<AccordionGroup>
  <Accordion title="Which search endpoints should I use?">
    Prefer `/service/v2/*` for new search integrations. Use `/service/*` for search sessions and OSINT point lookups.
  </Accordion>

  <Accordion title="What is the difference between stealer search and victims search?">
    Stealer search returns credential-style records. Victims search returns compromised-device summaries keyed by `log_id`.
  </Accordion>

  <Accordion title="How do I inspect files from a victim?">
    Search for a victim, fetch the victim manifest, then request a specific file or the archive download.
  </Accordion>
</AccordionGroup>

## Technical

<AccordionGroup>
  <Accordion title="What response format does the API use?">
    Successful responses use a few different shapes:

    ```json theme={null}
    {
      "success": true,
      "message": "Description",
      "data": { "...": "..." }
    }
    ```

    Search endpoints and most point lookups return the envelope above.

    Some v2 endpoints return raw JSON instead, including:

    * file-search jobs
    * export jobs
    * bulk-search list and status
    * AI filter endpoints
    * breach autocomplete endpoints
    * scanner CRUD endpoints

    Download endpoints return raw text or binary streams.
  </Accordion>

  <Accordion title="Can I use the API from a browser?">
    Technically yes, but it is not recommended. API keys should stay on a trusted server.
  </Accordion>

  <Accordion title="How does query detection work?">
    The `q` parameter automatically detects common types such as email, domain, IP, Discord ID, and username where supported by the endpoint.
  </Accordion>
</AccordionGroup>

## Support

For additional questions, contact [support@oathnet.org](mailto:support@oathnet.org) or join the [Discord](https://discord.gg/DCjnk9TAMK).