Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Use `loc` to locate the field — the last segment is the field name.
| 422 | `Invalid callback URL: <reason>` | [Update org settings](/api/org/update-settings) when `default_callback_url` resolves to a private/internal address. |
| 404 | `Scan not found` | [Get scan](/api/scans/get). |
| 404 | `Batch not found` | [Get batch](/api/scans/batch-get). |
| 404 | `Org settings not found` | Org settings or usage endpoints. |
| 404 | `Org settings not found` | Org settings endpoints. |
| 404 | `API key not found or already revoked` | [Revoke API key](/api/keys/revoke). |
| 400 | `No fields to update` | [Update org settings](/api/org/update-settings). |
| 400 | `Invalid recommendation values: [...]` | [List org scans](/api/org/list-scans). |
Expand Down
20 changes: 2 additions & 18 deletions api/scans/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,19 +117,10 @@ The response is the scan record. Fields you should rely on:
</ResponseField>

<ResponseField name="evidence_index" type="object[]">
Per-URL evidence the contextual model cited. See
Per-URL evidence Tumban cited in support of the decision. See
[Evidence index](/concepts/evidence-index).
</ResponseField>

<ResponseField name="strategy_scores" type="object" required>
Internal per-strategy scores: `blocklist`, `content_safety`, `llm`.
Useful for debugging unexpected recommendations.
</ResponseField>

<ResponseField name="judge_model_invoked" type="boolean" required>
Whether the judge model was invoked to resolve a borderline score.
</ResponseField>

## Coverage

The scan record's `triage_report` does **not** include `coverage` —
Expand Down Expand Up @@ -167,8 +158,6 @@ curl https://api.tumban.com/api/v2/scans/550e8400-e29b-41d4-a716-446655440000 \
"reason_summary": "Direct link to a prohibited platform combined with adult keywords in bio.",
"review_targets": ["https://prohibited-platform.example/username"],
"link_chain": "Profile -> External site",
"strategy_scores": {"blocklist": 50, "content_safety": 0, "llm": 85},
"judge_model_invoked": false,
"evidence_index": [
{
"ref": "link_1",
Expand All @@ -182,10 +171,7 @@ curl https://api.tumban.com/api/v2/scans/550e8400-e29b-41d4-a716-446655440000 \
```

<Note>
The response also includes internal fields not listed above —
`canonical_url`, `username`, `platform`, `last_scanned_at`, `bio`,
`profile_image_url`, `banner_image_url`, `social_links`,
`direct_links`, `blob_references`, `updated_at`, and `org_id`. These
The response also includes internal fields not listed above. These
reflect the underlying scan record and are subject to change. Do not
rely on their names, types, or presence; treat them as opaque.
</Note>
Expand All @@ -208,7 +194,5 @@ read-only sections:
codes, reason summary.
- **Coverage** — which analysis steps ran, login-blocked URLs,
referrer match counts.
- **Strategy scores** — internal per-strategy scores. Useful for
debugging an unexpected recommendation.
- **Raw JSON** — collapsible *"Show full document"* panel that
exposes the entire scan record.
71 changes: 0 additions & 71 deletions api/usage/priority.mdx

This file was deleted.

94 changes: 0 additions & 94 deletions api/usage/scans.mdx

This file was deleted.

68 changes: 0 additions & 68 deletions api/usage/totals.mdx

This file was deleted.

53 changes: 0 additions & 53 deletions api/usage/warmer-health.mdx

This file was deleted.

9 changes: 9 additions & 0 deletions authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,15 @@ Tumban only stores the SHA-256 hash of an API key. The raw `sk_…` value is
returned exactly once at creation time. If you lose it, revoke the key and
create a new one.

## Organization identifier

Every authenticated request resolves to exactly one `org_id`. Tumban
treats it as an **opaque, case-sensitive string** — do not regex-match
it against a hex or numeric alphabet. The leading `org_` prefix is the
only guaranteed part of the shape. Examples (`org_2abc...`) in this
reference are illustrative; the body is alphanumeric and may include
mixed case.

## Errors

| Status | Meaning |
Expand Down
Loading