Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Create OpenResponse

OpenResponses endpoint backed by Arrow. Hosted Quiver tools execute upstream and return namespaced receipt items. Streaming ends with the literal [DONE] transport sentinel.

POST/v1/responses
Authorization
AuthorizationBearer token · headerrequired
Authentication via Bearer token API key
Header parameters
x-trace-idstring
Optional client-supplied trace identifier. The API echoes this value in `X-Trace-ID` and includes it in request logs for client-side correlation.
min length 1 · max length 256
Request body
requiredapplication/json
backgroundboolean | null
inputstring | object[]required
Show properties
Any of:
string
string
object[]
Array of object
Any of:
object
contentstring | object[]required
Show properties
Any of:
string
string
object[]
Array of object
Any of:
object
textstringrequired
typestringrequired
Allowed:input_text
object
detailstring
Allowed:lowhighautooriginal
file_idstring | null
image_urlstring | null
refstring | null
typestringrequired
Allowed:input_image
object
detailstring | null
Allowed:autolowhighnull
file_datastring | null
file_idstring | null
file_urlstring | null
filenamestring | null
typestringrequired
Allowed:input_file
object
annotationsobject[] | null
textstringrequired
typestringrequired
Allowed:output_text
object
refusalstringrequired
typestringrequired
Allowed:refusal
idstring | null
phasestring | null
Allowed:commentaryfinal_answernull
rolestringrequired
Allowed:assistantdevelopersystemuser
statusstring | null
Allowed:in_progresscompletedincompletenull
typestring
Allowed:message
object
argumentsstring
call_idstringrequired
min length 1
idstring | null
namestringrequired
min length 1
statusstring | null
Allowed:in_progresscompletedincompletenull
typestringrequired
Allowed:function_call
object
call_idstringrequired
min length 1
idstring | null
outputstring | object[]required
Show properties
Any of:
string
string
object[]
Array of object
Any of:
object
textstringrequired
typestringrequired
Allowed:input_text
object
detailstring | null
Allowed:lowhighautooriginalnull
file_idstring | null
image_urlstring | null
refstring | null
typestringrequired
Allowed:input_image
object
detailstring | null
Allowed:autolowhighnull
file_datastring | null
file_idstring | null
file_urlstring | null
filenamestring | null
typestringrequired
Allowed:input_file
statusstring | null
Allowed:in_progresscompletedincompletenull
typestringrequired
Allowed:function_call_output
object
idstringrequired
matches ^rs_[A-Za-z0-9_-]{80,256}$
statusstring | null
Allowed:completed
summaryobject[] | null
Show properties
Array of object
textstringrequired
typestring
Allowed:summary_text
typestring
Allowed:reasoning
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
auto_cropboolean | null
ninteger | null
min 1 · max 16
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
mime_typestringrequired
Allowed:image/svg+xml
svgstringrequired
min length 1
idstringrequired
sRefstring | null
style_createdboolean
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_generation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
auto_cropboolean | null
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
max_output_tokensinteger | null
presence_penaltynumber | null
target_sizeinteger | null
temperaturenumber | null
top_pnumber | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
mime_typestringrequired
Allowed:image/svg+xml
svgstringrequired
min length 1
idstringrequired
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_vectorization_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
promptstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
loop_period_msinteger | null
min 0
mime_typestringrequired
Allowed:image/svg+xml
opening_animation_msinteger | null
min 0
svgstringrequired
min length 1
idstringrequired
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_animation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
max_review_stepsinteger
min 0 · max 5
promptstring | null
reference_imagesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
orchestrator_max_output_tokensinteger | null
shallow_max_output_tokensinteger | null
temperaturenumber | null
svg_refstring | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
mime_typestringrequired
Allowed:image/svg+xml
svgstringrequired
min length 1
idstringrequired
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_editing_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
idstringrequired
sRefstringrequired
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
styleobjectrequired
Show properties
createdintegerrequired
forked_fromstring | null
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
originobjectrequired
Show properties
auto_createdboolean
data_policystring
Allowed:allow_storage_and_trainingallow_storage_for_benchmarks_onlyforbid_storage
distinct_idstring | null
max length 256
endpointstringrequired
kindstringrequired
Allowed:styles_apigeneration_inlinegeneration_autofork
request_idstring | null
max length 256
parent_sRefstring | null
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
reference_preparationobject | null
Show properties
producerstringrequired
reference_formatstringrequired
s3_keystringrequired
referencesobject[]
Show properties
Array of object
media_typestringrequired
purposestring
Allowed:style
s3_keystringrequired
sRefstringrequired
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
schema_versionstring
styleobjectrequired
Show properties
attributesobject | null
Show properties
colorsstring[] | null
max items 32
line_capstring | null
Allowed:buttroundsquarenull
outline_solidstring | null
Allowed:outlinesolidnull
stroke_widthnumber | null
viewbox_sizeinteger | null
promptstring | null
max length 8000
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:style_creation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
auto_cropboolean | null
promptstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
subjectsobject[] | null
min items 1 · max items 9
Show properties
Array of object
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
textstringrequired
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
artwork_idstringrequired
max length 256
mime_typestring
statusstring
Allowed:completedfailed
subjectstringrequired
svgstringrequired
min length 1
idstringrequired
sRefstringrequired
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
style_createdbooleanrequired
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:icon_generation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
idstringrequired
sRefstring | null
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
svgstringrequired
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:icon_editing_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
glyph_setstring | null
Allowed:3672null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
skip_ttfboolean | null
resultobject | null
Show properties
createdintegerrequired
error_ttfboolean
font_namestringrequired
glyph_countintegerrequired
idstringrequired
partial_svgbooleanrequired
partial_ttfbooleanrequired
sRefstring | null
style_createdboolean
svg_countintegerrequired
svgsobjectrequired
ttf_base64string | null
ttf_excluded_glyphsstring[]required
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_generation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
glyph_namestring | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
glyph_namestring | null
idstringrequired
svgstringrequired
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_glyph_editing_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
glyph_setstring | null
Allowed:ascii_basic_36_extensionascii_extra_symbols_1ascii_extra_symbols_2null
settingsobject | null
Show properties
seedinteger | null
ttf_refstring | null
resultobject | null
Show properties
createdintegerrequired
error_ttfboolean
glyph_countintegerrequired
glyph_setstringrequired
Allowed:ascii_basic_36_extensionascii_extra_symbols_1ascii_extra_symbols_2
idstringrequired
partial_svgbooleanrequired
partial_ttfbooleanrequired
reference_charsstringrequired
svg_countintegerrequired
svgsobjectrequired
target_glyphsstring[]required
ttf_excluded_glyphsstring[]required
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_expansion_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
font_namestring | null
formatstring | null
Allowed:ttf
lax_exportboolean | null
svg_refsobject | null
resultobject | null
Show properties
createdintegerrequired
font_base64stringrequired
font_namestringrequired
formatstringrequired
Allowed:ttf
glyph_countintegerrequired
idstringrequired
partial_ttfbooleanrequired
ttf_excluded_glyphsstring[]required
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_export_call
instructionsstring | null
max_output_tokensinteger | null
max_tool_callsinteger | null
metadataobject
modelstringrequired
min length 1
parallel_tool_callsboolean
presence_penaltynumber
min -2 · max 2
previous_response_idstring | null
reasoningobject
Show properties
effortstring
Allowed:lowmediumhighxhigh
summarystring | null
Allowed:auto
storeboolean
streamboolean
temperaturenumber
min 0 · max 2
tool_choicestring | object
Show properties
Any of:
string
string
object
namestringrequired
min length 1
typestringrequired
Allowed:function
object
typestringrequired
Allowed:quiver:svg_generationquiver:svg_vectorizationquiver:svg_animationquiver:svg_editingquiver:style_creationquiver:icon_generationquiver:icon_editingquiver:font_generationquiver:font_glyph_editingquiver:font_expansionquiver:font_export
object
modestringrequired
Allowed:autorequired
toolsobject[]required
min items 1
Show properties
Array of object
Any of:
object
namestringrequired
min length 1
typestringrequired
Allowed:function
object
typestringrequired
Allowed:quiver:svg_generationquiver:svg_vectorizationquiver:svg_animationquiver:svg_editingquiver:style_creationquiver:icon_generationquiver:icon_editingquiver:font_generationquiver:font_glyph_editingquiver:font_expansionquiver:font_export
typestringrequired
Allowed:allowed_tools
toolsobject[] | null
Show properties
Array of object
Any of:
object
attributesobject | null
auto_cropboolean | null
ninteger | null
min 1 · max 16
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:svg_generation
object
attributesobject | null
auto_cropboolean | null
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
max_output_tokensinteger | null
presence_penaltynumber | null
target_sizeinteger | null
temperaturenumber | null
top_pnumber | null
typestringrequired
Allowed:quiver:svg_vectorization
object
promptstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:svg_animation
object
max_review_stepsinteger
min 0 · max 5
promptstring | null
reference_imagesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
orchestrator_max_output_tokensinteger | null
shallow_max_output_tokensinteger | null
temperaturenumber | null
svgstring | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:svg_editing
object
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:style_creation
object
attributesobject | null
auto_cropboolean | null
promptstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
subjectsobject[] | null
min items 1 · max items 9
Show properties
Array of object
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
textstringrequired
typestringrequired
Allowed:quiver:icon_generation
object
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:icon_editing
object
glyph_setstring | null
Allowed:3672null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
skip_ttfboolean | null
typestringrequired
Allowed:quiver:font_generation
object
glyph_namestring | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:font_glyph_editing
object
glyph_setstring | null
Allowed:ascii_basic_36_extensionascii_extra_symbols_1ascii_extra_symbols_2null
settingsobject | null
Show properties
seedinteger | null
ttf_base64string | null
typestringrequired
Allowed:quiver:font_expansion
object
font_namestring | null
formatstring | null
Allowed:ttf
lax_exportboolean | null
svgsobject | null
typestringrequired
Allowed:quiver:font_export
object
descriptionstring | null
namestringrequired
min length 1
parametersobject | nullrequired
strictboolean | nullrequired
typestringrequired
Allowed:function
top_pnumber
min 0 · max 1
websocketboolean | null
Responses
200OpenResponses-compatible ResponseResource returned by the upstream inference service.
backgroundboolean
Allowed:false
completed_atinteger | null
created_atintegerrequired
errorobject | null
Show properties
codestringrequired
Allowed:server_errorrate_limit_exceededinvalid_promptvector_store_timeoutinvalid_imageinvalid_image_formatinvalid_base64_imageinvalid_image_urlimage_too_largeimage_too_smallimage_parse_errorimage_content_policy_violationinvalid_image_modeimage_file_too_largeunsupported_image_media_typeempty_image_filefailed_to_download_imageimage_file_not_found
messagestringrequired
quiver_codestring | null
Allowed:invalid_requestunsupported_animation_requestimage_dimensions_too_largemissing_reference_imagetoo_many_reference_imagestoo_many_subjectsartwork_ids_mismatchinvalid_image_urlimage_url_restrictedimage_url_unresolvedimage_fetch_failedimage_payload_too_largeinvalid_image_payloadunsupported_image_referenceinvalid_svg_sourcesvg_too_largecontent_policy_violationrate_limitedrequest_timeoutupstream_errorinternal_errornull
status_codeinteger | null
frequency_penaltynumber
idstringrequired
incomplete_detailsobject | null
Show properties
codestring | null
Allowed:invalid_requestunsupported_animation_requestimage_dimensions_too_largemissing_reference_imagetoo_many_reference_imagestoo_many_subjectsartwork_ids_mismatchinvalid_image_urlimage_url_restrictedimage_url_unresolvedimage_fetch_failedimage_payload_too_largeinvalid_image_payloadunsupported_image_referenceinvalid_svg_sourcesvg_too_largecontent_policy_violationrate_limitedrequest_timeoutupstream_errorinternal_errornull
messagestring | null
reasonstringrequired
Allowed:content_filtermax_output_tokens
status_codeinteger | null
instructionsstring | nullrequired
max_output_tokensinteger | nullrequired
max_tool_callsinteger | null
metadataobjectrequired
modelstringrequired
objectstring
Allowed:response
outputobject[]required
Show properties
Array of object
Any of:
object
argumentsstring
call_idstringrequired
min length 1
idstringrequired
namestringrequired
min length 1
statusstring
Allowed:completed
typestring
Allowed:function_call
object
call_idstringrequired
min length 1
idstringrequired
outputstringrequired
statusstring
Allowed:completed
typestring
Allowed:function_call_output
object
idstringrequired
matches ^rs_[A-Za-z0-9_-]{80,256}$
statusstring
Allowed:completed
summaryobject[]required
Show properties
Array of object
textstringrequired
typestring
Allowed:summary_text
typestring
Allowed:reasoning
object
contentobject[]required
Show properties
Array of object
annotationsobject[]
textstringrequired
typestring
Allowed:output_text
idstringrequired
phasestring
Allowed:commentaryfinal_answer
rolestring
Allowed:assistant
statusstring
Allowed:completed
typestring
Allowed:message
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
auto_cropboolean | null
ninteger | null
min 1 · max 16
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
mime_typestringrequired
Allowed:image/svg+xml
svgstringrequired
min length 1
idstringrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
sRefstring | null
style_createdboolean
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_generation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
auto_cropboolean | null
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
max_output_tokensinteger | null
presence_penaltynumber | null
target_sizeinteger | null
temperaturenumber | null
top_pnumber | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
mime_typestringrequired
Allowed:image/svg+xml
svgstringrequired
min length 1
idstringrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_vectorization_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
promptstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
loop_period_msinteger | null
min 0
mime_typestringrequired
Allowed:image/svg+xml
opening_animation_msinteger | null
min 0
svgstringrequired
min length 1
idstringrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_animation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
max_review_stepsinteger
min 0 · max 5
promptstring | null
reference_imagesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
orchestrator_max_output_tokensinteger | null
shallow_max_output_tokensinteger | null
temperaturenumber | null
svg_refstring | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
mime_typestringrequired
Allowed:image/svg+xml
svgstringrequired
min length 1
idstringrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
svg_scorenumber | null
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:svg_editing_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
idstringrequired
sRefstringrequired
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
styleobjectrequired
Show properties
createdintegerrequired
forked_fromstring | null
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
originobjectrequired
Show properties
auto_createdboolean
data_policystring
Allowed:allow_storage_and_trainingallow_storage_for_benchmarks_onlyforbid_storage
distinct_idstring | null
max length 256
endpointstringrequired
kindstringrequired
Allowed:styles_apigeneration_inlinegeneration_autofork
request_idstring | null
max length 256
parent_sRefstring | null
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
reference_preparationobject | null
Show properties
producerstringrequired
reference_formatstringrequired
s3_keystringrequired
referencesobject[]
Show properties
Array of object
media_typestringrequired
purposestring
Allowed:style
s3_keystringrequired
sRefstringrequired
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
schema_versionstring
styleobjectrequired
Show properties
attributesobject | null
Show properties
colorsstring[] | null
max items 32
line_capstring | null
Allowed:buttroundsquarenull
outline_solidstring | null
Allowed:outlinesolidnull
stroke_widthnumber | null
viewbox_sizeinteger | null
promptstring | null
max length 8000
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:style_creation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
attributesobject | null
auto_cropboolean | null
promptstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
subjectsobject[] | null
min items 1 · max items 9
Show properties
Array of object
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
textstringrequired
resultobject | null
Show properties
createdintegerrequired
dataobject[]required
min items 1
Show properties
Array of object
artwork_idstringrequired
max length 256
mime_typestring
statusstring
Allowed:completedfailed
subjectstringrequired
svgstringrequired
min length 1
idstringrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
sRefstringrequired
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
style_createdbooleanrequired
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:icon_generation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
idstringrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
sRefstring | null
min length 8 · max length 8 · matches ^[23456789abcdefghjkmnpqrstvwxyz]{8}$
svgstringrequired
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:icon_editing_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
glyph_setstring | null
Allowed:3672null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
skip_ttfboolean | null
resultobject | null
Show properties
createdintegerrequired
error_ttfboolean
font_namestringrequired
glyph_countintegerrequired
idstringrequired
partial_svgbooleanrequired
partial_ttfbooleanrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
sRefstring | null
style_createdboolean
svg_countintegerrequired
svgsobjectrequired
ttf_base64string | null
ttf_excluded_glyphsstring[]required
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_generation_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
glyph_namestring | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
resultobject | null
Show properties
createdintegerrequired
glyph_namestring | null
idstringrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
svgstringrequired
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_glyph_editing_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
glyph_setstring | null
Allowed:ascii_basic_36_extensionascii_extra_symbols_1ascii_extra_symbols_2null
settingsobject | null
Show properties
seedinteger | null
ttf_refstring | null
resultobject | null
Show properties
createdintegerrequired
error_ttfboolean
glyph_countintegerrequired
glyph_setstringrequired
Allowed:ascii_basic_36_extensionascii_extra_symbols_1ascii_extra_symbols_2
idstringrequired
partial_svgbooleanrequired
partial_ttfbooleanrequired
reasoning_effortstring
Allowed:lowmediumhighxhigh
reference_charsstringrequired
svg_countintegerrequired
svgsobjectrequired
target_glyphsstring[]required
ttf_excluded_glyphsstring[]required
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_expansion_call
object
errorobject | null
Show properties
codestring | null
messagestringrequired
paramstring | null
status_codeinteger | null
typestringrequired
Allowed:invalid_requesttool_errorupstream_errorinternal_error
idstringrequired
min length 1
inputobjectrequired
Show properties
font_namestring | null
formatstring | null
Allowed:ttf
lax_exportboolean | null
svg_refsobject | null
resultobject | null
Show properties
createdintegerrequired
font_base64stringrequired
font_namestringrequired
formatstringrequired
Allowed:ttf
glyph_countintegerrequired
idstringrequired
partial_ttfbooleanrequired
ttf_excluded_glyphsstring[]required
usageobject | null
Show properties
input_tokensintegerrequired
min 0
input_tokens_detailsobject
Show properties
cache_write_tokensinteger
min 0
cached_tokensinteger
min 0
output_tokensintegerrequired
min 0
output_tokens_detailsobject
Show properties
reasoning_tokensinteger
min 0
total_tokensintegerrequired
min 0
statusstringrequired
Allowed:in_progresscompletedfailed
typestringrequired
Allowed:quiver:font_export_call
parallel_tool_callsboolean
presence_penaltynumberrequired
previous_response_idstring | null
prompt_cache_keystring | null
reasoningobject
Show properties
effortstring
Allowed:lowmediumhighxhigh
summarystring | null
Allowed:auto
safety_identifierstring | null
service_tierstring
Allowed:default
statusstring
Allowed:completedincompletefailed
storebooleanrequired
temperaturenumberrequired
textobject
Show properties
formatobject
Show properties
typestring
Allowed:text
tool_choicestring | objectrequired
Show properties
Any of:
string
string
object
namestringrequired
min length 1
typestringrequired
Allowed:function
object
typestringrequired
Allowed:quiver:svg_generationquiver:svg_vectorizationquiver:svg_animationquiver:svg_editingquiver:style_creationquiver:icon_generationquiver:icon_editingquiver:font_generationquiver:font_glyph_editingquiver:font_expansionquiver:font_export
object
modestringrequired
Allowed:autorequired
toolsobject[]required
min items 1
Show properties
Array of object
Any of:
object
namestringrequired
min length 1
typestringrequired
Allowed:function
object
typestringrequired
Allowed:quiver:svg_generationquiver:svg_vectorizationquiver:svg_animationquiver:svg_editingquiver:style_creationquiver:icon_generationquiver:icon_editingquiver:font_generationquiver:font_glyph_editingquiver:font_expansionquiver:font_export
typestringrequired
Allowed:allowed_tools
toolsobject[]
Show properties
Array of object
Any of:
object
attributesobject | null
auto_cropboolean | null
ninteger | null
min 1 · max 16
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:svg_generation
object
attributesobject | null
auto_cropboolean | null
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
max_output_tokensinteger | null
presence_penaltynumber | null
target_sizeinteger | null
temperaturenumber | null
top_pnumber | null
typestringrequired
Allowed:quiver:svg_vectorization
object
promptstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:svg_animation
object
max_review_stepsinteger
min 0 · max 5
promptstring | null
reference_imagesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
max_output_tokensinteger | null
orchestrator_max_output_tokensinteger | null
shallow_max_output_tokensinteger | null
temperaturenumber | null
svgstring | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:svg_editing
object
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:style_creation
object
attributesobject | null
auto_cropboolean | null
promptstring | null
sRefstring | null
settingsobject | null
Show properties
aspect_ratiostring | null
max length 64
instructionsstring | null
max length 8000
max_output_tokensinteger | null
presence_penaltynumber | null
seedinteger | null
temperaturenumber | null
top_pnumber | null
styleobject | null
Show properties
attributesobject | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
subjectsobject[] | null
min items 1 · max items 9
Show properties
Array of object
imageobject | null
Show properties
base64string | null
refstring | null
urlstring | null
textstringrequired
typestringrequired
Allowed:quiver:icon_generation
object
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
sRefstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:icon_editing
object
glyph_setstring | null
Allowed:3672null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
skip_ttfboolean | null
typestringrequired
Allowed:quiver:font_generation
object
glyph_namestring | null
promptstring | null
referencesobject[] | null
Show properties
Array of object
base64string | null
refstring | null
urlstring | null
settingsobject | null
Show properties
seedinteger | null
temperaturenumber | null
svg_sourceobject | null
Show properties
base64string | null
refstring | null
urlstring | null
typestringrequired
Allowed:quiver:font_glyph_editing
object
glyph_setstring | null
Allowed:ascii_basic_36_extensionascii_extra_symbols_1ascii_extra_symbols_2null
settingsobject | null
Show properties
seedinteger | null
ttf_base64string | null
typestringrequired
Allowed:quiver:font_expansion
object
font_namestring | null
formatstring | null
Allowed:ttf
lax_exportboolean | null
svgsobject | null
typestringrequired
Allowed:quiver:font_export
object
descriptionstring | null
namestringrequired
min length 1
parametersobject | nullrequired
strictboolean | nullrequired
typestringrequired
Allowed:function
top_logprobsinteger
top_pnumberrequired
truncationstring
Allowed:disabled
usageobject | null
Show properties
input_tokensintegerrequired
input_tokens_detailsobjectrequired
Show properties
cache_write_tokensintegerrequired
cached_tokensintegerrequired
output_tokensintegerrequired
output_tokens_detailsobjectrequired
Show properties
reasoning_tokensintegerrequired
total_tokensintegerrequired
400Bad request – malformed body, missing required fields, or invalid parameter values.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
401Unauthorized – missing, malformed, revoked, otherwise invalid API credentials, or an organization that could not be resolved for billing.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
402Payment required – the organization has insufficient credits.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
403Forbidden – the account is frozen, the request is not allowed, or content policy rejected the request.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
404Not found – the requested model does not exist.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
408Request timeout – the request exceeded an allowed client-facing deadline.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
413Payload too large – the submitted prompt, image, or SVG input is too large.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
429Rate limit exceeded – request throughput or measured input/output token usage exhausted a binding ceiling. `operation_rate_limit_exceeded` identifies operation throughput; `rate_limit_exceeded` covers overall request and token rates. `X-RateLimit-Dimension` names the exact dimension. When `Retry-After` is present, retry after the indicated period.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
500The request could not be completed. Please retry.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
502Bad gateway – model execution returned an invalid or failed response.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
503Service unavailable – model execution is temporarily unavailable.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
504Gateway timeout – model execution exceeded the server deadline.
codestringrequired
Allowed:invalid_requestinvalid_api_keyunauthorizedfunding_payment_failedfunding_payment_method_requiredfunding_payment_action_requiredfunding_pendinginsufficient_creditsaccount_frozencontent_policy_violationmodel_not_foundpayload_too_largerequest_timeoutrate_limit_exceededoperation_rate_limit_exceededweekly_limit_exceededserver_errormodel_errormodel_unavailable
messagestringrequired
min length 1
request_idstringrequired
min length 1
statusintegerrequired
min 400 · max 599
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST "https://api.quiver.ai/v1/responses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "background": true,
  "input": "string",
  "instructions": "string",
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "model": "string",
  "parallel_tool_calls": true,
  "presence_penalty": -2,
  "previous_response_id": "string",
  "reasoning": {
    "effort": "low",
    "summary": "auto"
  },
  "store": true,
  "stream": true,
  "temperature": 2,
  "tool_choice": "auto",
  "tools": [
    {
      "attributes": {
        "property1": null,
        "property2": null
      },
      "auto_crop": true,
      "n": 1,
      "prompt": "string",
      "references": [
        {
          "base64": "string",
          "ref": "string",
          "url": "string"
        }
      ],
      "sRef": "string",
      "settings": {
        "aspect_ratio": "string",
        "instructions": "string",
        "max_output_tokens": 0,
        "presence_penalty": 0,
        "seed": 0,
        "temperature": 0,
        "top_p": 0
      },
      "style": {
        "attributes": {
          "property1": null,
          "property2": null
        },
        "prompt": "string",
        "references": [
          {
            "base64": "string",
            "ref": "string",
            "url": "string"
          }
        ]
      },
      "type": "quiver:svg_generation"
    }
  ],
  "top_p": 1,
  "websocket": true,
  "property1": null,
  "property2": null
}'
Response
{
  "background": false,
  "completed_at": 0,
  "created_at": 0,
  "error": {
    "code": "server_error",
    "message": "string",
    "quiver_code": "invalid_request",
    "status_code": 0
  },
  "frequency_penalty": 0,
  "id": "string",
  "incomplete_details": {
    "code": "invalid_request",
    "message": "string",
    "reason": "content_filter",
    "status_code": 0
  },
  "instructions": "string",
  "max_output_tokens": 0,
  "max_tool_calls": 0,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "model": "string",
  "object": "response",
  "output": [
    {
      "arguments": "string",
      "call_id": "string",
      "id": "string",
      "name": "string",
      "status": "completed",
      "type": "function_call"
    }
  ],
  "parallel_tool_calls": true,
  "presence_penalty": 0,
  "previous_response_id": "string",
  "prompt_cache_key": "string",
  "reasoning": {
    "effort": "low",
    "summary": "auto"
  },
  "safety_identifier": "string",
  "service_tier": "default",
  "status": "completed",
  "store": true,
  "temperature": 0,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [
    {
      "attributes": {
        "property1": null,
        "property2": null
      },
      "auto_crop": true,
      "n": 1,
      "prompt": "string",
      "references": [
        {
          "base64": "string",
          "ref": "string",
          "url": "string"
        }
      ],
      "sRef": "string",
      "settings": {
        "aspect_ratio": "string",
        "instructions": "string",
        "max_output_tokens": 0,
        "presence_penalty": 0,
        "seed": 0,
        "temperature": 0,
        "top_p": 0
      },
      "style": {
        "attributes": {
          "property1": null,
          "property2": null
        },
        "prompt": "string",
        "references": [
          {
            "base64": "string",
            "ref": "string",
            "url": "string"
          }
        ]
      },
      "type": "quiver:svg_generation"
    }
  ],
  "top_logprobs": 0,
  "top_p": 0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cache_write_tokens": 0,
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}