ClippedDocs

API reference

Settings

One object holds everything the account has chosen, and a PATCH changes only the fields it names. The whole patch is checked before anything is saved, so one bad field changes nothing and the error says which. A field that isn't a setting is refused rather than ignored.

These are the defaults for every streamer. A streamer's own rules beat them, and a change here reaches every running recording that follows the default from its next clip.

Endpoints

GET/api/v1/settings

Every setting, and which accounts are connected where.

PATCH/api/v1/settings

Change some of them.

Answers with every setting as it now is.

Fields

Settings

autoPost{ on, minScore }

Whether clips post themselves by default, and the score (1–100) they must reach. See Auto-posting.

categoryRulesarray

Auto-posting for one game or genre, whoever is playing: { kind: "game" | "genre", value, on, minScore }. A PATCH replaces the whole list.

accountContentobject

Per connected account id: the kind of content it posts, as [{ kind: "game" | "genre", value }]. A clip posting itself goes only to an account that takes its game. null or [] takes any. Each account's is also under destinations, as content.

postsPerDayinteger

The most clips that post themselves in a day, 0–24.

privacystring

public, unlisted or private: what uploads are posted as.

accountPrivacyobject

PATCH only. { "<account id>": "public" } gives one connected account its own privacy; null puts it back.

formatstring

source (as broadcast), vertical (9:16 gameplay crop) or blur-fill (the whole frame over a blurred 9:16 copy — the vertical shape that needs no facecam found).

captionsboolean

Burn captions into clips that post themselves.

captionPositionstring

Where those captions go: auto (each line wherever is clearest), top or bottom.

endingstring

tight (~33s), balanced (~35s) or loose (~41s).

tasteobject

Five dials, each an integer from -2 to 2, 0 being Clipped's default: voice (chat ↔ the streamer), chat (how many are talking ↔ how they feel), streamer (how loud ↔ what they say), review and topic. Send all five.

titleTemplatestring

{headline} is the written title; also {quote}, {hook}, {channel}, {game}, {category}, {date}.

descriptionTemplatestring

The same fields, for the line the description opens with.

tagsstring[]

Added to every upload, up to 20.

destinationsarray

Read-only. Per destination: connected, and its accounts — id, name, whether it is the default, and its own privacy.

Examples

Post Valorant clips from 75, never post Just Chatting, and leave the rest at 90Shell
curl -X PATCH https://app.clipped.so/api/v1/settings \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{
    "autoPost": { "on": true, "minScore": 90 },
    "categoryRules": [
      { "kind": "game", "value": "Valorant", "on": true, "minScore": 75 },
      { "kind": "game", "value": "Just Chatting", "on": false, "minScore": 70 }
    ]
  }'

Use cases