Skip to main content
POST
/ifixit/guides

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
guide
string
required
Minimum string length: 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
language
enum<string> | null
Available options:
en,
de,
es,
fr,
it,
jp,
ko,
nl,
pt,
ru,
tr,
zh

Response

Successful Response

id
string
required
name
string
required
@type
string
default:IfixitGuide
url
string | null
summary
string | null
subject
string | null
category
string | null
guide_type
string | null
difficulty
string | null
time_required
string | null
time_required_min_seconds
integer | null
time_required_max_seconds
integer | null
introduction
string | null
introduction_html
string | null
conclusion
string | null
conclusion_html
string | null
language
string | null
available_languages
string[]
is_public
boolean | null
is_machine_translated
boolean | null
created_at
integer | null
published_at
integer | null
modified_at
integer | null
prerequisites_modified_at
integer | null
revision_id
string | null
image
string | null
intro_video_url
string | null
author
object | null
steps
object[]
tools
object[]
parts
object[]
documents
object[]
prerequisites
object[]
comments
object[]
flags
object[]