kittycad.py/docs/html/searchindex.js

Search.setIndex({docnames:["api/kittycad.Client","api/kittycad.ClientFromEnv","index","modules/kittycad.api","modules/kittycad.api.beta","modules/kittycad.api.file","modules/kittycad.api.file.create_file_conversion","modules/kittycad.api.file.create_file_conversion_with_base64_helper","modules/kittycad.api.file.file_conversion_status","modules/kittycad.api.file.file_conversion_status_with_base64_helper","modules/kittycad.api.file.get_file_conversion","modules/kittycad.api.file.get_file_conversion_for_user","modules/kittycad.api.file.list_file_conversions","modules/kittycad.api.file.list_file_conversions_for_user","modules/kittycad.api.file.post_file_conversion","modules/kittycad.api.file.post_file_conversion_with_base64_helper","modules/kittycad.api.internal","modules/kittycad.api.internal.gpu_devices","modules/kittycad.api.internal.stop_async_conversions","modules/kittycad.api.meta","modules/kittycad.api.meta.auth_session","modules/kittycad.api.meta.get_metadata","modules/kittycad.api.meta.instance_metadata","modules/kittycad.api.meta.ping","modules/kittycad.api.sessions","modules/kittycad.api.sessions.get_session_for_user","modules/kittycad.api.users","modules/kittycad.api.users.get_user","modules/kittycad.api.users.get_user_extended","modules/kittycad.api.users.get_user_self","modules/kittycad.api.users.get_user_self_extended","modules/kittycad.api.users.list_users","modules/kittycad.api.users.list_users_extended","modules/kittycad.client","modules/kittycad.models","modules/kittycad.models.api_call_query_group","modules/kittycad.models.api_call_query_group_by","modules/kittycad.models.api_call_with_price","modules/kittycad.models.api_call_with_price_results_page","modules/kittycad.models.api_token","modules/kittycad.models.api_token_results_page","modules/kittycad.models.auth_session","modules/kittycad.models.cluster","modules/kittycad.models.created_at_sort_mode","modules/kittycad.models.duration","modules/kittycad.models.engine_metadata","modules/kittycad.models.error","modules/kittycad.models.error_message","modules/kittycad.models.extended_user","modules/kittycad.models.extended_user_results_page","modules/kittycad.models.file_conversion","modules/kittycad.models.file_conversion_output_format","modules/kittycad.models.file_conversion_results_page","modules/kittycad.models.file_conversion_source_format","modules/kittycad.models.file_conversion_status","modules/kittycad.models.file_conversion_with_output","modules/kittycad.models.file_system_metadata","modules/kittycad.models.gateway","modules/kittycad.models.gpu_device","modules/kittycad.models.http_req_stats","modules/kittycad.models.instance","modules/kittycad.models.jetstream","modules/kittycad.models.jetstream_api_stats","modules/kittycad.models.jetstream_config","modules/kittycad.models.jetstream_stats","modules/kittycad.models.leaf_node","modules/kittycad.models.meta_cluster_info","modules/kittycad.models.metadata","modules/kittycad.models.method","modules/kittycad.models.nats_connection","modules/kittycad.models.pong","modules/kittycad.models.pong_enum","modules/kittycad.models.pong_message","modules/kittycad.models.server_env","modules/kittycad.models.session","modules/kittycad.models.status_code","modules/kittycad.models.user","modules/kittycad.models.user_results_page","modules/kittycad.models.uuid","modules/kittycad.models.valid_output_file_format","modules/kittycad.models.valid_source_file_format","modules/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.Client.rst","api/kittycad.ClientFromEnv.rst","index.rst","modules/kittycad.api.rst","modules/kittycad.api.beta.rst","modules/kittycad.api.file.rst","modules/kittycad.api.file.create_file_conversion.rst","modules/kittycad.api.file.create_file_conversion_with_base64_helper.rst","modules/kittycad.api.file.file_conversion_status.rst","modules/kittycad.api.file.file_conversion_status_with_base64_helper.rst","modules/kittycad.api.file.get_file_conversion.rst","modules/kittycad.api.file.get_file_conversion_for_user.rst","modules/kittycad.api.file.list_file_conversions.rst","modules/kittycad.api.file.list_file_conversions_for_user.rst","modules/kittycad.api.file.post_file_conversion.rst","modules/kittycad.api.file.post_file_conversion_with_base64_helper.rst","modules/kittycad.api.internal.rst","modules/kittycad.api.internal.gpu_devices.rst","modules/kittycad.api.internal.stop_async_conversions.rst","modules/kittycad.api.meta.rst","modules/kittycad.api.meta.auth_session.rst","modules/kittycad.api.meta.get_metadata.rst","modules/kittycad.api.meta.instance_metadata.rst","modules/kittycad.api.meta.ping.rst","modules/kittycad.api.sessions.rst","modules/kittycad.api.sessions.get_session_for_user.rst","modules/kittycad.api.users.rst","modules/kittycad.api.users.get_user.rst","modules/kittycad.api.users.get_user_extended.rst","modules/kittycad.api.users.get_user_self.rst","modules/kittycad.api.users.get_user_self_extended.rst","modules/kittycad.api.users.list_users.rst","modules/kittycad.api.users.list_users_extended.rst","modules/kittycad.client.rst","modules/kittycad.models.rst","modules/kittycad.models.api_call_query_group.rst","modules/kittycad.models.api_call_query_group_by.rst","modules/kittycad.models.api_call_with_price.rst","modules/kittycad.models.api_call_with_price_results_page.rst","modules/kittycad.models.api_token.rst","modules/kittycad.models.api_token_results_page.rst","modules/kittycad.models.auth_session.rst","modules/kittycad.models.cluster.rst","modules/kittycad.models.created_at_sort_mode.rst","modules/kittycad.models.duration.rst","modules/kittycad.models.engine_metadata.rst","modules/kittycad.models.error.rst","modules/kittycad.models.error_message.rst","modules/kittycad.models.extended_user.rst","modules/kittycad.models.extended_user_results_page.rst","modules/kittycad.models.file_conversion.rst","modules/kittycad.models.file_conversion_output_format.rst","modules/kittycad.models.file_conversion_results_page.rst","modules/kittycad.models.file_conversion_source_format.rst","modules/kittycad.models.file_conversion_status.rst","modules/kittycad.models.file_conversion_with_output.rst","modules/kittycad.models.file_system_metadata.rst","modules/kittycad.models.gateway.rst","modules/kittycad.models.gpu_device.rst","modules/kittycad.models.http_req_stats.rst","modules/kittycad.models.instance.rst","modules/kittycad.models.jetstream.rst","modules/kittycad.models.jetstream_api_stats.rst","modules/kittycad.models.jetstream_config.rst","modules/kittycad.models.jetstream_stats.rst","modules/kittycad.models.leaf_node.rst","modules/kittycad.models.meta_cluster_info.rst","modules/kittycad.models.metadata.rst","modules/kittycad.models.method.rst","modules/kittycad.models.nats_connection.rst","modules/kittycad.models.pong.rst","modules/kittycad.models.pong_enum.rst","modules/kittycad.models.pong_message.rst","modules/kittycad.models.server_env.rst","modules/kittycad.models.session.rst","modules/kittycad.models.status_code.rst","modules/kittycad.models.user.rst","modules/kittycad.models.user_results_page.rst","modules/kittycad.models.uuid.rst","modules/kittycad.models.valid_output_file_format.rst","modules/kittycad.models.valid_source_file_format.rst","modules/kittycad.types.rst"],objects:{"":[[2,0,0,"-","kittycad"]],"kittycad.Client":[[0,2,1,"","get_cookies"],[0,2,1,"","get_headers"],[0,2,1,"","get_timeout"],[0,2,1,"","with_cookies"],[0,2,1,"","with_headers"],[0,2,1,"","with_timeout"]],"kittycad.ClientFromEnv":[[1,2,1,"","get_headers"]],"kittycad.api":[[5,0,0,"-","file"],[19,0,0,"-","meta"],[24,0,0,"-","sessions"],[26,0,0,"-","users"]],"kittycad.api.file":[[6,0,0,"-","create_file_conversion"],[7,0,0,"-","create_file_conversion_with_base64_helper"],[10,0,0,"-","get_file_conversion"],[11,0,0,"-","get_file_conversion_for_user"],[12,0,0,"-","list_file_conversions"],[13,0,0,"-","list_file_conversions_for_user"]],"kittycad.api.meta":[[21,0,0,"-","get_metadata"],[23,0,0,"-","ping"]],"kittycad.api.sessions":[[25,0,0,"-","get_session_for_user"]],"kittycad.api.users":[[27,0,0,"-","get_user"],[28,0,0,"-","get_user_extended"],[29,0,0,"-","get_user_self"],[30,0,0,"-","get_user_self_extended"],[31,0,0,"-","list_users"],[32,0,0,"-","list_users_extended"]],"kittycad.models":[[35,0,0,"-","api_call_query_group"],[36,0,0,"-","api_call_query_group_by"],[37,0,0,"-","api_call_with_price"],[38,0,0,"-","api_call_with_price_results_page"],[39,0,0,"-","api_token"],[40,0,0,"-","api_token_results_page"],[42,0,0,"-","cluster"],[43,0,0,"-","created_at_sort_mode"],[44,0,0,"-","duration"],[45,0,0,"-","engine_metadata"],[46,0,0,"-","error"],[48,0,0,"-","extended_user"],[49,0,0,"-","extended_user_results_page"],[50,0,0,"-","file_conversion"],[51,0,0,"-","file_conversion_output_format"],[52,0,0,"-","file_conversion_results_page"],[53,0,0,"-","file_conversion_source_format"],[54,0,0,"-","file_conversion_status"],[55,0,0,"-","file_conversion_with_output"],[56,0,0,"-","file_system_metadata"],[57,0,0,"-","gateway"],[59,0,0,"-","http_req_stats"],[61,0,0,"-","jetstream"],[62,0,0,"-","jetstream_api_stats"],[63,0,0,"-","jetstream_config"],[64,0,0,"-","jetstream_stats"],[65,0,0,"-","leaf_node"],[66,0,0,"-","meta_cluster_info"],[67,0,0,"-","metadata"],[68,0,0,"-","method"],[69,0,0,"-","nats_connection"],[70,0,0,"-","pong"],[74,0,0,"-","session"],[75,0,0,"-","status_code"],[76,0,0,"-","user"],[77,0,0,"-","user_results_page"],[78,0,0,"-","uuid"]],kittycad:[[0,1,1,"","Client"],[1,1,1,"","ClientFromEnv"],[3,0,0,"-","api"],[33,0,0,"-","client"],[34,0,0,"-","models"],[81,0,0,"-","types"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},terms:{"0":[0,1],"50":[0,1],"class":[0,1,33,35,36,37,38,39,40,42,43,44,45,46,48,49,50,51,52,53,54,55,56,57,59,61,62,63,64,65,66,67,68,69,70,74,75,76,77,78,81],"float":0,"function":[6,7,10,11,12,13,21,23,25,27,28,29,30,31,32],"new":0,"return":[0,1],"true":[0,1],A:[0,1,2,26],about:[19,26],access:[2,3,5,19,24,26],ad:5,addit:0,all:[0,34],allow:24,also:26,api:[0,1],authent:[0,1],author:26,base:[0,1],base_url:[0,1],been:[0,1],browser:24,build:5,cad:5,call:24,can:26,client:[1,2],contain:[3,5,19,24,26,34,81],convers:5,cooki:[0,1,24],creat:[5,26],data:34,delet:26,dict:[0,1],document:[0,1],endpoint:[0,1,5],environ:1,etc:5,from:24,futur:5,get:[0,1,5,26],get_cooki:0,get_head:[0,1],get_timeout:0,ha:[0,1],header:[0,1],here:[5,26],http:[0,1],index:2,inform:[19,26],input:34,io:[0,1],kittycad:[0,1],kittycad_api_token:1,librari:2,list:[5,26],match:0,method:[0,1,3,5,19,24,26],model:5,modul:[2,3,5,16,19,24,26,34],more:5,none:1,noth:[0,1],object:0,one:0,onli:26,oper:[5,26],out:5,output:34,page:2,path:[5,19,24,26],properti:81,request:26,search:2,second:0,secur:[0,1],share:81,some:81,someon:26,sourc:[0,1],str:[0,1],summari:[0,1],themselv:26,thi:0,timeout:[0,1],token:[0,1],transform:5,type:[0,1],us:[0,1,26,34],user:24,variabl:1,verify_ssl:[0,1],we:[5,26],which:[0,1],who:26,with_cooki:0,with_head:0,with_timeout:0},titles:["Client","ClientFromEnv","Welcome to kittycad\u2019s documentation!","kittycad.api","kittycad.api.beta","kittycad.api.file","kittycad.api.file.create_file_conversion","kittycad.api.file.create_file_conversion_with_base64_helper","kittycad.api.file.file_conversion_status","kittycad.api.file.file_conversion_status_with_base64_helper","kittycad.api.file.get_file_conversion","kittycad.api.file.get_file_conversion_for_user","kittycad.api.file.list_file_conversions","kittycad.api.file.list_file_conversions_for_user","kittycad.api.file.post_file_conversion","kittycad.api.file.post_file_conversion_with_base64_helper","kittycad.api.internal","kittycad.api.internal.gpu_devices","kittycad.api.internal.stop_async_conversions","kittycad.api.meta","kittycad.api.meta.auth_session","kittycad.api.meta.get_metadata","kittycad.api.meta.instance_metadata","kittycad.api.meta.ping","kittycad.api.sessions","kittycad.api.sessions.get_session_for_user","kittycad.api.users","kittycad.api.users.get_user","kittycad.api.users.get_user_extended","kittycad.api.users.get_user_self","kittycad.api.users.get_user_self_extended","kittycad.api.users.list_users","kittycad.api.users.list_users_extended","kittycad.client","kittycad.models","kittycad.models.api_call_query_group","kittycad.models.api_call_query_group_by","kittycad.models.api_call_with_price","kittycad.models.api_call_with_price_results_page","kittycad.models.api_token","kittycad.models.api_token_results_page","kittycad.models.auth_session","kittycad.models.cluster","kittycad.models.created_at_sort_mode","kittycad.models.duration","kittycad.models.engine_metadata","kittycad.models.error","kittycad.models.error_message","kittycad.models.extended_user","kittycad.models.extended_user_results_page","kittycad.models.file_conversion","kittycad.models.file_conversion_output_format","kittycad.models.file_conversion_results_page","kittycad.models.file_conversion_source_format","kittycad.models.file_conversion_status","kittycad.models.file_conversion_with_output","kittycad.models.file_system_metadata","kittycad.models.gateway","kittycad.models.gpu_device","kittycad.models.http_req_stats","kittycad.models.instance","kittycad.models.jetstream","kittycad.models.jetstream_api_stats","kittycad.models.jetstream_config","kittycad.models.jetstream_stats","kittycad.models.leaf_node","kittycad.models.meta_cluster_info","kittycad.models.metadata","kittycad.models.method","kittycad.models.nats_connection","kittycad.models.pong","kittycad.models.pong_enum","kittycad.models.pong_message","kittycad.models.server_env","kittycad.models.session","kittycad.models.status_code","kittycad.models.user","kittycad.models.user_results_page","kittycad.models.uuid","kittycad.models.valid_output_file_format","kittycad.models.valid_source_file_format","kittycad.types"],titleterms:{"class":2,api:[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],api_call_query_group:35,api_call_query_group_bi:36,api_call_with_pric:37,api_call_with_price_results_pag:38,api_token:39,api_token_results_pag:40,auth_sess:[20,41],beta:4,client:[0,33],clientfromenv:1,cluster:42,create_file_convers:6,create_file_conversion_with_base64_help:7,created_at_sort_mod:43,document:2,durat:44,engine_metadata:45,error:46,error_messag:47,extended_us:48,extended_user_results_pag:49,file:[5,6,7,8,9,10,11,12,13,14,15],file_convers:50,file_conversion_output_format:51,file_conversion_results_pag:52,file_conversion_source_format:53,file_conversion_statu:[8,54],file_conversion_status_with_base64_help:9,file_conversion_with_output:55,file_system_metadata:56,gatewai:57,get_file_convers:10,get_file_conversion_for_us:11,get_metadata:21,get_session_for_us:25,get_us:27,get_user_extend:28,get_user_self:29,get_user_self_extend:30,gpu_devic:[17,58],http_req_stat:59,indic:2,instanc:60,instance_metadata:22,intern:[16,17,18],jetstream:61,jetstream_api_stat:62,jetstream_config:63,jetstream_stat:64,kittycad:[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,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81],leaf_nod:65,list_file_convers:12,list_file_conversions_for_us:13,list_us:31,list_users_extend:32,meta:[19,20,21,22,23],meta_cluster_info:66,metadata:67,method:68,model:[34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80],nats_connect:69,packag:2,ping:23,pong:70,pong_enum:71,pong_messag:72,post_file_convers:14,post_file_conversion_with_base64_help:15,s:2,server_env:73,session:[24,25,74],status_cod:75,stop_async_convers:18,tabl:2,type:81,user:[26,27,28,29,30,31,32,76],user_results_pag:77,uuid:78,valid_output_file_format:79,valid_source_file_format:80,welcom:2}})