Topshelf

Generated topshelf operations.

GET/v1/topshelfRead topshelfread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_topshelf

Responses

200Successapplication/json

Example

{
  "expiresAt": "2026-10-18T19:30:00Z",
  "profileId": "id_8h2k4q",
  "sections": [
    {
      "entries": [
        {
          "absoluteNumber": 0,
          "airDate": "string",
          "dateBased": true,
          "displayUrl": "https://example.com/…",
          "episodeNumber": 0,
          "id": "id_8h2k4q",
          "imageUrl": "https://example.com/…",
          "kind": "string",
          "playUrl": "https://example.com/…",
          "progressPercent": 0,
          "seasonNumber": 0,
          "showTitle": "Fargo",
          "special": true,
          "subtitle": "Fargo",
          "title": "Fargo"
        }
      ],
      "id": "id_8h2k4q",
      "shape": "string",
      "title": "Fargo",
      "titleText": {
        "code": "string",
        "fallback": "string",
        "params": {
          "key": "string"
        }
      }
    }
  ],
  "serverId": "id_8h2k4q",
  "serverName": "Fargo"
}

Schema

expiresAtstringrequired
profileIdstringrequired
sectionsarray of objectrequired
- entriesarray of objectrequired
  - absoluteNumberinteger
  - airDatestring
  - dateBasedboolean
  - displayUrlstringrequired
  - episodeNumberinteger
  - idstringrequired
  - imageUrlstring
  - kindstringrequired
  - playUrlstring
  - progressPercentinteger
  - seasonNumberinteger
  - showTitlestring
  - specialboolean
  - subtitlestring
  - titlestringrequired
- idstringrequired
- shapestringrequired
- titlestringrequired
- titleTextobjectrequired
  - codestringrequired
  - fallbackstringrequired
  - paramsobject
serverIdstringrequired
serverNamestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/topshelf" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/topshelf/art/{id}Read topshelf artread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_topshelf_art_id

Parameters

Name	In	Type	Description
`id`required	path	`string`
`grant`	query	`string`

Responses

200Successapplication/octet-stream

Example

"string"

Schema

string (binary)

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/topshelf/art/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/topshelf/tokenRun topshelf tokensession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_topshelf_token
Max body: 64 KiB

Request body application/json · required

Example

{
  "installationId": "id_8h2k4q"
}

Schema

installationIdstringrequired

Responses

201Successapplication/json

Example

{
  "expiresAt": "2026-10-18T19:30:00Z",
  "feedUrl": "https://example.com/…",
  "token": "string"
}

Schema

expiresAtstringrequired
feedUrlstringrequired
tokenstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/topshelf/token" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"installationId":"id_8h2k4q"}'