beats

Get Beat

get/v1/beats/{beat_id}

Request

  • Base URL: https://api.myarchivist.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.myarchivist.ai/v1/beats/{beat_id}
  • Auth: HTTP bearer

Path parameters

beat_idstring required

Query parameters

with_linksboolean

Return description with [[wikilinks]] intact

Headers

x-api-keystring nullable

Response

Successful Response

created_atstring date-time required
updated_atstring date-time nullable
idstring required
labelstring required
descriptionstring nullable
type'major' | 'minor' | 'step'
indexinteger
metadataobject nullable
parent_idstring nullable
campaign_idstring required
game_session_idsstring[]
game_session_idstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.