kittycad.py/docs/html/searchindex.js

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_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.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.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","kittycad.api","kittycad.api.file.file_conversion_by_id","kittycad.api.file.file_convert","kittycad.api.meta","kittycad.api.meta.meta_debug_instance","kittycad.api.meta.meta_debug_session","kittycad.api.meta.ping","kittycad.client","kittycad.models","kittycad.models.auth_session","kittycad.models.environment","kittycad.models.error_message","kittycad.models.file_conversion","kittycad.models.file_conversion_status","kittycad.models.instance_metadata","kittycad.models.message","kittycad.models.valid_file_types","kittycad.types"],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_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.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.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","kittycad.api.rst","kittycad.api.file.file_conversion_by_id.rst","kittycad.api.file.file_convert.rst","kittycad.api.meta.rst","kittycad.api.meta.meta_debug_instance.rst","kittycad.api.meta.meta_debug_session.rst","kittycad.api.meta.ping.rst","kittycad.client.rst","kittycad.models.rst","kittycad.models.auth_session.rst","kittycad.models.environment.rst","kittycad.models.error_message.rst","kittycad.models.file_conversion.rst","kittycad.models.file_conversion_status.rst","kittycad.models.instance_metadata.rst","kittycad.models.message.rst","kittycad.models.valid_file_types.rst","kittycad.types.rst"],objects:{"":[[43,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":[[47,0,0,"-","meta"]],"kittycad.api.file":[[45,0,0,"-","file_conversion_by_id"],[46,0,0,"-","file_convert"]],"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_convert":[[6,3,1,"","asyncio"],[7,3,1,"","asyncio_detailed"],[8,3,1,"","sync"],[9,3,1,"","sync_detailed"]],"kittycad.api.meta":[[48,0,0,"-","meta_debug_instance"],[49,0,0,"-","meta_debug_session"],[50,0,0,"-","ping"]],"kittycad.api.meta.meta_debug_instance":[[10,3,1,"","asyncio"],[11,3,1,"","asyncio_detailed"],[12,3,1,"","sync"],[13,3,1,"","sync_detailed"]],"kittycad.api.meta.meta_debug_session":[[14,3,1,"","asyncio"],[15,3,1,"","asyncio_detailed"],[16,3,1,"","sync"],[17,3,1,"","sync_detailed"]],"kittycad.api.meta.ping":[[18,3,1,"","asyncio"],[19,3,1,"","asyncio_detailed"],[20,3,1,"","sync"],[21,3,1,"","sync_detailed"]],"kittycad.client":[[22,1,1,"","AuthenticatedClient"],[23,1,1,"","Client"]],"kittycad.client.AuthenticatedClient":[[22,2,1,"","get_headers"]],"kittycad.client.Client":[[23,2,1,"","get_cookies"],[23,2,1,"","get_headers"],[23,2,1,"","get_timeout"],[23,2,1,"","with_cookies"],[23,2,1,"","with_headers"],[23,2,1,"","with_timeout"]],"kittycad.models":[[24,1,1,"","AuthSession"],[25,1,1,"","Environment"],[26,1,1,"","ErrorMessage"],[27,1,1,"","FileConversion"],[28,1,1,"","FileConversionStatus"],[29,1,1,"","InstanceMetadata"],[30,1,1,"","Message"],[31,1,1,"","ValidFileTypes"],[53,0,0,"-","auth_session"],[54,0,0,"-","environment"],[55,0,0,"-","error_message"],[56,0,0,"-","file_conversion"],[57,0,0,"-","file_conversion_status"],[58,0,0,"-","instance_metadata"],[59,0,0,"-","message"],[60,0,0,"-","valid_file_types"]],"kittycad.models.AuthSession":[[24,4,1,"","additional_keys"],[24,2,1,"","from_dict"],[24,2,1,"","to_dict"]],"kittycad.models.Environment":[[25,4,1,"","DEVELOPMENT"],[25,4,1,"","PREVIEW"],[25,4,1,"","PRODUCTION"]],"kittycad.models.ErrorMessage":[[26,4,1,"","additional_keys"],[26,2,1,"","from_dict"],[26,2,1,"","to_dict"]],"kittycad.models.FileConversion":[[27,4,1,"","additional_keys"],[27,2,1,"","from_dict"],[27,2,1,"","to_dict"]],"kittycad.models.FileConversionStatus":[[28,4,1,"","COMPLETED"],[28,4,1,"","FAILED"],[28,4,1,"","IN_PROGRESS"],[28,4,1,"","QUEUED"],[28,4,1,"","UPLOADED"]],"kittycad.models.InstanceMetadata":[[29,4,1,"","additional_keys"],[29,2,1,"","from_dict"],[29,2,1,"","to_dict"]],"kittycad.models.Message":[[30,4,1,"","additional_keys"],[30,2,1,"","from_dict"],[30,2,1,"","to_dict"]],"kittycad.models.ValidFileTypes":[[31,4,1,"","DWG"],[31,4,1,"","DXF"],[31,4,1,"","OBJ"],[31,4,1,"","STEP"],[31,4,1,"","STL"]],"kittycad.models.auth_session":[[32,1,1,"","AuthSession"]],"kittycad.models.auth_session.AuthSession":[[32,4,1,"","additional_keys"],[32,2,1,"","from_dict"],[32,2,1,"","to_dict"]],"kittycad.models.environment":[[33,1,1,"","Environment"]],"kittycad.models.environment.Environment":[[33,4,1,"","DEVELOPMENT"],[33,4,1,"","PREVIEW"],[33,4,1,"","PRODUCTION"]],"kittycad.models.error_message":[[34,1,1,"","ErrorMessage"]],"kittycad.models.error_message.ErrorMessage":[[34,4,1,"","additional_keys"],[34,2,1,"","from_dict"],[34,2,1,"","to_dict"]],"kittycad.models.file_conversion":[[35,1,1,"","FileConversion"],[36,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion.FileConversion":[[35,4,1,"","additional_keys"],[35,2,1,"","from_dict"],[35,2,1,"","to_dict"]],"kittycad.models.file_conversion.FileConversionStatus":[[36,4,1,"","COMPLETED"],[36,4,1,"","FAILED"],[36,4,1,"","IN_PROGRESS"],[36,4,1,"","QUEUED"],[36,4,1,"","UPLOADED"]],"kittycad.models.file_conversion_status":[[37,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion_status.FileConversionStatus":[[37,4,1,"","COMPLETED"],[37,4,1,"","FAILED"],[37,4,1,"","IN_PROGRESS"],[37,4,1,"","QUEUED"],[37,4,1,"","UPLOADED"]],"kittycad.models.instance_metadata":[[38,1,1,"","InstanceMetadata"]],"kittycad.models.instance_metadata.InstanceMetadata":[[38,4,1,"","additional_keys"],[38,2,1,"","from_dict"],[38,2,1,"","to_dict"]],"kittycad.models.message":[[39,1,1,"","Message"]],"kittycad.models.message.Message":[[39,4,1,"","additional_keys"],[39,2,1,"","from_dict"],[39,2,1,"","to_dict"]],"kittycad.models.valid_file_types":[[40,1,1,"","ValidFileTypes"]],"kittycad.models.valid_file_types.ValidFileTypes":[[40,4,1,"","DWG"],[40,4,1,"","DXF"],[40,4,1,"","OBJ"],[40,4,1,"","STEP"],[40,4,1,"","STL"]],"kittycad.types":[[41,1,1,"","File"],[42,1,1,"","Response"]],"kittycad.types.File":[[41,2,1,"","to_tuple"]],kittycad:[[0,1,1,"","AuthenticatedClient"],[1,1,1,"","Client"],[44,0,0,"-","api"],[51,0,0,"-","client"],[52,0,0,"-","models"],[61,0,0,"-","types"]]},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,22,23],"5":[0,1,22,23],"class":[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],"enum":[25,28,31,33,36,37,40],"float":[1,23],"function":47,"new":[1,23],"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,26,27,29,30,32,34,35,38,39,41],"true":[0,1,22,23],A:[0,1,22,23,42,43],If:[6,8],In:[28,36,37],about:[10,12,14,16],accept:41,access:[43,44],addit:[1,23],additional_kei:[24,26,27,29,30,32,34,35,38,39],all:[1,23,52],an:[25,28,31,33,36,37,40,42],ani:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,24,26,27,29,30,32,34,35,38,39],anoth:[6,8],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,43],async:[2,3,6,7,10,11,14,15,18,19],asynchron:[6,8],attribut:[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],auth_sess:[32,43,52],authent:[0,22],authenticatedcli:[],authsess:[14,15,16,17,43],base:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],base_url:[0,1,22,23],been:[0,22],being:[6,8],binaryio:41,cad:[6,8],certain:[6,8],classmethod:[24,26,27,29,30,32,34,35,38,39],client:[0,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,43],complet:[28,36,37],completed_at:[27,35],contain:[41,44,52,61],content:[8,9,42],convers:[2,4],convert:[6,8],cooki:[0,1,22,23],cpu_platform:[29,38],created_at:[24,27,32,35],data:[1,23,41,52],debug:[10,12,14,16],descript:[29,38],develop:[25,33],dict:[0,1,22,23,24,26,27,29,30,32,34,35,38,39],document:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],dwg:[31,40],dxf:[31,40],email:[24,32],endpoint:[0,1,22,23,42],enumer:[25,28,31,33,36,37,40],environ:[29,38,43,52],error_messag:[34,43,52],errormessag:43,fail:[28,36,37],fals:[24,32],file:[2,3,4,5,6,7,8,9],file_convers:[35,36,43,52],file_conversion_by_id:[2,3,4,5],file_conversion_statu:[37,43,52],file_convert:[6,7,8,9],file_nam:41,fileconvers:[2,3,4,5,6,7,8,9,43],fileconversionstatu:43,form:41,format:[6,8],from:[6,8,42],from_dict:[24,26,27,29,30,32,34,35,38,39],gener:42,get:[0,1,2,4,10,12,14,16,22,23],get_cooki:[1,23],get_head:[0,1,22,23],get_timeout:[1,23],git_hash:[29,38],ha:[0,22],header:[0,1,22,23,42],hostnam:[29,38],http:[0,1,22,23],httpx:41,id:[2,3,4,5,24,27,29,32,35,38],imag:[29,38],in_progress:[28,36,37],index:43,inform:[10,12,14,16,41],input:52,instanc:[10,12],instance_metadata:[38,43,52],instancemetadata:[10,11,12,13,43],io:[0,1,22,23],ip_address:[24,29,32,38],is_valid:[24,32],keep:[1,23],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,36,37,38,39,40,41,42],larger:[6,8],librari:43,list:[24,26,27,29,30,32,34,35,38,39],machine_typ:[29,38],match:[1,23],messag:[18,19,20,21,26,34,43,52],meta:[10,11,12,13,14,15,16,17,18,19,20,21,43,44],meta_debug_inst:[10,11,12,13,43,44,47],meta_debug_sess:[14,15,16,17,43,44,47],method:[0,1,22,23,24,26,27,29,30,32,34,35,38,39,41,44],mime_typ:41,model:[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43],modul:[43,44,47,52],multipart:41,name:[29,38],none:[2,4,6,8,10,12,14,16,18,20,41],noth:[0,1,22,23],obj:[31,40],object:[1,23,24,26,27,29,30,32,34,35,38,39,41],one:[1,6,8,23],option:[18,20,41],output:[27,35,52],output_format:[6,7,8,9,27,35],page:43,pars:42,payload:41,perform:[6,8],ping:[18,19,20,21,43,44,47],preview:[25,33],primarili:[10,12,14,16],product:[25,33],progress:[28,36,37],properti:61,queu:[28,36,37],relat:[1,23],represent:41,request:[14,16],respons:[3,5,7,9,11,13,15,17,19,21],search:43,second:[1,23],secur:[0,22],server:[10,12,18,20],session:[14,16],share:61,simpl:[18,20],size:[6,8],some:61,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,36,37,38,39,40,41,42],source_format:[6,7,8,9],specif:[10,12],src_dict:[24,26,27,29,30,32,34,35,38,39],src_format:[27,35],statu:[2,4,27,35],status_cod:42,step:[31,40],stl:[31,40],str:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],summari:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],t:[24,26,27,29,30,32,34,35,38,39,42],textio:41,than:[6,8],thi:[1,10,12,14,16,23],timeout:[0,1,22,23],to_dict:[24,26,27,29,30,32,34,35,38,39],to_tupl:41,token:[0,22,24,32],track:[1,23],tupl:41,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,26,27,29,30,32,34,35,38,39,41,42,43],union:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,41],unset:[24,26,27,29,30,32,34,35,38,39],upload:[28,36,37,41],us:[0,1,10,12,14,16,22,23,52],user_id:[24,32],valid_file_typ:[40,43,52],validfiletyp:43,valu:[25,28,31,33,36,37,40],verify_ssl:[0,1,22,23],which:[0,22],with_cooki:[1,23],with_head:[1,23],with_timeout:[1,23],your:[14,16],zone:[29,38]},titles:["AuthenticatedClient","Client","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","AuthenticatedClient","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!","kittycad.api Package","kittycad.api.file.file_conversion_by_id Module","kittycad.api.file.file_convert Module","kittycad.api.meta Package","kittycad.api.meta.meta_debug_instance Module","kittycad.api.meta.meta_debug_session Module","kittycad.api.meta.ping Module","kittycad.client Module","kittycad.models Package","kittycad.models.auth_session Module","kittycad.models.environment Module","kittycad.models.error_message Module","kittycad.models.file_conversion Module","kittycad.models.file_conversion_status Module","kittycad.models.instance_metadata Module","kittycad.models.message Module","kittycad.models.valid_file_types Module","kittycad.types Module"],titleterms:{"class":[43,51,52,53,54,55,56,57,58,59,60,61],"function":[45,46,48,49,50],api:[44,45,46,47,48,49,50],asyncio:[2,6,10,14,18],asyncio_detail:[3,7,11,15,19],auth_sess:53,authenticatedcli:[0,22],authsess:[24,32],client:[1,23,51],content:[43,44,47,52],diagram:[],document:43,environ:[25,33,54],error_messag:55,errormessag:[26,34],file:[41,45,46],file_convers:56,file_conversion_by_id:45,file_conversion_statu:57,file_convert:46,fileconvers:[27,35],fileconversionstatu:[28,36,37],indic:43,inherit:[],instance_metadata:58,instancemetadata:[29,38],kittycad:[43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61],messag:[30,39,59],meta:[47,48,49,50],meta_debug_inst:48,meta_debug_sess:49,model:[52,53,54,55,56,57,58,59,60],modul:[45,46,48,49,50,51,53,54,55,56,57,58,59,60,61],packag:[43,44,47,52],ping:50,respons:42,s:43,sync:[4,8,12,16,20],sync_detail:[5,9,13,17,21],tabl:43,type:61,valid_file_typ:60,validfiletyp:[31,40],welcom:43}})