# SUBJCT API — Full Agent Guide

> Expanded overview of the SUBJCT REST API for LLM agents and developer tools. Prefer the OpenAPI document for exact request/response schemas.

## What SUBJCT does

SUBJCT optimises existing content for AI search and classic discovery by automating:

- Semantic internal linking across an archive
- Entity tagging (organisations, people, products, places, events)
- Entity-aware JSON-LD schema generation
- Entity analysis and competitor gap analysis
- Editorial workflows via web app, WordPress plugin, and API

SUBJCT does not replace human writing; it structures and connects content so AI engines can read and cite it.

## Base URL

```
https://api.subjct.ai
```

Interactive documentation: https://docs.subjct.ai  
OpenAPI YAML: https://api.subjct.ai/docs/openapi.yaml  
This file: https://docs.subjct.ai/llms-full.txt  
Compact index: https://docs.subjct.ai/llms.txt

## Authentication

Two methods are supported on most endpoints:

1. **User JWT**
   ```http
   Authorization: Bearer <User-Authentication-Token>
   ```
2. **Organisation secret key**
   ```http
   X-Secret-Key: <Organisation-Secret-Key>
   ```

Obtain a user token via the auth login endpoint. Secret keys are managed in organisation settings in the web app.

## How to use these docs as an agent

1. Fetch https://api.subjct.ai/docs/openapi.yaml for authoritative paths, parameters, and schemas.
2. Use https://docs.subjct.ai/#tag/<tag> deep links for human-oriented sections (tags listed below).
3. Call https://api.subjct.ai with the documented auth headers.
4. Prefer idempotent reads first (`GET` search/list endpoints) before mutating content.

## API tags

| Tag | Purpose | Docs |
| --- | --- | --- |
| auth | Login and authentication | https://docs.subjct.ai/#tag/auth |
| org | Organisation management | https://docs.subjct.ai/#tag/org |
| properties | Properties / sites | https://docs.subjct.ai/#tag/properties |
| search | Content search | https://docs.subjct.ai/#tag/search |
| article | Articles | https://docs.subjct.ai/#tag/article |
| ingest | Archive / content ingestion | https://docs.subjct.ai/#tag/ingest |
| analysis | Content analysis | https://docs.subjct.ai/#tag/analysis |
| metrics | Metrics | https://docs.subjct.ai/#tag/metrics |
| autolink | Automated internal linking | https://docs.subjct.ai/#tag/autolink |
| competitors | Competitors | https://docs.subjct.ai/#tag/competitors |
| entity-analysis | Entity analysis | https://docs.subjct.ai/#tag/entity-analysis |
| tasks | Background tasks | https://docs.subjct.ai/#tag/tasks |
| google-analytics | Google Analytics | https://docs.subjct.ai/#tag/google-analytics |
| webhooks | Webhooks | https://docs.subjct.ai/#tag/webhooks |

## Related products

- Marketing site: https://www.subjct.ai
- Application: https://app.subjct.ai
- Contact: https://www.subjct.ai/contact

## License / contact

API license: Apache 2.0 (see OpenAPI `info.license`)  
Contact: ricardo@subjct.ai