Skip to content

Commit ff00793

Browse files
zoo-github-actions-auth[bot]zoo-github-actions-auth[bot]
committed
YOYO NEW API SPEC!
1 parent f7f6e4f commit ff00793

File tree

1 file changed

+117
-120
lines changed

1 file changed

+117
-120
lines changed

‎spec.json‎

Lines changed: 117 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -24801,26 +24801,26 @@
2480124801
]
2480224802
},
2480324803
"monthly_api_credits_remaining": {
24804-
"description": "The number of monthly API credits remaining in the balance.",
24804+
"description": "The number of monthly API credits remaining in the balance. This is the number of credits remaining in the balance.\n\nBoth the monetary value and the number of credits are returned, but they reflect the same value in the database.",
2480524805
"type": "integer",
2480624806
"format": "uint64",
2480724807
"minimum": 0
2480824808
},
2480924809
"monthly_api_credits_remaining_monetary_value": {
2481024810
"title": "double",
24811-
"description": "The monetary value of the monthly API credits remaining in the balance.",
24811+
"description": "The monetary value of the monthly API credits remaining in the balance. This gets re-upped every month, but if the credits are not used for a month they do not carry over to the next month.\n\nBoth the monetary value and the number of credits are returned, but they reflect the same value in the database.",
2481224812
"type": "number",
2481324813
"format": "money-usd"
2481424814
},
2481524815
"stable_api_credits_remaining": {
24816-
"description": "The number of stable API credits remaining in the balance.",
24816+
"description": "The number of stable API credits remaining in the balance. These do not get reset or re-upped every month. This is separate from the monthly credits. Credits will first pull from the monthly credits, then the stable credits. Stable just means that they do not get reset every month. A user will have stable credits if a Zoo employee granted them credits.\n\nBoth the monetary value and the number of credits are returned, but they reflect the same value in the database.",
2481724817
"type": "integer",
2481824818
"format": "uint64",
2481924819
"minimum": 0
2482024820
},
2482124821
"stable_api_credits_remaining_monetary_value": {
2482224822
"title": "double",
24823-
"description": "The monetary value of stable API credits remaining in the balance.",
24823+
"description": "The monetary value of stable API credits remaining in the balance. These do not get reset or re-upped every month. This is separate from the monthly credits. Credits will first pull from the monthly credits, then the stable credits. Stable just means that they do not get reset every month. A user will have stable credits if a Zoo employee granted them credits.\n\nBoth the monetary value and the number of credits are returned, but they reflect the same value in the database.",
2482424824
"type": "number",
2482524825
"format": "money-usd"
2482624826
},
@@ -28554,11 +28554,29 @@
2855428554
"$ref": "#/components/schemas/MlCopilotTool"
2855528555
}
2855628556
},
28557+
"model": {
28558+
"nullable": true,
28559+
"description": "Override the default model with another.",
28560+
"allOf": [
28561+
{
28562+
"$ref": "#/components/schemas/MlCopilotSupportedModels"
28563+
}
28564+
]
28565+
},
2855728566
"project_name": {
2855828567
"nullable": true,
2855928568
"description": "The project name, if any. This can be used to associate the message with a specific project.",
2856028569
"type": "string"
2856128570
},
28571+
"reasoning_effort": {
28572+
"nullable": true,
28573+
"description": "Change the default reasoning effort.",
28574+
"allOf": [
28575+
{
28576+
"$ref": "#/components/schemas/MlReasoningEffort"
28577+
}
28578+
]
28579+
},
2856228580
"source_ranges": {
2856328581
"description": "The source ranges the user suggested to change. If empty, the content (prompt) will be used and is required.",
2856428582
"type": "array",
@@ -28834,6 +28852,46 @@
2883428852
}
2883528853
]
2883628854
},
28855+
"MlCopilotSupportedModels": {
28856+
"description": "AI models that we support using with the system. In theory any model with reasoning capabilities can work.",
28857+
"oneOf": [
28858+
{
28859+
"description": "gpt-5-nano",
28860+
"type": "string",
28861+
"enum": [
28862+
"gpt5_nano"
28863+
]
28864+
},
28865+
{
28866+
"description": "gpt-5-mini",
28867+
"type": "string",
28868+
"enum": [
28869+
"gpt5_mini"
28870+
]
28871+
},
28872+
{
28873+
"description": "gpt-5-codex",
28874+
"type": "string",
28875+
"enum": [
28876+
"gpt5_codex"
28877+
]
28878+
},
28879+
{
28880+
"description": "gpt-5",
28881+
"type": "string",
28882+
"enum": [
28883+
"gpt5"
28884+
]
28885+
},
28886+
{
28887+
"description": "o3",
28888+
"type": "string",
28889+
"enum": [
28890+
"o3"
28891+
]
28892+
}
28893+
]
28894+
},
2883728895
"MlCopilotSystemCommand": {
2883828896
"description": "The type of system command that can be sent to the ML Copilot.",
2883928897
"oneOf": [
@@ -29143,6 +29201,32 @@
2914329201
}
2914429202
]
2914529203
},
29204+
"MlReasoningEffort": {
29205+
"description": "Specify the amount of effort used in reasoning. Read the following for more info: https://platform.openai.com/docs/guides/reasoning#how-reasoning-works",
29206+
"oneOf": [
29207+
{
29208+
"description": "Low reasoning",
29209+
"type": "string",
29210+
"enum": [
29211+
"low"
29212+
]
29213+
},
29214+
{
29215+
"description": "Medium reasoning",
29216+
"type": "string",
29217+
"enum": [
29218+
"medium"
29219+
]
29220+
},
29221+
{
29222+
"description": "High reasoning",
29223+
"type": "string",
29224+
"enum": [
29225+
"high"
29226+
]
29227+
}
29228+
]
29229+
},
2914629230
"MlToolResult": {
2914729231
"description": "Responses from tools.",
2914829232
"oneOf": [
@@ -29258,70 +29342,25 @@
2925829342
}
2925929343
]
2926029344
},
29261-
"ModelingAppIndividualSubscriptionTier": {
29262-
"description": "The subscription tiers we offer for the Modeling App to individuals.",
29263-
"oneOf": [
29264-
{
29265-
"description": "The free tier.",
29266-
"type": "string",
29267-
"enum": [
29268-
"free"
29269-
]
29270-
},
29271-
{
29272-
"description": "The plus tier.",
29273-
"type": "string",
29274-
"enum": [
29275-
"plus"
29276-
]
29277-
},
29278-
{
29279-
"description": "The pro tier.",
29280-
"type": "string",
29281-
"enum": [
29282-
"pro"
29283-
]
29284-
}
29285-
]
29286-
},
29287-
"ModelingAppOrganizationSubscriptionTier": {
29288-
"description": "The subscription tiers we offer for the Modeling App to organizations.",
29289-
"oneOf": [
29290-
{
29291-
"description": "The team tier.",
29292-
"type": "string",
29293-
"enum": [
29294-
"team"
29295-
]
29296-
},
29297-
{
29298-
"description": "The enterprise tier.",
29299-
"type": "string",
29300-
"enum": [
29301-
"enterprise"
29302-
]
29303-
}
29304-
]
29305-
},
2930629345
"ModelingAppShareLinks": {
29307-
"description": "The options for sharable links through the modeling app.",
29346+
"description": "Modeling App share link capabilities.",
2930829347
"oneOf": [
2930929348
{
29310-
"description": "Public.",
29349+
"description": "Publicly accessible share links.",
2931129350
"type": "string",
2931229351
"enum": [
2931329352
"public"
2931429353
]
2931529354
},
2931629355
{
29317-
"description": "Password protected.",
29356+
"description": "Share links guarded by a password.",
2931829357
"type": "string",
2931929358
"enum": [
2932029359
"password_protected"
2932129360
]
2932229361
},
2932329362
{
29324-
"description": "Organization only. Links can be made only available to members of the organization.",
29363+
"description": "Share links restricted to members of the organization.",
2932529364
"type": "string",
2932629365
"enum": [
2932729366
"organization_only"
@@ -29330,7 +29369,7 @@
2933029369
]
2933129370
},
2933229371
"ModelingAppSubscriptionTier": {
29333-
"description": "A subscription tier we offer for the Modeling App.",
29372+
"description": "Rich information about a Modeling App subscription tier.",
2933429373
"type": "object",
2933529374
"properties": {
2933629375
"annual_discount": {
@@ -29343,6 +29382,11 @@
2934329382
"description": "A description of the tier.",
2934429383
"type": "string"
2934529384
},
29385+
"display_name": {
29386+
"description": "The display name of the tier.",
29387+
"default": "",
29388+
"type": "string"
29389+
},
2934629390
"endpoints_included": {
2934729391
"description": "The Zoo API endpoints that are included when through an approved zoo tool.",
2934829392
"type": "array",
@@ -29375,11 +29419,7 @@
2937529419
},
2937629420
"name": {
2937729421
"description": "The name of the tier.",
29378-
"allOf": [
29379-
{
29380-
"$ref": "#/components/schemas/ModelingAppSubscriptionTierName"
29381-
}
29382-
]
29422+
"type": "string"
2938329423
},
2938429424
"pay_as_you_go_api_credit_price": {
2938529425
"title": "double",
@@ -29444,46 +29484,6 @@
2944429484
"type"
2944529485
]
2944629486
},
29447-
"ModelingAppSubscriptionTierName": {
29448-
"description": "An enum representing a Modeling App subscription tier name.",
29449-
"oneOf": [
29450-
{
29451-
"description": "The free tier.",
29452-
"type": "string",
29453-
"enum": [
29454-
"free"
29455-
]
29456-
},
29457-
{
29458-
"description": "The plus tier.",
29459-
"type": "string",
29460-
"enum": [
29461-
"plus"
29462-
]
29463-
},
29464-
{
29465-
"description": "The pro tier.",
29466-
"type": "string",
29467-
"enum": [
29468-
"pro"
29469-
]
29470-
},
29471-
{
29472-
"description": "The team tier.",
29473-
"type": "string",
29474-
"enum": [
29475-
"team"
29476-
]
29477-
},
29478-
{
29479-
"description": "The enterprise tier.",
29480-
"type": "string",
29481-
"enum": [
29482-
"enterprise"
29483-
]
29484-
}
29485-
]
29486-
},
2948729487
"ModelingCmd": {
2948829488
"description": "Commands that the KittyCAD engine can execute.",
2948929489
"oneOf": [
@@ -43685,6 +43685,11 @@
4368543685
"description": "A description of the tier.",
4368643686
"type": "string"
4368743687
},
43688+
"display_name": {
43689+
"description": "The display name of the tier.",
43690+
"default": "",
43691+
"type": "string"
43692+
},
4368843693
"endpoints_included": {
4368943694
"description": "The Zoo API endpoints that are included when through an approved zoo tool.",
4369043695
"type": "array",
@@ -43717,11 +43722,7 @@
4371743722
},
4371843723
"name": {
4371943724
"description": "The name of the tier.",
43720-
"allOf": [
43721-
{
43722-
"$ref": "#/components/schemas/ModelingAppSubscriptionTierName"
43723-
}
43724-
]
43725+
"type": "string"
4372543726
},
4372643727
"pay_as_you_go_api_credit_price": {
4372743728
"title": "double",
@@ -43810,40 +43811,36 @@
4381043811
"type": "object",
4381143812
"properties": {
4381243813
"modeling_app": {
43813-
"description": "A modeling app subscription.",
43814-
"default": "team",
43815-
"allOf": [
43816-
{
43817-
"$ref": "#/components/schemas/ModelingAppOrganizationSubscriptionTier"
43818-
}
43819-
]
43814+
"description": "Slug of the modeling app subscription tier requested.",
43815+
"type": "string"
4382043816
},
4382143817
"pay_annually": {
4382243818
"nullable": true,
4382343819
"description": "If the customer chooses to pay annually or monthly, we can add that here. The annual discount will apply if there is a discount for the subscription.",
4382443820
"type": "boolean"
4382543821
}
43826-
}
43822+
},
43823+
"required": [
43824+
"modeling_app"
43825+
]
4382743826
},
4382843827
"ZooProductSubscriptionsUserRequest": {
4382943828
"description": "A struct of Zoo product subscriptions a user can request.",
4383043829
"type": "object",
4383143830
"properties": {
4383243831
"modeling_app": {
43833-
"description": "A modeling app subscription.",
43834-
"default": "free",
43835-
"allOf": [
43836-
{
43837-
"$ref": "#/components/schemas/ModelingAppIndividualSubscriptionTier"
43838-
}
43839-
]
43832+
"description": "Slug of the modeling app subscription tier requested.",
43833+
"type": "string"
4384043834
},
4384143835
"pay_annually": {
4384243836
"nullable": true,
4384343837
"description": "If the customer chooses to pay annually or monthly, we can add that here. The annual discount will apply if there is a discount for the subscription.",
4384443838
"type": "boolean"
4384543839
}
43846-
}
43840+
},
43841+
"required": [
43842+
"modeling_app"
43843+
]
4384743844
},
4384843845
"ZooTool": {
4384943846
"description": "The Zoo tools that can make API calls.",

0 commit comments

Comments
 (0)