KittyCAD: API Reference

API Reference

KittyCAD's API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The root endpoint / returns the OpenAPI specification for the API. It's handy if you want to use it to generate things.

Base url

https://api.kittycad.io

Client libraries

curl

python

rust

typescript

Authentication

KittyCAD's API uses API keys, also referred to as API tokens, to authenticate requests. You can view and manage your API keys in your account on the KittyCAD website.

Authentication to the API is performed via Bearer Token Auth. Provide your API key as the token value. We will automatically add your token to the examples here if you are logged in.

All API requests must be made over HTTPS. API requests without authentication will fail.

Authenticated request

$ curl --header "Authorization: Bearer $TOKEN" \
	"https://api.kittycad.io/_meta/debug/session"

Errors

KittyCAD uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with KittyCAD's servers (these are rare).

HTTP Status Code Summary

400 - Bad Request	The request failed could not authenticate, but the token existed.
401 - Unauthorized	No valid API key provided.
403 - Forbidden	The API key doesn't have permissions to perform the request.
404 - Not Found	The requested resource doesn't exist.
406 - Not Acceptable	The request was unacceptable, often due to missing a required parameter.
500 - Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request.

API Calls

Endpoints

GET/async/operations/{id}

GET/user/api-calls

GET/user/api-calls/{id}

Get an async operation

Parameters

idstringrequired

Returns

200 OK

successful operation

GET/async/operations/{id}

$ curl "https://api.kittycad.io/async/operations/{id}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.281Z",
  "created_at": "2023-09-30T00:38:09.281Z",
  "density": 27,
  "error": "Q8Nk0zpkzgT4vmhq7zpXeK5tuRUJRv",
  "id": "8385ed03-168f-44cc-a78e-d6625ad29168",
  "material_mass": 28,
  "material_mass_unit": "kg",
  "output_unit": "lb:ft3",
  "src_format": "stl",
  "started_at": "2023-09-30T00:38:09.281Z",
  "status": "completed",
  "type": "file_density",
  "updated_at": "2023-09-30T00:38:09.281Z",
  "user_id": "L4fmJprCzAhP6KcKItTncJRjHp5"
}

List API calls for your user

Parameters

limitintegeroptional
page_tokenstringoptional
sort_bystringrequired
Possible values
- created_at_ascending: Sort in increasing order of "created_at".
- created_at_descending: Sort in decreasing order of "created_at".

Returns

200 OK

successful operation

itemsarrayoptional
Array of
- completed_atstringISO-8601optional
- created_atstringISO-8601optional
- durationintegerDurationoptional
- emailstringEmail Addressoptional
- endpointstringoptional
- idstringUUIDoptional
- ip_addressstringIP Addressoptional
- litterboxbooleanoptional
- methodstringoptional
  Possible values
  - OPTIONS: The `OPTIONS` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.2.1).
  - GET: The `GET` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1).
  - POST: The `POST` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1).
  - PUT: The `PUT` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1).
  - DELETE: The `DELETE` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.5).
  - HEAD: The `HEAD` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.2).
  - TRACE: The `TRACE` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3).
  - CONNECT: The `CONNECT` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.6).
  - PATCH: The `PATCH` method as defined in [RFC 5789](https://tools.ietf.org/html/rfc5789).
  - EXTENSION: A catch all.
- minutesintegeroptional
- originstringoptional
- pricenumberUSD Priceoptional
- request_bodystringoptional
- request_query_paramsstringoptional
- response_bodystringoptional
- started_atstringISO-8601optional
- status_codeintegeroptional
- stripe_invoice_item_idstringoptional
- tokenstringUUIDoptional
- updated_atstringISO-8601optional
- user_agentstringoptional
- user_idstringoptional
next_pagestringoptional

GET/user/api-calls

$ curl "https://api.kittycad.io/user/api-calls" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "items": [
    {
      "completed_at": "2023-09-30T00:38:09.289Z",
      "created_at": "2023-09-30T00:38:09.289Z",
      "duration": 26,
      "email": "bHcW@r.com",
      "endpoint": "wpWzbAMMHIDaofBYs0Lug",
      "id": "5676443c-9601-4599-a7d0-72cc077f2ef2",
      "ip_address": "192.0.2.90",
      "litterbox": false,
      "method": "EXTENSION",
      "minutes": 14,
      "origin": "",
      "price": "62.31",
      "request_body": "5WTmiNYNf0Q50gV9",
      "request_query_params": "pewwtzPz8ADTHXokSH",
      "response_body": "22GOakMN",
      "started_at": "2023-09-30T00:38:09.289Z",
      "status_code": 1,
      "stripe_invoice_item_id": "8cNbEPxWXNE",
      "token": "85a6924a-881a-4469-bfad-d512e00be8be",
      "updated_at": "2023-09-30T00:38:09.289Z",
      "user_agent": "D2f",
      "user_id": "AQTWLSLq2AMMgtD"
    }
  ],
  "next_page": "87TRY5Rc"
}

Get an API call for a user

Parameters

idstringrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
durationintegerDurationoptional
emailstringEmail Addressoptional
endpointstringoptional
idstringUUIDoptional
ip_addressstringIP Addressoptional
litterboxbooleanoptional
methodstringoptional
Possible values
- OPTIONS: The `OPTIONS` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.2.1).
- GET: The `GET` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1).
- POST: The `POST` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1).
- PUT: The `PUT` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.1).
- DELETE: The `DELETE` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.5).
- HEAD: The `HEAD` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.2).
- TRACE: The `TRACE` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3).
- CONNECT: The `CONNECT` method as defined in [RFC 7231](https://tools.ietf.org/html/rfc7231#section-4.3.6).
- PATCH: The `PATCH` method as defined in [RFC 5789](https://tools.ietf.org/html/rfc5789).
- EXTENSION: A catch all.
minutesintegeroptional
originstringoptional
pricenumberUSD Priceoptional
request_bodystringoptional
request_query_paramsstringoptional
response_bodystringoptional
started_atstringISO-8601optional
status_codeintegeroptional
stripe_invoice_item_idstringoptional
tokenstringUUIDoptional
updated_atstringISO-8601optional
user_agentstringoptional
user_idstringoptional

GET/user/api-calls/{id}

$ curl "https://api.kittycad.io/user/api-calls/{id}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.301Z",
  "created_at": "2023-09-30T00:38:09.301Z",
  "duration": 22,
  "email": "phAQ@2sWfOE.com",
  "endpoint": "Hmcuw",
  "id": "0b3b472e-e2d6-4651-bc97-791c6a481281",
  "ip_address": "192.0.2.44",
  "litterbox": true,
  "method": "GET",
  "minutes": 30,
  "origin": "JWUFIR6BlpDTugW3c",
  "price": "0.86",
  "request_body": "k",
  "request_query_params": "5qdAGZIQd",
  "response_body": "Vk",
  "started_at": "2023-09-30T00:38:09.301Z",
  "status_code": 4,
  "stripe_invoice_item_id": "j",
  "token": "a0081b0b-ba27-46a1-b1e7-2e8b5aeecc68",
  "updated_at": "2023-09-30T00:38:09.301Z",
  "user_agent": "JwoMY",
  "user_id": "n9WoJgaSfpV6q1h"
}

API Tokens

Endpoints

GET/user/api-tokens

POST/user/api-tokens

DELETE/user/api-tokens/{token}

GET/user/api-tokens/{token}

List API tokens for your user

Parameters

limitintegeroptional
page_tokenstringoptional
sort_bystringrequired
Possible values
- created_at_ascending: Sort in increasing order of "created_at".
- created_at_descending: Sort in decreasing order of "created_at".

Returns

200 OK

successful operation

itemsarrayoptional
Array of
- created_atstringISO-8601optional
- idstringoptional
- is_validbooleanoptional
- tokenstringUUIDoptional
- updated_atstringISO-8601optional
- user_idstringoptional
next_pagestringoptional

GET/user/api-tokens

$ curl "https://api.kittycad.io/user/api-tokens" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "items": [
    {
      "created_at": "2023-09-30T00:38:09.313Z",
      "id": "GcRh3z2i4SrmhrstKdAwyyEkT",
      "is_valid": true,
      "token": "cfeb2d52-3b2f-4ca2-b150-2864c55febc2",
      "updated_at": "2023-09-30T00:38:09.313Z",
      "user_id": "nH4lvhM"
    }
  ],
  "next_page": "fMVHqR"
}

Create a new API token for your user

Parameters

No parameters

Returns

201 Created

successful creation

created_atstringISO-8601optional
idstringoptional
is_validbooleanoptional
tokenstringUUIDoptional
updated_atstringISO-8601optional
user_idstringoptional

POST/user/api-tokens

$ curl -X POST "https://api.kittycad.io/user/api-tokens" \
	--header "Authorization: Bearer $TOKEN"

201 Created

Response

{
  "created_at": "2023-09-30T00:38:09.319Z",
  "id": "CgWGm0xzouRY",
  "is_valid": false,
  "token": "07314fbc-3b06-4f96-926e-6d7aaaf9a3b3",
  "updated_at": "2023-09-30T00:38:09.319Z",
  "user_id": "SdozLalLL8q1mzZN20Si"
}

Delete an API token for your user

Parameters

tokenstringUUIDrequired

Returns

204 No Content

successful deletion

DELETE/user/api-tokens/{token}

$ curl -X DELETE "https://api.kittycad.io/user/api-tokens/{token}" \
	--header "Authorization: Bearer $TOKEN"

Get an API token for your user

Parameters

tokenstringUUIDrequired

Returns

200 OK

successful operation

created_atstringISO-8601optional
idstringoptional
is_validbooleanoptional
tokenstringUUIDoptional
updated_atstringISO-8601optional
user_idstringoptional

GET/user/api-tokens/{token}

$ curl "https://api.kittycad.io/user/api-tokens/{token}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "created_at": "2023-09-30T00:38:09.328Z",
  "id": "NjTNhQP6XZqWHPQCeHNdO8qcKmM4C",
  "is_valid": false,
  "token": "21790fd3-37b3-4fd8-9ceb-3be7f35741d2",
  "updated_at": "2023-09-30T00:38:09.328Z",
  "user_id": "AlZQq912qTVEnayZ"
}

File

Endpoints

POST/file/conversion/{src_format}/{output_format}

POST/file/density

POST/file/mass

Convert CAD file with defaults

Parameters

output_formatstringrequired
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- glb: Binary glTF 2.0. This is a single binary with .glb extension. This is better if you want a compressed format as opposed to the human readable glTF that lacks compression.
- gltf: glTF 2.0. Embedded glTF 2.0 (pretty printed). Single JSON file with .gltf extension binary data encoded as base64 data URIs. The JSON contents are pretty printed. It is human readable, single file, and you can view the diff easily in a git commit.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
src_formatstringrequired
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- gltf: glTF 2.0.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- sldprt: SolidWorks part (SLDPRT) format.
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
bodyapplication/octet-streamstringBINARYoptional

Returns

201 Created

successful creation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
output_formatstringoptional
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- glb: Binary glTF 2.0. This is a single binary with .glb extension. This is better if you want a compressed format as opposed to the human readable glTF that lacks compression.
- gltf: glTF 2.0. Embedded glTF 2.0 (pretty printed). Single JSON file with .gltf extension binary data encoded as base64 data URIs. The JSON contents are pretty printed. It is human readable, single file, and you can view the diff easily in a git commit.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
output_format_optionsoneOfoptional
One of
- output_format_optionsFbxobjectoptional
  Object
  - storagestringoptional
    Possible values
    - ascii: ASCII FBX encoding.
    - binary: Binary FBX encoding.
  - typestringoptional
    Possible values
    - fbx
- output_format_optionsGltfobjectoptional
  Object
  - presentationstringoptional
    Possible values
    - compact: Condense the JSON into the smallest possible size.
    - pretty: Expand the JSON into a more human readable format. This is the default setting.
  - storagestringoptional
    Possible values
    - binary: Binary glTF 2.0. This is a single binary with .glb extension.
    - standard: Standard glTF 2.0. This is a JSON file with .gltf extension paired with a separate binary blob file with .bin extension.
    - embedded: Embedded glTF 2.0. Single JSON file with .gltf extension binary data encoded as base64 data URIs. This is the default setting.
  - typestringoptional
    Possible values
    - gltf
- output_format_optionsObjobjectoptional
  Object
  - coordsobjectoptional
    Object
    - forwardobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - upobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - typestringoptional
    Possible values
    - obj
  - unitsstringoptional
    Possible values
    - cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
    - ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
    - in: Inches <https://en.wikipedia.org/wiki/Inch>
    - m: Meters <https://en.wikipedia.org/wiki/Meter>
    - mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
    - yd: Yards <https://en.wikipedia.org/wiki/Yard>
- output_format_optionsPlyobjectoptional
  Object
  - coordsobjectoptional
    Object
    - forwardobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - upobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - storagestringoptional
    Possible values
    - ascii: Write numbers in their ascii representation (e.g. -13, 6.28, etc.). Properties are separated by spaces and elements are separated by line breaks.
    - binary_little_endian: Encode payload as binary using little endian.
    - binary_big_endian: Encode payload as binary using big endian.
  - typestringoptional
    Possible values
    - ply
- output_format_optionsStepobjectoptional
  Object
  - coordsobjectoptional
    Object
    - forwardobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - upobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - typestringoptional
    Possible values
    - step
- output_format_optionsStlobjectoptional
  Object
  - coordsobjectoptional
    Object
    - forwardobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - upobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - storagestringoptional
    Possible values
    - ascii: Plaintext encoding.
    - binary: Binary STL encoding. This is the default setting.
  - typestringoptional
    Possible values
    - stl
  - unitsstringoptional
    Possible values
    - cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
    - ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
    - in: Inches <https://en.wikipedia.org/wiki/Inch>
    - m: Meters <https://en.wikipedia.org/wiki/Meter>
    - mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
    - yd: Yards <https://en.wikipedia.org/wiki/Yard>
outputsobjectoptional
src_formatstringoptional
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- gltf: glTF 2.0.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- sldprt: SolidWorks part (SLDPRT) format.
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
src_format_optionsoneOfoptional
One of
- src_format_optionsFbxobjectoptional
  Object
  - typestringoptional
    Possible values
    - fbx
- src_format_optionsGltfobjectoptional
  Object
  - typestringoptional
    Possible values
    - gltf
- src_format_optionsObjobjectoptional
  Object
  - coordsobjectoptional
    Object
    - forwardobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - upobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - typestringoptional
    Possible values
    - obj
  - unitsstringoptional
    Possible values
    - cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
    - ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
    - in: Inches <https://en.wikipedia.org/wiki/Inch>
    - m: Meters <https://en.wikipedia.org/wiki/Meter>
    - mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
    - yd: Yards <https://en.wikipedia.org/wiki/Yard>
- src_format_optionsPlyobjectoptional
  Object
  - coordsobjectoptional
    Object
    - forwardobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - upobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - typestringoptional
    Possible values
    - ply
  - unitsstringoptional
    Possible values
    - cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
    - ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
    - in: Inches <https://en.wikipedia.org/wiki/Inch>
    - m: Meters <https://en.wikipedia.org/wiki/Meter>
    - mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
    - yd: Yards <https://en.wikipedia.org/wiki/Yard>
- src_format_optionsSldprtobjectoptional
  Object
  - typestringoptional
    Possible values
    - sldprt
- src_format_optionsStepobjectoptional
  Object
  - typestringoptional
    Possible values
    - step
- src_format_optionsStlobjectoptional
  Object
  - coordsobjectoptional
    Object
    - forwardobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - upobjectoptional
      Object
      - axisstringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - directionstringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - typestringoptional
    Possible values
    - stl
  - unitsstringoptional
    Possible values
    - cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
    - ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
    - in: Inches <https://en.wikipedia.org/wiki/Inch>
    - m: Meters <https://en.wikipedia.org/wiki/Meter>
    - mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
    - yd: Yards <https://en.wikipedia.org/wiki/Yard>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

POST/file/conversion/{src_format}/{output_format}

$ curl -X POST "https://api.kittycad.io/file/conversion/{src_format}/{output_format}" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/octet-stream" \
	--data-binary "@path/to/file"

201 Created

Response

{
  "completed_at": "2023-09-30T00:38:09.361Z",
  "created_at": "2023-09-30T00:38:09.361Z",
  "error": "NAYkqiGt9",
  "id": "08b3a3d3-43c4-4739-af62-35ce57214d9d",
  "output_format": "gltf",
  "output_format_options": {
    "coords": {
      "forward": {
        "axis": "y",
        "direction": "negative"
      },
      "up": {
        "axis": "z",
        "direction": "negative"
      }
    },
    "storage": "binary_little_endian",
    "type": "ply"
  },
  "outputs": {},
  "src_format": "step",
  "src_format_options": {
    "coords": {
      "forward": {
        "axis": "y",
        "direction": "positive"
      },
      "up": {
        "axis": "z",
        "direction": "negative"
      }
    },
    "type": "stl",
    "units": "cm"
  },
  "started_at": "2023-09-30T00:38:09.361Z",
  "status": "uploaded",
  "updated_at": "2023-09-30T00:38:09.361Z",
  "user_id": ""
}

Get CAD file density
beta

Parameters

material_massnumberrequired
material_mass_unitstringrequired
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
output_unitstringrequired
Possible values
- lb:ft3: Pounds per cubic feet.
- kg:m3: Kilograms per cubic meter.
src_formatstringrequired
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- gltf: glTF 2.0.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- sldprt: SolidWorks part (SLDPRT) format.
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
bodyapplication/octet-streamstringBINARYoptional

Returns

201 Created

successful creation

completed_atstringISO-8601optional
created_atstringISO-8601optional
densitynumberoptional
errorstringoptional
idstringUUIDoptional
material_massnumberoptional
material_mass_unitstringoptional
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
output_unitstringoptional
Possible values
- lb:ft3: Pounds per cubic feet.
- kg:m3: Kilograms per cubic meter.
src_formatstringoptional
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- gltf: glTF 2.0.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- sldprt: SolidWorks part (SLDPRT) format.
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

POST/file/density

$ curl -X POST "https://api.kittycad.io/file/density" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/octet-stream" \
	--data-binary "@path/to/file"

201 Created

Response

{
  "completed_at": "2023-09-30T00:38:09.376Z",
  "created_at": "2023-09-30T00:38:09.376Z",
  "density": 27,
  "error": "q8uWZiUTlYrKoB8",
  "id": "25b01cff-2345-4d5c-9f29-531ae2cd280e",
  "material_mass": 26,
  "material_mass_unit": "lb",
  "output_unit": "kg:m3",
  "src_format": "stl",
  "started_at": "2023-09-30T00:38:09.376Z",
  "status": "completed",
  "updated_at": "2023-09-30T00:38:09.376Z",
  "user_id": "itylwRA"
}

Get CAD file mass
beta

Parameters

material_densitynumberrequired
material_density_unitstringrequired
Possible values
- lb:ft3: Pounds per cubic feet.
- kg:m3: Kilograms per cubic meter.
output_unitstringrequired
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
src_formatstringrequired
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- gltf: glTF 2.0.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- sldprt: SolidWorks part (SLDPRT) format.
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
bodyapplication/octet-streamstringBINARYoptional

Returns

201 Created

successful creation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
massnumberoptional
material_densitynumberoptional
material_density_unitstringoptional
Possible values
- lb:ft3: Pounds per cubic feet.
- kg:m3: Kilograms per cubic meter.
output_unitstringoptional
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
src_formatstringoptional
Possible values
- fbx: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
- gltf: glTF 2.0.
- obj: The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
- ply: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
- sldprt: SolidWorks part (SLDPRT) format.
- step: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
- stl: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

POST/file/mass

$ curl -X POST "https://api.kittycad.io/file/mass" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/octet-stream" \
	--data-binary "@path/to/file"

201 Created

Response

{
  "completed_at": "2023-09-30T00:38:09.388Z",
  "created_at": "2023-09-30T00:38:09.388Z",
  "error": "B4ouCH",
  "id": "04088d7e-3849-49f2-ba8e-ce76a3525086",
  "mass": 25,
  "material_density": 23,
  "material_density_unit": "lb:ft3",
  "output_unit": "kg",
  "src_format": "ply",
  "started_at": "2023-09-30T00:38:09.388Z",
  "status": "failed",
  "updated_at": "2023-09-30T00:38:09.388Z",
  "user_id": "kLah6jU590sO3Svv"
}

Get OpenAPI schema

Parameters

No parameters

Returns

200 OK

successful operation

GET/

$ curl "https://api.kittycad.io/" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

Return pong

Parameters

No parameters

Returns

200 OK

successful operation

messagestringoptional

GET/ping

$ curl "https://api.kittycad.io/ping" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "message": "lfcAg6HOa0tGNu250gpPwV3fjchh"
}

Payments

Endpoints

GET/user/payment/balance

GET/user/payment/invoices

GET/user/payment/methods

Delete payment info for your user

Parameters

No parameters

Returns

204 No Content

successful deletion

DELETE/user/payment

$ curl -X DELETE "https://api.kittycad.io/user/payment" \
	--header "Authorization: Bearer $TOKEN"

Get payment info about your user

Parameters

No parameters

Returns

200 OK

successful operation

addressobjectoptional
Object
- citystringoptional
- countrystringoptional
- statestringoptional
- street1stringoptional
- street2stringoptional
- user_idstringoptional
- zipstringoptional
balancenumberUSD Priceoptional
created_atstringISO-8601optional
currencystringoptional
delinquentbooleanoptional
emailstringEmail Addressoptional
idstringoptional
metadataobjectoptional
namestringoptional
phonestringPhone Numberoptional

GET/user/payment

$ curl "https://api.kittycad.io/user/payment" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "address": {
    "city": "",
    "country": "",
    "state": "wPvRLWoE7NVtioZhE",
    "street1": "kKuZmERSKawUr0TeOV",
    "street2": "ZljrnOiHR7NV",
    "user_id": "OKroK3IJJ696MJs0uUNRekYMAxP",
    "zip": "onV2p88aJjZEYsewK"
  },
  "balance": "62.42",
  "created_at": "2023-09-30T00:38:09.412Z",
  "currency": "QOSytu",
  "delinquent": true,
  "email": "@d.com",
  "id": "L3",
  "metadata": {},
  "name": "GtT8TKyxzHjN3f7Ox1mnoSBLKu9",
  "phone": "+1-643-714-8401"
}

Create payment info for your user

Parameters

bodyapplication/jsonobjectoptional
Object
- addressobjectoptional
  Object
  - citystringoptional
  - countrystringoptional
  - statestringoptional
  - street1stringoptional
  - street2stringoptional
  - user_idstringoptional
  - zipstringoptional
- namestringoptional
- phonestringPhone Numberoptional

Returns

201 Created

successful creation

addressobjectoptional
Object
- citystringoptional
- countrystringoptional
- statestringoptional
- street1stringoptional
- street2stringoptional
- user_idstringoptional
- zipstringoptional
balancenumberUSD Priceoptional
created_atstringISO-8601optional
currencystringoptional
delinquentbooleanoptional
emailstringEmail Addressoptional
idstringoptional
metadataobjectoptional
namestringoptional
phonestringPhone Numberoptional

POST/user/payment

$ curl -X POST "https://api.kittycad.io/user/payment" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/json" \
	--data '{
  "address": {
    "city": "B7NXUXR5UyZgecECno0xa",
    "country": "rqYSBhp",
    "state": "",
    "street1": "UKytb9fAWbJnX9jt1ZwKXNo",
    "street2": "f9yGcML",
    "user_id": "",
    "zip": "LICgAbu40yDy"
  },
  "name": "XnZIbYDMBDBK",
  "phone": "+1-784-120-7560"
}'

201 Created

Response

{
  "address": {
    "city": "adSFBX17xahQaPQtQMXUKn2n2n1k",
    "country": "Bsrkrrvz1V13a4hl",
    "state": "NS7qk6OGJOX4QslXhCWVQxzR4AY",
    "street1": "YXnfb8Z",
    "street2": "ZGmY",
    "user_id": "13g0xaf",
    "zip": "db69mODbRssqAH8HKmDL5Sf2wtds9j"
  },
  "balance": "89.42",
  "created_at": "2023-09-30T00:38:09.428Z",
  "currency": "K5goV1k8L3EbB3egtzdJtB",
  "delinquent": false,
  "email": "jYz@rp5DmD6o.com",
  "id": "rt9aClQXr13lqpU",
  "metadata": {},
  "name": "bjO",
  "phone": "+1-834-374-6008"
}

Update payment info for your user

Parameters

bodyapplication/jsonobjectoptional
Object
- addressobjectoptional
  Object
  - citystringoptional
  - countrystringoptional
  - statestringoptional
  - street1stringoptional
  - street2stringoptional
  - user_idstringoptional
  - zipstringoptional
- namestringoptional
- phonestringPhone Numberoptional

Returns

200 OK

successful operation

addressobjectoptional
Object
- citystringoptional
- countrystringoptional
- statestringoptional
- street1stringoptional
- street2stringoptional
- user_idstringoptional
- zipstringoptional
balancenumberUSD Priceoptional
created_atstringISO-8601optional
currencystringoptional
delinquentbooleanoptional
emailstringEmail Addressoptional
idstringoptional
metadataobjectoptional
namestringoptional
phonestringPhone Numberoptional

PUT/user/payment

$ curl -X PUT "https://api.kittycad.io/user/payment" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/json" \
	--data '{
  "address": {
    "city": "w",
    "country": "xQags5VIKQxi73VA05i0gE44R",
    "state": "dPddVo6N8BrLuONfBW",
    "street1": "TKC4JXUPXd",
    "street2": "UzqQSKox",
    "user_id": "Rj9ql3J50DqAoD7nf3nByeV1guB",
    "zip": "aswxIkm"
  },
  "name": "qnrcvkhpgHvvk0qR",
  "phone": "+1-326-742-6240"
}'

200 OK

Response

{
  "address": {
    "city": "XZonZ1lQLQwFCK5wWTpYA6",
    "country": "kf0WXDpBFsnxisp1KqPV2X8FgevSGg",
    "state": "MwHZj0tODBv1gqP6a",
    "street1": "N1u8h",
    "street2": "Ax2zhgRTRx7ShNWcFCfw6iCHGu",
    "user_id": "eCQq2X2u",
    "zip": "1Yz45otYiB21k4MLvS0WoCBf7J"
  },
  "balance": "98.39",
  "created_at": "2023-09-30T00:38:09.443Z",
  "currency": "1NXMvLEivwUQN",
  "delinquent": true,
  "email": "@3VLvdl.com",
  "id": "JcQLuncAUAnmTupbwej3",
  "metadata": {},
  "name": "nWIGDXoieVsKPHa",
  "phone": "+1-421-405-8303"
}

Get balance for your user

Parameters

No parameters

Returns

200 OK

successful operation

created_atstringISO-8601optional
idstringUUIDoptional
monthly_credits_remainingnumberUSD Priceoptional
pre_pay_cash_remainingnumberUSD Priceoptional
pre_pay_credits_remainingnumberUSD Priceoptional
total_duenumberUSD Priceoptional
updated_atstringISO-8601optional
user_idstringoptional

GET/user/payment/balance

$ curl "https://api.kittycad.io/user/payment/balance" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "created_at": "2023-09-30T00:38:09.452Z",
  "id": "605ce776-6301-4161-bdb8-467b6c895029",
  "monthly_credits_remaining": "12.73",
  "pre_pay_cash_remaining": "64.23",
  "pre_pay_credits_remaining": "8.94",
  "total_due": "86.54",
  "updated_at": "2023-09-30T00:38:09.452Z",
  "user_id": "SLT2ETz2l08wHjIMg9r"
}

List invoices for your user

Parameters

No parameters

Returns

200 OK

successful operation

GET/user/payment/invoices

$ curl "https://api.kittycad.io/user/payment/invoices" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

[
  {
    "amount_due": "25.04",
    "amount_paid": "80.77",
    "amount_remaining": "33.29",
    "attempt_count": 2,
    "attempted": false,
    "created_at": "2023-09-30T00:38:09.459Z",
    "currency": "",
    "customer_email": "X@j7Fx.com",
    "customer_id": "5cryxT",
    "default_payment_method": "PDoUym",
    "description": "qEVcOIho",
    "discounts": [
      {
        "coupon": {
          "amount_off": "40.95",
          "deleted": true,
          "id": "PWRf26woQcv5ULKCt2FI",
          "percent_off": 27
        }
      }
    ],
    "id": "ivAOKsA4CwIUa6v9MUK",
    "lines": [
      {
        "amount": "32.93",
        "currency": "zX3gnXWdvNejTR1",
        "description": "kDl2a",
        "id": "J5eTB0sptnIGf",
        "invoice_item": "2uh86FOA",
        "metadata": {}
      }
    ],
    "metadata": {},
    "number": "EdMSFLI6",
    "paid": false,
    "pdf": "https://l1KeHIIs.yJ.com/5I/",
    "receipt_number": "gibIxHn9eulNcjnBMap5V0K6UdRfs",
    "statement_descriptor": "J169yhJPNFQnlWqsu5clSTg9U",
    "status": "uncollectible",
    "subtotal": "23.29",
    "tax": "59.05",
    "total": "41.22",
    "url": "https://Sue02.xLKL3OU48.com/aY2/MvO"
  }
]

List payment methods for your user

Parameters

No parameters

Returns

200 OK

successful operation

GET/user/payment/methods

$ curl "https://api.kittycad.io/user/payment/methods" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

[
  {
    "billing_info": {
      "address": {
        "city": "l17",
        "country": "Jwb9EMd",
        "state": "cF6sSV88VaudRwYv9MX8aT3VMErKE",
        "street1": "wsG1WGxybr",
        "street2": "a",
        "user_id": "V8",
        "zip": "ckXLNHmqqObazgSU"
      },
      "name": "dx3suK5aFAuXy4wHxEoGkrsACR",
      "phone": "+1-139-686-3609"
    },
    "card": {
      "brand": "PcIVHKyAQpVtYMXHLtID",
      "checks": {
        "address_line1_check": "lDIQhqSmZxGBFRZLr6CZWx",
        "address_postal_code_check": "5",
        "cvc_check": "UrUZ2PbPExhDo90MYrus96S4Q"
      },
      "country": "wUtIJDl",
      "exp_month": 15,
      "exp_year": 28,
      "fingerprint": "8DmgF2AOOXC8LomGjgtqKmPcRYT64",
      "funding": "DUFLFqMP3nRT6",
      "last4": "XB3FhL3hGQyjcOZzJki2j7h"
    },
    "created_at": "2023-09-30T00:38:09.467Z",
    "id": "lIFrfmLiyukw1IxR33JMH",
    "metadata": {},
    "type": "card"
  }
]

Unit

Endpoints

GET/unit/conversion/angle/{input_unit}/{output_unit}

GET/unit/conversion/area/{input_unit}/{output_unit}

GET/unit/conversion/current/{input_unit}/{output_unit}

GET/unit/conversion/energy/{input_unit}/{output_unit}

GET/unit/conversion/force/{input_unit}/{output_unit}

GET/unit/conversion/frequency/{input_unit}/{output_unit}

GET/unit/conversion/length/{input_unit}/{output_unit}

GET/unit/conversion/mass/{input_unit}/{output_unit}

GET/unit/conversion/power/{input_unit}/{output_unit}

GET/unit/conversion/pressure/{input_unit}/{output_unit}

GET/unit/conversion/temperature/{input_unit}/{output_unit}

GET/unit/conversion/torque/{input_unit}/{output_unit}

GET/unit/conversion/volume/{input_unit}/{output_unit}

Convert angle units

Parameters

input_unitstringrequired
Possible values
- degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
- radians: Radians <https://en.wikipedia.org/wiki/Radian>
output_unitstringrequired
Possible values
- degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
- radians: Radians <https://en.wikipedia.org/wiki/Radian>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
- radians: Radians <https://en.wikipedia.org/wiki/Radian>
outputnumberoptional
output_unitstringoptional
Possible values
- degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
- radians: Radians <https://en.wikipedia.org/wiki/Radian>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/angle/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/angle/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.476Z",
  "created_at": "2023-09-30T00:38:09.476Z",
  "error": "BWn2LI7CP9",
  "id": "0e8d68f2-cefb-4a28-824d-f1b95acf00c1",
  "input": 15,
  "input_unit": "degrees",
  "output": 23,
  "output_unit": "radians",
  "started_at": "2023-09-30T00:38:09.476Z",
  "status": "uploaded",
  "updated_at": "2023-09-30T00:38:09.476Z",
  "user_id": "dx1GOBGbP"
}

Convert area units

Parameters

input_unitstringrequired
Possible values
- cm2: Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>
- dm2: Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>
- ft2: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- in2: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- km2: Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>
- m2: Square meters <https://en.wikipedia.org/wiki/Square_meter>
- mm2: Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>
- yd2: Square yards <https://en.wikipedia.org/wiki/Square_mile>
output_unitstringrequired
Possible values
- cm2: Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>
- dm2: Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>
- ft2: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- in2: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- km2: Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>
- m2: Square meters <https://en.wikipedia.org/wiki/Square_meter>
- mm2: Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>
- yd2: Square yards <https://en.wikipedia.org/wiki/Square_mile>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- cm2: Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>
- dm2: Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>
- ft2: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- in2: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- km2: Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>
- m2: Square meters <https://en.wikipedia.org/wiki/Square_meter>
- mm2: Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>
- yd2: Square yards <https://en.wikipedia.org/wiki/Square_mile>
outputnumberoptional
output_unitstringoptional
Possible values
- cm2: Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>
- dm2: Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>
- ft2: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- in2: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- km2: Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>
- m2: Square meters <https://en.wikipedia.org/wiki/Square_meter>
- mm2: Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>
- yd2: Square yards <https://en.wikipedia.org/wiki/Square_mile>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/area/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/area/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.482Z",
  "created_at": "2023-09-30T00:38:09.482Z",
  "error": "VbYftQclv2UiK0t3EJGpBRU",
  "id": "7113fe99-05b4-412d-9e5f-8e4be23847a9",
  "input": 2,
  "input_unit": "in2",
  "output": 11,
  "output_unit": "ft2",
  "started_at": "2023-09-30T00:38:09.482Z",
  "status": "completed",
  "updated_at": "2023-09-30T00:38:09.482Z",
  "user_id": "JEnbMswnLE5XrP34FbOdwEEFbbvZ"
}

Convert current units

Parameters

input_unitstringrequired
Possible values
- amperes: Amperes <https://en.wikipedia.org/wiki/Ampere>
- microamperes: Microamperes <https://en.wikipedia.org/wiki/Microampere>
- milliamperes: Milliamperes <https://en.wikipedia.org/wiki/Milliampere>
- nanoamperes: Nanoamperes <https://en.wikipedia.org/wiki/Nanoampere>
output_unitstringrequired
Possible values
- amperes: Amperes <https://en.wikipedia.org/wiki/Ampere>
- microamperes: Microamperes <https://en.wikipedia.org/wiki/Microampere>
- milliamperes: Milliamperes <https://en.wikipedia.org/wiki/Milliampere>
- nanoamperes: Nanoamperes <https://en.wikipedia.org/wiki/Nanoampere>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- amperes: Amperes <https://en.wikipedia.org/wiki/Ampere>
- microamperes: Microamperes <https://en.wikipedia.org/wiki/Microampere>
- milliamperes: Milliamperes <https://en.wikipedia.org/wiki/Milliampere>
- nanoamperes: Nanoamperes <https://en.wikipedia.org/wiki/Nanoampere>
outputnumberoptional
output_unitstringoptional
Possible values
- amperes: Amperes <https://en.wikipedia.org/wiki/Ampere>
- microamperes: Microamperes <https://en.wikipedia.org/wiki/Microampere>
- milliamperes: Milliamperes <https://en.wikipedia.org/wiki/Milliampere>
- nanoamperes: Nanoamperes <https://en.wikipedia.org/wiki/Nanoampere>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/current/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/current/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.487Z",
  "created_at": "2023-09-30T00:38:09.487Z",
  "error": "GzwVzM8",
  "id": "d11ba263-d3c3-4dbe-a9b1-87f5b1b5042a",
  "input": 5,
  "input_unit": "milliamperes",
  "output": 24,
  "output_unit": "milliamperes",
  "started_at": "2023-09-30T00:38:09.487Z",
  "status": "failed",
  "updated_at": "2023-09-30T00:38:09.487Z",
  "user_id": "EEneQC3LCiueCEZYVg672xHCCE"
}

Convert energy units

Parameters

input_unitstringrequired
Possible values
- btu: British Thermal Unit (BTU) <https://en.wikipedia.org/wiki/British_thermal_unit>
- electronvolts: Electron Volts (eV) <https://en.wikipedia.org/wiki/Electronvolt>
- joules: Joules (or watt-seconds) <https://en.wikipedia.org/wiki/Joule>
- kilocalories: Kilocalories (often just called calories) <https://en.wikipedia.org/wiki/Kilocalorie>
- kilowatt_hours: Kilowatt hours (kWh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
- watt_hours: Watt hours (Wh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
output_unitstringrequired
Possible values
- btu: British Thermal Unit (BTU) <https://en.wikipedia.org/wiki/British_thermal_unit>
- electronvolts: Electron Volts (eV) <https://en.wikipedia.org/wiki/Electronvolt>
- joules: Joules (or watt-seconds) <https://en.wikipedia.org/wiki/Joule>
- kilocalories: Kilocalories (often just called calories) <https://en.wikipedia.org/wiki/Kilocalorie>
- kilowatt_hours: Kilowatt hours (kWh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
- watt_hours: Watt hours (Wh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- btu: British Thermal Unit (BTU) <https://en.wikipedia.org/wiki/British_thermal_unit>
- electronvolts: Electron Volts (eV) <https://en.wikipedia.org/wiki/Electronvolt>
- joules: Joules (or watt-seconds) <https://en.wikipedia.org/wiki/Joule>
- kilocalories: Kilocalories (often just called calories) <https://en.wikipedia.org/wiki/Kilocalorie>
- kilowatt_hours: Kilowatt hours (kWh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
- watt_hours: Watt hours (Wh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
outputnumberoptional
output_unitstringoptional
Possible values
- btu: British Thermal Unit (BTU) <https://en.wikipedia.org/wiki/British_thermal_unit>
- electronvolts: Electron Volts (eV) <https://en.wikipedia.org/wiki/Electronvolt>
- joules: Joules (or watt-seconds) <https://en.wikipedia.org/wiki/Joule>
- kilocalories: Kilocalories (often just called calories) <https://en.wikipedia.org/wiki/Kilocalorie>
- kilowatt_hours: Kilowatt hours (kWh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
- watt_hours: Watt hours (Wh) <https://en.wikipedia.org/wiki/Kilowatt-hour>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/energy/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/energy/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.496Z",
  "created_at": "2023-09-30T00:38:09.496Z",
  "error": "6cKvp",
  "id": "b99befd7-5eb8-43b4-be6d-3bbb41682769",
  "input": 22,
  "input_unit": "btu",
  "output": 12,
  "output_unit": "joules",
  "started_at": "2023-09-30T00:38:09.496Z",
  "status": "failed",
  "updated_at": "2023-09-30T00:38:09.496Z",
  "user_id": "hY3JulE7xSJMoH0Shk"
}

Convert force units

Parameters

input_unitstringrequired
Possible values
- dynes: Dynes <https://en.wikipedia.org/wiki/Dyne>
- kiloponds: Kiloponds <https://en.wikipedia.org/wiki/Kilopond>
- micronewtons: Micronewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- millinewtons: Millinewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- newtons: Newtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- poundals: Poundals <https://en.wikipedia.org/wiki/Poundal>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(force)>
output_unitstringrequired
Possible values
- dynes: Dynes <https://en.wikipedia.org/wiki/Dyne>
- kiloponds: Kiloponds <https://en.wikipedia.org/wiki/Kilopond>
- micronewtons: Micronewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- millinewtons: Millinewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- newtons: Newtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- poundals: Poundals <https://en.wikipedia.org/wiki/Poundal>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(force)>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- dynes: Dynes <https://en.wikipedia.org/wiki/Dyne>
- kiloponds: Kiloponds <https://en.wikipedia.org/wiki/Kilopond>
- micronewtons: Micronewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- millinewtons: Millinewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- newtons: Newtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- poundals: Poundals <https://en.wikipedia.org/wiki/Poundal>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(force)>
outputnumberoptional
output_unitstringoptional
Possible values
- dynes: Dynes <https://en.wikipedia.org/wiki/Dyne>
- kiloponds: Kiloponds <https://en.wikipedia.org/wiki/Kilopond>
- micronewtons: Micronewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- millinewtons: Millinewtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- newtons: Newtons <https://en.wikipedia.org/wiki/Newton_(unit)>
- poundals: Poundals <https://en.wikipedia.org/wiki/Poundal>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(force)>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/force/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/force/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.502Z",
  "created_at": "2023-09-30T00:38:09.502Z",
  "error": "W",
  "id": "726129ae-7cad-4210-8271-a4daf4a32c7b",
  "input": 25,
  "input_unit": "millinewtons",
  "output": 4,
  "output_unit": "kiloponds",
  "started_at": "2023-09-30T00:38:09.502Z",
  "status": "failed",
  "updated_at": "2023-09-30T00:38:09.502Z",
  "user_id": "fl0rtlaxTWZs46m"
}

Convert frequency units

Parameters

input_unitstringrequired
Possible values
- gigahertz: Gigahertz <https://en.wikipedia.org/wiki/Hertz>
- hertz: Hertz <https://en.wikipedia.org/wiki/Hertz>
- kilohertz: Kilohertz <https://en.wikipedia.org/wiki/Hertz>
- megahertz: Megahertz <https://en.wikipedia.org/wiki/Hertz>
- microhertz: Microhertz <https://en.wikipedia.org/wiki/Hertz>
- millihertz: Millihertz <https://en.wikipedia.org/wiki/Hertz>
- nanohertz: Nanohertz <https://en.wikipedia.org/wiki/Hertz>
- terahertz: Terahertz <https://en.wikipedia.org/wiki/Hertz>
output_unitstringrequired
Possible values
- gigahertz: Gigahertz <https://en.wikipedia.org/wiki/Hertz>
- hertz: Hertz <https://en.wikipedia.org/wiki/Hertz>
- kilohertz: Kilohertz <https://en.wikipedia.org/wiki/Hertz>
- megahertz: Megahertz <https://en.wikipedia.org/wiki/Hertz>
- microhertz: Microhertz <https://en.wikipedia.org/wiki/Hertz>
- millihertz: Millihertz <https://en.wikipedia.org/wiki/Hertz>
- nanohertz: Nanohertz <https://en.wikipedia.org/wiki/Hertz>
- terahertz: Terahertz <https://en.wikipedia.org/wiki/Hertz>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- gigahertz: Gigahertz <https://en.wikipedia.org/wiki/Hertz>
- hertz: Hertz <https://en.wikipedia.org/wiki/Hertz>
- kilohertz: Kilohertz <https://en.wikipedia.org/wiki/Hertz>
- megahertz: Megahertz <https://en.wikipedia.org/wiki/Hertz>
- microhertz: Microhertz <https://en.wikipedia.org/wiki/Hertz>
- millihertz: Millihertz <https://en.wikipedia.org/wiki/Hertz>
- nanohertz: Nanohertz <https://en.wikipedia.org/wiki/Hertz>
- terahertz: Terahertz <https://en.wikipedia.org/wiki/Hertz>
outputnumberoptional
output_unitstringoptional
Possible values
- gigahertz: Gigahertz <https://en.wikipedia.org/wiki/Hertz>
- hertz: Hertz <https://en.wikipedia.org/wiki/Hertz>
- kilohertz: Kilohertz <https://en.wikipedia.org/wiki/Hertz>
- megahertz: Megahertz <https://en.wikipedia.org/wiki/Hertz>
- microhertz: Microhertz <https://en.wikipedia.org/wiki/Hertz>
- millihertz: Millihertz <https://en.wikipedia.org/wiki/Hertz>
- nanohertz: Nanohertz <https://en.wikipedia.org/wiki/Hertz>
- terahertz: Terahertz <https://en.wikipedia.org/wiki/Hertz>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/frequency/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/frequency/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.508Z",
  "created_at": "2023-09-30T00:38:09.508Z",
  "error": "hT8RJPJHt0eiY2nsBvSUeoyPv",
  "id": "d83ea3db-1bcc-477b-9db7-0398e108aed3",
  "input": 17,
  "input_unit": "millihertz",
  "output": 25,
  "output_unit": "millihertz",
  "started_at": "2023-09-30T00:38:09.508Z",
  "status": "in_progress",
  "updated_at": "2023-09-30T00:38:09.508Z",
  "user_id": "r"
}

Convert length units

Parameters

input_unitstringrequired
Possible values
- cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
- ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- in: Inches <https://en.wikipedia.org/wiki/Inch>
- m: Meters <https://en.wikipedia.org/wiki/Meter>
- mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
- yd: Yards <https://en.wikipedia.org/wiki/Yard>
output_unitstringrequired
Possible values
- cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
- ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- in: Inches <https://en.wikipedia.org/wiki/Inch>
- m: Meters <https://en.wikipedia.org/wiki/Meter>
- mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
- yd: Yards <https://en.wikipedia.org/wiki/Yard>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
- ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- in: Inches <https://en.wikipedia.org/wiki/Inch>
- m: Meters <https://en.wikipedia.org/wiki/Meter>
- mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
- yd: Yards <https://en.wikipedia.org/wiki/Yard>
outputnumberoptional
output_unitstringoptional
Possible values
- cm: Centimeters <https://en.wikipedia.org/wiki/Centimeter>
- ft: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- in: Inches <https://en.wikipedia.org/wiki/Inch>
- m: Meters <https://en.wikipedia.org/wiki/Meter>
- mm: Millimeters <https://en.wikipedia.org/wiki/Millimeter>
- yd: Yards <https://en.wikipedia.org/wiki/Yard>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/length/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/length/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.515Z",
  "created_at": "2023-09-30T00:38:09.515Z",
  "error": "Mn7qrfGCCmaRNklSs2NrmmG",
  "id": "84187304-cbf5-4efa-8fc3-915a234ff5b6",
  "input": 12,
  "input_unit": "m",
  "output": 32,
  "output_unit": "yd",
  "started_at": "2023-09-30T00:38:09.515Z",
  "status": "completed",
  "updated_at": "2023-09-30T00:38:09.515Z",
  "user_id": "DTJPfDeMaR5JpkjAPC31"
}

Convert mass units

Parameters

input_unitstringrequired
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
output_unitstringrequired
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
outputnumberoptional
output_unitstringoptional
Possible values
- g: Grams <https://en.wikipedia.org/wiki/Gram>
- kg: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- lb: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/mass/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/mass/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.521Z",
  "created_at": "2023-09-30T00:38:09.521Z",
  "error": "VifuhaNih4eIAKGAme",
  "id": "6c13f8b7-6abe-437a-94e2-b01abb2e1059",
  "input": 16,
  "input_unit": "g",
  "output": 28,
  "output_unit": "g",
  "started_at": "2023-09-30T00:38:09.521Z",
  "status": "completed",
  "updated_at": "2023-09-30T00:38:09.521Z",
  "user_id": "YlxbykjkGqSlY584A"
}

Convert power units

Parameters

input_unitstringrequired
Possible values
- btu_per_minute: British thermal units (BTU) per minute <https://en.wikipedia.org/wiki/British_thermal_unit>
- horsepower: Horsepower (hp) <https://en.wikipedia.org/wiki/Horsepower>
- kilowatts: Kilowatts <https://en.wikipedia.org/wiki/Kilowatt>
- metric_horsepower: Metric horsepower (PS) <https://en.wikipedia.org/wiki/Horsepower#Metric_horsepower>
- microwatts: Microwatts <https://en.wikipedia.org/wiki/Microwatt>
- milliwatts: Millwatts <https://en.wikipedia.org/wiki/Milliwatt>
- watts: Watts <https://en.wikipedia.org/wiki/Watt>
output_unitstringrequired
Possible values
- btu_per_minute: British thermal units (BTU) per minute <https://en.wikipedia.org/wiki/British_thermal_unit>
- horsepower: Horsepower (hp) <https://en.wikipedia.org/wiki/Horsepower>
- kilowatts: Kilowatts <https://en.wikipedia.org/wiki/Kilowatt>
- metric_horsepower: Metric horsepower (PS) <https://en.wikipedia.org/wiki/Horsepower#Metric_horsepower>
- microwatts: Microwatts <https://en.wikipedia.org/wiki/Microwatt>
- milliwatts: Millwatts <https://en.wikipedia.org/wiki/Milliwatt>
- watts: Watts <https://en.wikipedia.org/wiki/Watt>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- btu_per_minute: British thermal units (BTU) per minute <https://en.wikipedia.org/wiki/British_thermal_unit>
- horsepower: Horsepower (hp) <https://en.wikipedia.org/wiki/Horsepower>
- kilowatts: Kilowatts <https://en.wikipedia.org/wiki/Kilowatt>
- metric_horsepower: Metric horsepower (PS) <https://en.wikipedia.org/wiki/Horsepower#Metric_horsepower>
- microwatts: Microwatts <https://en.wikipedia.org/wiki/Microwatt>
- milliwatts: Millwatts <https://en.wikipedia.org/wiki/Milliwatt>
- watts: Watts <https://en.wikipedia.org/wiki/Watt>
outputnumberoptional
output_unitstringoptional
Possible values
- btu_per_minute: British thermal units (BTU) per minute <https://en.wikipedia.org/wiki/British_thermal_unit>
- horsepower: Horsepower (hp) <https://en.wikipedia.org/wiki/Horsepower>
- kilowatts: Kilowatts <https://en.wikipedia.org/wiki/Kilowatt>
- metric_horsepower: Metric horsepower (PS) <https://en.wikipedia.org/wiki/Horsepower#Metric_horsepower>
- microwatts: Microwatts <https://en.wikipedia.org/wiki/Microwatt>
- milliwatts: Millwatts <https://en.wikipedia.org/wiki/Milliwatt>
- watts: Watts <https://en.wikipedia.org/wiki/Watt>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional
user_idstringoptional

GET/unit/conversion/power/{input_unit}/{output_unit}

$ curl "https://api.kittycad.io/unit/conversion/power/{input_unit}/{output_unit}" \
	--header "Authorization: Bearer $TOKEN"

200 OK

Response

{
  "completed_at": "2023-09-30T00:38:09.531Z",
  "created_at": "2023-09-30T00:38:09.531Z",
  "error": "Yl26ZEe8MMF1M",
  "id": "1684dba7-83db-4940-a6ed-2b51dfbeccae",
  "input": 24,
  "input_unit": "kilowatts",
  "output": 10,
  "output_unit": "watts",
  "started_at": "2023-09-30T00:38:09.531Z",
  "status": "completed",
  "updated_at": "2023-09-30T00:38:09.531Z",
  "user_id": "ZYaeNZZQwf"
}

Convert pressure units

Parameters

input_unitstringrequired
Possible values
- atmospheres: Atmospheres <https://en.wikipedia.org/wiki/Standard_atmosphere_(unit)>
- bars: Bars <https://en.wikipedia.org/wiki/Bar_(unit)>
- hectopascals: Hectopascals <https://en.wikipedia.org/wiki/Hectopascal>
- kilopascals: Kilopascals <https://en.wikipedia.org/wiki/Kilopascal>
- millibars: Millibars <https://en.wikipedia.org/wiki/Bar_(unit)>
- pascals: Pascals <https://en.wikipedia.org/wiki/Pascal_(unit)>
- psi: Pounds per square inch (PSI) - <https://en.wikipedia.org/wiki/Pound_per_square_inch>
output_unitstringrequired
Possible values
- atmospheres: Atmospheres <https://en.wikipedia.org/wiki/Standard_atmosphere_(unit)>
- bars: Bars <https://en.wikipedia.org/wiki/Bar_(unit)>
- hectopascals: Hectopascals <https://en.wikipedia.org/wiki/Hectopascal>
- kilopascals: Kilopascals <https://en.wikipedia.org/wiki/Kilopascal>
- millibars: Millibars <https://en.wikipedia.org/wiki/Bar_(unit)>
- pascals: Pascals <https://en.wikipedia.org/wiki/Pascal_(unit)>
- psi: Pounds per square inch (PSI) - <https://en.wikipedia.org/wiki/Pound_per_square_inch>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- atmospheres: Atmospheres <https://en.wikipedia.org/wiki/Standard_atmosphere_(unit)>
- bars: Bars <https://en.wikipedia.org/wiki/Bar_(unit)>
- hectopascals: Hectopascals <https://en.wikipedia.org/wiki/Hectopascal>
- kilopascals: Kilopascals <https://en.wikipedia.org/wiki/Kilopascal>
- millibars: Millibars <https://en.wikipedia.org/wiki/Bar_(unit)>
- pascals: Pascals <https://en.wikipedia.org/wiki/Pascal_(unit)>
- psi: Pounds per square inch (PSI) - <https://en.wikipedia.org/wiki/Pound_per_square_inch>
outputnumberoptional
output_unitstringoptional
Possible values
- atmospheres: Atmospheres <https://en.wikipedia.org/wiki/Standard_atmosphere_(unit)>
- bars: Bars <https://en.wikipedia.org/wiki/Bar_(unit)>
- hectopascals: Hectopascals <https://en.wikipedia.org/wiki/Hectopascal>
- kilopascals: Kilopascals <https://en.wikipedia.org/wiki/Kilopascal>
- millibars: Millibars <https://en.wikipedia.org/wiki/Bar_(unit)>
- pascals: Pascals <https://en.wikipedia.org/wiki/Pascal_(unit)>
- psi: Pounds per square inch (PSI) - <https://en.wikipedia.org/wiki/Pound_per_square_inch>
started_atstringISO-8601optional
statusstringoptional
Possible values
- queued: The async API call is queued.
- uploaded: The async API call was uploaded to be converted.
- in_progress: The async API call is in progress.
- completed: The async API call has completed.
- failed: The async API call has failed.
updated_atstringISO-8601optional

API Reference

Client libraries

Authentication

Errors

API Calls

Get an async operation

Parameters

Returns

200 OK

List API calls for your user

Parameters

Possible values

Returns

200 OK

Array of

Possible values

Get an API call for a user

Parameters

Returns

200 OK

Possible values

API Tokens

List API tokens for your user

Parameters

Possible values

Returns

200 OK

Array of

Create a new API token for your user

Parameters

Returns

201 Created

Delete an API token for your user

Parameters

Returns

204 No Content

Get an API token for your user

Parameters

Returns

200 OK

File

Convert CAD file with defaults

Parameters

Possible values

Possible values

Returns

201 Created

Possible values

One of

Object

Possible values

Possible values

Object

Possible values

Possible values

Possible values

Object

Object

Object

Possible values

Possible values

Object

Possible values

Possible values

Possible values

Possible values

Object

Object

Object

Possible values

Possible values

Object

Possible values

Possible values

Possible values

Possible values

Object

Object

Object

Possible values

Get CAD file density
beta

Get CAD file mass
beta