Crate kittycad

Expand description

A fully generated & opinionated API client for the KittyCAD API.

API server for KittyCAD

url	email
https://kittycad.io	api@kittycad.io

This client is generated from the OpenAPI specs based on API spec version 0.1.0. This way it will remain up to date as features are added.

The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
kittycad = "0.2.21"

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use kittycad::Client;

let client = Client::new(String::from("api-key"));

Alternatively, the library can search for most of the variables required for the client in the environment:

And then you can create a client from the environment.

use kittycad::Client;

let client = Client::new_from_env();

Modules

ai
AI uses machine learning to generate 3D meshes.
api_calls
API calls that have been performed by users can be queried by the API. This is helpful for debugging as well as billing.
api_tokens
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.
apps
Endpoints for third party app grant flows.
executor
Endpoints that allow for code execution or creation of code execution environments.
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.
hidden
Hidden API endpoints that should not show up in the docs.
meta
Meta information about the API.
modeling
Modeling API for updating your 3D files using the KittyCAD engine.
oauth2
Endpoints that implement OAuth 2.0 grant flows.
payments
Operations around payments and billing.
types
This module contains the generated types for the library.
unit
Unit conversion operations.
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.