Skip to content

Commit

Permalink
YOYO NEW API SPEC!
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 15, 2024
1 parent 72cb7e8 commit f6bc69c
Showing 1 changed file with 34 additions and 36 deletions.
70 changes: 34 additions & 36 deletions spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,7 @@
"/ai/text-to-cad/{output_format}": {
"post": {
"tags": [
"ai",
"beta"
"ai"
],
"summary": "Generate a CAD model from text.",
"description": "Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.\nThis operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\nOne thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not `Completed` or `Failed`.\nThis is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.",
Expand Down Expand Up @@ -6465,8 +6464,7 @@
},
"post": {
"tags": [
"ai",
"beta"
"ai"
],
"summary": "Give feedback to a specific text-to-CAD response.",
"description": "This endpoint requires authentication by any Zoo user. The user must be the owner of the text-to-CAD model, in order to give feedback.",
Expand Down Expand Up @@ -7153,18 +7151,6 @@
}
},
"components": {
"responses": {
"Error": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"schemas": {
"AccountProvider": {
"description": "An account provider.",
Expand Down Expand Up @@ -9143,7 +9129,7 @@
}
},
"CodeLanguage": {
"description": "The language code is written in.",
"description": "The language code is written in.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"The language code is written in.\", \"oneOf\": [ { \"description\": \"The `go` programming language.\", \"type\": \"string\", \"enum\": [ \"go\" ] }, { \"description\": \"The `python` programming language.\", \"type\": \"string\", \"enum\": [ \"python\" ] }, { \"description\": \"The `node` programming language.\", \"type\": \"string\", \"enum\": [ \"node\" ] } ] } ``` </details>",
"oneOf": [
{
"description": "The `go` programming language.",
Expand All @@ -9169,7 +9155,7 @@
]
},
"CodeOutput": {
"description": "Output of the code being executed.",
"description": "Output of the code being executed.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"Output of the code being executed.\", \"type\": \"object\", \"properties\": { \"output_files\": { \"description\": \"The contents of the files requested if they were passed.\", \"type\": \"array\", \"items\": { \"$ref\": \"#/components/schemas/OutputFile\" } }, \"stderr\": { \"description\": \"The stderr of the code.\", \"default\": \"\", \"type\": \"string\" }, \"stdout\": { \"description\": \"The stdout of the code.\", \"default\": \"\", \"type\": \"string\" } } } ``` </details>",
"type": "object",
"properties": {
"output_files": {
Expand Down Expand Up @@ -15485,7 +15471,7 @@
}
},
"OutputFile": {
"description": "Output file contents.",
"description": "Output file contents.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"Output file contents.\", \"type\": \"object\", \"properties\": { \"contents\": { \"description\": \"The contents of the file. This is base64 encoded so we can ensure it is UTF-8 for JSON.\", \"type\": \"string\" }, \"name\": { \"description\": \"The name of the file.\", \"default\": \"\", \"type\": \"string\" } } } ``` </details>",
"type": "object",
"properties": {
"contents": {
Expand Down Expand Up @@ -19165,112 +19151,124 @@
}
]
}
},
"responses": {
"Error": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"tags": [
{
"name": "ai",
"description": "AI uses machine learning to generate CAD models.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/ai"
"url": "https://zoo.dev/docs/api/ai"
}
},
{
"name": "api-calls",
"description": "API calls that have been performed by users can be queried by the API. This is helpful for debugging as well as billing.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/api-calls"
"url": "https://zoo.dev/docs/api/api-calls"
}
},
{
"name": "api-tokens",
"description": "API tokens allow users to call the API outside of their session token that is used as a cookie in the user interface. Users can create, delete, and list their API tokens. But, of course, you need an API token to do this, so first be sure to generate one in the account UI.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/api-tokens"
"url": "https://zoo.dev/docs/api/api-tokens"
}
},
{
"name": "apps",
"description": "Endpoints for third party app grant flows.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/apps"
"url": "https://zoo.dev/docs/api/apps"
}
},
{
"name": "beta",
"description": "Beta API endpoints. We will not charge for these endpoints while they are in beta.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/beta"
"url": "https://zoo.dev/docs/api/beta"
}
},
{
"name": "constant",
"description": "Constants. These are helpful as helpers.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/constant"
"url": "https://zoo.dev/docs/api/constant"
}
},
{
"name": "executor",
"description": "Endpoints that allow for code execution or creation of code execution environments.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/executor"
"url": "https://zoo.dev/docs/api/executor"
}
},
{
"name": "file",
"description": "CAD file operations. Create, get, and list CAD file conversions. More endpoints will be added here in the future as we build out transforms, etc on CAD models.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/file"
"url": "https://zoo.dev/docs/api/file"
}
},
{
"name": "hidden",
"description": "Hidden API endpoints that should not show up in the docs.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/hidden"
"url": "https://zoo.dev/docs/api/hidden"
}
},
{
"name": "meta",
"description": "Meta information about the API.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/meta"
"url": "https://zoo.dev/docs/api/meta"
}
},
{
"name": "modeling",
"description": "Modeling API for updating your 3D files using the KittyCAD engine.",
"description": "Modeling API for updating your 3D files using the Zoo engine.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/modeling"
"url": "https://zoo.dev/docs/api/modeling"
}
},
{
"name": "oauth2",
"description": "Endpoints that implement OAuth 2.0 grant flows.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/oauth2"
"url": "https://zoo.dev/docs/api/oauth2"
}
},
{
"name": "payments",
"description": "Operations around payments and billing.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/payments"
"url": "https://zoo.dev/docs/api/payments"
}
},
{
"name": "unit",
"description": "Unit conversion operations.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/file"
"url": "https://zoo.dev/docs/api/file"
}
},
{
"name": "users",
"description": "A user is someone who uses the KittyCAD API. Here, we can create, delete, and list users. We can also get information about a user. Operations will only be authorized if the user is requesting information about themselves.",
"description": "A user is someone who uses the Zoo API. Here, we can create, delete, and list users. We can also get information about a user. Operations will only be authorized if the user is requesting information about themselves.",
"externalDocs": {
"url": "https://docs.kittycad.io/api/users"
"url": "https://zoo.dev/docs/api/users"
}
}
]
Expand Down

0 comments on commit f6bc69c

Please sign in to comment.