Struct kittycad::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Entrypoint for interacting with the API client.

Implementations§

source §

impl Client

source

pub fn new_from_reqwest<T>( token: T, builder_http: ClientBuilder, builder_websocket: ClientBuilder ) -> Selfwhere T: ToString + Debug,

Create a new Client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key your requests will work. Also takes reqwest client builders, for customizing the client’s behaviour.

source

pub fn new<T>(token: T) -> Selfwhere T: ToString + Debug,

Create a new Client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key your requests will work.

source

pub fn set_base_url<H>(&mut self, base_url: H)where H: Into<String> + Display + Debug,

Set the base URL for the client to something other than the default: https://api.kittycad.io.

source

pub fn new_from_env() -> Self

Create a new Client struct from the environment variable: KITTYCAD_API_TOKEN.

source

pub async fn request_raw( &self, method: Method, uri: &str, body: Option<Body> ) -> Result<RequestBuilder>

Create a raw request to our API.

source

pub fn ai(&self) -> Ai

AI uses machine learning to generate 3D meshes.

FROM: https://docs.kittycad.io/api/ai

source

pub fn api_calls(&self) -> ApiCalls

API calls that have been performed by users can be queried by the API. This is helpful for debugging as well as billing.

FROM: https://docs.kittycad.io/api/api-calls

source

pub fn api_tokens(&self) -> ApiTokens

API tokens allow users to call the API outside of their session token that is used as a cookie in the user interface. Users can create, delete, and list their API tokens. But, of course, you need an API token to do this, so first be sure to generate one in the account UI.

FROM: https://docs.kittycad.io/api/api-tokens

source

pub fn apps(&self) -> Apps

Endpoints for third party app grant flows.

FROM: https://docs.kittycad.io/api/apps

source

pub fn executor(&self) -> Executor

Endpoints that allow for code execution or creation of code execution environments.

FROM: https://docs.kittycad.io/api/executor

source

pub fn file(&self) -> File

CAD file operations. Create, get, and list CAD file conversions. More endpoints will be added here in the future as we build out transforms, etc on CAD models.

FROM: https://docs.kittycad.io/api/file

source

pub fn hidden(&self) -> Hidden

Hidden API endpoints that should not show up in the docs.

FROM: https://docs.kittycad.io/api/hidden

source

pub fn meta(&self) -> Meta

Meta information about the API.

FROM: https://docs.kittycad.io/api/meta

source

pub fn modeling(&self) -> Modeling

Modeling API for updating your 3D files using the KittyCAD engine.

FROM: https://docs.kittycad.io/api/modeling

source

pub fn oauth2(&self) -> Oauth2

Endpoints that implement OAuth 2.0 grant flows.

FROM: https://docs.kittycad.io/api/oauth2

source

pub fn payments(&self) -> Payments

Operations around payments and billing.

FROM: https://docs.kittycad.io/api/payments

source

pub fn unit(&self) -> Unit

Unit conversion operations.

FROM: https://docs.kittycad.io/api/file

source

pub fn users(&self) -> Users

A user is someone who uses the KittyCAD API. Here, we can create, delete, and list users. We can also get information about a user. Operations will only be authorized if the user is requesting information about themselves.

FROM: https://docs.kittycad.io/api/users