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-06-02T19:34:24.256Z",
  "created_at": "2023-06-02T19:34:24.256Z",
  "error": "SiYFyMngsor",
  "id": "5810789c-6aa5-445f-ae38-27c0c643b4b5",
  "mass": 4,
  "material_density": 19,
  "src_format": "obj",
  "started_at": "2023-06-02T19:34:24.257Z",
  "status": "Uploaded",
  "updated_at": "2023-06-02T19:34:24.257Z",
  "user_id": "yRUPcIu87WQ8RHjtpvk8c3d"
}

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-06-02T19:34:24.287Z",
      "created_at": "2023-06-02T19:34:24.287Z",
      "duration": 6,
      "email": "tV5jglZF@x4ezAOsd.com",
      "endpoint": "uI",
      "id": "169b3894-bcc6-4523-ac36-daa3dcb98704",
      "ip_address": "192.0.2.6",
      "litterbox": true,
      "method": "HEAD",
      "minutes": 31,
      "origin": "NQ0cTNYI2FH8bwL5Bl",
      "price": "61.13",
      "request_body": "fqlkYXwz2Ej5F5F48HdJgpF6t",
      "request_query_params": "6Uz1X9XM5QiKm3SLLWFeSJgqjWXjw2",
      "response_body": "hKPcfRlUoKEX4fARoMVpks6ZT",
      "started_at": "2023-06-02T19:34:24.287Z",
      "status_code": 18,
      "stripe_invoice_item_id": "l8bt6vpVK",
      "token": "52abb0c8-f533-433b-adef-56677020700f",
      "updated_at": "2023-06-02T19:34:24.287Z",
      "user_agent": "y9jOHSsF835",
      "user_id": "3JKBbuPL"
    }
  ],
  "next_page": "VJI3D4BtsBdJyBjbtlwnPBydvoQU2"
}

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-06-02T19:34:24.318Z",
  "created_at": "2023-06-02T19:34:24.318Z",
  "duration": 32,
  "email": "UPJ1@.com",
  "endpoint": "AkLjDYJQjGVNj8hAm43n",
  "id": "1df5f288-3642-4576-b699-2c4ad967ccd8",
  "ip_address": "192.0.2.67",
  "litterbox": false,
  "method": "OPTIONS",
  "minutes": 30,
  "origin": "NLr8bwYz30n8RjtCuOBVM7loV",
  "price": "54.33",
  "request_body": "bIEeV7cdDMTVm3JFWQ43xMIFWMRfN",
  "request_query_params": "YObJVug6HJXJmVlO",
  "response_body": "pWfq7UKLfHXGJM3FF1",
  "started_at": "2023-06-02T19:34:24.318Z",
  "status_code": 27,
  "stripe_invoice_item_id": "otY9ZUODWWuk",
  "token": "4f61dc3f-3948-48ed-b032-d0a61d344106",
  "updated_at": "2023-06-02T19:34:24.318Z",
  "user_agent": "",
  "user_id": "HWpsE0ZIz8S9QE8Vm"
}

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-06-02T19:34:24.331Z",
      "id": "P15",
      "is_valid": false,
      "token": "25c6b96e-496c-41f8-8adc-a6eb66d61bef",
      "updated_at": "2023-06-02T19:34:24.331Z",
      "user_id": "wUXgjGgyh6yF"
    }
  ],
  "next_page": "xmhZBBkmcWZUkSlNEvXE8YNjmF3HFi"
}

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-06-02T19:34:24.341Z",
  "id": "67CvZ6jcJ1WK0ApT6RGe2D3UPnX",
  "is_valid": true,
  "token": "d9803e6f-0445-4305-be28-a74e9d5f8148",
  "updated_at": "2023-06-02T19:34:24.341Z",
  "user_id": "DehewYNe"
}

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-06-02T19:34:24.347Z",
  "id": "w74n9855mQjHi3yfH0",
  "is_valid": false,
  "token": "ff5a139f-fffb-4c22-b6ea-9b86b64f6990",
  "updated_at": "2023-06-02T19:34:24.347Z",
  "user_id": "SY2gVk4QcXm0Lz5K2RDDc9X"
}

File

Endpoints

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

POST/file/density

POST/file/mass

Convert CAD file

Parameters

output_formatstringrequired
Possible values
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- fbxb: The FBX file format (in binary). <https://en.wikipedia.org/wiki/FBX>
- obj: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>> 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
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- obj_zip: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>>
- 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)>
bodyapplication/octet-streamstringBINARYoptional

Returns

201 Created

successful creation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
outputstringBASE64optional
output_formatstringoptional
Possible values
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- fbxb: The FBX file format (in binary). <https://en.wikipedia.org/wiki/FBX>
- obj: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>> 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_formatstringoptional
Possible values
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- obj_zip: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>>
- 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)>
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-06-02T19:34:24.365Z",
  "created_at": "2023-06-02T19:34:24.365Z",
  "error": "mFPq",
  "id": "3c47fde2-41f7-4d37-b049-3e86a16ef960",
  "output": "BASE64_ENCODED_BYTE_STRING",
  "output_format": "step",
  "src_format": "obj_zip",
  "started_at": "2023-06-02T19:34:24.365Z",
  "status": "Completed",
  "updated_at": "2023-06-02T19:34:24.365Z",
  "user_id": "J8r"
}

Get CAD file density
beta

Parameters

material_massnumberrequired
src_formatstringrequired
Possible values
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- obj_zip: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>>
- 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)>
bodyapplication/octet-streamstringBINARYoptional

Returns

201 Created

successful creation

completed_atstringISO-8601optional
created_atstringISO-8601optional
densitynumberoptional
errorstringoptional
idstringUUIDoptional
material_massnumberoptional
src_formatstringoptional
Possible values
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- obj_zip: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>>
- 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)>
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-06-02T19:34:24.390Z",
  "created_at": "2023-06-02T19:34:24.390Z",
  "density": 26,
  "error": "dAO",
  "id": "36aba05f-c855-4909-82eb-7b5f4d7cd6d5",
  "material_mass": 12,
  "src_format": "fbx",
  "started_at": "2023-06-02T19:34:24.390Z",
  "status": "Failed",
  "updated_at": "2023-06-02T19:34:24.390Z",
  "user_id": "7jb3sqmndzzE2k"
}

Get CAD file mass
beta

Parameters

material_densitynumberrequired
src_formatstringrequired
Possible values
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- obj_zip: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>>
- 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)>
bodyapplication/octet-streamstringBINARYoptional

Returns

201 Created

successful creation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
massnumberoptional
material_densitynumberoptional
src_formatstringoptional
Possible values
- dae: The COLLADA/DAE file format. <https://en.wikipedia.org/wiki/COLLADA>
- dxf: The DXF file format. <https://en.wikipedia.org/wiki/AutoCAD_DXF>
- fbx: The FBX file format. <https://en.wikipedia.org/wiki/FBX>
- obj_zip: The OBJ file format. A zip file containing both the obj file itself and its associated mtl file for full processing. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>>
- 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)>
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-06-02T19:34:24.403Z",
  "created_at": "2023-06-02T19:34:24.403Z",
  "error": "AHbt5fxeh4PLpoh3WAfiM4",
  "id": "35035d14-b7d8-48ca-ab57-cf754258d362",
  "mass": 3,
  "material_density": 19,
  "src_format": "dae",
  "started_at": "2023-06-02T19:34:24.403Z",
  "status": "Completed",
  "updated_at": "2023-06-02T19:34:24.403Z",
  "user_id": "xtE5RMuBVLPm"
}

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": "T3Fi7tHmF9au6wS"
}

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
  Possible values
  249 possible values
  - AF: Afghanistan
  - AX: Åland Islands
  - AL: Albania
  - DZ: Algeria
  - AS: American Samoa
  - AD: Andorra
  - AO: Angola
  - AI: Anguilla
  - AQ: Antarctica
  - AG: Antigua and Barbuda
  - AR: Argentina
  - AM: Armenia
  - AW: Aruba
  - AU: Australia
  - AT: Austria
  - AZ: Azerbaijan
  - BS: Bahamas
  - BH: Bahrain
  - BD: Bangladesh
  - BB: Barbados
  - BY: Belarus
  - BE: Belgium
  - BZ: Belize
  - BJ: Benin
  - BM: Bermuda
  - BT: Bhutan
  - BO: Bolivia (Plurinational State of)
  - BQ: Bonaire, Sint Eustatius and Saba
  - BA: Bosnia and Herzegovina
  - BW: Botswana
  - BV: Bouvet Island
  - BR: Brazil
  - IO: British Indian Ocean Territory
  - BN: Brunei Darussalam
  - BG: Bulgaria
  - BF: Burkina Faso
  - BI: Burundi
  - CV: Cabo Verde
  - KH: Cambodia
  - CM: Cameroon
  - CA: Canada
  - KY: Cayman Islands
  - CF: Central African Republic
  - TD: Chad
  - CL: Chile
  - CN: China
  - CX: Christmas Island
  - CC: Cocos (Keeling) Islands
  - CO: Colombia
  - KM: Comoros
  - CG: Congo
  - CD: Congo (Democratic Republic of the)
  - CK: Cook Islands
  - CR: Costa Rica
  - CI: Côte d'Ivoire
  - HR: Croatia
  - CU: Cuba
  - CW: Curaçao
  - CY: Cyprus
  - CZ: Czechia
  - DK: Denmark
  - DJ: Djibouti
  - DM: Dominica
  - DO: Dominican Republic
  - EC: Ecuador
  - EG: Egypt
  - SV: El Salvador
  - GQ: Equatorial Guinea
  - ER: Eritrea
  - EE: Estonia
  - ET: Ethiopia
  - FK: Falkland Islands (Malvinas)
  - FO: Faroe Islands
  - FJ: Fiji
  - FI: Finland
  - FR: France
  - GF: French Guiana
  - PF: French Polynesia
  - TF: French Southern Territories
  - GA: Gabon
  - GM: Gambia
  - GE: Georgia
  - DE: Germany
  - GH: Ghana
  - GI: Gibraltar
  - GR: Greece
  - GL: Greenland
  - GD: Grenada
  - GP: Guadeloupe
  - GU: Guam
  - GT: Guatemala
  - GG: Guernsey
  - GN: Guinea
  - GW: Guinea-Bissau
  - GY: Guyana
  - HT: Haiti
  - HM: Heard Island and McDonald Islands
  - VA: Holy See
  - HN: Honduras
  - HK: Hong Kong
  - HU: Hungary
  - IS: Iceland
  - IN: India
  - ID: Indonesia
  - IR: Iran (Islamic Republic of)
  - IQ: Iraq
  - IE: Ireland
  - IM: Isle of Man
  - IL: Israel
  - IT: Italy
  - JM: Jamaica
  - JP: Japan
  - JE: Jersey
  - JO: Jordan
  - KZ: Kazakhstan
  - KE: Kenya
  - KI: Kiribati
  - KP: Korea (Democratic People's Republic of)
  - KR: Korea (Republic of)
  - KW: Kuwait
  - KG: Kyrgyzstan
  - LA: Lao People's Democratic Republic
  - LV: Latvia
  - LB: Lebanon
  - LS: Lesotho
  - LR: Liberia
  - LY: Libya
  - LI: Liechtenstein
  - LT: Lithuania
  - LU: Luxembourg
  - MO: Macao
  - MK: Macedonia (the former Yugoslav Republic of)
  - MG: Madagascar
  - MW: Malawi
  - MY: Malaysia
  - MV: Maldives
  - ML: Mali
  - MT: Malta
  - MH: Marshall Islands
  - MQ: Martinique
  - MR: Mauritania
  - MU: Mauritius
  - YT: Mayotte
  - MX: Mexico
  - FM: Micronesia (Federated States of)
  - MD: Moldova (Republic of)
  - MC: Monaco
  - MN: Mongolia
  - ME: Montenegro
  - MS: Montserrat
  - MA: Morocco
  - MZ: Mozambique
  - MM: Myanmar
  - NA: Namibia
  - NR: Nauru
  - NP: Nepal
  - NL: Netherlands
  - NC: New Caledonia
  - NZ: New Zealand
  - NI: Nicaragua
  - NE: Niger
  - NG: Nigeria
  - NU: Niue
  - NF: Norfolk Island
  - MP: Northern Mariana Islands
  - NO: Norway
  - OM: Oman
  - PK: Pakistan
  - PW: Palau
  - PS: Palestine, State of
  - PA: Panama
  - PG: Papua New Guinea
  - PY: Paraguay
  - PE: Peru
  - PH: Philippines
  - PN: Pitcairn
  - PL: Poland
  - PT: Portugal
  - PR: Puerto Rico
  - QA: Qatar
  - RE: Réunion
  - RO: Romania
  - RU: Russian Federation
  - RW: Rwanda
  - BL: Saint Barthélemy
  - SH: Saint Helena, Ascension and Tristan da Cunha
  - KN: Saint Kitts and Nevis
  - LC: Saint Lucia
  - MF: Saint Martin (French part)
  - PM: Saint Pierre and Miquelon
  - VC: Saint Vincent and the Grenadines
  - WS: Samoa
  - SM: San Marino
  - ST: Sao Tome and Principe
  - SA: Saudi Arabia
  - SN: Senegal
  - RS: Serbia
  - SC: Seychelles
  - SL: Sierra Leone
  - SG: Singapore
  - SX: Sint Maarten (Dutch part)
  - SK: Slovakia
  - SI: Slovenia
  - SB: Solomon Islands
  - SO: Somalia
  - ZA: South Africa
  - GS: South Georgia and the South Sandwich Islands
  - SS: South Sudan
  - ES: Spain
  - LK: Sri Lanka
  - SD: Sudan
  - SR: Suriname
  - SJ: Svalbard and Jan Mayen
  - SZ: Swaziland
  - SE: Sweden
  - CH: Switzerland
  - SY: Syrian Arab Republic
  - TW: Taiwan, Province of China
  - TJ: Tajikistan
  - TZ: Tanzania, United Republic of
  - TH: Thailand
  - TL: Timor-Leste
  - TG: Togo
  - TK: Tokelau
  - TO: Tonga
  - TT: Trinidad and Tobago
  - TN: Tunisia
  - TR: Turkey
  - TM: Turkmenistan
  - TC: Turks and Caicos Islands
  - TV: Tuvalu
  - UG: Uganda
  - UA: Ukraine
  - AE: United Arab Emirates
  - GB: United Kingdom of Great Britain and Northern Ireland
  - US: United States of America
  - UM: United States Minor Outlying Islands
  - UY: Uruguay
  - UZ: Uzbekistan
  - VU: Vanuatu
  - VE: Venezuela (Bolivarian Republic of)
  - VN: Viet Nam
  - VG: Virgin Islands (British)
  - VI: Virgin Islands (U.S.)
  - WF: Wallis and Futuna
  - EH: Western Sahara
  - YE: Yemen
  - ZM: Zambia
  - ZW: Zimbabwe
- statestringoptional
- street1stringoptional
- street2stringoptional
- user_idstringoptional
- zipstringoptional
balancenumberUSD Priceoptional
created_atstringISO-8601optional
currencystringoptional
Possible values
139 possible values
- aed: United Arab Emirates Dirham
- afn: Afghan Afghani
- all: Albanian Lek
- amd: Armenian Dram
- ang: Netherlands Antillean Gulden
- aoa: Angolan Kwanza
- ars: Argentine Peso
- aud: Australian Dollar
- awg: Aruban Florin
- azn: Azerbaijani Manat
- bam: Bosnia & Herzegovina Convertible Mark
- bbd: Barbadian Dollar
- bdt: Bangladeshi Taka
- bgn: Bulgarian Lev
- bif: Burundian Franc
- bmd: Bermudian Dollar
- bnd: Brunei Dollar
- bob: Bolivian Boliviano
- brl: Brazilian Real
- bsd: Bahamian Dollar
- bwp: Botswana Pula
- bzd: Belize Dollar
- cad: Canadian Dollar
- cdf: Congolese Franc
- chf: Swiss Franc
- clp: Chilean Peso
- cny: Chinese Renminbi Yuan
- cop: Colombian Peso
- crc: Costa Rican Colón
- cve: Cape Verdean Escudo
- czk: Czech Koruna
- djf: Djiboutian Franc
- dkk: Danish Krone
- dop: Dominican Peso
- dzd: Algerian Dinar
- eek: Estonian Kroon
- egp: Egyptian Pound
- etb: Ethiopian Birr
- eur: Euro
- fjd: Fijian Dollar
- fkp: Falkland Islands Pound
- gbp: British Pound
- gel: Georgian Lari
- gip: Gibraltar Pound
- gmd: Gambian Dalasi
- gnf: Guinean Franc
- gtq: Guatemalan Quetzal
- gyd: Guyanese Dollar
- hkd: Hong Kong Dollar
- hnl: Honduran Lempira
- hrk: Croatian Kuna
- htg: Haitian Gourde
- huf: Hungarian Forint
- idr: Indonesian Rupiah
- ils: Israeli New Sheqel
- inr: Indian Rupee
- isk: Icelandic Króna
- jmd: Jamaican Dollar
- jpy: Japanese Yen
- kes: Kenyan Shilling
- kgs: Kyrgyzstani Som
- khr: Cambodian Riel
- kmf: Comorian Franc
- krw: South Korean Won
- kyd: Cayman Islands Dollar
- kzt: Kazakhstani Tenge
- lak: Lao Kip
- lbp: Lebanese Pound
- lkr: Sri Lankan Rupee
- lrd: Liberian Dollar
- lsl: Lesotho Loti
- ltl: Lithuanian Litas
- lvl: Latvian Lats
- mad: Moroccan Dirham
- mdl: Moldovan Leu
- mga: Malagasy Ariary
- mkd: Macedonian Denar
- mnt: Mongolian Tögrög
- mop: Macanese Pataca
- mro: Mauritanian Ouguiya
- mur: Mauritian Rupee
- mvr: Maldivian Rufiyaa
- mwk: Malawian Kwacha
- mxn: Mexican Peso
- myr: Malaysian Ringgit
- mzn: Mozambican Metical
- nad: Namibian Dollar
- ngn: Nigerian Naira
- nio: Nicaraguan Córdoba
- nok: Norwegian Krone
- npr: Nepalese Rupee
- nzd: New Zealand Dollar
- pab: Panamanian Balboa
- pen: Peruvian Nuevo Sol
- pgk: Papua New Guinean Kina
- php: Philippine Peso
- pkr: Pakistani Rupee
- pln: Polish Złoty
- pyg: Paraguayan Guaraní
- qar: Qatari Riyal
- ron: Romanian Leu
- rsd: Serbian Dinar
- rub: Russian Ruble
- rwf: Rwandan Franc
- sar: Saudi Riyal
- sbd: Solomon Islands Dollar
- scr: Seychellois Rupee
- sek: Swedish Krona
- sgd: Singapore Dollar
- shp: Saint Helenian Pound
- sll: Sierra Leonean Leone
- sos: Somali Shilling
- srd: Surinamese Dollar
- std: São Tomé and Príncipe Dobra
- svc: Salvadoran Colón
- szl: Swazi Lilangeni
- thb: Thai Baht
- tjs: Tajikistani Somoni
- top: Tongan Paʻanga
- try: Turkish Lira
- ttd: Trinidad and Tobago Dollar
- twd: New Taiwan Dollar
- tzs: Tanzanian Shilling
- uah: Ukrainian Hryvnia
- ugx: Ugandan Shilling
- usd: United States Dollar
- uyu: Uruguayan Peso
- uzs: Uzbekistani Som
- vef: Venezuelan Bolívar
- vnd: Vietnamese Đồng
- vuv: Vanuatu Vatu
- wst: Samoan Tala
- xaf: Central African Cfa Franc
- xcd: East Caribbean Dollar
- xof: West African Cfa Franc
- xpf: Cfp Franc
- yer: Yemeni Rial
- zar: South African Rand
- zmw: Zambian Kwacha
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": "4Be9l",
    "country": "SL",
    "state": "QhiJS26R39p2uY0LqwBGVFZRMne",
    "street1": "b",
    "street2": "Pb4icV1G5KtQd5T",
    "user_id": "rID3PS0l7lnS2e",
    "zip": "G73P0M9BtG8"
  },
  "balance": "46.91",
  "created_at": "2023-06-02T19:34:24.425Z",
  "currency": "nzd",
  "delinquent": false,
  "email": "Vq@ok.com",
  "id": "V7Kd4V18R02TE",
  "metadata": {},
  "name": "1PcJd0jIh2HSzB",
  "phone": "+1-398-227-9903"
}

Create payment info for your user

Parameters

bodyapplication/jsonobjectoptional
Object
- addressobjectoptional
  Object
  - citystringoptional
  - countrystringoptional
    Possible values
    249 possible values
    - AF: Afghanistan
    - AX: Åland Islands
    - AL: Albania
    - DZ: Algeria
    - AS: American Samoa
    - AD: Andorra
    - AO: Angola
    - AI: Anguilla
    - AQ: Antarctica
    - AG: Antigua and Barbuda
    - AR: Argentina
    - AM: Armenia
    - AW: Aruba
    - AU: Australia
    - AT: Austria
    - AZ: Azerbaijan
    - BS: Bahamas
    - BH: Bahrain
    - BD: Bangladesh
    - BB: Barbados
    - BY: Belarus
    - BE: Belgium
    - BZ: Belize
    - BJ: Benin
    - BM: Bermuda
    - BT: Bhutan
    - BO: Bolivia (Plurinational State of)
    - BQ: Bonaire, Sint Eustatius and Saba
    - BA: Bosnia and Herzegovina
    - BW: Botswana
    - BV: Bouvet Island
    - BR: Brazil
    - IO: British Indian Ocean Territory
    - BN: Brunei Darussalam
    - BG: Bulgaria
    - BF: Burkina Faso
    - BI: Burundi
    - CV: Cabo Verde
    - KH: Cambodia
    - CM: Cameroon
    - CA: Canada
    - KY: Cayman Islands
    - CF: Central African Republic
    - TD: Chad
    - CL: Chile
    - CN: China
    - CX: Christmas Island
    - CC: Cocos (Keeling) Islands
    - CO: Colombia
    - KM: Comoros
    - CG: Congo
    - CD: Congo (Democratic Republic of the)
    - CK: Cook Islands
    - CR: Costa Rica
    - CI: Côte d'Ivoire
    - HR: Croatia
    - CU: Cuba
    - CW: Curaçao
    - CY: Cyprus
    - CZ: Czechia
    - DK: Denmark
    - DJ: Djibouti
    - DM: Dominica
    - DO: Dominican Republic
    - EC: Ecuador
    - EG: Egypt
    - SV: El Salvador
    - GQ: Equatorial Guinea
    - ER: Eritrea
    - EE: Estonia
    - ET: Ethiopia
    - FK: Falkland Islands (Malvinas)
    - FO: Faroe Islands
    - FJ: Fiji
    - FI: Finland
    - FR: France
    - GF: French Guiana
    - PF: French Polynesia
    - TF: French Southern Territories
    - GA: Gabon
    - GM: Gambia
    - GE: Georgia
    - DE: Germany
    - GH: Ghana
    - GI: Gibraltar
    - GR: Greece
    - GL: Greenland
    - GD: Grenada
    - GP: Guadeloupe
    - GU: Guam
    - GT: Guatemala
    - GG: Guernsey
    - GN: Guinea
    - GW: Guinea-Bissau
    - GY: Guyana
    - HT: Haiti
    - HM: Heard Island and McDonald Islands
    - VA: Holy See
    - HN: Honduras
    - HK: Hong Kong
    - HU: Hungary
    - IS: Iceland
    - IN: India
    - ID: Indonesia
    - IR: Iran (Islamic Republic of)
    - IQ: Iraq
    - IE: Ireland
    - IM: Isle of Man
    - IL: Israel
    - IT: Italy
    - JM: Jamaica
    - JP: Japan
    - JE: Jersey
    - JO: Jordan
    - KZ: Kazakhstan
    - KE: Kenya
    - KI: Kiribati
    - KP: Korea (Democratic People's Republic of)
    - KR: Korea (Republic of)
    - KW: Kuwait
    - KG: Kyrgyzstan
    - LA: Lao People's Democratic Republic
    - LV: Latvia
    - LB: Lebanon
    - LS: Lesotho
    - LR: Liberia
    - LY: Libya
    - LI: Liechtenstein
    - LT: Lithuania
    - LU: Luxembourg
    - MO: Macao
    - MK: Macedonia (the former Yugoslav Republic of)
    - MG: Madagascar
    - MW: Malawi
    - MY: Malaysia
    - MV: Maldives
    - ML: Mali
    - MT: Malta
    - MH: Marshall Islands
    - MQ: Martinique
    - MR: Mauritania
    - MU: Mauritius
    - YT: Mayotte
    - MX: Mexico
    - FM: Micronesia (Federated States of)
    - MD: Moldova (Republic of)
    - MC: Monaco
    - MN: Mongolia
    - ME: Montenegro
    - MS: Montserrat
    - MA: Morocco
    - MZ: Mozambique
    - MM: Myanmar
    - NA: Namibia
    - NR: Nauru
    - NP: Nepal
    - NL: Netherlands
    - NC: New Caledonia
    - NZ: New Zealand
    - NI: Nicaragua
    - NE: Niger
    - NG: Nigeria
    - NU: Niue
    - NF: Norfolk Island
    - MP: Northern Mariana Islands
    - NO: Norway
    - OM: Oman
    - PK: Pakistan
    - PW: Palau
    - PS: Palestine, State of
    - PA: Panama
    - PG: Papua New Guinea
    - PY: Paraguay
    - PE: Peru
    - PH: Philippines
    - PN: Pitcairn
    - PL: Poland
    - PT: Portugal
    - PR: Puerto Rico
    - QA: Qatar
    - RE: Réunion
    - RO: Romania
    - RU: Russian Federation
    - RW: Rwanda
    - BL: Saint Barthélemy
    - SH: Saint Helena, Ascension and Tristan da Cunha
    - KN: Saint Kitts and Nevis
    - LC: Saint Lucia
    - MF: Saint Martin (French part)
    - PM: Saint Pierre and Miquelon
    - VC: Saint Vincent and the Grenadines
    - WS: Samoa
    - SM: San Marino
    - ST: Sao Tome and Principe
    - SA: Saudi Arabia
    - SN: Senegal
    - RS: Serbia
    - SC: Seychelles
    - SL: Sierra Leone
    - SG: Singapore
    - SX: Sint Maarten (Dutch part)
    - SK: Slovakia
    - SI: Slovenia
    - SB: Solomon Islands
    - SO: Somalia
    - ZA: South Africa
    - GS: South Georgia and the South Sandwich Islands
    - SS: South Sudan
    - ES: Spain
    - LK: Sri Lanka
    - SD: Sudan
    - SR: Suriname
    - SJ: Svalbard and Jan Mayen
    - SZ: Swaziland
    - SE: Sweden
    - CH: Switzerland
    - SY: Syrian Arab Republic
    - TW: Taiwan, Province of China
    - TJ: Tajikistan
    - TZ: Tanzania, United Republic of
    - TH: Thailand
    - TL: Timor-Leste
    - TG: Togo
    - TK: Tokelau
    - TO: Tonga
    - TT: Trinidad and Tobago
    - TN: Tunisia
    - TR: Turkey
    - TM: Turkmenistan
    - TC: Turks and Caicos Islands
    - TV: Tuvalu
    - UG: Uganda
    - UA: Ukraine
    - AE: United Arab Emirates
    - GB: United Kingdom of Great Britain and Northern Ireland
    - US: United States of America
    - UM: United States Minor Outlying Islands
    - UY: Uruguay
    - UZ: Uzbekistan
    - VU: Vanuatu
    - VE: Venezuela (Bolivarian Republic of)
    - VN: Viet Nam
    - VG: Virgin Islands (British)
    - VI: Virgin Islands (U.S.)
    - WF: Wallis and Futuna
    - EH: Western Sahara
    - YE: Yemen
    - ZM: Zambia
    - ZW: Zimbabwe
  - statestringoptional
  - street1stringoptional
  - street2stringoptional
  - user_idstringoptional
  - zipstringoptional
- namestringoptional
- phonestringPhone Numberoptional

Returns

201 Created

successful creation

addressobjectoptional
Object
- citystringoptional
- countrystringoptional
  Possible values
  249 possible values
  - AF: Afghanistan
  - AX: Åland Islands
  - AL: Albania
  - DZ: Algeria
  - AS: American Samoa
  - AD: Andorra
  - AO: Angola
  - AI: Anguilla
  - AQ: Antarctica
  - AG: Antigua and Barbuda
  - AR: Argentina
  - AM: Armenia
  - AW: Aruba
  - AU: Australia
  - AT: Austria
  - AZ: Azerbaijan
  - BS: Bahamas
  - BH: Bahrain
  - BD: Bangladesh
  - BB: Barbados
  - BY: Belarus
  - BE: Belgium
  - BZ: Belize
  - BJ: Benin
  - BM: Bermuda
  - BT: Bhutan
  - BO: Bolivia (Plurinational State of)
  - BQ: Bonaire, Sint Eustatius and Saba
  - BA: Bosnia and Herzegovina
  - BW: Botswana
  - BV: Bouvet Island
  - BR: Brazil
  - IO: British Indian Ocean Territory
  - BN: Brunei Darussalam
  - BG: Bulgaria
  - BF: Burkina Faso
  - BI: Burundi
  - CV: Cabo Verde
  - KH: Cambodia
  - CM: Cameroon
  - CA: Canada
  - KY: Cayman Islands
  - CF: Central African Republic
  - TD: Chad
  - CL: Chile
  - CN: China
  - CX: Christmas Island
  - CC: Cocos (Keeling) Islands
  - CO: Colombia
  - KM: Comoros
  - CG: Congo
  - CD: Congo (Democratic Republic of the)
  - CK: Cook Islands
  - CR: Costa Rica
  - CI: Côte d'Ivoire
  - HR: Croatia
  - CU: Cuba
  - CW: Curaçao
  - CY: Cyprus
  - CZ: Czechia
  - DK: Denmark
  - DJ: Djibouti
  - DM: Dominica
  - DO: Dominican Republic
  - EC: Ecuador
  - EG: Egypt
  - SV: El Salvador
  - GQ: Equatorial Guinea
  - ER: Eritrea
  - EE: Estonia
  - ET: Ethiopia
  - FK: Falkland Islands (Malvinas)
  - FO: Faroe Islands
  - FJ: Fiji
  - FI: Finland
  - FR: France
  - GF: French Guiana
  - PF: French Polynesia
  - TF: French Southern Territories
  - GA: Gabon
  - GM: Gambia
  - GE: Georgia
  - DE: Germany
  - GH: Ghana
  - GI: Gibraltar
  - GR: Greece
  - GL: Greenland
  - GD: Grenada
  - GP: Guadeloupe
  - GU: Guam
  - GT: Guatemala
  - GG: Guernsey
  - GN: Guinea
  - GW: Guinea-Bissau
  - GY: Guyana
  - HT: Haiti
  - HM: Heard Island and McDonald Islands
  - VA: Holy See
  - HN: Honduras
  - HK: Hong Kong
  - HU: Hungary
  - IS: Iceland
  - IN: India
  - ID: Indonesia
  - IR: Iran (Islamic Republic of)
  - IQ: Iraq
  - IE: Ireland
  - IM: Isle of Man
  - IL: Israel
  - IT: Italy
  - JM: Jamaica
  - JP: Japan
  - JE: Jersey
  - JO: Jordan
  - KZ: Kazakhstan
  - KE: Kenya
  - KI: Kiribati
  - KP: Korea (Democratic People's Republic of)
  - KR: Korea (Republic of)
  - KW: Kuwait
  - KG: Kyrgyzstan
  - LA: Lao People's Democratic Republic
  - LV: Latvia
  - LB: Lebanon
  - LS: Lesotho
  - LR: Liberia
  - LY: Libya
  - LI: Liechtenstein
  - LT: Lithuania
  - LU: Luxembourg
  - MO: Macao
  - MK: Macedonia (the former Yugoslav Republic of)
  - MG: Madagascar
  - MW: Malawi
  - MY: Malaysia
  - MV: Maldives
  - ML: Mali
  - MT: Malta
  - MH: Marshall Islands
  - MQ: Martinique
  - MR: Mauritania
  - MU: Mauritius
  - YT: Mayotte
  - MX: Mexico
  - FM: Micronesia (Federated States of)
  - MD: Moldova (Republic of)
  - MC: Monaco
  - MN: Mongolia
  - ME: Montenegro
  - MS: Montserrat
  - MA: Morocco
  - MZ: Mozambique
  - MM: Myanmar
  - NA: Namibia
  - NR: Nauru
  - NP: Nepal
  - NL: Netherlands
  - NC: New Caledonia
  - NZ: New Zealand
  - NI: Nicaragua
  - NE: Niger
  - NG: Nigeria
  - NU: Niue
  - NF: Norfolk Island
  - MP: Northern Mariana Islands
  - NO: Norway
  - OM: Oman
  - PK: Pakistan
  - PW: Palau
  - PS: Palestine, State of
  - PA: Panama
  - PG: Papua New Guinea
  - PY: Paraguay
  - PE: Peru
  - PH: Philippines
  - PN: Pitcairn
  - PL: Poland
  - PT: Portugal
  - PR: Puerto Rico
  - QA: Qatar
  - RE: Réunion
  - RO: Romania
  - RU: Russian Federation
  - RW: Rwanda
  - BL: Saint Barthélemy
  - SH: Saint Helena, Ascension and Tristan da Cunha
  - KN: Saint Kitts and Nevis
  - LC: Saint Lucia
  - MF: Saint Martin (French part)
  - PM: Saint Pierre and Miquelon
  - VC: Saint Vincent and the Grenadines
  - WS: Samoa
  - SM: San Marino
  - ST: Sao Tome and Principe
  - SA: Saudi Arabia
  - SN: Senegal
  - RS: Serbia
  - SC: Seychelles
  - SL: Sierra Leone
  - SG: Singapore
  - SX: Sint Maarten (Dutch part)
  - SK: Slovakia
  - SI: Slovenia
  - SB: Solomon Islands
  - SO: Somalia
  - ZA: South Africa
  - GS: South Georgia and the South Sandwich Islands
  - SS: South Sudan
  - ES: Spain
  - LK: Sri Lanka
  - SD: Sudan
  - SR: Suriname
  - SJ: Svalbard and Jan Mayen
  - SZ: Swaziland
  - SE: Sweden
  - CH: Switzerland
  - SY: Syrian Arab Republic
  - TW: Taiwan, Province of China
  - TJ: Tajikistan
  - TZ: Tanzania, United Republic of
  - TH: Thailand
  - TL: Timor-Leste
  - TG: Togo
  - TK: Tokelau
  - TO: Tonga
  - TT: Trinidad and Tobago
  - TN: Tunisia
  - TR: Turkey
  - TM: Turkmenistan
  - TC: Turks and Caicos Islands
  - TV: Tuvalu
  - UG: Uganda
  - UA: Ukraine
  - AE: United Arab Emirates
  - GB: United Kingdom of Great Britain and Northern Ireland
  - US: United States of America
  - UM: United States Minor Outlying Islands
  - UY: Uruguay
  - UZ: Uzbekistan
  - VU: Vanuatu
  - VE: Venezuela (Bolivarian Republic of)
  - VN: Viet Nam
  - VG: Virgin Islands (British)
  - VI: Virgin Islands (U.S.)
  - WF: Wallis and Futuna
  - EH: Western Sahara
  - YE: Yemen
  - ZM: Zambia
  - ZW: Zimbabwe
- statestringoptional
- street1stringoptional
- street2stringoptional
- user_idstringoptional
- zipstringoptional
balancenumberUSD Priceoptional
created_atstringISO-8601optional
currencystringoptional
Possible values
139 possible values
- aed: United Arab Emirates Dirham
- afn: Afghan Afghani
- all: Albanian Lek
- amd: Armenian Dram
- ang: Netherlands Antillean Gulden
- aoa: Angolan Kwanza
- ars: Argentine Peso
- aud: Australian Dollar
- awg: Aruban Florin
- azn: Azerbaijani Manat
- bam: Bosnia & Herzegovina Convertible Mark
- bbd: Barbadian Dollar
- bdt: Bangladeshi Taka
- bgn: Bulgarian Lev
- bif: Burundian Franc
- bmd: Bermudian Dollar
- bnd: Brunei Dollar
- bob: Bolivian Boliviano
- brl: Brazilian Real
- bsd: Bahamian Dollar
- bwp: Botswana Pula
- bzd: Belize Dollar
- cad: Canadian Dollar
- cdf: Congolese Franc
- chf: Swiss Franc
- clp: Chilean Peso
- cny: Chinese Renminbi Yuan
- cop: Colombian Peso
- crc: Costa Rican Colón
- cve: Cape Verdean Escudo
- czk: Czech Koruna
- djf: Djiboutian Franc
- dkk: Danish Krone
- dop: Dominican Peso
- dzd: Algerian Dinar
- eek: Estonian Kroon
- egp: Egyptian Pound
- etb: Ethiopian Birr
- eur: Euro
- fjd: Fijian Dollar
- fkp: Falkland Islands Pound
- gbp: British Pound
- gel: Georgian Lari
- gip: Gibraltar Pound
- gmd: Gambian Dalasi
- gnf: Guinean Franc
- gtq: Guatemalan Quetzal
- gyd: Guyanese Dollar
- hkd: Hong Kong Dollar
- hnl: Honduran Lempira
- hrk: Croatian Kuna
- htg: Haitian Gourde
- huf: Hungarian Forint
- idr: Indonesian Rupiah
- ils: Israeli New Sheqel
- inr: Indian Rupee
- isk: Icelandic Króna
- jmd: Jamaican Dollar
- jpy: Japanese Yen
- kes: Kenyan Shilling
- kgs: Kyrgyzstani Som
- khr: Cambodian Riel
- kmf: Comorian Franc
- krw: South Korean Won
- kyd: Cayman Islands Dollar
- kzt: Kazakhstani Tenge
- lak: Lao Kip
- lbp: Lebanese Pound
- lkr: Sri Lankan Rupee
- lrd: Liberian Dollar
- lsl: Lesotho Loti
- ltl: Lithuanian Litas
- lvl: Latvian Lats
- mad: Moroccan Dirham
- mdl: Moldovan Leu
- mga: Malagasy Ariary
- mkd: Macedonian Denar
- mnt: Mongolian Tögrög
- mop: Macanese Pataca
- mro: Mauritanian Ouguiya
- mur: Mauritian Rupee
- mvr: Maldivian Rufiyaa
- mwk: Malawian Kwacha
- mxn: Mexican Peso
- myr: Malaysian Ringgit
- mzn: Mozambican Metical
- nad: Namibian Dollar
- ngn: Nigerian Naira
- nio: Nicaraguan Córdoba
- nok: Norwegian Krone
- npr: Nepalese Rupee
- nzd: New Zealand Dollar
- pab: Panamanian Balboa
- pen: Peruvian Nuevo Sol
- pgk: Papua New Guinean Kina
- php: Philippine Peso
- pkr: Pakistani Rupee
- pln: Polish Złoty
- pyg: Paraguayan Guaraní
- qar: Qatari Riyal
- ron: Romanian Leu
- rsd: Serbian Dinar
- rub: Russian Ruble
- rwf: Rwandan Franc
- sar: Saudi Riyal
- sbd: Solomon Islands Dollar
- scr: Seychellois Rupee
- sek: Swedish Krona
- sgd: Singapore Dollar
- shp: Saint Helenian Pound
- sll: Sierra Leonean Leone
- sos: Somali Shilling
- srd: Surinamese Dollar
- std: São Tomé and Príncipe Dobra
- svc: Salvadoran Colón
- szl: Swazi Lilangeni
- thb: Thai Baht
- tjs: Tajikistani Somoni
- top: Tongan Paʻanga
- try: Turkish Lira
- ttd: Trinidad and Tobago Dollar
- twd: New Taiwan Dollar
- tzs: Tanzanian Shilling
- uah: Ukrainian Hryvnia
- ugx: Ugandan Shilling
- usd: United States Dollar
- uyu: Uruguayan Peso
- uzs: Uzbekistani Som
- vef: Venezuelan Bolívar
- vnd: Vietnamese Đồng
- vuv: Vanuatu Vatu
- wst: Samoan Tala
- xaf: Central African Cfa Franc
- xcd: East Caribbean Dollar
- xof: West African Cfa Franc
- xpf: Cfp Franc
- yer: Yemeni Rial
- zar: South African Rand
- zmw: Zambian Kwacha
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": "J0mRcYoOn",
    "country": "BR",
    "state": "T9h",
    "street1": "",
    "street2": "N4M1cdiIwFm52azioHpawcsGHVv5W",
    "user_id": "8epE9qCPjYB9dAoGqbrt8Dl",
    "zip": "YQGQfphNbiNPbZjGZu5edKg"
  },
  "name": "6bS2bW8lY",
  "phone": "+1-936-111-2427"
}'

201 Created

Response

{
  "address": {
    "city": "Y9PheqXhI",
    "country": "IN",
    "state": "Qd9E6PAohCiLDftov",
    "street1": "3u0bUAgGhCJ1FlCqsH0d",
    "street2": "pgOU1hFX7kfwBUEqywuo",
    "user_id": "",
    "zip": "vnUUKZc8q8k18fWlyEgdNLM3keB8PP"
  },
  "balance": "94.26",
  "created_at": "2023-06-02T19:34:24.453Z",
  "currency": "egp",
  "delinquent": false,
  "email": "Qyt6eb8l@Umulgz.com",
  "id": "mgKkRDgpHFWw5hP",
  "metadata": {},
  "name": "iizKAfhHCHZfoKGzgm0WydHQ",
  "phone": "+1-772-325-8470"
}

Update payment info for your user

Parameters

bodyapplication/jsonobjectoptional
Object
- addressobjectoptional
  Object
  - citystringoptional
  - countrystringoptional
    Possible values
    249 possible values
    - AF: Afghanistan
    - AX: Åland Islands
    - AL: Albania
    - DZ: Algeria
    - AS: American Samoa
    - AD: Andorra
    - AO: Angola
    - AI: Anguilla
    - AQ: Antarctica
    - AG: Antigua and Barbuda
    - AR: Argentina
    - AM: Armenia
    - AW: Aruba
    - AU: Australia
    - AT: Austria
    - AZ: Azerbaijan
    - BS: Bahamas
    - BH: Bahrain
    - BD: Bangladesh
    - BB: Barbados
    - BY: Belarus
    - BE: Belgium
    - BZ: Belize
    - BJ: Benin
    - BM: Bermuda
    - BT: Bhutan
    - BO: Bolivia (Plurinational State of)
    - BQ: Bonaire, Sint Eustatius and Saba
    - BA: Bosnia and Herzegovina
    - BW: Botswana
    - BV: Bouvet Island
    - BR: Brazil
    - IO: British Indian Ocean Territory
    - BN: Brunei Darussalam
    - BG: Bulgaria
    - BF: Burkina Faso
    - BI: Burundi
    - CV: Cabo Verde
    - KH: Cambodia
    - CM: Cameroon
    - CA: Canada
    - KY: Cayman Islands
    - CF: Central African Republic
    - TD: Chad
    - CL: Chile
    - CN: China
    - CX: Christmas Island
    - CC: Cocos (Keeling) Islands
    - CO: Colombia
    - KM: Comoros
    - CG: Congo
    - CD: Congo (Democratic Republic of the)
    - CK: Cook Islands
    - CR: Costa Rica
    - CI: Côte d'Ivoire
    - HR: Croatia
    - CU: Cuba
    - CW: Curaçao
    - CY: Cyprus
    - CZ: Czechia
    - DK: Denmark
    - DJ: Djibouti
    - DM: Dominica
    - DO: Dominican Republic
    - EC: Ecuador
    - EG: Egypt
    - SV: El Salvador
    - GQ: Equatorial Guinea
    - ER: Eritrea
    - EE: Estonia
    - ET: Ethiopia
    - FK: Falkland Islands (Malvinas)
    - FO: Faroe Islands
    - FJ: Fiji
    - FI: Finland
    - FR: France
    - GF: French Guiana
    - PF: French Polynesia
    - TF: French Southern Territories
    - GA: Gabon
    - GM: Gambia
    - GE: Georgia
    - DE: Germany
    - GH: Ghana
    - GI: Gibraltar
    - GR: Greece
    - GL: Greenland
    - GD: Grenada
    - GP: Guadeloupe
    - GU: Guam
    - GT: Guatemala
    - GG: Guernsey
    - GN: Guinea
    - GW: Guinea-Bissau
    - GY: Guyana
    - HT: Haiti
    - HM: Heard Island and McDonald Islands
    - VA: Holy See
    - HN: Honduras
    - HK: Hong Kong
    - HU: Hungary
    - IS: Iceland
    - IN: India
    - ID: Indonesia
    - IR: Iran (Islamic Republic of)
    - IQ: Iraq
    - IE: Ireland
    - IM: Isle of Man
    - IL: Israel
    - IT: Italy
    - JM: Jamaica
    - JP: Japan
    - JE: Jersey
    - JO: Jordan
    - KZ: Kazakhstan
    - KE: Kenya
    - KI: Kiribati
    - KP: Korea (Democratic People's Republic of)
    - KR: Korea (Republic of)
    - KW: Kuwait
    - KG: Kyrgyzstan
    - LA: Lao People's Democratic Republic
    - LV: Latvia
    - LB: Lebanon
    - LS: Lesotho
    - LR: Liberia
    - LY: Libya
    - LI: Liechtenstein
    - LT: Lithuania
    - LU: Luxembourg
    - MO: Macao
    - MK: Macedonia (the former Yugoslav Republic of)
    - MG: Madagascar
    - MW: Malawi
    - MY: Malaysia
    - MV: Maldives
    - ML: Mali
    - MT: Malta
    - MH: Marshall Islands
    - MQ: Martinique
    - MR: Mauritania
    - MU: Mauritius
    - YT: Mayotte
    - MX: Mexico
    - FM: Micronesia (Federated States of)
    - MD: Moldova (Republic of)
    - MC: Monaco
    - MN: Mongolia
    - ME: Montenegro
    - MS: Montserrat
    - MA: Morocco
    - MZ: Mozambique
    - MM: Myanmar
    - NA: Namibia
    - NR: Nauru
    - NP: Nepal
    - NL: Netherlands
    - NC: New Caledonia
    - NZ: New Zealand
    - NI: Nicaragua
    - NE: Niger
    - NG: Nigeria
    - NU: Niue
    - NF: Norfolk Island
    - MP: Northern Mariana Islands
    - NO: Norway
    - OM: Oman
    - PK: Pakistan
    - PW: Palau
    - PS: Palestine, State of
    - PA: Panama
    - PG: Papua New Guinea
    - PY: Paraguay
    - PE: Peru
    - PH: Philippines
    - PN: Pitcairn
    - PL: Poland
    - PT: Portugal
    - PR: Puerto Rico
    - QA: Qatar
    - RE: Réunion
    - RO: Romania
    - RU: Russian Federation
    - RW: Rwanda
    - BL: Saint Barthélemy
    - SH: Saint Helena, Ascension and Tristan da Cunha
    - KN: Saint Kitts and Nevis
    - LC: Saint Lucia
    - MF: Saint Martin (French part)
    - PM: Saint Pierre and Miquelon
    - VC: Saint Vincent and the Grenadines
    - WS: Samoa
    - SM: San Marino
    - ST: Sao Tome and Principe
    - SA: Saudi Arabia
    - SN: Senegal
    - RS: Serbia
    - SC: Seychelles
    - SL: Sierra Leone
    - SG: Singapore
    - SX: Sint Maarten (Dutch part)
    - SK: Slovakia
    - SI: Slovenia
    - SB: Solomon Islands
    - SO: Somalia
    - ZA: South Africa
    - GS: South Georgia and the South Sandwich Islands
    - SS: South Sudan
    - ES: Spain
    - LK: Sri Lanka
    - SD: Sudan
    - SR: Suriname
    - SJ: Svalbard and Jan Mayen
    - SZ: Swaziland
    - SE: Sweden
    - CH: Switzerland
    - SY: Syrian Arab Republic
    - TW: Taiwan, Province of China
    - TJ: Tajikistan
    - TZ: Tanzania, United Republic of
    - TH: Thailand
    - TL: Timor-Leste
    - TG: Togo
    - TK: Tokelau
    - TO: Tonga
    - TT: Trinidad and Tobago
    - TN: Tunisia
    - TR: Turkey
    - TM: Turkmenistan
    - TC: Turks and Caicos Islands
    - TV: Tuvalu
    - UG: Uganda
    - UA: Ukraine
    - AE: United Arab Emirates
    - GB: United Kingdom of Great Britain and Northern Ireland
    - US: United States of America
    - UM: United States Minor Outlying Islands
    - UY: Uruguay
    - UZ: Uzbekistan
    - VU: Vanuatu
    - VE: Venezuela (Bolivarian Republic of)
    - VN: Viet Nam
    - VG: Virgin Islands (British)
    - VI: Virgin Islands (U.S.)
    - WF: Wallis and Futuna
    - EH: Western Sahara
    - YE: Yemen
    - ZM: Zambia
    - ZW: Zimbabwe
  - statestringoptional
  - street1stringoptional
  - street2stringoptional
  - user_idstringoptional
  - zipstringoptional
- namestringoptional
- phonestringPhone Numberoptional

Returns

200 OK

successful operation

addressobjectoptional
Object
- citystringoptional
- countrystringoptional
  Possible values
  249 possible values
  - AF: Afghanistan
  - AX: Åland Islands
  - AL: Albania
  - DZ: Algeria
  - AS: American Samoa
  - AD: Andorra
  - AO: Angola
  - AI: Anguilla
  - AQ: Antarctica
  - AG: Antigua and Barbuda
  - AR: Argentina
  - AM: Armenia
  - AW: Aruba
  - AU: Australia
  - AT: Austria
  - AZ: Azerbaijan
  - BS: Bahamas
  - BH: Bahrain
  - BD: Bangladesh
  - BB: Barbados
  - BY: Belarus
  - BE: Belgium
  - BZ: Belize
  - BJ: Benin
  - BM: Bermuda
  - BT: Bhutan
  - BO: Bolivia (Plurinational State of)
  - BQ: Bonaire, Sint Eustatius and Saba
  - BA: Bosnia and Herzegovina
  - BW: Botswana
  - BV: Bouvet Island
  - BR: Brazil
  - IO: British Indian Ocean Territory
  - BN: Brunei Darussalam
  - BG: Bulgaria
  - BF: Burkina Faso
  - BI: Burundi
  - CV: Cabo Verde
  - KH: Cambodia
  - CM: Cameroon
  - CA: Canada
  - KY: Cayman Islands
  - CF: Central African Republic
  - TD: Chad
  - CL: Chile
  - CN: China
  - CX: Christmas Island
  - CC: Cocos (Keeling) Islands
  - CO: Colombia
  - KM: Comoros
  - CG: Congo
  - CD: Congo (Democratic Republic of the)
  - CK: Cook Islands
  - CR: Costa Rica
  - CI: Côte d'Ivoire
  - HR: Croatia
  - CU: Cuba
  - CW: Curaçao
  - CY: Cyprus
  - CZ: Czechia
  - DK: Denmark
  - DJ: Djibouti
  - DM: Dominica
  - DO: Dominican Republic
  - EC: Ecuador
  - EG: Egypt
  - SV: El Salvador
  - GQ: Equatorial Guinea
  - ER: Eritrea
  - EE: Estonia
  - ET: Ethiopia
  - FK: Falkland Islands (Malvinas)
  - FO: Faroe Islands
  - FJ: Fiji
  - FI: Finland
  - FR: France
  - GF: French Guiana
  - PF: French Polynesia
  - TF: French Southern Territories
  - GA: Gabon
  - GM: Gambia
  - GE: Georgia
  - DE: Germany
  - GH: Ghana
  - GI: Gibraltar
  - GR: Greece
  - GL: Greenland
  - GD: Grenada
  - GP: Guadeloupe
  - GU: Guam
  - GT: Guatemala
  - GG: Guernsey
  - GN: Guinea
  - GW: Guinea-Bissau
  - GY: Guyana
  - HT: Haiti
  - HM: Heard Island and McDonald Islands
  - VA: Holy See
  - HN: Honduras
  - HK: Hong Kong
  - HU: Hungary
  - IS: Iceland
  - IN: India
  - ID: Indonesia
  - IR: Iran (Islamic Republic of)
  - IQ: Iraq
  - IE: Ireland
  - IM: Isle of Man
  - IL: Israel
  - IT: Italy
  - JM: Jamaica
  - JP: Japan
  - JE: Jersey
  - JO: Jordan
  - KZ: Kazakhstan
  - KE: Kenya
  - KI: Kiribati
  - KP: Korea (Democratic People's Republic of)
  - KR: Korea (Republic of)
  - KW: Kuwait
  - KG: Kyrgyzstan
  - LA: Lao People's Democratic Republic
  - LV: Latvia
  - LB: Lebanon
  - LS: Lesotho
  - LR: Liberia
  - LY: Libya
  - LI: Liechtenstein
  - LT: Lithuania
  - LU: Luxembourg
  - MO: Macao
  - MK: Macedonia (the former Yugoslav Republic of)
  - MG: Madagascar
  - MW: Malawi
  - MY: Malaysia
  - MV: Maldives
  - ML: Mali
  - MT: Malta
  - MH: Marshall Islands
  - MQ: Martinique
  - MR: Mauritania
  - MU: Mauritius
  - YT: Mayotte
  - MX: Mexico
  - FM: Micronesia (Federated States of)
  - MD: Moldova (Republic of)
  - MC: Monaco
  - MN: Mongolia
  - ME: Montenegro
  - MS: Montserrat
  - MA: Morocco
  - MZ: Mozambique
  - MM: Myanmar
  - NA: Namibia
  - NR: Nauru
  - NP: Nepal
  - NL: Netherlands
  - NC: New Caledonia
  - NZ: New Zealand
  - NI: Nicaragua
  - NE: Niger
  - NG: Nigeria
  - NU: Niue
  - NF: Norfolk Island
  - MP: Northern Mariana Islands
  - NO: Norway
  - OM: Oman
  - PK: Pakistan
  - PW: Palau
  - PS: Palestine, State of
  - PA: Panama
  - PG: Papua New Guinea
  - PY: Paraguay
  - PE: Peru
  - PH: Philippines
  - PN: Pitcairn
  - PL: Poland
  - PT: Portugal
  - PR: Puerto Rico
  - QA: Qatar
  - RE: Réunion
  - RO: Romania
  - RU: Russian Federation
  - RW: Rwanda
  - BL: Saint Barthélemy
  - SH: Saint Helena, Ascension and Tristan da Cunha
  - KN: Saint Kitts and Nevis
  - LC: Saint Lucia
  - MF: Saint Martin (French part)
  - PM: Saint Pierre and Miquelon
  - VC: Saint Vincent and the Grenadines
  - WS: Samoa
  - SM: San Marino
  - ST: Sao Tome and Principe
  - SA: Saudi Arabia
  - SN: Senegal
  - RS: Serbia
  - SC: Seychelles
  - SL: Sierra Leone
  - SG: Singapore
  - SX: Sint Maarten (Dutch part)
  - SK: Slovakia
  - SI: Slovenia
  - SB: Solomon Islands
  - SO: Somalia
  - ZA: South Africa
  - GS: South Georgia and the South Sandwich Islands
  - SS: South Sudan
  - ES: Spain
  - LK: Sri Lanka
  - SD: Sudan
  - SR: Suriname
  - SJ: Svalbard and Jan Mayen
  - SZ: Swaziland
  - SE: Sweden
  - CH: Switzerland
  - SY: Syrian Arab Republic
  - TW: Taiwan, Province of China
  - TJ: Tajikistan
  - TZ: Tanzania, United Republic of
  - TH: Thailand
  - TL: Timor-Leste
  - TG: Togo
  - TK: Tokelau
  - TO: Tonga
  - TT: Trinidad and Tobago
  - TN: Tunisia
  - TR: Turkey
  - TM: Turkmenistan
  - TC: Turks and Caicos Islands
  - TV: Tuvalu
  - UG: Uganda
  - UA: Ukraine
  - AE: United Arab Emirates
  - GB: United Kingdom of Great Britain and Northern Ireland
  - US: United States of America
  - UM: United States Minor Outlying Islands
  - UY: Uruguay
  - UZ: Uzbekistan
  - VU: Vanuatu
  - VE: Venezuela (Bolivarian Republic of)
  - VN: Viet Nam
  - VG: Virgin Islands (British)
  - VI: Virgin Islands (U.S.)
  - WF: Wallis and Futuna
  - EH: Western Sahara
  - YE: Yemen
  - ZM: Zambia
  - ZW: Zimbabwe
- statestringoptional
- street1stringoptional
- street2stringoptional
- user_idstringoptional
- zipstringoptional
balancenumberUSD Priceoptional
created_atstringISO-8601optional
currencystringoptional
Possible values
139 possible values
- aed: United Arab Emirates Dirham
- afn: Afghan Afghani
- all: Albanian Lek
- amd: Armenian Dram
- ang: Netherlands Antillean Gulden
- aoa: Angolan Kwanza
- ars: Argentine Peso
- aud: Australian Dollar
- awg: Aruban Florin
- azn: Azerbaijani Manat
- bam: Bosnia & Herzegovina Convertible Mark
- bbd: Barbadian Dollar
- bdt: Bangladeshi Taka
- bgn: Bulgarian Lev
- bif: Burundian Franc
- bmd: Bermudian Dollar
- bnd: Brunei Dollar
- bob: Bolivian Boliviano
- brl: Brazilian Real
- bsd: Bahamian Dollar
- bwp: Botswana Pula
- bzd: Belize Dollar
- cad: Canadian Dollar
- cdf: Congolese Franc
- chf: Swiss Franc
- clp: Chilean Peso
- cny: Chinese Renminbi Yuan
- cop: Colombian Peso
- crc: Costa Rican Colón
- cve: Cape Verdean Escudo
- czk: Czech Koruna
- djf: Djiboutian Franc
- dkk: Danish Krone
- dop: Dominican Peso
- dzd: Algerian Dinar
- eek: Estonian Kroon
- egp: Egyptian Pound
- etb: Ethiopian Birr
- eur: Euro
- fjd: Fijian Dollar
- fkp: Falkland Islands Pound
- gbp: British Pound
- gel: Georgian Lari
- gip: Gibraltar Pound
- gmd: Gambian Dalasi
- gnf: Guinean Franc
- gtq: Guatemalan Quetzal
- gyd: Guyanese Dollar
- hkd: Hong Kong Dollar
- hnl: Honduran Lempira
- hrk: Croatian Kuna
- htg: Haitian Gourde
- huf: Hungarian Forint
- idr: Indonesian Rupiah
- ils: Israeli New Sheqel
- inr: Indian Rupee
- isk: Icelandic Króna
- jmd: Jamaican Dollar
- jpy: Japanese Yen
- kes: Kenyan Shilling
- kgs: Kyrgyzstani Som
- khr: Cambodian Riel
- kmf: Comorian Franc
- krw: South Korean Won
- kyd: Cayman Islands Dollar
- kzt: Kazakhstani Tenge
- lak: Lao Kip
- lbp: Lebanese Pound
- lkr: Sri Lankan Rupee
- lrd: Liberian Dollar
- lsl: Lesotho Loti
- ltl: Lithuanian Litas
- lvl: Latvian Lats
- mad: Moroccan Dirham
- mdl: Moldovan Leu
- mga: Malagasy Ariary
- mkd: Macedonian Denar
- mnt: Mongolian Tögrög
- mop: Macanese Pataca
- mro: Mauritanian Ouguiya
- mur: Mauritian Rupee
- mvr: Maldivian Rufiyaa
- mwk: Malawian Kwacha
- mxn: Mexican Peso
- myr: Malaysian Ringgit
- mzn: Mozambican Metical
- nad: Namibian Dollar
- ngn: Nigerian Naira
- nio: Nicaraguan Córdoba
- nok: Norwegian Krone
- npr: Nepalese Rupee
- nzd: New Zealand Dollar
- pab: Panamanian Balboa
- pen: Peruvian Nuevo Sol
- pgk: Papua New Guinean Kina
- php: Philippine Peso
- pkr: Pakistani Rupee
- pln: Polish Złoty
- pyg: Paraguayan Guaraní
- qar: Qatari Riyal
- ron: Romanian Leu
- rsd: Serbian Dinar
- rub: Russian Ruble
- rwf: Rwandan Franc
- sar: Saudi Riyal
- sbd: Solomon Islands Dollar
- scr: Seychellois Rupee
- sek: Swedish Krona
- sgd: Singapore Dollar
- shp: Saint Helenian Pound
- sll: Sierra Leonean Leone
- sos: Somali Shilling
- srd: Surinamese Dollar
- std: São Tomé and Príncipe Dobra
- svc: Salvadoran Colón
- szl: Swazi Lilangeni
- thb: Thai Baht
- tjs: Tajikistani Somoni
- top: Tongan Paʻanga
- try: Turkish Lira
- ttd: Trinidad and Tobago Dollar
- twd: New Taiwan Dollar
- tzs: Tanzanian Shilling
- uah: Ukrainian Hryvnia
- ugx: Ugandan Shilling
- usd: United States Dollar
- uyu: Uruguayan Peso
- uzs: Uzbekistani Som
- vef: Venezuelan Bolívar
- vnd: Vietnamese Đồng
- vuv: Vanuatu Vatu
- wst: Samoan Tala
- xaf: Central African Cfa Franc
- xcd: East Caribbean Dollar
- xof: West African Cfa Franc
- xpf: Cfp Franc
- yer: Yemeni Rial
- zar: South African Rand
- zmw: Zambian Kwacha
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": "BZb2HQKTbKlAZm1NARLZh96akke9o",
    "country": "SO",
    "state": "ydDq",
    "street1": "b8P4QW65H3AWl01mBwJk",
    "street2": "a0qFzx8",
    "user_id": "pHWqR",
    "zip": "Hd"
  },
  "name": "c",
  "phone": "+1-121-937-9561"
}'

200 OK

Response

{
  "address": {
    "city": "FoD",
    "country": "GI",
    "state": "z7JVkob",
    "street1": "KGLLyIWo00yYezUM1D",
    "street2": "D62IJ",
    "user_id": "Sts9gsNcyr8DPPiXx",
    "zip": "qRzr9l87v8n7XLx9DneCfSm1"
  },
  "balance": "20.03",
  "created_at": "2023-06-02T19:34:24.478Z",
  "currency": "crc",
  "delinquent": true,
  "email": "O@7.com",
  "id": "wXI9qVBLXk76Mb2oWPeT5NFg",
  "metadata": {},
  "name": "z6W7udCkh6AjRyW",
  "phone": "+1-499-781-9975"
}

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-06-02T19:34:24.485Z",
  "id": "1b55368e-cca8-449c-9615-c2528df7631b",
  "monthly_credits_remaining": "7.74",
  "pre_pay_cash_remaining": "57.75",
  "pre_pay_credits_remaining": "87.37",
  "total_due": "86.58",
  "updated_at": "2023-06-02T19:34:24.485Z",
  "user_id": "N2kqwhNF"
}

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": "36.83",
    "amount_paid": "12.94",
    "amount_remaining": "67.87",
    "attempt_count": 23,
    "attempted": false,
    "created_at": "2023-06-02T19:34:24.488Z",
    "currency": "clp",
    "customer_email": "J@j.com",
    "customer_id": "lhLu2zU",
    "default_payment_method": "DLpLgnN0pAU0uXHdCWNlfuwVw7tI",
    "description": "rvxt27uyzWSJJL",
    "id": "UzqvRRfysyIyIS6E",
    "lines": [
      {
        "amount": "62.36",
        "currency": "mxn",
        "description": "YHgdzTXp",
        "id": "qLA0RvMKC",
        "invoice_item": "QB",
        "metadata": {}
      }
    ],
    "metadata": {},
    "number": "vAgMoA4wsO63i87cY4Qf",
    "paid": true,
    "pdf": "https://FU6oCitGvyO.LitHaiSAMCO.com/m1lEm/B99fzfmE1sg",
    "receipt_number": "18zkn",
    "statement_descriptor": "fS06J8xTsEI7W",
    "status": "open",
    "subtotal": "45.13",
    "tax": "33.03",
    "total": "65.62",
    "url": "https://p.AspxW1lh0lI.com/Gl81QX/bLEr2UFlc"
  }
]

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": "ISPdCNaVKl4KpBTHB2kU0YHNkISc",
        "country": "BB",
        "state": "PNx4HuIPkyGOEHE",
        "street1": "21dzYj7hKrGJH0WZfYLFIkzYQq",
        "street2": "1hs",
        "user_id": "HzPzzAsj",
        "zip": "VnnD7GAKEEQC5ecRoPgWQBN8i"
      },
      "name": "tHyNweF1ymiOo97pbvOko",
      "phone": "+1-864-697-8501"
    },
    "card": {
      "brand": "zpB8AzeFh",
      "checks": {
        "address_line1_check": "G1",
        "address_postal_code_check": "Lz8tifn8hqLpXV1mr",
        "cvc_check": "ZTd8LE4s6jhRP4pdq5q77A041Lka"
      },
      "country": "ppUS7LTrgue3kw1UeJyiS7pCpS0",
      "exp_month": 21,
      "exp_year": 23,
      "fingerprint": "sOJ6kKwCUAD7NZpb7s",
      "funding": "Gf5ZxWlKf",
      "last4": "pV"
    },
    "created_at": "2023-06-02T19:34:24.505Z",
    "id": "szi5pRImKFxQawI1pa7O",
    "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-06-02T19:34:24.523Z",
  "created_at": "2023-06-02T19:34:24.523Z",
  "error": "",
  "id": "7a4851e2-5f01-413c-912a-2d32b27ad5a3",
  "input": 26,
  "input_unit": "radians",
  "output": 29,
  "output_unit": "degrees",
  "started_at": "2023-06-02T19:34:24.523Z",
  "status": "Completed",
  "updated_at": "2023-06-02T19:34:24.523Z",
  "user_id": "mW6bAvlXz0zP"
}

Convert area units

Parameters

input_unitstringrequired
Possible values
- acres: Acres <https://en.wikipedia.org/wiki/Acre>
- hectares: Hectares <https://en.wikipedia.org/wiki/Hectare>
- square_centimetres: Square centimetres <https://en.wikipedia.org/wiki/Square_centimetre>
- square_decimetres: Square decimetres <https://en.wikipedia.org/wiki/Square_decimetre>
- square_feet: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- square_hectometres: Square hectometres <https://en.wikipedia.org/wiki/Square_hectometre>
- square_inches: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- square_kilometres: Square kilometres <https://en.wikipedia.org/wiki/Square_kilometre>
- square_metres: Square metres <https://en.wikipedia.org/wiki/Square_metre>
- square_micrometres: Square micrometres <https://en.wikipedia.org/wiki/Square_micrometre>
- square_miles: Square miles <https://en.wikipedia.org/wiki/Square_mile>
- square_millimetres: Square millimetres <https://en.wikipedia.org/wiki/Square_millimetre>
- square_nanometres: Square nanometres <https://en.wikipedia.org/wiki/Square_nanometre>
- square_yards: Square yards <https://en.wikipedia.org/wiki/Square_mile>
output_unitstringrequired
Possible values
- acres: Acres <https://en.wikipedia.org/wiki/Acre>
- hectares: Hectares <https://en.wikipedia.org/wiki/Hectare>
- square_centimetres: Square centimetres <https://en.wikipedia.org/wiki/Square_centimetre>
- square_decimetres: Square decimetres <https://en.wikipedia.org/wiki/Square_decimetre>
- square_feet: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- square_hectometres: Square hectometres <https://en.wikipedia.org/wiki/Square_hectometre>
- square_inches: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- square_kilometres: Square kilometres <https://en.wikipedia.org/wiki/Square_kilometre>
- square_metres: Square metres <https://en.wikipedia.org/wiki/Square_metre>
- square_micrometres: Square micrometres <https://en.wikipedia.org/wiki/Square_micrometre>
- square_miles: Square miles <https://en.wikipedia.org/wiki/Square_mile>
- square_millimetres: Square millimetres <https://en.wikipedia.org/wiki/Square_millimetre>
- square_nanometres: Square nanometres <https://en.wikipedia.org/wiki/Square_nanometre>
- square_yards: 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
- acres: Acres <https://en.wikipedia.org/wiki/Acre>
- hectares: Hectares <https://en.wikipedia.org/wiki/Hectare>
- square_centimetres: Square centimetres <https://en.wikipedia.org/wiki/Square_centimetre>
- square_decimetres: Square decimetres <https://en.wikipedia.org/wiki/Square_decimetre>
- square_feet: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- square_hectometres: Square hectometres <https://en.wikipedia.org/wiki/Square_hectometre>
- square_inches: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- square_kilometres: Square kilometres <https://en.wikipedia.org/wiki/Square_kilometre>
- square_metres: Square metres <https://en.wikipedia.org/wiki/Square_metre>
- square_micrometres: Square micrometres <https://en.wikipedia.org/wiki/Square_micrometre>
- square_miles: Square miles <https://en.wikipedia.org/wiki/Square_mile>
- square_millimetres: Square millimetres <https://en.wikipedia.org/wiki/Square_millimetre>
- square_nanometres: Square nanometres <https://en.wikipedia.org/wiki/Square_nanometre>
- square_yards: Square yards <https://en.wikipedia.org/wiki/Square_mile>
outputnumberoptional
output_unitstringoptional
Possible values
- acres: Acres <https://en.wikipedia.org/wiki/Acre>
- hectares: Hectares <https://en.wikipedia.org/wiki/Hectare>
- square_centimetres: Square centimetres <https://en.wikipedia.org/wiki/Square_centimetre>
- square_decimetres: Square decimetres <https://en.wikipedia.org/wiki/Square_decimetre>
- square_feet: Square feet <https://en.wikipedia.org/wiki/Square_foot>
- square_hectometres: Square hectometres <https://en.wikipedia.org/wiki/Square_hectometre>
- square_inches: Square inches <https://en.wikipedia.org/wiki/Square_inch>
- square_kilometres: Square kilometres <https://en.wikipedia.org/wiki/Square_kilometre>
- square_metres: Square metres <https://en.wikipedia.org/wiki/Square_metre>
- square_micrometres: Square micrometres <https://en.wikipedia.org/wiki/Square_micrometre>
- square_miles: Square miles <https://en.wikipedia.org/wiki/Square_mile>
- square_millimetres: Square millimetres <https://en.wikipedia.org/wiki/Square_millimetre>
- square_nanometres: Square nanometres <https://en.wikipedia.org/wiki/Square_nanometre>
- square_yards: 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-06-02T19:34:24.536Z",
  "created_at": "2023-06-02T19:34:24.536Z",
  "error": "C8uygOXPqIX48hPYnwr",
  "id": "66b2a13c-aae6-4022-b72d-1adff5a0f98a",
  "input": 30,
  "input_unit": "hectares",
  "output": 11,
  "output_unit": "square_hectometres",
  "started_at": "2023-06-02T19:34:24.536Z",
  "status": "Queued",
  "updated_at": "2023-06-02T19:34:24.536Z",
  "user_id": "IxI"
}

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-06-02T19:34:24.554Z",
  "created_at": "2023-06-02T19:34:24.554Z",
  "error": "Ivh2p5vGyTdXyLsaVv22DyrzHOX",
  "id": "626616c3-4785-4c09-b341-7c6eff4a1e82",
  "input": 13,
  "input_unit": "nanoamperes",
  "output": 16,
  "output_unit": "amperes",
  "started_at": "2023-06-02T19:34:24.554Z",
  "status": "In Progress",
  "updated_at": "2023-06-02T19:34:24.554Z",
  "user_id": "qoAIKx4lnWnZJLSeEE7J9vHCh3vjy"
}

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-06-02T19:34:24.574Z",
  "created_at": "2023-06-02T19:34:24.574Z",
  "error": "VG1w452qpM9qJliD0YiiIKmJXHUAYg",
  "id": "170f59da-89dc-4037-92d0-b4fabffc2cc3",
  "input": 4,
  "input_unit": "electronvolts",
  "output": 21,
  "output_unit": "kilocalories",
  "started_at": "2023-06-02T19:34:24.574Z",
  "status": "Queued",
  "updated_at": "2023-06-02T19:34:24.574Z",
  "user_id": "0M"
}

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-06-02T19:34:24.593Z",
  "created_at": "2023-06-02T19:34:24.593Z",
  "error": "oTS",
  "id": "e247fe29-0e73-4254-951a-ac4261a2562f",
  "input": 3,
  "input_unit": "pounds",
  "output": 31,
  "output_unit": "millinewtons",
  "started_at": "2023-06-02T19:34:24.593Z",
  "status": "Completed",
  "updated_at": "2023-06-02T19:34:24.593Z",
  "user_id": "RYxmsXYGm"
}

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-06-02T19:34:24.606Z",
  "created_at": "2023-06-02T19:34:24.606Z",
  "error": "vJMjYd6kdZrOAoFcGbP",
  "id": "2ab8529b-b5c5-4da1-abe6-a861cb3b25fa",
  "input": 3,
  "input_unit": "gigahertz",
  "output": 26,
  "output_unit": "hertz",
  "started_at": "2023-06-02T19:34:24.606Z",
  "status": "In Progress",
  "updated_at": "2023-06-02T19:34:24.606Z",
  "user_id": "L"
}

Convert length units

Parameters

input_unitstringrequired
Possible values
- centimetres: Centimetres <https://en.wikipedia.org/wiki/Centimetre>
- decimetres: Decimetres <https://en.wikipedia.org/wiki/Decimetre>
- feet: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- furlongs: Furlongs <https://en.wikipedia.org/wiki/Furlong>
- hectometres: Hectometres <https://en.wikipedia.org/wiki/Hectometre>
- inches: Inches <https://en.wikipedia.org/wiki/Inch>
- kilometres: Kilometres <https://en.wikipedia.org/wiki/Kilometre>
- metres: Metres <https://en.wikipedia.org/wiki/Metre>
- micrometres: Micrometres <https://en.wikipedia.org/wiki/Micrometre>
- miles: Miles <https://en.wikipedia.org/wiki/Mile>
- millimetres: Millimetres <https://en.wikipedia.org/wiki/Millimetre>
- nanometres: Nanometres <https://en.wikipedia.org/wiki/Nanometre>
- yards: Yards <https://en.wikipedia.org/wiki/Yard>
output_unitstringrequired
Possible values
- centimetres: Centimetres <https://en.wikipedia.org/wiki/Centimetre>
- decimetres: Decimetres <https://en.wikipedia.org/wiki/Decimetre>
- feet: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- furlongs: Furlongs <https://en.wikipedia.org/wiki/Furlong>
- hectometres: Hectometres <https://en.wikipedia.org/wiki/Hectometre>
- inches: Inches <https://en.wikipedia.org/wiki/Inch>
- kilometres: Kilometres <https://en.wikipedia.org/wiki/Kilometre>
- metres: Metres <https://en.wikipedia.org/wiki/Metre>
- micrometres: Micrometres <https://en.wikipedia.org/wiki/Micrometre>
- miles: Miles <https://en.wikipedia.org/wiki/Mile>
- millimetres: Millimetres <https://en.wikipedia.org/wiki/Millimetre>
- nanometres: Nanometres <https://en.wikipedia.org/wiki/Nanometre>
- yards: 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
- centimetres: Centimetres <https://en.wikipedia.org/wiki/Centimetre>
- decimetres: Decimetres <https://en.wikipedia.org/wiki/Decimetre>
- feet: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- furlongs: Furlongs <https://en.wikipedia.org/wiki/Furlong>
- hectometres: Hectometres <https://en.wikipedia.org/wiki/Hectometre>
- inches: Inches <https://en.wikipedia.org/wiki/Inch>
- kilometres: Kilometres <https://en.wikipedia.org/wiki/Kilometre>
- metres: Metres <https://en.wikipedia.org/wiki/Metre>
- micrometres: Micrometres <https://en.wikipedia.org/wiki/Micrometre>
- miles: Miles <https://en.wikipedia.org/wiki/Mile>
- millimetres: Millimetres <https://en.wikipedia.org/wiki/Millimetre>
- nanometres: Nanometres <https://en.wikipedia.org/wiki/Nanometre>
- yards: Yards <https://en.wikipedia.org/wiki/Yard>
outputnumberoptional
output_unitstringoptional
Possible values
- centimetres: Centimetres <https://en.wikipedia.org/wiki/Centimetre>
- decimetres: Decimetres <https://en.wikipedia.org/wiki/Decimetre>
- feet: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
- furlongs: Furlongs <https://en.wikipedia.org/wiki/Furlong>
- hectometres: Hectometres <https://en.wikipedia.org/wiki/Hectometre>
- inches: Inches <https://en.wikipedia.org/wiki/Inch>
- kilometres: Kilometres <https://en.wikipedia.org/wiki/Kilometre>
- metres: Metres <https://en.wikipedia.org/wiki/Metre>
- micrometres: Micrometres <https://en.wikipedia.org/wiki/Micrometre>
- miles: Miles <https://en.wikipedia.org/wiki/Mile>
- millimetres: Millimetres <https://en.wikipedia.org/wiki/Millimetre>
- nanometres: Nanometres <https://en.wikipedia.org/wiki/Nanometre>
- yards: 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-06-02T19:34:24.618Z",
  "created_at": "2023-06-02T19:34:24.618Z",
  "error": "O",
  "id": "b2e2d7ff-5fbf-44bc-b879-818f0b69096b",
  "input": 16,
  "input_unit": "inches",
  "output": 8,
  "output_unit": "nanometres",
  "started_at": "2023-06-02T19:34:24.618Z",
  "status": "Uploaded",
  "updated_at": "2023-06-02T19:34:24.618Z",
  "user_id": "8XvVB"
}

Convert mass units

Parameters

input_unitstringrequired
Possible values
15 possible values
- carats: Carats <https://en.wikipedia.org/wiki/Carat_(mass)>
- grains: Grains <https://en.wikipedia.org/wiki/Grain_(unit)>
- grams: Grams <https://en.wikipedia.org/wiki/Gram>
- kilograms: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- long_tons: Long tons <https://en.wikipedia.org/wiki/Long_ton>
- metric_tons: Metric tons <https://en.wikipedia.org/wiki/Tonne>
- micrograms: Micrograms <https://en.wikipedia.org/wiki/Microgram>
- milligrams: Milligrams <https://en.wikipedia.org/wiki/Milligram>
- ounces: Ounces <https://en.wikipedia.org/wiki/Ounce>
- pennyweights: Pennyweights <https://en.wikipedia.org/wiki/Pennyweight>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
- short_tons: Short tons <https://en.wikipedia.org/wiki/Short_ton>
- stones: Stones <https://en.wikipedia.org/wiki/Stone_(unit)>
- troy_ounces: Troy ounces <https://en.wikipedia.org/wiki/Troy_ounce>
- troy_pounds: Troy pounds <https://en.wikipedia.org/wiki/Troy_pound>
output_unitstringrequired
Possible values
15 possible values
- carats: Carats <https://en.wikipedia.org/wiki/Carat_(mass)>
- grains: Grains <https://en.wikipedia.org/wiki/Grain_(unit)>
- grams: Grams <https://en.wikipedia.org/wiki/Gram>
- kilograms: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- long_tons: Long tons <https://en.wikipedia.org/wiki/Long_ton>
- metric_tons: Metric tons <https://en.wikipedia.org/wiki/Tonne>
- micrograms: Micrograms <https://en.wikipedia.org/wiki/Microgram>
- milligrams: Milligrams <https://en.wikipedia.org/wiki/Milligram>
- ounces: Ounces <https://en.wikipedia.org/wiki/Ounce>
- pennyweights: Pennyweights <https://en.wikipedia.org/wiki/Pennyweight>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
- short_tons: Short tons <https://en.wikipedia.org/wiki/Short_ton>
- stones: Stones <https://en.wikipedia.org/wiki/Stone_(unit)>
- troy_ounces: Troy ounces <https://en.wikipedia.org/wiki/Troy_ounce>
- troy_pounds: Troy pounds <https://en.wikipedia.org/wiki/Troy_pound>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
15 possible values
- carats: Carats <https://en.wikipedia.org/wiki/Carat_(mass)>
- grains: Grains <https://en.wikipedia.org/wiki/Grain_(unit)>
- grams: Grams <https://en.wikipedia.org/wiki/Gram>
- kilograms: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- long_tons: Long tons <https://en.wikipedia.org/wiki/Long_ton>
- metric_tons: Metric tons <https://en.wikipedia.org/wiki/Tonne>
- micrograms: Micrograms <https://en.wikipedia.org/wiki/Microgram>
- milligrams: Milligrams <https://en.wikipedia.org/wiki/Milligram>
- ounces: Ounces <https://en.wikipedia.org/wiki/Ounce>
- pennyweights: Pennyweights <https://en.wikipedia.org/wiki/Pennyweight>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
- short_tons: Short tons <https://en.wikipedia.org/wiki/Short_ton>
- stones: Stones <https://en.wikipedia.org/wiki/Stone_(unit)>
- troy_ounces: Troy ounces <https://en.wikipedia.org/wiki/Troy_ounce>
- troy_pounds: Troy pounds <https://en.wikipedia.org/wiki/Troy_pound>
outputnumberoptional
output_unitstringoptional
Possible values
15 possible values
- carats: Carats <https://en.wikipedia.org/wiki/Carat_(mass)>
- grains: Grains <https://en.wikipedia.org/wiki/Grain_(unit)>
- grams: Grams <https://en.wikipedia.org/wiki/Gram>
- kilograms: Kilograms <https://en.wikipedia.org/wiki/Kilogram>
- long_tons: Long tons <https://en.wikipedia.org/wiki/Long_ton>
- metric_tons: Metric tons <https://en.wikipedia.org/wiki/Tonne>
- micrograms: Micrograms <https://en.wikipedia.org/wiki/Microgram>
- milligrams: Milligrams <https://en.wikipedia.org/wiki/Milligram>
- ounces: Ounces <https://en.wikipedia.org/wiki/Ounce>
- pennyweights: Pennyweights <https://en.wikipedia.org/wiki/Pennyweight>
- pounds: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
- short_tons: Short tons <https://en.wikipedia.org/wiki/Short_ton>
- stones: Stones <https://en.wikipedia.org/wiki/Stone_(unit)>
- troy_ounces: Troy ounces <https://en.wikipedia.org/wiki/Troy_ounce>
- troy_pounds: Troy pounds <https://en.wikipedia.org/wiki/Troy_pound>
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-06-02T19:34:24.630Z",
  "created_at": "2023-06-02T19:34:24.630Z",
  "error": "9v0Hn8ijlSnq99",
  "id": "9d6e3d0b-80c6-4981-a73b-0c15bbab702b",
  "input": 3,
  "input_unit": "short_tons",
  "output": 28,
  "output_unit": "micrograms",
  "started_at": "2023-06-02T19:34:24.630Z",
  "status": "In Progress",
  "updated_at": "2023-06-02T19:34:24.630Z",
  "user_id": "fz8WLCmmekavCwtQdzQw"
}

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-06-02T19:34:24.641Z",
  "created_at": "2023-06-02T19:34:24.641Z",
  "error": "Cg40Jmi",
  "id": "6ae99598-aa7a-4453-afe6-f1022ea9dd86",
  "input": 22,
  "input_unit": "kilowatts",
  "output": 15,
  "output_unit": "kilowatts",
  "started_at": "2023-06-02T19:34:24.642Z",
  "status": "Completed",
  "updated_at": "2023-06-02T19:34:24.642Z",
  "user_id": "Phu8MMJV"
}

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
user_idstringoptional

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

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

200 OK

Response

{
  "completed_at": "2023-06-02T19:34:24.653Z",
  "created_at": "2023-06-02T19:34:24.653Z",
  "error": "YpTLZxCXG1yf",
  "id": "51123d44-41ff-49fa-af44-182e99bfde22",
  "input": 22,
  "input_unit": "psi",
  "output": 22,
  "output_unit": "pascals",
  "started_at": "2023-06-02T19:34:24.653Z",
  "status": "In Progress",
  "updated_at": "2023-06-02T19:34:24.653Z",
  "user_id": "UcjBlawMYSiJX2"
}

Convert temperature units

Parameters

input_unitstringrequired
Possible values
- celsius: Celsius <https://en.wikipedia.org/wiki/Celsius>
- fahrenheit: Fahrenheit <https://en.wikipedia.org/wiki/Fahrenheit>
- kelvin: Kelvin <https://en.wikipedia.org/wiki/Kelvin>
- rankine: Rankine <https://en.wikipedia.org/wiki/Rankine_scale>
output_unitstringrequired
Possible values
- celsius: Celsius <https://en.wikipedia.org/wiki/Celsius>
- fahrenheit: Fahrenheit <https://en.wikipedia.org/wiki/Fahrenheit>
- kelvin: Kelvin <https://en.wikipedia.org/wiki/Kelvin>
- rankine: Rankine <https://en.wikipedia.org/wiki/Rankine_scale>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- celsius: Celsius <https://en.wikipedia.org/wiki/Celsius>
- fahrenheit: Fahrenheit <https://en.wikipedia.org/wiki/Fahrenheit>
- kelvin: Kelvin <https://en.wikipedia.org/wiki/Kelvin>
- rankine: Rankine <https://en.wikipedia.org/wiki/Rankine_scale>
outputnumberoptional
output_unitstringoptional
Possible values
- celsius: Celsius <https://en.wikipedia.org/wiki/Celsius>
- fahrenheit: Fahrenheit <https://en.wikipedia.org/wiki/Fahrenheit>
- kelvin: Kelvin <https://en.wikipedia.org/wiki/Kelvin>
- rankine: Rankine <https://en.wikipedia.org/wiki/Rankine_scale>
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/temperature/{input_unit}/{output_unit}

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

200 OK

Response

{
  "completed_at": "2023-06-02T19:34:24.669Z",
  "created_at": "2023-06-02T19:34:24.669Z",
  "error": "l8M8sk3Z6MzWxufXaApdcr",
  "id": "245b228f-fc4a-41c4-b357-d2de8798ff7f",
  "input": 5,
  "input_unit": "celsius",
  "output": 29,
  "output_unit": "kelvin",
  "started_at": "2023-06-02T19:34:24.669Z",
  "status": "Uploaded",
  "updated_at": "2023-06-02T19:34:24.669Z",
  "user_id": "jW5IF2wUeFJXoK6HBcq7e9crHw"
}

Convert torque units

Parameters

input_unitstringrequired
Possible values
- newton_metres: Newton metres <https://en.wikipedia.org/wiki/Newton_metre>
- pound_foot: Pound foot <https://en.wikipedia.org/wiki/Pound-foot_(torque)>
output_unitstringrequired
Possible values
- newton_metres: Newton metres <https://en.wikipedia.org/wiki/Newton_metre>
- pound_foot: Pound foot <https://en.wikipedia.org/wiki/Pound-foot_(torque)>
valuenumberrequired

Returns

200 OK

successful operation

completed_atstringISO-8601optional
created_atstringISO-8601optional
errorstringoptional
idstringUUIDoptional
inputnumberoptional
input_unitstringoptional
Possible values
- newton_metres: Newton metres <https://en.wikipedia.org/wiki/Newton_metre>
- pound_foot: Pound foot <https://en.wikipedia.org/wiki/Pound-foot_(torque)>
outputnumberoptional
output_unitstringoptional
Possible values
- newton_metres: Newton metres <https://en.wikipedia.org/wiki/Newton_metre>
- pound_foot: Pound foot <https://en.wikipedia.org/wiki/Pound-foot_(torque)>
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/torque/{input_unit}/{output_unit}

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

Parameters

Possible values

Possible values

Returns

201 Created

Possible values

Possible values

Possible values

Get CAD file density beta

Parameters

Possible values

Returns

201 Created

Possible values

Possible values

Get CAD file mass beta

Parameters

Possible values

Returns

201 Created

Possible values

Possible values

Meta

Get OpenAPI schema

Parameters

Returns

200 OK

Return pong

Parameters

Returns

200 OK

Payments

Delete payment info for your user

Parameters

Returns

204 No Content

Get payment info about your user

Parameters

Get CAD file density
beta

Get CAD file mass
beta