roasOS
API referenceCatalog

List ad formats

Every ad format roasOS makes: video formats, product effects, TikTok slideshows and statics. Each format has its premise, its beats, how to shoot it, what breaks it, what it needs, its default model roles (resolve them in `GET /v1/catalog` roles) and the pack skill that runs it. Ask for a format by name in `POST /v1/agent/completions`. This call is free.

GET
/v1/formats

Every ad format roasOS makes: video formats, product effects, TikTok slideshows and statics. Each format has its premise, its beats, how to shoot it, what breaks it, what it needs, its default model roles (resolve them in GET /v1/catalog roles) and the pack skill that runs it. Ask for a format by name in POST /v1/agent/completions. This call is free.

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication. Use your API key as the bearer token: Authorization: Bearer roasos_sk_...

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/formats"
{  "data": {    "registry_version": "string",    "formats": [      {        "id": "string",        "name": "string",        "kind": "video",        "aliases": [          "string"        ],        "premise": "string",        "beats": [          "string"        ],        "shoot": "string",        "avoid": "string",        "needs": {          "product": true,          "person": true        },        "aspect": "string",        "duration_sec": 0,        "roles": {          "video": "string",          "image": "string"        },        "skill": "string",        "starter": "string"      }    ]  }}