Skip to content

Commit

Permalink
Update api spec (#248)
Browse files Browse the repository at this point in the history
YOYO NEW API SPEC!

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
1 parent 8fbf879 commit 54814c6
Showing 1 changed file with 31 additions and 15 deletions.
46 changes: 31 additions & 15 deletions spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@
"/ai-prompts": {
"get": {
"tags": [
"ai",
"ml",
"hidden"
],
"summary": "List all AI prompts.",
Expand Down Expand Up @@ -292,7 +292,7 @@
"/ai-prompts/{id}": {
"get": {
"tags": [
"ai",
"ml",
"hidden"
],
"summary": "Get an AI prompt.",
Expand Down Expand Up @@ -367,7 +367,7 @@
"/ai/kcl/completions": {
"post": {
"tags": [
"ai",
"ml",
"beta"
],
"summary": "Generate code completions for KCL.",
Expand Down Expand Up @@ -492,7 +492,7 @@
"/ai/text-to-cad/{output_format}": {
"post": {
"tags": [
"ai"
"ml"
],
"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`.",
Expand Down Expand Up @@ -11326,7 +11326,7 @@
"/user/text-to-cad": {
"get": {
"tags": [
"ai"
"ml"
],
"summary": "List text-to-CAD models you've generated.",
"description": "This will always return the STEP file contents as well as the format the user originally requested.\nThis endpoint requires authentication by any Zoo user. It returns the text-to-CAD models for the authenticated user.\nThe text-to-CAD models are returned in order of creation, with the most recently created text-to-CAD models first.",
Expand Down Expand Up @@ -11429,7 +11429,7 @@
"/user/text-to-cad/{id}": {
"get": {
"tags": [
"ai"
"ml"
],
"summary": "Get a 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.",
Expand Down Expand Up @@ -11501,7 +11501,7 @@
},
"post": {
"tags": [
"ai"
"ml"
],
"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 @@ -12608,7 +12608,12 @@
},
"metadata": {
"nullable": true,
"description": "The metadata for the prompt."
"description": "The metadata for the prompt.",
"allOf": [
{
"$ref": "#/components/schemas/AiPromptMetadata"
}
]
},
"model_version": {
"description": "The version of the model.",
Expand Down Expand Up @@ -12672,6 +12677,17 @@
"user_id"
]
},
"AiPromptMetadata": {
"description": "Metadata for an AI prompt.",
"type": "object",
"properties": {
"code": {
"nullable": true,
"description": "Code for the model.",
"type": "string"
}
}
},
"AiPromptResultsPage": {
"description": "A single page of results",
"type": "object",
Expand Down Expand Up @@ -28166,13 +28182,6 @@
}
},
"tags": [
{
"name": "ai",
"description": "AI uses machine learning to generate CAD models.",
"externalDocs": {
"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.",
Expand Down Expand Up @@ -28236,6 +28245,13 @@
"url": "https://zoo.dev/docs/api/meta"
}
},
{
"name": "ml",
"description": "Machine learning to generate CAD models and other things.",
"externalDocs": {
"url": "https://zoo.dev/docs/api/ml"
}
},
{
"name": "modeling",
"description": "Modeling API for updating your 3D files using the Zoo engine.",
Expand Down

0 comments on commit 54814c6

Please sign in to comment.