Search.setIndex({docnames:["api/kittycad.AuthenticatedClient","api/kittycad.Client","api/kittycad.api.file.file_conversion_by_id.asyncio","api/kittycad.api.file.file_conversion_by_id.asyncio_detailed","api/kittycad.api.file.file_conversion_by_id.sync","api/kittycad.api.file.file_conversion_by_id.sync_detailed","api/kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio","api/kittycad.api.file.file_conversion_by_id_with_base64_helper.sync","api/kittycad.api.file.file_convert.asyncio","api/kittycad.api.file.file_convert.asyncio_detailed","api/kittycad.api.file.file_convert.sync","api/kittycad.api.file.file_convert.sync_detailed","api/kittycad.api.file.file_convert_with_base64_helper.asyncio","api/kittycad.api.file.file_convert_with_base64_helper.sync","api/kittycad.api.meta.meta_debug_instance.asyncio","api/kittycad.api.meta.meta_debug_instance.asyncio_detailed","api/kittycad.api.meta.meta_debug_instance.sync","api/kittycad.api.meta.meta_debug_instance.sync_detailed","api/kittycad.api.meta.meta_debug_session.asyncio","api/kittycad.api.meta.meta_debug_session.asyncio_detailed","api/kittycad.api.meta.meta_debug_session.sync","api/kittycad.api.meta.meta_debug_session.sync_detailed","api/kittycad.api.meta.ping.asyncio","api/kittycad.api.meta.ping.asyncio_detailed","api/kittycad.api.meta.ping.sync","api/kittycad.api.meta.ping.sync_detailed","api/kittycad.client.AuthenticatedClient","api/kittycad.client.AuthenticatedClientFromEnv","api/kittycad.client.Client","api/kittycad.models.AuthSession","api/kittycad.models.Environment","api/kittycad.models.ErrorMessage","api/kittycad.models.FileConversion","api/kittycad.models.FileConversionStatus","api/kittycad.models.InstanceMetadata","api/kittycad.models.Message","api/kittycad.models.ValidFileTypes","api/kittycad.models.auth_session.AuthSession","api/kittycad.models.environment.Environment","api/kittycad.models.error_message.ErrorMessage","api/kittycad.models.file_conversion.FileConversion","api/kittycad.models.file_conversion.FileConversionStatus","api/kittycad.models.file_conversion_status.FileConversionStatus","api/kittycad.models.instance_metadata.InstanceMetadata","api/kittycad.models.message.Message","api/kittycad.models.valid_file_types.ValidFileTypes","api/kittycad.types.File","api/kittycad.types.Response","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["api/kittycad.AuthenticatedClient.rst","api/kittycad.Client.rst","api/kittycad.api.file.file_conversion_by_id.asyncio.rst","api/kittycad.api.file.file_conversion_by_id.asyncio_detailed.rst","api/kittycad.api.file.file_conversion_by_id.sync.rst","api/kittycad.api.file.file_conversion_by_id.sync_detailed.rst","api/kittycad.api.file.file_conversion_by_id_with_base64_helper.asyncio.rst","api/kittycad.api.file.file_conversion_by_id_with_base64_helper.sync.rst","api/kittycad.api.file.file_convert.asyncio.rst","api/kittycad.api.file.file_convert.asyncio_detailed.rst","api/kittycad.api.file.file_convert.sync.rst","api/kittycad.api.file.file_convert.sync_detailed.rst","api/kittycad.api.file.file_convert_with_base64_helper.asyncio.rst","api/kittycad.api.file.file_convert_with_base64_helper.sync.rst","api/kittycad.api.meta.meta_debug_instance.asyncio.rst","api/kittycad.api.meta.meta_debug_instance.asyncio_detailed.rst","api/kittycad.api.meta.meta_debug_instance.sync.rst","api/kittycad.api.meta.meta_debug_instance.sync_detailed.rst","api/kittycad.api.meta.meta_debug_session.asyncio.rst","api/kittycad.api.meta.meta_debug_session.asyncio_detailed.rst","api/kittycad.api.meta.meta_debug_session.sync.rst","api/kittycad.api.meta.meta_debug_session.sync_detailed.rst","api/kittycad.api.meta.ping.asyncio.rst","api/kittycad.api.meta.ping.asyncio_detailed.rst","api/kittycad.api.meta.ping.sync.rst","api/kittycad.api.meta.ping.sync_detailed.rst","api/kittycad.client.AuthenticatedClient.rst","api/kittycad.client.AuthenticatedClientFromEnv.rst","api/kittycad.client.Client.rst","api/kittycad.models.AuthSession.rst","api/kittycad.models.Environment.rst","api/kittycad.models.ErrorMessage.rst","api/kittycad.models.FileConversion.rst","api/kittycad.models.FileConversionStatus.rst","api/kittycad.models.InstanceMetadata.rst","api/kittycad.models.Message.rst","api/kittycad.models.ValidFileTypes.rst","api/kittycad.models.auth_session.AuthSession.rst","api/kittycad.models.environment.Environment.rst","api/kittycad.models.error_message.ErrorMessage.rst","api/kittycad.models.file_conversion.FileConversion.rst","api/kittycad.models.file_conversion.FileConversionStatus.rst","api/kittycad.models.file_conversion_status.FileConversionStatus.rst","api/kittycad.models.instance_metadata.InstanceMetadata.rst","api/kittycad.models.message.Message.rst","api/kittycad.models.valid_file_types.ValidFileTypes.rst","api/kittycad.types.File.rst","api/kittycad.types.Response.rst","index.rst"],objects:{"":[[48,0,0,"-","kittycad"]],"kittycad.AuthenticatedClient":[[0,2,1,"","get_headers"]],"kittycad.Client":[[1,2,1,"","get_cookies"],[1,2,1,"","get_headers"],[1,2,1,"","get_timeout"],[1,2,1,"","with_cookies"],[1,2,1,"","with_headers"],[1,2,1,"","with_timeout"]],"kittycad.api.file.file_conversion_by_id":[[2,3,1,"","asyncio"],[3,3,1,"","asyncio_detailed"],[4,3,1,"","sync"],[5,3,1,"","sync_detailed"]],"kittycad.api.file.file_conversion_by_id_with_base64_helper":[[6,3,1,"","asyncio"],[7,3,1,"","sync"]],"kittycad.api.file.file_convert":[[8,3,1,"","asyncio"],[9,3,1,"","asyncio_detailed"],[10,3,1,"","sync"],[11,3,1,"","sync_detailed"]],"kittycad.api.file.file_convert_with_base64_helper":[[12,3,1,"","asyncio"],[13,3,1,"","sync"]],"kittycad.api.meta.meta_debug_instance":[[14,3,1,"","asyncio"],[15,3,1,"","asyncio_detailed"],[16,3,1,"","sync"],[17,3,1,"","sync_detailed"]],"kittycad.api.meta.meta_debug_session":[[18,3,1,"","asyncio"],[19,3,1,"","asyncio_detailed"],[20,3,1,"","sync"],[21,3,1,"","sync_detailed"]],"kittycad.api.meta.ping":[[22,3,1,"","asyncio"],[23,3,1,"","asyncio_detailed"],[24,3,1,"","sync"],[25,3,1,"","sync_detailed"]],"kittycad.client":[[26,1,1,"","AuthenticatedClient"],[27,1,1,"","AuthenticatedClientFromEnv"],[28,1,1,"","Client"]],"kittycad.client.AuthenticatedClient":[[26,2,1,"","get_headers"]],"kittycad.client.AuthenticatedClientFromEnv":[[27,2,1,"","get_headers"]],"kittycad.client.Client":[[28,2,1,"","get_cookies"],[28,2,1,"","get_headers"],[28,2,1,"","get_timeout"],[28,2,1,"","with_cookies"],[28,2,1,"","with_headers"],[28,2,1,"","with_timeout"]],"kittycad.models":[[29,1,1,"","AuthSession"],[30,1,1,"","Environment"],[31,1,1,"","ErrorMessage"],[32,1,1,"","FileConversion"],[33,1,1,"","FileConversionStatus"],[34,1,1,"","InstanceMetadata"],[35,1,1,"","Message"]],"kittycad.models.AuthSession":[[29,4,1,"","additional_keys"],[29,2,1,"","from_dict"],[29,2,1,"","to_dict"]],"kittycad.models.Environment":[[30,4,1,"","DEVELOPMENT"],[30,4,1,"","PREVIEW"],[30,4,1,"","PRODUCTION"]],"kittycad.models.ErrorMessage":[[31,4,1,"","additional_keys"],[31,2,1,"","from_dict"],[31,2,1,"","to_dict"]],"kittycad.models.FileConversion":[[32,4,1,"","additional_keys"],[32,2,1,"","from_dict"],[32,2,1,"","to_dict"]],"kittycad.models.FileConversionStatus":[[33,4,1,"","COMPLETED"],[33,4,1,"","FAILED"],[33,4,1,"","IN_PROGRESS"],[33,4,1,"","QUEUED"],[33,4,1,"","UPLOADED"]],"kittycad.models.InstanceMetadata":[[34,4,1,"","additional_keys"],[34,2,1,"","from_dict"],[34,2,1,"","to_dict"]],"kittycad.models.Message":[[35,4,1,"","additional_keys"],[35,2,1,"","from_dict"],[35,2,1,"","to_dict"]],"kittycad.models.auth_session":[[37,1,1,"","AuthSession"]],"kittycad.models.auth_session.AuthSession":[[37,4,1,"","additional_keys"],[37,2,1,"","from_dict"],[37,2,1,"","to_dict"]],"kittycad.models.environment":[[38,1,1,"","Environment"]],"kittycad.models.environment.Environment":[[38,4,1,"","DEVELOPMENT"],[38,4,1,"","PREVIEW"],[38,4,1,"","PRODUCTION"]],"kittycad.models.error_message":[[39,1,1,"","ErrorMessage"]],"kittycad.models.error_message.ErrorMessage":[[39,4,1,"","additional_keys"],[39,2,1,"","from_dict"],[39,2,1,"","to_dict"]],"kittycad.models.file_conversion":[[40,1,1,"","FileConversion"],[41,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion.FileConversion":[[40,4,1,"","additional_keys"],[40,2,1,"","from_dict"],[40,2,1,"","to_dict"]],"kittycad.models.file_conversion.FileConversionStatus":[[41,4,1,"","COMPLETED"],[41,4,1,"","FAILED"],[41,4,1,"","IN_PROGRESS"],[41,4,1,"","QUEUED"],[41,4,1,"","UPLOADED"]],"kittycad.models.file_conversion_status":[[42,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion_status.FileConversionStatus":[[42,4,1,"","COMPLETED"],[42,4,1,"","FAILED"],[42,4,1,"","IN_PROGRESS"],[42,4,1,"","QUEUED"],[42,4,1,"","UPLOADED"]],"kittycad.models.instance_metadata":[[43,1,1,"","InstanceMetadata"]],"kittycad.models.instance_metadata.InstanceMetadata":[[43,4,1,"","additional_keys"],[43,2,1,"","from_dict"],[43,2,1,"","to_dict"]],"kittycad.models.message":[[44,1,1,"","Message"]],"kittycad.models.message.Message":[[44,4,1,"","additional_keys"],[44,2,1,"","from_dict"],[44,2,1,"","to_dict"]],"kittycad.types":[[46,1,1,"","File"],[47,1,1,"","Response"]],"kittycad.types.File":[[46,2,1,"","to_tuple"]],kittycad:[[0,1,1,"","AuthenticatedClient"],[1,1,1,"","Client"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function","4":"py:attribute"},terms:{"0":[0,1,26,27,28],"50":[0,1,26,27,28],"class":[0,1,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,46,47],"enum":[30,33,38,41,42],"float":[1,28],"function":[6,7,12,13],"new":[1,28],"return":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,34,35,37,39,40,43,44,46],"true":[0,1,26,27,28],A:[0,1,26,27,28,47,48],If:[8,10,12,13],In:[33,41,42],about:[14,16,18,20],accept:46,access:48,addit:[1,28],additional_kei:[29,31,32,34,35,37,39,40,43,44],all:[1,28],an:[30,33,38,41,42,47],ani:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,29,31,32,34,35,37,39,40,43,44],anoth:[8,10,12,13],api:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],async:[2,3,6,8,9,12,14,15,18,19,22,23],asynchron:[8,10,12,13],attribut:[29,30,31,32,33,34,35,37,38,39,40,41,42,43,44],auth_sess:37,authent:[0,26,27],authsess:[18,19,20,21],automat:[6,7,12,13],base64:[6,7,12,13],base:[0,1,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,46,47],base_url:[0,1,26,27,28],been:[0,26,27],being:[8,10,12,13],binaryio:46,bodi:[12,13],cad:[8,10,12,13],certain:[8,10,12,13],classmethod:[29,31,32,34,35,37,39,40,43,44],client:[0,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,48],complet:[33,41,42],completed_at:[32,40],contain:46,content:[8,9,10,11,12,13,47],convers:[2,4,6,7],convert:[8,10,12,13],cooki:[0,1,26,27,28],cpu_platform:[34,43],created_at:[29,32,37,40],data:[1,28,46],debug:[14,16,18,20],decod:[6,7,12,13],descript:[34,43],develop:[30,38],dict:[0,1,26,27,28,29,31,32,34,35,37,39,40,43,44],document:[0,1,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,46],email:[29,37],encod:[12,13],endpoint:[0,1,26,27,28,47],enumer:[30,33,38,41,42],environ:[27,34,43],error_messag:39,fail:[33,41,42],fals:[29,37],file:[2,3,4,5,6,7,8,9,10,11,12,13],file_convers:[40,41],file_conversion_by_id:[2,3,4,5],file_conversion_by_id_with_base64_help:[6,7],file_conversion_statu:42,file_convert:[8,9,10,11],file_convert_with_base64_help:[12,13],file_nam:46,fileconvers:[2,3,4,5,6,7,8,9,10,11,12,13],form:46,format:[8,10,12,13],from:[8,10,12,13,47],from_dict:[29,31,32,34,35,37,39,40,43,44],gener:47,get:[0,1,2,4,6,7,14,16,18,20,26,27,28],get_cooki:[1,28],get_head:[0,1,26,27,28],get_timeout:[1,28],git_hash:[34,43],ha:[0,26,27],header:[0,1,26,27,28,47],hostnam:[34,43],http:[0,1,26,27,28],httpx:46,id:[2,3,4,5,6,7,29,32,34,37,40,43],imag:[34,43],in_progress:[33,41,42],index:48,inform:[14,16,18,20,46],instanc:[14,16],instance_metadata:43,instancemetadata:[14,15,16,17],io:[0,1,26,27,28],ip_address:[29,34,37,43],is_valid:[29,37],keep:[1,28],kittycad:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,46,47],kittycad_api_token:27,larger:[8,10,12,13],librari:48,list:[29,31,32,34,35,37,39,40,43,44],machine_typ:[34,43],match:[1,28],messag:[22,23,24,25,31,39],meta:[14,15,16,17,18,19,20,21,22,23,24,25],meta_debug_inst:[14,15,16,17],meta_debug_sess:[18,19,20,21],method:[0,1,26,27,28,29,31,32,34,35,37,39,40,43,44,46],mime_typ:46,model:[29,30,31,32,33,34,35,37,38,39,40,41,42,43,44],modul:48,multipart:46,name:[34,43],none:[2,4,6,7,8,10,12,13,14,16,18,20,22,24,27,46],noth:[0,1,26,27,28],object:[1,28,29,31,32,34,35,37,39,40,43,44,46],one:[1,6,7,8,10,12,13,28],option:[22,24,46],output:[6,7,12,13,32,40],output_format:[8,9,10,11,12,13,32,40],page:48,pars:47,payload:46,perform:[8,10,12,13],ping:[22,23,24,25],preview:[30,38],primarili:[14,16,18,20],product:[30,38],progress:[33,41,42],queu:[33,41,42],relat:[1,28],represent:46,request:[12,13,18,20],respons:[3,5,6,7,9,11,15,17,19,21,23,25],search:48,second:[1,28],secur:[0,26,27],server:[14,16,22,24],session:[18,20],simpl:[22,24],size:[8,10,12,13],sourc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,46,47],source_format:[8,9,10,11,12,13],specif:[14,16],src_dict:[29,31,32,34,35,37,39,40,43,44],src_format:[32,40],statu:[2,4,6,7,32,40],status_cod:47,str:[0,1,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,46],summari:[0,1,26,27,28,29,30,31,32,33,34,35,37,38,39,40,41,42,43,44,46],t:[29,31,32,34,35,37,39,40,43,44,47],textio:46,than:[8,10,12,13],thi:[1,6,7,12,13,14,16,18,20,28],timeout:[0,1,26,27,28],to_dict:[29,31,32,34,35,37,39,40,43,44],to_tupl:46,token:[0,26,27,29,37],track:[1,28],tupl:46,type:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,31,32,34,35,37,39,40,43,44,46,47],union:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,46],unset:[29,31,32,34,35,37,39,40,43,44],upload:[33,41,42,46],us:[0,1,14,16,18,20,26,27,28],user_id:[29,37],valu:[30,33,38,41,42],variabl:27,verify_ssl:[0,1,26,27,28],which:[0,26,27],with_cooki:[1,28],with_head:[1,28],with_timeout:[1,28],your:[18,20],zone:[34,43]},titles:["AuthenticatedClient","Client","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","sync","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","sync","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","AuthenticatedClient","AuthenticatedClientFromEnv","Client","AuthSession","Environment","ErrorMessage","FileConversion","FileConversionStatus","InstanceMetadata","Message","ValidFileTypes","AuthSession","Environment","ErrorMessage","FileConversion","FileConversionStatus","FileConversionStatus","InstanceMetadata","Message","ValidFileTypes","File","Response","Welcome to kittycad\u2019s documentation!"],titleterms:{"class":48,asyncio:[2,6,8,12,14,18,22],asyncio_detail:[3,9,15,19,23],authenticatedcli:[0,26],authenticatedclientfromenv:27,authsess:[29,37],client:[1,28],document:48,environ:[30,38],errormessag:[31,39],file:46,fileconvers:[32,40],fileconversionstatu:[33,41,42],indic:48,instancemetadata:[34,43],kittycad:48,messag:[35,44],packag:48,respons:47,s:48,sync:[4,7,10,13,16,20,24],sync_detail:[5,11,17,21,25],tabl:48,validfiletyp:[36,45],welcom:48}})