{"openapi":"3.1.0","info":{"title":"Protyus API","description":"Protyus reads a STEP file and plans how to mill it: its features, setups, tool access and DFM findings.\n\n**Signing in.** Send `Authorization: Bearer <token>` with a Clerk session token, or with an API key\n(`ak_...`) made under Preferences > API keys (in the app's user menu) or with `POST /api/v1/me/api-keys`. Every route but `/api/v1/health`\nand this document needs one. A key acts as the person who made it. To act in one of their organizations, also\nsend `X-Protyus-Org: <organization id>`; without it the key has no active organization, and anything done in one,\nuploading and analysing included, is refused with `403` and code `NO_ORGANIZATION`. Each key may make\n120 requests a minute; past that, requests get `429` with code `RATE_LIMITED` and a `Retry-After` header. Keys\ncome with the Pro and Enterprise plans and Pro's free trial: in a company on another plan, a request with a key gets\n`402` with code `API_NOT_IN_PLAN`.\nA request made in an organization that Protyus can't check right now gets `503` with code `SERVICE_UNAVAILABLE`\nand a `Retry-After` header; try it again then.\n\n**Analysing a part.** `POST /api/v1/uploads` gives a signed URL to `PUT` the STEP file to, which answers with its\n`upload_url` (the web app uploads to Vercel Blob itself). Then `POST /api/v1/projects/{project_id}/analyses` with that\nURL. The analysis runs in the background: poll `GET /api/v1/analyses/{analysis_id}` until it's ready, and name the\n`sections` of the result you need. An upload is only yours: it's kept in your own folder, `uploads/{org_id}/{user_id}/`,\nand any other URL is refused with `NOT_YOUR_UPLOAD`. Use each `upload_url` as the person who uploaded it.\n\n**MCP.** Every operation here is also an MCP tool, at `POST /api/v1/mcp` (Streamable HTTP), with the same bearer token:\nan API key, or a Clerk session token, which acts in the session's active organization.\n\n**What a call can change.** Each operation's `x-protyus-risk` says so: `read` changes nothing, `change` adds or\nedits something, `destructive` deletes, archives, revokes or removes something, and `external` reaches someone\noutside Protyus, such as by sending an email. Ask the person before any call but a `read`. MCP tools carry the same\nas their `readOnlyHint`, `destructiveHint` and `openWorldHint` annotations.\n\n**Errors.** Every error is JSON with a stable `code`, a `message` for people and, when one request field is\nat fault, its `field`. Branch on `code`, never on `message`.\n","version":"1"},"paths":{"/api/v1/me":{"get":{"summary":"Get my access","description":"Who the caller is and what they may do.","operationId":"me_api_v1_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Access"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Account"],"x-protyus-risk":"read"}},"/api/v1/me/settings":{"get":{"summary":"Get my settings","description":"The caller's own settings.","operationId":"get_settings_api_v1_me_settings_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"read"},"patch":{"summary":"Update my settings","description":"Change the caller's own settings. Only the fields given change. An unknown field is refused.","operationId":"update_settings_api_v1_me_settings_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"change"}},"/api/v1/me/api-keys":{"get":{"summary":"List my API keys","description":"List the caller's own API keys. Newest first. Secrets are never listed: a key's secret is shown once, when it's created.","operationId":"list_my_api_keys_api_v1_me_api_keys_get","parameters":[{"name":"include_revoked","in":"query","required":false,"schema":{"type":"boolean","description":"Also list keys that were revoked or have expired.","default":false,"title":"Include Revoked"},"description":"Also list keys that were revoked or have expired."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiKeyOut"},"title":"Response List My Api Keys Api V1 Me Api Keys Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["API keys"],"x-protyus-risk":"read"},"post":{"summary":"Create API key","description":"Create an API key that acts as the caller, for their own agents. The response holds the key's secret, the only time it's shown. The key sees exactly what the caller sees, in whichever of their organizations a request names with X-Protyus-Org. Needs a signed-in session: a request made with an API key can't create another (SIGN_IN_TO_CREATE_KEYS).","operationId":"create_my_api_key_api_v1_me_api_keys_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedApiKey"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["API keys"],"x-protyus-risk":"change"}},"/api/v1/me/api-keys/{key_id}/revoke":{"post":{"summary":"Revoke API key","description":"Revoke one of the caller's own API keys. The key is refused from the next request on. Revoking a revoked key changes nothing. A key can revoke itself.","operationId":"revoke_my_api_key_api_v1_me_api_keys__key_id__revoke_post","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","pattern":"^ak_[0-9A-Fa-f]{32}$","description":"An API key's id (ak_ and 32 hex digits), from a list of keys. Not its secret.","title":"Key Id"},"description":"An API key's id (ak_ and 32 hex digits), from a list of keys. Not its secret."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["API keys"],"x-protyus-risk":"destructive"}},"/api/v1/organization/api-keys":{"get":{"summary":"List organization API keys","description":"List every API key held by people in the active organization (admins). Needs api_keys:manage, which admins hold. Each key is personal and acts as the person named.","operationId":"list_organization_api_keys_api_v1_organization_api_keys_get","parameters":[{"name":"include_revoked","in":"query","required":false,"schema":{"type":"boolean","description":"Also list keys that were revoked or have expired.","default":false,"title":"Include Revoked"},"description":"Also list keys that were revoked or have expired."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrgApiKeyOut"},"title":"Response List Organization Api Keys Api V1 Organization Api Keys Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["API keys"],"x-protyus-risk":"read"}},"/api/v1/organization/api-keys/{key_id}/revoke":{"post":{"summary":"Revoke organization API key","description":"Revoke the API key of anyone in the active organization (admins). Needs api_keys:manage, which admins hold. The key is refused from the next request on, in every organization its owner belongs to.","operationId":"revoke_organization_api_key_api_v1_organization_api_keys__key_id__revoke_post","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","pattern":"^ak_[0-9A-Fa-f]{32}$","description":"An API key's id (ak_ and 32 hex digits), from a list of keys. Not its secret.","title":"Key Id"},"description":"An API key's id (ak_ and 32 hex digits), from a list of keys. Not its secret."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgApiKeyOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["API keys"],"x-protyus-risk":"destructive"}},"/api/v1/organization/members":{"get":{"summary":"List members","description":"List the people in the active organization.","operationId":"list_members_api_v1_organization_members_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MemberOut"},"type":"array","title":"Response List Members Api V1 Organization Members Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"read"}},"/api/v1/organization/invitations":{"get":{"summary":"List invitations","description":"List pending invitations to the active organization (admins).","operationId":"list_invitations_api_v1_organization_invitations_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InvitationOut"},"type":"array","title":"Response List Invitations Api V1 Organization Invitations Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"read"},"post":{"summary":"Invite member","description":"Invite someone to the active organization by email (admins).","operationId":"invite_api_v1_organization_invitations_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"change"}},"/api/v1/organization/invitations/{invitation_id}/revoke":{"post":{"summary":"Revoke pending invitation","description":"Revoke a pending invitation to the active organization, so its link stops working (admins). An invitation that was accepted, revoked or isn't this organization's is refused with INVITATION_NOT_FOUND.","operationId":"revoke_invitation_api_v1_organization_invitations__invitation_id__revoke_post","parameters":[{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","description":"Clerk's id for a pending invitation, from GET /api/v1/organization/invitations.","title":"Invitation Id"},"description":"Clerk's id for a pending invitation, from GET /api/v1/organization/invitations."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"destructive"}},"/api/v1/organization/invitations/{invitation_id}/resend":{"post":{"summary":"Resend pending invitation","description":"Send a pending invitation again (admins): it's revoked, and a new one goes to the same email with the same role, so the answer has a new id and the old link stops working.","operationId":"resend_invitation_api_v1_organization_invitations__invitation_id__resend_post","parameters":[{"name":"invitation_id","in":"path","required":true,"schema":{"type":"string","description":"Clerk's id for a pending invitation, from GET /api/v1/organization/invitations.","title":"Invitation Id"},"description":"Clerk's id for a pending invitation, from GET /api/v1/organization/invitations."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"change"}},"/api/v1/organization/members/{user_id}/role":{"put":{"summary":"Set member role","description":"Make someone in the active organization an admin or a member (admins). An admin holds every permission; a member holds their roles from GET /api/v1/organization/role-assignments, which stay as they were. An organization always keeps an admin: making the last one a member is refused with 409 LAST_ADMIN. Setting the role they already have changes nothing.","operationId":"set_member_role_api_v1_organization_members__user_id__role_put","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRoleIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"destructive","tags":["Members and roles"]}},"/api/v1/organization/leave":{"post":{"summary":"Leave organization","description":"The caller leaves the active organization. The projects they own pass to one of its admins, and they're taken off every other project and lose their roles there. Its last admin can't leave (409 LAST_ADMIN): make someone else an admin first.","operationId":"leave_organization_api_v1_organization_leave_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeftOrganization"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"destructive","tags":["Members and roles"]}},"/api/v1/organization":{"get":{"summary":"Get active organization","description":"The active organization's name and how many people are in it.","operationId":"get_organization_api_v1_organization_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Account"],"x-protyus-risk":"read"},"patch":{"summary":"Rename active organization","description":"Change the active organization's name (admins). It's what people see in the app's organization switcher and in Clerk's invitation emails.","operationId":"rename_organization_api_v1_organization_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationNameIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Account"],"x-protyus-risk":"change"}},"/api/v1/organization/members/{user_id}":{"patch":{"summary":"Update member","description":"Change a member's settings, such as can_create_projects (admins).","operationId":"update_member_api_v1_organization_members__user_id__patch","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberSettingsIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"change"},"delete":{"summary":"Remove member","description":"Remove someone from the organization; their projects pass to you (admins). Its last admin can't be removed (409 LAST_ADMIN), and you can't remove yourself: leave instead.","operationId":"remove_member_api_v1_organization_members__user_id__delete","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemovedMember"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"destructive"}},"/api/v1/roles":{"get":{"summary":"List roles","description":"List the roles that can be granted, and the permissions they give. Roles and permissions are defined by Protyus. Grant one across the organization with PUT /api/v1/organization/members/{user_id}/roles/{role}, or on one project with PUT /api/v1/projects/{project_id}/members/{user_id}/roles/{role}.","operationId":"list_roles_api_v1_roles_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"read"}},"/api/v1/organization/role-assignments":{"get":{"summary":"List role assignments","description":"List the roles granted in the active organization. Organization-wide grants, and grants on the projects the caller can see. Default roles held by every member aren't listed; GET /api/v1/organization/members shows them.","operationId":"list_role_assignments_api_v1_organization_role_assignments_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoleAssignmentOut"},"type":"array","title":"Response List Role Assignments Api V1 Organization Role Assignments Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"read"}},"/api/v1/organization/members/{user_id}/roles/{role}":{"put":{"summary":"Grant organization role","description":"Grant someone a role across the organization (admins). Granting a role they already hold changes nothing.","operationId":"grant_org_role_api_v1_organization_members__user_id__roles__role__put","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."},{"name":"role","in":"path","required":true,"schema":{"type":"string","description":"A role's key, such as tool_manager, from GET /api/v1/roles.","title":"Role"},"description":"A role's key, such as tool_manager, from GET /api/v1/roles."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRolesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"change"},"delete":{"summary":"Revoke organization role","description":"Take an organization-wide role away from someone (admins). Taking away a default role, such as project_creator, withholds it from that person.","operationId":"revoke_org_role_api_v1_organization_members__user_id__roles__role__delete","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."},{"name":"role","in":"path","required":true,"schema":{"type":"string","description":"A role's key, such as tool_manager, from GET /api/v1/roles.","title":"Role"},"description":"A role's key, such as tool_manager, from GET /api/v1/roles."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRolesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"destructive"}},"/api/v1/projects/{project_id}/members/{user_id}/roles/{role}":{"put":{"summary":"Grant project role","description":"Grant someone on a project a role on that project only (its owner or an admin). They must already be on the project. Granting a role they already hold changes nothing.","operationId":"grant_project_role_api_v1_projects__project_id__members__user_id__roles__role__put","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."},{"name":"role","in":"path","required":true,"schema":{"type":"string","description":"A role's key, such as tool_manager, from GET /api/v1/roles.","title":"Role"},"description":"A role's key, such as tool_manager, from GET /api/v1/roles."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRolesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"change"},"delete":{"summary":"Revoke project role","description":"Take a project role away from someone (its owner or an admin).","operationId":"revoke_project_role_api_v1_projects__project_id__members__user_id__roles__role__delete","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."},{"name":"role","in":"path","required":true,"schema":{"type":"string","description":"A role's key, such as tool_manager, from GET /api/v1/roles.","title":"Role"},"description":"A role's key, such as tool_manager, from GET /api/v1/roles."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRolesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"destructive"}},"/api/v1/projects":{"get":{"summary":"List projects","description":"List the projects the caller can see.","operationId":"list_projects_api_v1_projects_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectOut"},"type":"array","title":"Response List Projects Api V1 Projects Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Projects"],"x-protyus-risk":"read"},"post":{"summary":"Create project","description":"Create a project the caller owns.","operationId":"create_project_api_v1_projects_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Projects"],"x-protyus-risk":"change"}},"/api/v1/projects/{project_id}":{"get":{"summary":"Get project","description":"A project and its members.","operationId":"get_project_api_v1_projects__project_id__get","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Projects"],"x-protyus-risk":"read"},"delete":{"summary":"Delete project","description":"Delete a project and its analyses (its owner or an admin). Analyses someone sent feedback about are kept for the Protyus team but no longer shown; the rest are removed.","operationId":"delete_project_api_v1_projects__project_id__delete","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Projects"],"x-protyus-risk":"destructive"}},"/api/v1/projects/{project_id}/members":{"post":{"summary":"Add project member","description":"Add an organization member to a project (its owner or an admin).","operationId":"add_project_member_api_v1_projects__project_id__members_post","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectMemberIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Projects"],"x-protyus-risk":"change"}},"/api/v1/projects/{project_id}/members/{user_id}":{"delete":{"summary":"Remove project member","description":"Take someone off a project (its owner or an admin).","operationId":"remove_project_member_api_v1_projects__project_id__members__user_id__delete","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Projects"],"x-protyus-risk":"destructive"}},"/api/v1/feature-flags/{key}":{"get":{"summary":"Check feature flag","description":"Whether one feature flag is on for you. A flag that doesn't exist is off; nothing else about it is told.","operationId":"check_feature_flag_api_v1_feature_flags__key__get","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$","description":"The flag's name, such as quote_pdf_v2.","title":"Key"},"description":"The flag's name, such as quote_pdf_v2."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagCheck"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Account"],"x-protyus-risk":"read"}},"/api/v1/parts":{"get":{"summary":"List parts","description":"The organization's parts in every project you can see, or in one, the most recently changed first: each one's name, the customer's part number and revision, its project, its newest version, who holds its working version, its newest analysis and whether you may change it in Design. Only where the design flag is on.","operationId":"list_parts_api_v1_parts_get","parameters":[{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only this project's parts: a project id from list_projects.","title":"Project Id"},"description":"Only this project's parts: a project id from list_projects."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"How many parts to return at most.","default":50,"title":"Limit"},"description":"How many parts to return at most."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many matching parts to skip, for the next page.","default":0,"title":"Offset"},"description":"How many matching parts to skip, for the next page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartPage"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"read"}},"/api/v1/projects/{project_id}/designs":{"post":{"summary":"Start a design","description":"Start a new part in the project, made in Design from nothing: its v1, working, held by you. Describe it with run_design_turn. Needs the design flag, the Design entitlement and the designer role (design:use).","operationId":"start_design_api_v1_projects__project_id__designs_post","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/part-versions/{version_id}/optimise":{"post":{"summary":"Optimise a version","description":"Start a working version from a final one, to change it in Design: it starts as the part was uploaded, and turns change only what's asked. A part has one working version at a time: 409 PART_VERSION_IN_WORK names who holds it.","operationId":"optimise_version_api_v1_part_versions__version_id__optimise_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Picks"},{"type":"null"}],"title":"Body"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}":{"get":{"summary":"Get a design","description":"A version made in Design: whether it's built, its picks, its latest quick check, its checkpoints and its features: what the part is made of, in order, each with the sizes that edit_design_feature changes.","operationId":"get_design_api_v1_designs__version_id__get","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"read"},"delete":{"summary":"Delete a working version","description":"Delete the working version you hold, with its checkpoints and turns. Final versions are kept.","operationId":"delete_design_api_v1_designs__version_id__delete","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"destructive"}},"/api/v1/designs/{version_id}/turns":{"post":{"summary":"Run a Design turn","description":"Ask Protyus AI to change the working version: it changes the part, which is built and quick-checked, and the answer is what changed, the score before and after, and the findings fixed and found. It changes only the working version. Limited per person a minute and a day (429 DESIGN_RATE_LIMITED, DESIGN_DAILY_LIMIT). Mode auto needs the design_auto entitlement and design:auto.","operationId":"run_design_turn_api_v1_designs__version_id__turns_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnIn"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}/attachments":{"post":{"summary":"Attach a drawing","description":"Attach a PDF drawing, a hand sketch or a photo of a part to the working version, base64, to build from: at most 3 MB, a PDF of at most 10 pages, a picture at most 8000 pixels a side, and at most 10 a version. Its type is told from its bytes, and a picture's metadata (EXIF, GPS, XMP) is cut out before it's kept. Read it with read_design_attachment before a turn builds from it. It's deleted with the working version, and when it's finalised.","operationId":"add_design_attachment_api_v1_designs__version_id__attachments_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}/attachments/{attachment_id}/read":{"post":{"summary":"Read a drawing","description":"Protyus AI reads the attachment and says what it read (each size, hole and thread) and what it left out, and builds nothing. Show the person the items to correct, then run_design_turn with the attachment and the items as they confirmed them. The picture is sent to the AI model as its bytes, with zero data retention. Counts against the turn limits (429 DESIGN_RATE_LIMITED, DESIGN_DAILY_LIMIT), never against the monthly analyses.","operationId":"read_design_attachment_api_v1_designs__version_id__attachments__attachment_id__read_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","description":"The attachment's id, from add_design_attachment.","title":"Attachment Id"},"description":"The attachment's id, from add_design_attachment."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ReadIn"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadingOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}/attachments/{attachment_id}":{"delete":{"summary":"Remove a drawing","description":"Remove an attachment from the working version and delete its file. A turn built from it keeps what was read from it, never the file.","operationId":"remove_design_attachment_api_v1_designs__version_id__attachments__attachment_id__delete","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","description":"The attachment's id, from add_design_attachment.","title":"Attachment Id"},"description":"The attachment's id, from add_design_attachment."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"destructive"}},"/api/v1/designs/{version_id}/turns/{turn_id}":{"get":{"summary":"Get a Design turn","description":"One turn's conclusions.","operationId":"get_design_turn_api_v1_designs__version_id__turns__turn_id__get","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"turn_id","in":"path","required":true,"schema":{"type":"string","description":"The turn's id, from run_design_turn.","title":"Turn Id"},"description":"The turn's id, from run_design_turn."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"read"}},"/api/v1/designs/{version_id}/progress":{"get":{"summary":"Follow a Design turn","description":"The version's newest turn and what it has done so far, in the person's words: poll it while a turn's own request is still running.","operationId":"get_design_progress_api_v1_designs__version_id__progress_get","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnProgressOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"read"}},"/api/v1/designs/{version_id}/preview":{"get":{"summary":"Preview a Design turn","description":"The part as the version's newest turn has built it so far, for a 3D viewer, with no quick check yet: read it when GET .../progress says its preview_step has moved on.","operationId":"get_design_preview_api_v1_designs__version_id__preview_get","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"read"}},"/api/v1/designs/{version_id}/turns/{turn_id}/undo":{"post":{"summary":"Undo a Design turn","description":"Undo the newest turn that changed the part: it's rebuilt as it was before, with no AI call, and the next turn starts from there. Only the newest can be undone (409 DESIGN_TURN_NOT_LATEST); a checkpoint goes further back.","operationId":"undo_design_turn_api_v1_designs__version_id__turns__turn_id__undo_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"turn_id","in":"path","required":true,"schema":{"type":"string","description":"The turn's id, from run_design_turn.","title":"Turn Id"},"description":"The turn's id, from run_design_turn."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","x-protyus-risk":"change","tags":["Design"]}},"/api/v1/designs/{version_id}/features/{number}":{"patch":{"summary":"Change a design feature","description":"Change one feature of the working version yourself: its sizes, its position, its thread, screw or bearing. The part is rebuilt and quick-checked with no AI call, and the answer is the change as a turn of mode edit: the score before and after and the findings fixed and found. undo_design_turn takes it back. A part that wouldn't build is refused with the reason (422 DESIGN_FEATURE_NOT_BUILT) and nothing changes. It counts nothing against the monthly analyses, and counts against the turn limits.","operationId":"edit_design_feature_api_v1_designs__version_id__features__number__patch","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"number","in":"path","required":true,"schema":{"type":"integer","maximum":10000,"minimum":1,"description":"The feature's number in get_design's features, from 1.","title":"Number"},"description":"The feature's number in get_design's features, from 1."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeatureEditIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"},"delete":{"summary":"Remove a design feature","description":"Remove one feature from the working version yourself, with no AI call: the part is rebuilt without it and quick-checked, and the answer is the change as a turn of mode edit. The first feature starts the part and stays. undo_design_turn takes it back.","operationId":"remove_design_feature_api_v1_designs__version_id__features__number__delete","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"number","in":"path","required":true,"schema":{"type":"integer","maximum":10000,"minimum":1,"description":"The feature's number in get_design's features, from 1.","title":"Number"},"description":"The feature's number in get_design's features, from 1."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","x-protyus-risk":"change","tags":["Design"]}},"/api/v1/designs/{version_id}/check":{"post":{"summary":"Check a design","description":"Quick-check the working version with another machine, material or quantity, without a turn: the score and findings, stored with the version, never as an analysis. It counts nothing against the monthly analyses, and counts against the turn limits.","operationId":"check_design_api_v1_designs__version_id__check_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Picks"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}/checkpoints":{"post":{"summary":"Save a checkpoint","description":"Save the working version as it is now, to go back to. At most 25 a version: 409 DESIGN_CHECKPOINTS_FULL.","operationId":"save_design_checkpoint_api_v1_designs__version_id__checkpoints_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckpointOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"},"get":{"summary":"List checkpoints","description":"The working version's checkpoints, oldest first, with the quick check's score at each.","operationId":"list_design_checkpoints_api_v1_designs__version_id__checkpoints_get","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CheckpointOut"},"title":"Response List Design Checkpoints Api V1 Designs  Version Id  Checkpoints Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"read"}},"/api/v1/designs/{version_id}/checkpoints/{checkpoint_id}/restore":{"post":{"summary":"Restore a checkpoint","description":"Go back to a checkpoint: the part is rebuilt as it was then, with no AI call, and the next turn starts from it.","operationId":"restore_design_checkpoint_api_v1_designs__version_id__checkpoints__checkpoint_id__restore_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"checkpoint_id","in":"path","required":true,"schema":{"type":"string","description":"The checkpoint's id, from save_design_checkpoint or get_design.","title":"Checkpoint Id"},"description":"The checkpoint's id, from save_design_checkpoint or get_design."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-writes":"working_version","tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}/checkpoints/{checkpoint_id}":{"delete":{"summary":"Remove a checkpoint","description":"Remove one checkpoint from the working version. The part doesn't change.","operationId":"remove_design_checkpoint_api_v1_designs__version_id__checkpoints__checkpoint_id__delete","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"checkpoint_id","in":"path","required":true,"schema":{"type":"string","description":"The checkpoint's id, from save_design_checkpoint or get_design.","title":"Checkpoint Id"},"description":"The checkpoint's id, from save_design_checkpoint or get_design."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"destructive"}},"/api/v1/designs/{version_id}/analyse":{"post":{"summary":"Analyse a design","description":"Run a full analysis of the working version: it's saved first as a final version of its own, so the analysis names a file that never changes. Counts one analysis, unless that STEP file was already analysed this month.","operationId":"analyse_design_api_v1_designs__version_id__analyse_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysedOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}/finalise":{"post":{"summary":"Finalise a design","description":"Finalise the working version: it never changes again, its checkpoints go, and its analysis runs and is kept. Needs parts:finalize on the project (part approver, or the project's owner). Counts one analysis, unless that STEP file was already analysed this month.","operationId":"finalise_design_api_v1_designs__version_id__finalise_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysedOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"change"}},"/api/v1/designs/{version_id}/step":{"get":{"summary":"Download a design","description":"The version's STEP file, written the same way every time.","operationId":"download_design_api_v1_designs__version_id__step_get","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."}],"responses":{"200":{"description":"The STEP file.","content":{"application/json":{"schema":{}},"application/step":{}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Design"],"x-protyus-risk":"read"}},"/api/v1/designs/{version_id}/turns/{turn_id}/feedback":{"post":{"summary":"Send turn feedback","description":"Send the Protyus team this turn: your words, its prompt, Protyus AI's reply, the part it made and its quick check. Refused with FEEDBACK_SHARING_OFF until an admin turns feedback sharing on.","operationId":"send_design_feedback_api_v1_designs__version_id__turns__turn_id__feedback_post","parameters":[{"name":"version_id","in":"path","required":true,"schema":{"type":"string","description":"The working version's id, from start_design or optimise_version.","title":"Version Id"},"description":"The working version's id, from start_design or optimise_version."},{"name":"turn_id","in":"path","required":true,"schema":{"type":"string","description":"The turn's id, from run_design_turn.","title":"Turn Id"},"description":"The turn's id, from run_design_turn."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignFeedbackIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignFeedbackSent"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"change","tags":["Design"]}},"/api/v1/projects/{project_id}/analyses":{"post":{"summary":"Start analysis","description":"Start analysing an uploaded STEP file, kept in a project (any project member). Upload the file first: POST /api/v1/uploads gives a URL to send it to, which answers with the upload_url. This answers at once with the analysis's id and status running; the engine works in the background. Poll GET /api/v1/analyses/{analysis_id} every few seconds until status is ready (with the result) or failed (with the error). The upload is deleted afterwards; the analysis keeps its own copy. A failed analysis stores nothing. A sheet metal or moulding analysis may name the machine it's made on and its grade or resin with process_machine and process_material, from the project's choices; a machine picked is the only one it's costed on, and Best Fit (auto) takes the cheapest that can make it.","operationId":"create_analysis_api_v1_projects__project_id__analyses_post","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisIn"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"},"get":{"summary":"List analyses","description":"List a project's analyses, newest first. Each says its iteration and how many iterations its part has; latest_only shows each part once.","operationId":"list_analyses_api_v1_projects__project_id__analyses_get","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."},{"name":"latest_only","in":"query","required":false,"schema":{"type":"boolean","description":"True to show each part once: an analysis with a later iteration is left out, and its latest iteration stands for the group, with iterations saying how many it has.","default":false,"title":"Latest Only"},"description":"True to show each part once: an analysis with a later iteration is left out, and its latest iteration stands for the group, with iterations saying how many it has."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalysisOut"},"title":"Response List Analyses Api V1 Projects  Project Id  Analyses Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/analyses/recent":{"get":{"summary":"List recent analyses","description":"The caller's most recent analyses across every project they can see.","operationId":"recent_analyses_api_v1_analyses_recent_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"How many to return.","default":10,"title":"Limit"},"description":"How many to return."},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only analyses run at or after this time.","title":"Since"},"description":"Only analyses run at or after this time."},{"name":"latest_only","in":"query","required":false,"schema":{"type":"boolean","description":"True to show each part once: an analysis with a later iteration is left out, and its latest iteration stands for the group, with iterations saying how many it has.","default":false,"title":"Latest Only"},"description":"True to show each part once: an analysis with a later iteration is left out, and its latest iteration stands for the group, with iterations saying how many it has."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalysisOut"},"title":"Response Recent Analyses Api V1 Analyses Recent Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/analyses/{analysis_id}":{"get":{"summary":"Get analysis","description":"One analysis: its status, and its result once ready. While status is running, result is null: ask again in a few seconds. A failed analysis is reported once with its error, then removed, so asking again gives 404. The result can be a few hundred kB, most of it the display mesh: name the sections you need. recognition.setup_plan holds the setups, recognition.dfm the findings and scorecard on each machine, recognition.estimate the time, cost and tools (time.setups[].tools lists each setup's tools, and each item names the tool that cuts it), recognition.holes and recognition.pockets the features, and part the part's size, faces and file warnings. A STEP AP242 file that carries tolerances (PMI) also has characteristics: each toleranced dimension and geometric tolerance on its faces, and the datums. A round part can also have turning: whether it turns on a lathe and why or why not (turning.reasons), and for a lathe part what the lathe turns, its operations, findings, routes (mill only, lathe then mill, mill-turn), each costed, and the one it's made by (turning.route), which price_analysis prices.","operationId":"get_analysis_api_v1_analyses__analysis_id__get","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."},{"name":"sections","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Which parts of the result to return: a group (part, display, recognition or, where the result has them, characteristics or turning) or one of its keys, such as recognition.setup_plan, kept at its place in the result. Leave out for the whole result. One that isn't there is refused with UNKNOWN_SECTION, which lists what is.","default":[],"title":"Sections"},"description":"Which parts of the result to return: a group (part, display, recognition or, where the result has them, characteristics or turning) or one of its keys, such as recognition.setup_plan, kept at its place in the result. Leave out for the whole result. One that isn't there is refused with UNKNOWN_SECTION, which lists what is."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"},"delete":{"summary":"Delete analysis","description":"Delete an analysis (whoever ran it, the project's owner or an admin). One someone sent feedback about is kept for the Protyus team but no longer shown; one without is removed.","operationId":"delete_analysis_api_v1_analyses__analysis_id__delete","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"destructive"}},"/api/v1/analyses/{analysis_id}/view":{"post":{"summary":"View part","description":"Show the person something on the part: which faces to highlight, in what tone, from which side, as frames to step through (anyone who can see the analysis; it changes nothing). Use it to show rather than tell: what's wrong (preset problems), how it's set up (preset setups; for one setup, a frame with ref {setup: n} and camera {setup: n}), why it scores what it does (preset score), or frames you write naming a finding by its id, a score check by its code, a setup by its number, a hole or pocket by its index in recognition.holes or recognition.pockets, a role, or faces. camera bottom shows it from underneath; auto looks from the side that shows the highlights best. On a lathe part, preset route shows how it's made: what the lathe turns about its axis, then each operation of the route it's made by, with its arrow; frames can name a turned feature ({turned: T3}), an operation of a route ({step: 1}), camera profile (side on to the turning axis) and the layers turning_axis and step_arrows. On a part that isn't turned, preset route says why not. The faces, cameras, callout numbers and anchors are worked out here; a reference that doesn't resolve is left out and listed in dropped, and the rest still draws. It carries no mesh: the card draws the part from GET /api/v1/analyses/{analysis_id} with sections=display. Refused with ANALYSIS_NOT_READY (409) while the analysis runs, and INVALID_VIEW, naming the field, for a view that isn't one: preset and frames together, more than 8 frames or highlights, an unknown tone.","operationId":"view_part_api_v1_analyses__analysis_id__view_post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"read","tags":["Analyses"]}},"/api/v1/analyses/{analysis_id}/view/picture":{"post":{"summary":"View part picture","description":"One frame of a part view as a PNG picture, 800 by 600 pixels, drawn as the card draws it: the highlights in their tones, the rest of the part faded, numbered callouts (dashed when round the back), setup arrows and the section cut, and on a lathe part its turning axis and route operations' arrows, from the frame's camera (anyone who can see the analysis; it changes nothing). Takes what POST /api/v1/analyses/{analysis_id}/view takes, plus frame, the frame to draw from 0. Use it to see the part, or to show it where the interactive view can't be drawn. Refused as POST /api/v1/analyses/{analysis_id}/view refuses, and with INVALID_VIEW, naming frame, for a frame the view doesn't have.","operationId":"view_part_picture_api_v1_analyses__analysis_id__view_picture_post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PictureIn"}}}},"responses":{"200":{"description":"The picture.","content":{"image/png":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"read","tags":["Analyses"]}},"/api/v1/analyses/{analysis_id}/flat/dxf":{"get":{"summary":"Get flat pattern DXF","description":"A sheet metal analysis's flat pattern as a DXF to cut from: AutoCAD R12, which every cutting and CAM program reads (anyone who can see the analysis and run a sheet metal analysis). The outline is on layer OUTER, holes, slots and cut-outs on INNER, each bend line on BEND_UP or BEND_DOWN, and each bend's note (direction, angle, inside radius and bend allowance) on ANNOTATION, from the flat's (0, 0) corner. It draws result.sheet_metal.flat, which has the same size, cut length, pierces and bend lines in numbers. Refused with ANALYSIS_NOT_READY (409) while the analysis runs, NO_FLAT_PATTERN (409) for an analysis that isn't sheet metal or a part that couldn't be unfolded, and PROCESS_NOT_AVAILABLE (403) where sheet metal isn't open to you.","operationId":"get_flat_dxf_api_v1_analyses__analysis_id__flat_dxf_get","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."},{"name":"units","in":"query","required":false,"schema":{"enum":["mm","in"],"type":"string","description":"The DXF's units: mm or in (inches).","default":"mm","title":"Units"},"description":"The DXF's units: mm or in (inches)."}],"responses":{"200":{"description":"The DXF.","content":{"application/dxf":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/analyses/{analysis_id}/iterations":{"post":{"summary":"Add iteration","description":"Start analysing a changed STEP file of the same part as its next iteration, in the analysis's project (anyone who can run an analysis there). Upload the file first, as for POST /api/v1/projects/{project_id}/analyses. Machine, material and quantity default to the latest iteration's. It's a full analysis of its own: this answers at once with status running, and GET /api/v1/analyses/{analysis_id} on its id gives the result once it's ready.","operationId":"add_iteration_api_v1_analyses__analysis_id__iterations_post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IterationIn"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"},"get":{"summary":"List iterations","description":"Every ready iteration of an analysis's part, iteration 1 first. An analysis with no other iterations lists itself alone.","operationId":"list_iterations_api_v1_analyses__analysis_id__iterations_get","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalysisOut"},"title":"Response List Iterations Api V1 Analyses  Analysis Id  Iterations Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/analyses/{analysis_id}/reruns":{"post":{"summary":"Rerun analysis","description":"Run a ready analysis's own STEP file again as its part's next iteration, with changed picks, such as a moulding analysis's parting plane set by hand (anyone who can run an analysis in its project). Each pick left out is this analysis's; leaving out parting_plane runs with the plane the engine finds, which resets one set by hand. The analysis keeps its result, so compare_iterations shows what the change did. This answers at once with status running; GET /api/v1/analyses/{analysis_id} on the new id gives the result once it's ready. Refused with ANALYSIS_NOT_READY while this one runs.","operationId":"rerun_analysis_api_v1_analyses__analysis_id__reruns_post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RerunIn"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"}},"/api/v1/analyses/{analysis_id}/compare/{other_id}":{"get":{"summary":"Compare iterations","description":"Two ready analyses side by side, the earlier first, usually two iterations of one part: verdict, score, setups, minutes and cost a part, and the findings fixed, added and kept. changed_picks says whether the machine, material or quantity changed too.","operationId":"compare_iterations_api_v1_analyses__analysis_id__compare__other_id__get","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."},{"name":"other_id","in":"path","required":true,"schema":{"type":"string","description":"The other analysis's id, usually another iteration from GET /api/v1/analyses/{analysis_id}/iterations.","title":"Other Id"},"description":"The other analysis's id, usually another iteration from GET /api/v1/analyses/{analysis_id}/iterations."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IterationComparison"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/analyses/{analysis_id}/lines/{line}/tools":{"get":{"summary":"List line tools","description":"The tools one Time tab line may take by hand (anyone who can see the analysis): valid for it by the engine's own rule, no larger than the largest diameter its feature allows, reaching the flute length it needs, of a type and corner radius it takes. The organization's allowed tools come first, then the standard sizes, each to buy where the organization has tools of its own; current marks the one it uses. A line is a time item with a line id in recognition.estimate.time; one without, such as drilling, isn't changed by hand. Refused with LINE_NOT_FOUND for a line that isn't there, and ANALYSIS_NOT_READY while it runs.","operationId":"list_line_tools_api_v1_analyses__analysis_id__lines__line__tools_get","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."},{"name":"line","in":"path","required":true,"schema":{"type":"string","maxLength":120,"description":"The line's id: a time item's line in the analysis's result, recognition.estimate.time.setups[].items[].line.","title":"Line"},"description":"The line's id: a time item's line in the analysis's result, recognition.estimate.time.setups[].items[].line."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineTools"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/analyses/{analysis_id}/lines/{line}/tool":{"put":{"summary":"Set line tool","description":"Choose one Time tab line's tool by hand, a manual tool override (anyone who can run an analysis in its project): one of the tools GET /api/v1/analyses/{analysis_id}/lines/{line}/tools lists, by its key, else refused with TOOL_NOT_VALID. It re-runs the analysis on its own file, keeping every line's override, with its machine, material and quantity and the project's settings as they are now, so time, cost and the totals move with the tool. It answers at once with rerun running; the analysis stays ready, with its last result, until GET /api/v1/analyses/{analysis_id} shows rerun null and the new result, or rerun failed with why, the last result kept. Refused with RERUN_RUNNING while one runs. An override is kept by later re-runs and new iterations, and goes back to automatic, listed in recognition.estimate.time.reverted, where its tool no longer fits the line.","operationId":"set_line_tool_api_v1_analyses__analysis_id__lines__line__tool_put","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."},{"name":"line","in":"path","required":true,"schema":{"type":"string","maxLength":120,"description":"The line's id: a time item's line in the analysis's result, recognition.estimate.time.setups[].items[].line.","title":"Line"},"description":"The line's id: a time item's line in the analysis's result, recognition.estimate.time.setups[].items[].line."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolChoiceIn"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"},"delete":{"summary":"Revert line tool","description":"Revert one Time tab line to its automatic tool, removing its manual tool override (anyone who can run an analysis in its project). It re-runs the analysis with the other overrides, as PUT /api/v1/analyses/{analysis_id}/lines/{line}/tool does, and answers at once with rerun running. Refused with OVERRIDE_NOT_FOUND where the line's tool wasn't chosen by hand, and RERUN_RUNNING while a re-run runs.","operationId":"revert_line_tool_api_v1_analyses__analysis_id__lines__line__tool_delete","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."},{"name":"line","in":"path","required":true,"schema":{"type":"string","maxLength":120,"description":"The line's id: a time item's line in the analysis's result, recognition.estimate.time.setups[].items[].line.","title":"Line"},"description":"The line's id: a time item's line in the analysis's result, recognition.estimate.time.setups[].items[].line."}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"change","tags":["Analyses"]}},"/api/v1/analyses/{analysis_id}/feedback":{"post":{"summary":"Send feedback","description":"Send Protyus feedback about an analysis (anyone who can see it), once the company shares feedback: refused with FEEDBACK_SHARING_OFF until an admin turns it on. Feedback goes to the Protyus team, to improve the analysis. It can't be read back by the sender.","operationId":"send_feedback_api_v1_analyses__analysis_id__feedback_post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSent"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"}},"/api/v1/machines":{"get":{"summary":"List machine types","description":"The machine types an analysis can plan for.","operationId":"list_machines_api_v1_machines_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MachineOut"},"type":"array","title":"Response List Machines Api V1 Machines Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/library/kinds":{"get":{"summary":"List library kinds","description":"List the kinds of library item and the schema each one's data matches.","operationId":"list_kinds_api_v1_library_kinds_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/KindOut"},"type":"array","title":"Response List Kinds Api V1 Library Kinds Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"}},"/api/v1/library/{kind}/items":{"get":{"summary":"List library items","description":"List an organization library's items at their current revision.","operationId":"list_items_api_v1_library__kind__items_get","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","description":"The kind of item, such as tool, from GET /api/v1/library/kinds.","title":"Kind"},"description":"The kind of item, such as tool, from GET /api/v1/library/kinds."},{"name":"archived","in":"query","required":false,"schema":{"type":"string","pattern":"^(no|yes|any)$","description":"Include archived items: no, only them (yes), or any.","default":"no","title":"Archived"},"description":"Include archived items: no, only them (yes), or any."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"How many items to return at most.","default":100,"title":"Limit"},"description":"How many items to return at most."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many matching items to skip, for the next page.","default":0,"title":"Offset"},"description":"How many matching items to skip, for the next page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPage"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"},"post":{"summary":"Create library item","description":"Add an item to the organization's library (needs the kind's write permission).","operationId":"create_item_api_v1_library__kind__items_post","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","description":"The kind of item, such as tool, from GET /api/v1/library/kinds.","title":"Kind"},"description":"The kind of item, such as tool, from GET /api/v1/library/kinds."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"change"}},"/api/v1/library/{kind}/items/search":{"post":{"summary":"Search library items","description":"List the items matching a filter. Filter by ids and by fields of the current revision's data. Lengths are compared in mm.","operationId":"search_items_api_v1_library__kind__items_search_post","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","description":"The kind of item, such as tool, from GET /api/v1/library/kinds.","title":"Kind"},"description":"The kind of item, such as tool, from GET /api/v1/library/kinds."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"How many items to return at most.","default":100,"title":"Limit"},"description":"How many items to return at most."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many matching items to skip, for the next page.","default":0,"title":"Offset"},"description":"How many matching items to skip, for the next page."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemFilter"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPage"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"}},"/api/v1/library/{kind}/items/archive":{"post":{"summary":"Archive library items","description":"Archive many items at once, as one batch that can be undone. Give ids, a where filter, or both. Undo with POST /api/v1/library/batches/{batch_id}/undo.","operationId":"archive_items_api_v1_library__kind__items_archive_post","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","description":"The kind of item, such as tool, from GET /api/v1/library/kinds.","title":"Kind"},"description":"The kind of item, such as tool, from GET /api/v1/library/kinds."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemFilter"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"destructive"}},"/api/v1/library/items/{item_id}":{"get":{"summary":"Get library item","description":"An item, archived or not, with every revision.","operationId":"get_item_api_v1_library_items__item_id__get","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The library item's id, a UUID.","title":"Item Id"},"description":"The library item's id, a UUID."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"},"delete":{"summary":"Delete library item","description":"Delete an archived item and all its revisions for good (admins). Analyses that used it can no longer show it. Archive instead unless it must be gone.","operationId":"purge_item_api_v1_library_items__item_id__delete","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The library item's id, a UUID.","title":"Item Id"},"description":"The library item's id, a UUID."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"destructive"}},"/api/v1/library/items/{item_id}/revisions":{"post":{"summary":"Edit library item","description":"Edit an item, which saves a new revision (needs the kind's write permission). Earlier revisions never change, so analyses that used them still read them.","operationId":"edit_item_api_v1_library_items__item_id__revisions_post","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The library item's id, a UUID.","title":"Item Id"},"description":"The library item's id, a UUID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemEdit"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"change"}},"/api/v1/library/items/{item_id}/archive":{"post":{"summary":"Archive library item","description":"Archive an item: it leaves the library but stays readable.","operationId":"archive_item_api_v1_library_items__item_id__archive_post","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The library item's id, a UUID.","title":"Item Id"},"description":"The library item's id, a UUID."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"destructive"}},"/api/v1/library/items/{item_id}/unarchive":{"post":{"summary":"Unarchive library item","description":"Put an archived item back in the library.","operationId":"unarchive_item_api_v1_library_items__item_id__unarchive_post","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The library item's id, a UUID.","title":"Item Id"},"description":"The library item's id, a UUID."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"change"}},"/api/v1/library/revisions/{revision_id}":{"get":{"summary":"Get library revision","description":"One revision of an item, even if the item is archived.","operationId":"get_revision_api_v1_library_revisions__revision_id__get","parameters":[{"name":"revision_id","in":"path","required":true,"schema":{"type":"string","description":"A revision's id, a UUID, as an analysis records it.","title":"Revision Id"},"description":"A revision's id, a UUID, as an analysis records it."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevisionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"}},"/api/v1/library/batches":{"get":{"summary":"List library batches","description":"List imports and bulk archives, newest first.","operationId":"list_batches_api_v1_library_batches_get","parameters":[{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only batches of this kind, such as tool.","title":"Kind"},"description":"Only batches of this kind, such as tool."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"How many batches to return at most.","default":50,"title":"Limit"},"description":"How many batches to return at most."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BatchOut"},"title":"Response List Batches Api V1 Library Batches Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"}},"/api/v1/library/batches/{batch_id}":{"get":{"summary":"Get library batch","description":"One import or bulk archive.","operationId":"get_batch_api_v1_library_batches__batch_id__get","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","description":"The batch's id, a UUID, from GET /api/v1/library/batches.","title":"Batch Id"},"description":"The batch's id, a UUID, from GET /api/v1/library/batches."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"}},"/api/v1/library/batches/{batch_id}/undo":{"post":{"summary":"Undo library batch","description":"Undo an import or bulk archive (needs the kind's write permission). Items it added are archived, items it updated go back to their earlier revision, and items it archived come back. Items changed since the batch are left alone and listed in skipped.","operationId":"undo_batch_api_v1_library_batches__batch_id__undo_post","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","description":"The batch's id, a UUID, from GET /api/v1/library/batches.","title":"Batch Id"},"description":"The batch's id, a UUID, from GET /api/v1/library/batches."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UndoOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"destructive"}},"/api/v1/library/{kind}/collections":{"get":{"summary":"List collections","description":"List the organization's collections of one kind.","operationId":"list_collections_api_v1_library__kind__collections_get","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","description":"The kind of item, such as tool, from GET /api/v1/library/kinds.","title":"Kind"},"description":"The kind of item, such as tool, from GET /api/v1/library/kinds."},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","description":"List archived collections instead.","default":false,"title":"Archived"},"description":"List archived collections instead."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CollectionOut"},"title":"Response List Collections Api V1 Library  Kind  Collections Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"},"post":{"summary":"Create collection","description":"Make a collection, empty, from items or from a filter (needs the kind's write permission). A filter is applied once: the items matching now are kept as a fixed list.","operationId":"create_collection_api_v1_library__kind__collections_post","parameters":[{"name":"kind","in":"path","required":true,"schema":{"type":"string","description":"The kind of item, such as tool, from GET /api/v1/library/kinds.","title":"Kind"},"description":"The kind of item, such as tool, from GET /api/v1/library/kinds."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"change"}},"/api/v1/library/collections/{collection_id}":{"get":{"summary":"Get collection","description":"One collection, with how many items it holds.","operationId":"get_collection_api_v1_library_collections__collection_id__get","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections.","title":"Collection Id"},"description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"},"patch":{"summary":"Update collection","description":"Rename a collection or change its description.","operationId":"change_collection_api_v1_library_collections__collection_id__patch","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections.","title":"Collection Id"},"description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionChange"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"change"}},"/api/v1/library/collections/{collection_id}/items":{"get":{"summary":"List collection items","description":"A collection's items at their current revision. Archived items are left out unless asked for. An edit to an item shows here at once.","operationId":"collection_items_api_v1_library_collections__collection_id__items_get","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections.","title":"Collection Id"},"description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections."},{"name":"archived","in":"query","required":false,"schema":{"type":"string","pattern":"^(no|yes|any)$","description":"Include archived items: no, only them (yes), or any.","default":"no","title":"Archived"},"description":"Include archived items: no, only them (yes), or any."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"How many items to return at most.","default":100,"title":"Limit"},"description":"How many items to return at most."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many matching items to skip, for the next page.","default":0,"title":"Offset"},"description":"How many matching items to skip, for the next page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPage"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"read"},"post":{"summary":"Add collection items","description":"Put items in a collection.","operationId":"add_collection_items_api_v1_library_collections__collection_id__items_post","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections.","title":"Collection Id"},"description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItemsIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"change"}},"/api/v1/library/collections/{collection_id}/items/remove":{"post":{"summary":"Remove collection items","description":"Take items out of a collection; they stay in the library.","operationId":"remove_collection_items_api_v1_library_collections__collection_id__items_remove_post","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections.","title":"Collection Id"},"description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionItemsIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"destructive"}},"/api/v1/library/collections/{collection_id}/archive":{"post":{"summary":"Archive collection","description":"Archive a collection; its items are untouched.","operationId":"archive_collection_api_v1_library_collections__collection_id__archive_post","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections.","title":"Collection Id"},"description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"destructive"}},"/api/v1/library/collections/{collection_id}/unarchive":{"post":{"summary":"Unarchive collection","description":"Put an archived collection back.","operationId":"unarchive_collection_api_v1_library_collections__collection_id__unarchive_post","parameters":[{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections.","title":"Collection Id"},"description":"The collection's id, a UUID, from GET /api/v1/library/{kind}/collections."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Library"],"x-protyus-risk":"change"}},"/api/v1/tools/search":{"post":{"summary":"Search tools","description":"Search the organization's tools.","operationId":"search_api_v1_tools_search_post","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"How many tools to return at most.","default":100,"title":"Limit"},"description":"How many tools to return at most."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many matching tools to skip, for the next page.","default":0,"title":"Offset"},"description":"How many matching tools to skip, for the next page."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolQuery"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPage"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"read"}},"/api/v1/tools/facets":{"get":{"summary":"List tool facets","description":"The vendors, coatings and tool materials the library's filters can offer.","operationId":"facets_api_v1_tools_facets_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolFacets"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"read"}},"/api/v1/tools":{"post":{"summary":"Create tool","description":"Add a tool to the organization's library (tools:write).","operationId":"create_api_v1_tools_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cutter"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"change"}},"/api/v1/tools/{item_id}/revisions":{"post":{"summary":"Edit tool","description":"Edit a tool, which saves a new revision (tools:write). Archive it with POST /api/v1/library/items/{item_id}/archive, bring it back with POST /api/v1/library/items/{item_id}/unarchive, and read its history with GET /api/v1/library/items/{item_id}.","operationId":"edit_api_v1_tools__item_id__revisions_post","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The tool's library item id, a UUID.","title":"Item Id"},"description":"The tool's library item id, a UUID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolEdit"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"change"}},"/api/v1/tools/standard-sizes/search":{"post":{"summary":"Search standard sizes","description":"Search the standard sizes, the read-only reference library.","operationId":"standard_sizes_api_v1_tools_standard_sizes_search_post","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"How many tools to return at most.","default":100,"title":"Limit"},"description":"How many tools to return at most."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many matching tools to skip, for the next page.","default":0,"title":"Offset"},"description":"How many matching tools to skip, for the next page."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolQuery"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardSizes"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"read"}},"/api/v1/tools/standard-sizes/copy":{"post":{"summary":"Copy standard sizes","description":"Copy standard sizes into the organization's library (tools:write). They're added as one batch, which POST /api/v1/library/batches/{batch_id}/undo takes back out.","operationId":"copy_standard_api_v1_tools_standard_sizes_copy_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"change"}},"/api/v1/tools/imports/preview":{"post":{"summary":"Preview tool import","description":"Preview importing a Fusion or CSV tool file (tools:write). Reads an uploaded file and says what importing it would do, row by row: new, exact or likely duplicate, changed, or invalid with the reason. Changes nothing.","operationId":"preview_import_api_v1_tools_imports_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSource"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportPreview"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"read"}},"/api/v1/tools/imports":{"post":{"summary":"Import tools","description":"Import a Fusion or CSV tool file as one batch (tools:write). Rows take their status's default action (new: add, exact and likely duplicates: skip, changed: update) unless group_actions or actions say otherwise. Undo with POST /api/v1/library/batches/{batch_id}/undo; list imports with GET /api/v1/library/batches, kind tool. The upload is deleted once it's imported.","operationId":"commit_import_api_v1_tools_imports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportCommit"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"change"}},"/api/v1/tools/imports/template.csv":{"get":{"summary":"Get import template","description":"The CSV template for importing tools. One column per tool field, with two example rows. Lengths are in each row's unit.","operationId":"template_api_v1_tools_imports_template_csv_get","responses":{"200":{"description":"The template.","content":{"application/json":{"schema":{}},"text/csv":{}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"read"}},"/api/v1/tools/export":{"get":{"summary":"Export tools","description":"Export the organization's tools as CSV or Fusion tool JSON. Every tool in the library, lengths in each tool's own unit, so a shop can take its tools anywhere.","operationId":"export_api_v1_tools_export_get","parameters":[{"name":"format","in":"query","required":false,"schema":{"type":"string","pattern":"^(csv|fusion)$","description":"csv, or fusion for Fusion's tool JSON.","default":"csv","title":"Format"},"description":"csv, or fusion for Fusion's tool JSON."}],"responses":{"200":{"description":"The file.","content":{"application/json":{"schema":{}},"text/csv":{}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tools"],"x-protyus-risk":"read"}},"/api/v1/machine-classes":{"get":{"summary":"List machine classes","description":"List the machine classes, the fields each class's machines have and the values it fills in. Its process is milling for a mill, which an analysis plans on, or turning for a lathe or mill-turn, which an analysis never mills on.","operationId":"list_classes_api_v1_machine_classes_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MachineClassOut"},"type":"array","title":"Response List Classes Api V1 Machine Classes Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"read"}},"/api/v1/organization/machines":{"get":{"summary":"List machines","description":"List the organization's machines, each value marked as its own or its class's. An organization with no machines gets every reference mill, numbered #1, and a generic machine for each milling class the list has none of, the first time they're listed.","operationId":"list_machines_api_v1_organization_machines_get","parameters":[{"name":"archived","in":"query","required":false,"schema":{"type":"string","pattern":"^(no|yes|any)$","description":"Include hidden (archived) machines: no, only them (yes), or any.","default":"no","title":"Archived"},"description":"Include hidden (archived) machines: no, only them (yes), or any."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResolvedMachine"},"title":"Response List Machines Api V1 Organization Machines Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"read"},"post":{"summary":"Create machine","description":"Add a machine (machines:write). It takes only its class's fields, as GET /api/v1/machine-classes lists them.","operationId":"create_machine_api_v1_organization_machines_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Machine"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedMachine"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/reference-machines":{"get":{"summary":"List reference machines","description":"List Protyus's reference machines: real models, mills, lathes and mill-turns, each with its class, its maker's specs and the machine it fills in. Add one with POST /api/v1/organization/machines/from-reference.","operationId":"list_reference_machines_api_v1_reference_machines_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ReferenceMachine"},"type":"array","title":"Response List Reference Machines Api V1 Reference Machines Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"read"}},"/api/v1/organization/machines/from-reference":{"post":{"summary":"Create machine from reference","description":"Add a machine filled in from a reference machine, by its key, under the shop's own name for it (machines:write). Change any value afterwards with POST /api/v1/organization/machines/{item_id}/revisions.","operationId":"create_machine_from_reference_api_v1_organization_machines_from_reference_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineFromReference"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedMachine"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/organization/machines/from-reference/all":{"post":{"summary":"Add all reference machines","description":"Add every reference mill the organization doesn't have yet, matched on make and model, each named make and model #1 (machines:write). A machine the organization archived counts as one it has, so it isn't added back. Running it again adds nothing. Lathes and mill-turns aren't added: add each one the shop has with POST /api/v1/organization/machines/from-reference.","operationId":"add_all_reference_machines_api_v1_organization_machines_from_reference_all_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddedFromList"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/organization/machines/hide":{"post":{"summary":"Hide machines","description":"Hide machines from the machine menus, for the whole organization (machines:write). A hidden machine is archived: it's in no project's choices, and an analysis that asks for it, or whose project's default it is, is refused with MACHINE_HIDDEN. Analyses already run on it keep their results. One batch: POST /api/v1/library/batches/{batch_id}/undo shows them again. Hiding every machine is refused with LAST_MACHINE, as each analysis needs one. List hidden machines with GET /api/v1/organization/machines, archived yes.","operationId":"hide_machines_api_v1_organization_machines_hide_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineIds"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"destructive","tags":["Machines"]}},"/api/v1/organization/machines/show":{"post":{"summary":"Show machines","description":"Bring hidden machines back into the machine menus, as they were (machines:write).","operationId":"show_machines_api_v1_organization_machines_show_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineIds"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResolvedMachine"},"type":"array","title":"Response Show Machines Api V1 Organization Machines Show Post"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/organization/machines/reset":{"post":{"summary":"Reset machines","description":"Put machines back to their starting values and show them (machines:write). A model on Protyus's reference list, matched on make and model, takes the list's values again; any other machine goes back to the values it was added with. Each keeps its name. The change is a new revision, so analyses run before it keep the values they used.","operationId":"reset_machines_api_v1_organization_machines_reset_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineIds"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResolvedMachine"},"type":"array","title":"Response Reset Machines Api V1 Organization Machines Reset Post"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"destructive","tags":["Machines"]}},"/api/v1/organization/process-machines":{"get":{"summary":"List process machines","description":"List Protyus's sheet metal cutting machines and molding presses, each shown or hidden for the organization. Hide the ones the shop doesn't have with POST /api/v1/organization/process-machines/hide.","operationId":"list_process_machines_api_v1_organization_process_machines_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMachinesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"read"}},"/api/v1/organization/process-machines/hide":{"post":{"summary":"Hide process machines","description":"Hide sheet metal cutting machines or molding presses, for the whole organization (machines:write). A hidden one is in no project's choices, and Best Fit doesn't weigh it; an analysis that names it is refused with MACHINE_HIDDEN. Analyses already run on it keep their results. Hiding every machine of a process is refused with LAST_MACHINE, as each analysis needs one. Show them again with POST /api/v1/organization/process-machines/show.","operationId":"hide_process_machines_api_v1_organization_process_machines_hide_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMachineIds"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMachinesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"destructive","tags":["Machines"]}},"/api/v1/organization/process-machines/show":{"post":{"summary":"Show process machines","description":"Bring hidden sheet metal cutting machines or molding presses back into the choices and Best Fit (machines:write).","operationId":"show_process_machines_api_v1_organization_process_machines_show_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMachineIds"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMachinesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/organization/process-machines/reset":{"post":{"summary":"Reset process machines","description":"Put sheet metal cutting machines or molding presses back to their starting state (machines:write): Protyus's values, which a shop doesn't change, and shown.","operationId":"reset_process_machines_api_v1_organization_process_machines_reset_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMachineIds"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessMachinesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/organization/machines/imports/preview":{"post":{"summary":"Preview machine import","description":"Preview importing machines from an uploaded CSV or XLSX spreadsheet (machines:write). Says, row by row, what importing it would do: add a new machine, update the machine with the same name, leave one unchanged, or nothing for an invalid row, with the reason. It lists each column header and the field it was read as, and notes what it does with the sheet's values, such as an hourly rate that includes overhead. Changes nothing.","operationId":"preview_machine_import_api_v1_organization_machines_imports_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetSource"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineImportPreview"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"read"}},"/api/v1/organization/machines/imports":{"post":{"summary":"Import machines","description":"Import machines from an uploaded CSV or XLSX spreadsheet as one batch (machines:write). Each row updates the machine with its name, ignoring case, or adds one. Rows take their status's default action (new: add, changed: update, unchanged: skip) unless group_actions or actions say otherwise; invalid rows are left out. Undo with POST /api/v1/library/batches/{batch_id}/undo; list imports with GET /api/v1/library/batches, kind machine. The upload is deleted once it's imported.","operationId":"commit_machine_import_api_v1_organization_machines_imports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetCommit"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/organization/machines/imports/template.csv":{"get":{"summary":"Get machine import template","description":"The CSV template for importing machines: a header for each field, with its unit, and one example row.","operationId":"machine_import_template_api_v1_organization_machines_imports_template_csv_get","responses":{"200":{"description":"The template.","content":{"application/json":{"schema":{}},"text/csv":{}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"read"}},"/api/v1/organization/machines/{item_id}":{"get":{"summary":"Get machine","description":"One machine, each value marked as its own or its class's.","operationId":"get_machine_api_v1_organization_machines__item_id__get","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The machine's library item id, a UUID.","title":"Item Id"},"description":"The machine's library item id, a UUID."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedMachine"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"read"}},"/api/v1/organization/machines/{item_id}/revisions":{"post":{"summary":"Edit machine","description":"Edit a machine, which saves a new revision (machines:write). Archive it with POST /api/v1/library/items/{item_id}/archive, bring it back with POST /api/v1/library/items/{item_id}/unarchive, and read its history with GET /api/v1/library/items/{item_id}.","operationId":"edit_machine_api_v1_organization_machines__item_id__revisions_post","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The machine's library item id, a UUID.","title":"Item Id"},"description":"The machine's library item id, a UUID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineEdit"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedMachine"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Machines"],"x-protyus-risk":"change"}},"/api/v1/reference-materials":{"get":{"summary":"List reference materials","description":"List Protyus's reference grades: name, family, ISO group, cutting group and density.","operationId":"list_reference_api_v1_reference_materials_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ReferenceGrade"},"type":"array","title":"Response List Reference Api V1 Reference Materials Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"read"}},"/api/v1/organization/materials":{"get":{"summary":"List materials","description":"List the grades the organization offers. An organization with no materials offers every reference grade the first time they're listed, those on the starting material list at its stock price.","operationId":"list_materials_api_v1_organization_materials_get","parameters":[{"name":"archived","in":"query","required":false,"schema":{"type":"string","pattern":"^(no|yes|any)$","description":"Include grades no longer offered (archived): no, only them (yes), or any.","default":"no","title":"Archived"},"description":"Include grades no longer offered (archived): no, only them (yes), or any."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResolvedMaterial"},"title":"Response List Materials Api V1 Organization Materials Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"read"},"post":{"summary":"Add material","description":"Offer a reference grade, or add a custom one (materials:write). A custom grade must name the cutting group it machines like. Stop offering a grade by archiving it with POST /api/v1/library/items/{item_id}/archive.","operationId":"create_material_api_v1_organization_materials_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Material-Input"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedMaterial"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"change"}},"/api/v1/organization/materials/starting-list":{"post":{"summary":"Add starting materials","description":"Offer each grade on Protyus's starting material list that the organization doesn't offer now, at the list's stock price per kg as the organization's own (materials:write). Grades already offered keep their price. Returns the grades added; run again, it adds none. A new organization starts with the list already.","operationId":"add_starting_list_api_v1_organization_materials_starting_list_post","responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResolvedMaterial"},"type":"array","title":"Response Add Starting List Api V1 Organization Materials Starting List Post"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"change"}},"/api/v1/organization/materials/imports/preview":{"post":{"summary":"Preview material import","description":"Preview importing materials and their stock prices from an uploaded CSV or XLSX spreadsheet (materials:write). Each row names a reference grade, by key, name or another name shops use for it, or is a custom grade with a name, family and cutting group. Says, row by row, whether it offers a new grade, changes the price of one offered, leaves one unchanged, or is invalid, with the reason. Changes nothing.","operationId":"preview_material_import_api_v1_organization_materials_imports_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetSource"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaterialImportPreview"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"read"}},"/api/v1/organization/materials/imports":{"post":{"summary":"Import materials","description":"Import materials and their stock prices from an uploaded CSV or XLSX spreadsheet as one batch (materials:write). Rows take their status's default action (new: add, changed: update, unchanged: skip) unless group_actions or actions say otherwise; invalid rows are left out. Undo with POST /api/v1/library/batches/{batch_id}/undo; list imports with GET /api/v1/library/batches, kind material. The upload is deleted once it's imported.","operationId":"commit_material_import_api_v1_organization_materials_imports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetCommit"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"change"}},"/api/v1/organization/materials/imports/template.csv":{"get":{"summary":"Get material import template","description":"The CSV template for importing materials: a reference grade with its price, and a custom grade.","operationId":"material_import_template_api_v1_organization_materials_imports_template_csv_get","responses":{"200":{"description":"The template.","content":{"application/json":{"schema":{}},"text/csv":{}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"read"}},"/api/v1/organization/materials/{item_id}/revisions":{"post":{"summary":"Edit material","description":"Change a grade, such as its stock price or its form factors, which saves a new revision (materials:write).","operationId":"edit_material_api_v1_organization_materials__item_id__revisions_post","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The grade's library item id, a UUID.","title":"Item Id"},"description":"The grade's library item id, a UUID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaterialEdit"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedMaterial"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Materials"],"x-protyus-risk":"change"}},"/api/v1/organization/settings":{"get":{"summary":"Get organization settings","description":"The active organization's settings.","operationId":"get_org_settings_api_v1_organization_settings_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgSettingsOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"read"},"patch":{"summary":"Update organization settings","description":"Change the organization's settings (settings:write). Only the fields given change. A field sent as null goes back to Protyus's default. general_tolerance needs tolerances:write instead, quote needs pricing:write, and logo_url, sender_name, privacy_url and email_templates, what leads see from submission links, need submission_links:manage. Analyses already run keep the settings they used.","operationId":"update_org_settings_api_v1_organization_settings_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsChange"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgSettingsOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"change"}},"/api/v1/projects/{project_id}/settings":{"get":{"summary":"Get project settings","description":"A project's settings: what it overrides, what it inherits, and the choices a new analysis has.","operationId":"get_project_settings_api_v1_projects__project_id__settings_get","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSettingsOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"read"},"patch":{"summary":"Update project settings","description":"Override settings or narrow lists for one project. Values need settings:write on the project, the quote settings pricing:write there, and the branding and email templates submission_links:manage there; a list needs its kind's permission there, such as tools:write. A value sent as null goes back to the organization's; a list sent as null allows everything again.","operationId":"update_project_settings_api_v1_projects__project_id__settings_patch","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSettingsIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSettingsOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"change"}},"/api/v1/organization/tolerances":{"get":{"summary":"Get organization tolerances","description":"What the shop can hold: the general tolerance and the capability table.","operationId":"get_tolerances_api_v1_organization_tolerances_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgTolerancesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tolerances"],"x-protyus-risk":"read"}},"/api/v1/organization/tolerances/{item_id}/revisions":{"post":{"summary":"Edit capability row","description":"Set what one operation holds (tolerances:write). The values become the shop's own and stop being provisional. Read its history with GET /api/v1/library/items/{item_id}.","operationId":"edit_tolerance_row_api_v1_organization_tolerances__item_id__revisions_post","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","description":"The row's library item id.","title":"Item Id"},"description":"The row's library item id."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowEdit"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedRow"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tolerances"],"x-protyus-risk":"change"}},"/api/v1/projects/{project_id}/tolerances":{"get":{"summary":"Get project tolerances","description":"What a project holds: its general tolerance and capability table.","operationId":"get_project_tolerances_api_v1_projects__project_id__tolerances_get","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectTolerancesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tolerances"],"x-protyus-risk":"read"},"patch":{"summary":"Update project tolerances","description":"Set a project's own values for capability rows (tolerances:write on the project). The general tolerance is overridden through PATCH /api/v1/projects/{project_id}/settings.","operationId":"update_project_tolerances_api_v1_projects__project_id__tolerances_patch","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectTolerancesIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectTolerancesOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Tolerances"],"x-protyus-risk":"change"}},"/api/v1/organization/feedback-sharing":{"get":{"summary":"Get feedback sharing","description":"Whether the company shares feedback with the Protyus team, and whether the app should ask the caller to turn it on (an admin, while it's off, once). Off until an admin turns it on.","operationId":"get_feedback_sharing_api_v1_organization_feedback_sharing_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSharingOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"read"},"put":{"summary":"Set feedback sharing","description":"Turn feedback sharing on or off (admins only). While it's on, the company's people can send the Protyus team feedback, which Protyus AI does for them; while it's off, all feedback is refused with FEEDBACK_SHARING_OFF. Either answer counts as the admin having been asked.","operationId":"set_feedback_sharing_api_v1_organization_feedback_sharing_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSharingIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSharingOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"change"}},"/api/v1/analyses/{analysis_id}/price":{"post":{"summary":"Price analysis","description":"Price an analysis at today's settings, without saving (anyone who sees the project). Prices the analysis's cost lines at the quantity asked for, 2x and 5x, with the project's margin, material markup, minimum charge and rush. Every step and every value is in the answer, each value marked as the shop's own (the organization's or the project's) or Protyus's default. The rates are those the analysis ran with: re-run it after changing a rate. repeat_job true prices a part the shop has made before: no programming and no first article. An analysis with nothing to price is refused with 409: NO_ESTIMATE when it ran before Protyus estimated cost, ESTIMATE_FAILED when its estimate failed, NOT_COSTED when the part can't be made on its process (a sheet part's flat too big for the sheet, say), ANALYSIS_NOT_READY while it runs.","operationId":"price_analysis_api_v1_analyses__analysis_id__price_post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricePreview"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"read"}},"/api/v1/analyses/{analysis_id}/quotes":{"post":{"summary":"Create quote","description":"Price an analysis and save it as a quote, version 1 (quotes:write). The version copies in the cost lines, every pricing value and the price, so it never changes when settings do, and its overrides record whether it was priced as a repeat job. Add versions with POST /api/v1/quotes/{quote_id}/versions. A plan limits quotes per part, an analysis's iterations being one part: Hobbyist has none, Pro one, Enterprise no limit; past it this is refused with 402 QUOTE_LIMIT_REACHED, and a newer iteration is a new version of the part's quote instead. An analysis with nothing to price is refused with 409: NO_ESTIMATE when it ran before Protyus estimated cost, ESTIMATE_FAILED when its estimate failed, NOT_COSTED when the part can't be made on its process (a sheet part's flat too big for the sheet, say), ANALYSIS_NOT_READY while it runs.","operationId":"create_quote_api_v1_analyses__analysis_id__quotes_post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"change"}},"/api/v1/quotes":{"get":{"summary":"List quotes","description":"List quotes in every project the caller sees, latest change first. Each with its latest version's price at the quantity asked for. Archived quotes are left out unless asked for.","operationId":"list_quotes_api_v1_quotes_get","parameters":[{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only quotes in this project.","title":"Project Id"},"description":"Only quotes in this project."},{"name":"analysis_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only quotes of this analysis.","title":"Analysis Id"},"description":"Only quotes of this analysis."},{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","description":"Also list archived quotes.","default":false,"title":"Include Archived"},"description":"Also list archived quotes."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/QuoteOut"},"title":"Response List Quotes Api V1 Quotes Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"read"}},"/api/v1/quotes/{quote_id}":{"get":{"summary":"Get quote","description":"One quote with every version, newest first (anyone who sees the project).","operationId":"get_quote_api_v1_quotes__quote_id__get","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","description":"The quote's id, a UUID from GET /api/v1/quotes.","title":"Quote Id"},"description":"The quote's id, a UUID from GET /api/v1/quotes."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"read"}},"/api/v1/quotes/{quote_id}/versions":{"post":{"summary":"Create quote version","description":"Save a new version of a quote: changed rush, repeat job or tools to buy, or repriced at today's settings (quotes:write). Starts from the last version: what's left out keeps its value. reprice true takes today's margin, markup, minimum and rush; false keeps the last version's. The cost lines are the ones the quote copied in. Earlier versions never change. A version that would match the last one is refused with NOTHING_CHANGED. analysis_id prices a newer iteration of the same part instead (NOT_THE_SAME_PART otherwise). After a move to a plan with fewer quotes per part, only a part's first quotes take new versions (402 QUOTE_LIMIT_REACHED); the rest stay readable.","operationId":"add_version_api_v1_quotes__quote_id__versions_post","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","description":"The quote's id, a UUID from GET /api/v1/quotes.","title":"Quote Id"},"description":"The quote's id, a UUID from GET /api/v1/quotes."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"change"}},"/api/v1/quotes/{quote_id}/archive":{"post":{"summary":"Archive quote","description":"Archive a quote, hiding it from lists (quotes:write). Its versions stay, and GET /api/v1/quotes/{quote_id} still reads it.","operationId":"archive_quote_api_v1_quotes__quote_id__archive_post","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","description":"The quote's id, a UUID from GET /api/v1/quotes.","title":"Quote Id"},"description":"The quote's id, a UUID from GET /api/v1/quotes."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"destructive"}},"/api/v1/quotes/{quote_id}/unarchive":{"post":{"summary":"Unarchive quote","description":"Bring an archived quote back into lists (quotes:write).","operationId":"unarchive_quote_api_v1_quotes__quote_id__unarchive_post","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","description":"The quote's id, a UUID from GET /api/v1/quotes.","title":"Quote Id"},"description":"The quote's id, a UUID from GET /api/v1/quotes."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"change"}},"/api/v1/quotes/{quote_id}/versions/{number}/pdf":{"get":{"summary":"Get quote PDF","description":"One version of a quote as the customer's quote, a PDF (anyone who sees the project). Made from the version as saved, so it matches it: the organization's name, the quote's number, date and valid-until date, the part's file name and a picture of it, the price a part and for the order at the quantity asked for, 2x and 5x, the price for the quantity asked for in a few lines (material, machining, setup and programming, tooling, inspection and finishing, rush, minimum order adjustment) that add up to it, and the lead time, validity and terms from the quote settings it was priced with. It shows no cost line, rate, hour, margin or markup: it's the one to send the customer.","operationId":"get_quote_pdf_api_v1_quotes__quote_id__versions__number__pdf_get","parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","description":"The quote's id, a UUID from GET /api/v1/quotes.","title":"Quote Id"},"description":"The quote's id, a UUID from GET /api/v1/quotes."},{"name":"number","in":"path","required":true,"schema":{"type":"integer","minimum":1,"description":"The version's number, from 1, as GET /api/v1/quotes/{quote_id} lists them.","title":"Number"},"description":"The version's number, from 1, as GET /api/v1/quotes/{quote_id} lists them."}],"responses":{"200":{"description":"The PDF.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Quotes"],"x-protyus-risk":"read"}},"/api/v1/projects/{project_id}/submission-links":{"get":{"summary":"List submission links","description":"List a project's submission links, newest first, revoked ones included (anyone who sees the project). Tokens are never listed.","operationId":"list_links_api_v1_projects__project_id__submission_links_get","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubmissionLinkOut"},"title":"Response List Links Api V1 Projects  Project Id  Submission Links Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Submission links"],"x-protyus-risk":"read"},"post":{"summary":"Create submission link","description":"Make a submission link for a project: a URL to share, whose form collects leads that are then emailed an upload link (submission_links:manage on the project, and the plan's intake_links feature). It expires in 30 days unless expires_at says otherwise; null never expires. Refused with PROJECT_HAS_NO_DEFAULTS when the project has no default machine and material its analyses can use. The response holds the link's token and URL, shown only this once: Protyus keeps only the token's hash.","operationId":"create_link_api_v1_projects__project_id__submission_links_post","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","description":"The project's id, a UUID from GET /api/v1/projects.","title":"Project Id"},"description":"The project's id, a UUID from GET /api/v1/projects."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionLinkIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedSubmissionLink"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Submission links"],"x-protyus-risk":"change"}},"/api/v1/submission-links/{link_id}":{"get":{"summary":"Get submission link","description":"One submission link with its settings (anyone who sees its project). Its token is never shown again.","operationId":"get_link_api_v1_submission_links__link_id__get","parameters":[{"name":"link_id","in":"path","required":true,"schema":{"type":"string","description":"The submission link's id, a UUID from a project's list of submission links.","title":"Link Id"},"description":"The submission link's id, a UUID from a project's list of submission links."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionLinkOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Submission links"],"x-protyus-risk":"read"},"patch":{"summary":"Update submission link","description":"Change a submission link's name, whether it takes requests, its expiry or its settings (submission_links:manage on its project). Only what's given changes, at any depth of the settings. A revoked link is refused with SUBMISSION_LINK_REVOKED.","operationId":"update_link_api_v1_submission_links__link_id__patch","parameters":[{"name":"link_id","in":"path","required":true,"schema":{"type":"string","description":"The submission link's id, a UUID from a project's list of submission links.","title":"Link Id"},"description":"The submission link's id, a UUID from a project's list of submission links."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionLinkChange"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionLinkOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Submission links"],"x-protyus-risk":"change"}},"/api/v1/submission-links/{link_id}/regenerate":{"post":{"summary":"Regenerate submission link","description":"Give a submission link a new token and URL (submission_links:manage on its project). The old URL stops working at once, so a page using it needs the new one; the settings and leads stay. The response holds the link's token and URL, shown only this once: Protyus keeps only the token's hash.","operationId":"regenerate_link_api_v1_submission_links__link_id__regenerate_post","parameters":[{"name":"link_id","in":"path","required":true,"schema":{"type":"string","description":"The submission link's id, a UUID from a project's list of submission links.","title":"Link Id"},"description":"The submission link's id, a UUID from a project's list of submission links."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedSubmissionLink"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Submission links"],"x-protyus-risk":"destructive"}},"/api/v1/submission-links/{link_id}/revoke":{"post":{"summary":"Revoke submission link","description":"Revoke a submission link for good (submission_links:manage on its project): its URL stops working and it can't be turned back on. Its leads and their submissions stay. Revoking twice changes nothing.","operationId":"revoke_link_api_v1_submission_links__link_id__revoke_post","parameters":[{"name":"link_id","in":"path","required":true,"schema":{"type":"string","description":"The submission link's id, a UUID from a project's list of submission links.","title":"Link Id"},"description":"The submission link's id, a UUID from a project's list of submission links."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionLinkOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Submission links"],"x-protyus-risk":"destructive"}},"/api/v1/settings/email-templates/test":{"post":{"summary":"Send test email","description":"Send yourself one of the emails submission links send, filled in with sample data: the organization's template, a link's own (link_id), or a draft subject and body to try before saving. It goes to the caller's own email address and no one else's. Needs submission_links:manage in the organization, or with link_id, on that link's project. 20 a day per organization, refused past that with TEST_EMAIL_LIMIT. Each counts against the company's share of the day's email, refused past it with EMAIL_DAILY_SHARE or EMAIL_QUEUE_FULL (429), and against the deployment's daily email limit: past that, the email is queued (state queued) and sent the next day. In test mode (test_mode true) only the Resend account's own address receives it. Save templates with PATCH /api/v1/organization/settings (email_templates) or PATCH /api/v1/submission-links/{link_id} (config.templates).","operationId":"send_test_email_api_v1_settings_email_templates_test_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTestIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTestOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"external","tags":["Settings"]}},"/api/v1/upload-links":{"post":{"summary":"Send upload link","description":"Email someone an upload link: a page, open for 72 hours, where they upload up to 10 STEP files and a quantity for a quote. Give project_id, or submission_link_id to use that link's project, form fields, sender name, reply-to and logo (submission_links:manage on the project, and the plan's intake_links feature). The lead is found by email address or made; prefill fills in what's known on their page, and on the lead where it's blank. Each call sends a fresh link, and an older unused one to the same lead for the same project stops working. The link's token is only in the email, so the lead proves they read that inbox: it's never in the answer. Refused with PROJECT_HAS_NO_DEFAULTS when the project has no default machine and material, and, through a submission link, with EMAIL_DOMAIN_BLOCKED or EMAIL_DOMAIN_NOT_ALLOWED when the link's own domain lists rule the address out. Each file they upload becomes an analysis in the project, counted as usage against you. One address takes at most 3 upload links an hour and 6 a day from the company (TOO_MANY_TO_ADDRESS, 429). Each counts against the company's share of the day's email (the emails_per_day entitlement): past it, or with too many of its emails still waiting, it's refused with EMAIL_DAILY_SHARE or EMAIL_QUEUE_FULL (429) and nothing is sent. Past the deployment's daily email limit, the email is queued (email_state queued) and sent later.","operationId":"send_upload_link_api_v1_upload_links_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadLinkIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadLinkSent"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"external","tags":["Submission links"]}},"/api/v1/public/upload-links/{token}":{"get":{"summary":"Get upload page","description":"Public, no sign-in: what an upload link's page shows. The shop's sender name and logo (as a data: URI), the lead's email, which answers to ask for and those already known, the consent box's privacy policy, the quantity and the file limits. Nothing else. Opening it marks the lead verified. Refused with UPLOAD_LINK_NOT_FOUND (404) for a token Protyus didn't send, and UPLOAD_LINK_USED, UPLOAD_LINK_EXPIRED or UPLOAD_LINK_CLOSED (410) for one that no longer takes a submission. Rate limited per IP (RATE_LIMITED, 429).","operationId":"get_upload_page_api_v1_public_upload_links__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","description":"The upload link's token, from the /u/<token> URL emailed to the lead.","title":"Token"},"description":"The upload link's token, from the /u/<token> URL emailed to the lead."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadPageOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"security":[],"tags":["Submission links"],"x-protyus-risk":"read"}},"/api/v1/public/upload-links/{token}/files":{"post":{"summary":"Sign upload page file","description":"Public, no sign-in: a signed upload for one STEP file (.step or .stp, up to 25 MB) through an upload link. Send the file straight to the file store with put(pathname, file, {access: 'private', token: client_token, multipart: true}) from @vercel/blob/client; it works for 15 minutes. Then list its url in POST .../submit. Refused with NOT_A_STEP_NAME, FILE_TOO_LARGE, or TOO_MANY_UPLOADS once a link has handed out 30. Refused with UPLOAD_LINK_NOT_FOUND (404) for a token Protyus didn't send, and UPLOAD_LINK_USED, UPLOAD_LINK_EXPIRED or UPLOAD_LINK_CLOSED (410) for one that no longer takes a submission. Rate limited per IP (RATE_LIMITED, 429).","operationId":"sign_upload_page_file_api_v1_public_upload_links__token__files_post","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","description":"The upload link's token, from the /u/<token> URL emailed to the lead.","title":"Token"},"description":"The upload link's token, from the /u/<token> URL emailed to the lead."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"security":[],"tags":["Submission links"],"x-protyus-risk":"change"}},"/api/v1/public/upload-links/{token}/submit":{"post":{"summary":"Submit upload page","description":"Public, no sign-in: the lead's answers, quantity and uploaded files (1 to 10), through an upload link. Each file is checked to be one this link uploaded (NOT_THIS_LINKS_FILE) and to start with ISO-10303-21 (NOT_A_STEP_FILE); a required answer left empty is ANSWER_REQUIRED, and an unticked consent box CONSENT_REQUIRED when there's a privacy policy. It uses the link, which takes no other submission, and starts one analysis per file in the link's project. Past the organization's daily cap on intake analyses (100 unless staff set it otherwise, every link at once) it's refused with INTAKE_DAILY_LIMIT (429) before the link is used, so it can be sent again tomorrow. Answers only thanks: the quote is emailed. Refused with UPLOAD_LINK_NOT_FOUND (404) for a token Protyus didn't send, and UPLOAD_LINK_USED, UPLOAD_LINK_EXPIRED or UPLOAD_LINK_CLOSED (410) for one that no longer takes a submission. Rate limited per IP (RATE_LIMITED, 429).","operationId":"submit_upload_page_api_v1_public_upload_links__token__submit_post","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","description":"The upload link's token, from the /u/<token> URL emailed to the lead.","title":"Token"},"description":"The upload link's token, from the /u/<token> URL emailed to the lead."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionReceived"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"security":[],"tags":["Submission links"],"x-protyus-risk":"change"}},"/api/v1/public/submission-links/{token}":{"get":{"summary":"Get submission link form","description":"Public, no sign-in: what a submission link's form shows. The shop's sender name and logo (as a data: URI), which fields to ask for, the privacy policy the consent box links to, and the Cloudflare Turnstile site key for its bot check. Nothing else: not the link's name, id, project or settings. Refused with SUBMISSION_LINK_NOT_FOUND (404) for a token that isn't a link's, SUBMISSION_LINK_REVOKED or SUBMISSION_LINK_EXPIRED (410), SUBMISSION_LINK_PAUSED (409) while the link isn't taking requests, and SUBMISSION_LINK_NOT_SET_UP (409) when neither the link nor its organization has a privacy policy. BOT_CHECK_UNAVAILABLE (503) when this deployment has no Turnstile keys. Rate limited per IP (RATE_LIMITED, 429).","operationId":"get_submission_form_api_v1_public_submission_links__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","description":"The submission link's token, from the /s/<token> URL the shop shared.","title":"Token"},"description":"The submission link's token, from the /s/<token> URL the shop shared."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicFormOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"security":[],"tags":["Submission links"],"x-protyus-risk":"read"},"post":{"summary":"Send submission link form","description":"Public, no sign-in: someone's answers, consent and Cloudflare Turnstile token, through a submission link's form. It records them as an unverified lead and emails an upload link (72 hours, one submission) for the link's project. It always answers 202 \"Check your inbox\", the same whether or not an email went: past 5 forms an hour from one IP, 1 upload link email an hour or 3 a day to one address, a throwaway, blocked or unlisted email domain, or the link's daily cap, nothing is sent and the answer doesn't change. Only the form's own mistakes are refused, with 422: EMAIL_REQUIRED, EMAIL_INVALID, ANSWER_REQUIRED, CONSENT_REQUIRED and BOT_CHECK_FAILED, each with its field. A link pauses itself at its daily cap, or when its traffic jumps to 10 times its 7-day hourly average (at least 10 an hour), and emails its notify list. Refused with SUBMISSION_LINK_NOT_FOUND (404) for a token that isn't a link's, SUBMISSION_LINK_REVOKED or SUBMISSION_LINK_EXPIRED (410), SUBMISSION_LINK_PAUSED (409) while the link isn't taking requests, and SUBMISSION_LINK_NOT_SET_UP (409) when neither the link nor its organization has a privacy policy. BOT_CHECK_UNAVAILABLE (503) when this deployment has no Turnstile keys. Rate limited per IP (RATE_LIMITED, 429).","operationId":"send_submission_form_api_v1_public_submission_links__token__post","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","description":"The submission link's token, from the /s/<token> URL the shop shared.","title":"Token"},"description":"The submission link's token, from the /s/<token> URL the shop shared."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicFormIn"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormAccepted"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"security":[],"x-protyus-risk":"external","tags":["Submission links"]}},"/api/v1/submissions/{submission_id}":{"get":{"summary":"Get submission","description":"One lead's submission, for the shop's own people (anyone who sees its project): its state (analysing, held, sent or declined), the lead's answers and quantity, and each part with its analysis, its quote and latest version, its order price, score and verdict, whether it's clean and why it was held. Nothing here reaches the lead.","operationId":"get_submission_api_v1_submissions__submission_id__get","parameters":[{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","description":"The submission's id, a UUID from a lead's submissions (GET /api/v1/leads/{lead_id}).","title":"Submission Id"},"description":"The submission's id, a UUID from a lead's submissions (GET /api/v1/leads/{lead_id})."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Leads"],"x-protyus-risk":"read"}},"/api/v1/submissions/{submission_id}/send":{"post":{"summary":"Send submission","description":"Email the lead a held submission's quotes (quotes:write on its project): one email, from the link's sender name and reply-to, with one PDF of a page a part, each quote at its latest version. To change a price first, save a new version with POST /api/v1/quotes/{quote_id}/versions, then send. A part with no quote (its analysis or estimate failed) is left out; with none to send it's NOTHING_TO_SEND (409). Refused with 409 unless it's held: SUBMISSION_STILL_ANALYSING, SUBMISSION_ALREADY_SENT or SUBMISSION_ALREADY_DECLINED. Counts against the deployment's daily email limit: past it, the email is queued (email_state queued) and sent later.","operationId":"send_submission_api_v1_submissions__submission_id__send_post","parameters":[{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","description":"The submission's id, a UUID from a lead's submissions (GET /api/v1/leads/{lead_id}).","title":"Submission Id"},"description":"The submission's id, a UUID from a lead's submissions (GET /api/v1/leads/{lead_id})."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionSent"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"external","tags":["Leads"]}},"/api/v1/submissions/{submission_id}/decline":{"post":{"summary":"Decline submission","description":"Email the lead that the shop can't quote a held submission, and mark it declined (quotes:write on its project). It sends the decline template (the link's, the project's or the organization's), or the subject and body given for this email only, plain text with {{fields}}. Its quotes stay in the project. Refused with 409 unless it's held: SUBMISSION_STILL_ANALYSING, SUBMISSION_ALREADY_SENT or SUBMISSION_ALREADY_DECLINED. Counts against the deployment's daily email limit.","operationId":"decline_submission_api_v1_submissions__submission_id__decline_post","parameters":[{"name":"submission_id","in":"path","required":true,"schema":{"type":"string","description":"The submission's id, a UUID from a lead's submissions (GET /api/v1/leads/{lead_id}).","title":"Submission Id"},"description":"The submission's id, a UUID from a lead's submissions (GET /api/v1/leads/{lead_id})."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeclineIn"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionSent"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"external","tags":["Leads"]}},"/api/v1/leads":{"get":{"summary":"List leads","description":"List the organization's leads, the people outside Protyus who were sent an upload link or filled in a submission link's form, most recent activity first, a page at a time. A lead is listed for anyone who sees a project their submissions or upload links are in; admins see every lead. Status is worked out from the lead's events: the latest that says where they are wins. Unverified leads are left out unless include_unverified is true. Read one, with their submissions and timeline, with GET /api/v1/leads/{lead_id}.","operationId":"list_leads_api_v1_leads_get","parameters":[{"name":"submission_link_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only leads who came through this submission link, by id.","title":"Submission Link Id"},"description":"Only leads who came through this submission link, by id."},{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only leads with a submission or upload link in this project, by id.","title":"Project Id"},"description":"Only leads with a submission or upload link in this project, by id."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["unverified","verified","submitted","analysed","held","quoted","declined","won","lost"],"type":"string"},{"type":"null"}],"description":"Only leads with this status: unverified, verified, submitted, analysed, held, quoted, declined, won or lost.","title":"Status"},"description":"Only leads with this status: unverified, verified, submitted, analysed, held, quoted, declined, won or lost."},{"name":"include_unverified","in":"query","required":false,"schema":{"type":"boolean","description":"Also list leads who never opened an upload link. Default false; asking for status unverified lists them anyway.","default":false,"title":"Include Unverified"},"description":"Also list leads who never opened an upload link. Default false; asking for status unverified lists them anyway."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"How many leads to return at most, up to 200.","default":50,"title":"Limit"},"description":"How many leads to return at most, up to 200."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"How many matching leads to skip, for the next page.","default":0,"title":"Offset"},"description":"How many matching leads to skip, for the next page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadPage"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Leads"],"x-protyus-risk":"read"}},"/api/v1/leads/export":{"get":{"summary":"Export leads","description":"The leads GET /api/v1/leads would list with the same filters, every page, as CSV: email, first_name, last_name, company, phone, status, first_submission_at, last_submission_at, submission_count, submission_links and projects (several joined by \"; \"). Text a spreadsheet would run as a formula starts with a quote. A lead is listed for anyone who sees a project their submissions or upload links are in; admins see every lead. Status is worked out from the lead's events: the latest that says where they are wins.","operationId":"export_leads_api_v1_leads_export_get","parameters":[{"name":"submission_link_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only leads who came through this submission link, by id.","title":"Submission Link Id"},"description":"Only leads who came through this submission link, by id."},{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only leads with a submission or upload link in this project, by id.","title":"Project Id"},"description":"Only leads with a submission or upload link in this project, by id."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["unverified","verified","submitted","analysed","held","quoted","declined","won","lost"],"type":"string"},{"type":"null"}],"description":"Only leads with this status: unverified, verified, submitted, analysed, held, quoted, declined, won or lost.","title":"Status"},"description":"Only leads with this status: unverified, verified, submitted, analysed, held, quoted, declined, won or lost."},{"name":"include_unverified","in":"query","required":false,"schema":{"type":"boolean","description":"Also list leads who never opened an upload link. Default false; asking for status unverified lists them anyway.","default":false,"title":"Include Unverified"},"description":"Also list leads who never opened an upload link. Default false; asking for status unverified lists them anyway."}],"responses":{"200":{"description":"The CSV file.","content":{"application/json":{"schema":{}},"text/csv":{}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Leads"],"x-protyus-risk":"read"}},"/api/v1/leads/{lead_id}":{"get":{"summary":"Get lead","description":"One lead with their answers, their submissions and each part's analysis and quote, and their timeline of events, oldest first. Within a lead, only the submissions and events of projects the caller sees are shown. A held submission is sent or declined by its submission's own send and decline operations. A lead is listed for anyone who sees a project their submissions or upload links are in; admins see every lead. Status is worked out from the lead's events: the latest that says where they are wins.","operationId":"get_lead_api_v1_leads__lead_id__get","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","description":"The lead's id, a UUID from GET /api/v1/leads.","title":"Lead Id"},"description":"The lead's id, a UUID from GET /api/v1/leads."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Leads"],"x-protyus-risk":"read"},"delete":{"summary":"Delete lead","description":"Delete a lead for good, for a privacy request (organization admins only): the lead, their upload links, submissions, parts and timeline, and the files they uploaded. Their analyses and quotes stay, holding no name of theirs, and emails to or about them are emptied of what they said. It can't be undone.","operationId":"delete_lead_api_v1_leads__lead_id__delete","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","description":"The lead's id, a UUID from GET /api/v1/leads.","title":"Lead Id"},"description":"The lead's id, a UUID from GET /api/v1/leads."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadDeleted"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Leads"],"x-protyus-risk":"destructive"}},"/api/v1/leads/{lead_id}/status":{"post":{"summary":"Set lead status","description":"Mark a lead won or lost, or send null to clear it and go back to what their events say (quotes:write on a project their submissions are in). Adds an event to their timeline; asking for the status they already have adds none. A lead with no submissions is refused with LEAD_HAS_NO_SUBMISSIONS.","operationId":"set_lead_status_api_v1_leads__lead_id__status_post","parameters":[{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","description":"The lead's id, a UUID from GET /api/v1/leads.","title":"Lead Id"},"description":"The lead's id, a UUID from GET /api/v1/leads."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadDetail"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Leads"],"x-protyus-risk":"change"}},"/api/v1/organization/part-sharing":{"get":{"summary":"Get part sharing","description":"Whether the company prevents sharing parts. Prevent sharing is on until an admin turns it off: while it's on, no analysis can be shared.","operationId":"get_part_sharing_api_v1_organization_part_sharing_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartSharingOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"read"},"put":{"summary":"Set part sharing","description":"Turn Prevent sharing on or off (admins only). Turning it on stops every shared link in the company at once, for good, and answers with how many in revoked. Turning it off brings none back: each part is shared again with a new link.","operationId":"set_part_sharing_api_v1_organization_part_sharing_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartSharingIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartSharingOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Settings"],"x-protyus-risk":"change"}},"/api/v1/analyses/{analysis_id}/share":{"get":{"summary":"Get part share","description":"Whether an analysis is shared, and its link while it is, for anyone who can see the analysis. can_share says whether the caller may share it.","operationId":"get_share_api_v1_analyses__analysis_id__share_get","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"read"},"put":{"summary":"Share part","description":"Share an analysis: anyone with the link it answers with sees the part in 3D, its score, findings, setups and features, and nothing about the company, its file name or its cost. The project's owner or an admin only, while the company allows sharing (SHARING_PREVENTED otherwise). A finished milling analysis only (SHARING_NOT_AVAILABLE otherwise). Sharing one that's shared keeps its link.","operationId":"share_api_v1_analyses__analysis_id__share_put","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"},"delete":{"summary":"Stop sharing part","description":"Stop sharing an analysis: its link stops working at once, for good. Sharing it again makes a new link. The project's owner or an admin only.","operationId":"stop_sharing_api_v1_analyses__analysis_id__share_delete","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","description":"The analysis's id, a UUID from a project's list of analyses.","title":"Analysis Id"},"description":"The analysis's id, a UUID from a project's list of analyses."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"destructive"}},"/api/v1/public/shared-parts/{token}":{"get":{"summary":"Get shared part","description":"Public, no sign-in: what a shared part's page shows. The part's size, faces, edges and triangles, its features, its setups on the machine it was analysed for, and that plan's findings and scorecard. Nothing about the company, the file or its cost. Refused with SHARED_PART_NOT_FOUND (404) for any token that doesn't open a shared part, whatever the reason. Rate limited per IP (RATE_LIMITED, 429).","operationId":"get_shared_part_api_v1_public_shared_parts__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","description":"The shared part's token, from the /p/<token> link.","title":"Token"},"description":"The shared part's token, from the /p/<token> link."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedPart"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"security":[],"tags":["Analyses"],"x-protyus-risk":"read"}},"/api/v1/dashboards":{"get":{"summary":"List dashboards","description":"Every dashboard in the organization, in order, with its cards. Any member may read them. An organization that has never had one starts with Overview: analyses and parts that can't be made in the last 7 days, quote value, findings per week by severity, the most common findings, recent analyses and quotes. To show a card, call its operation with its params as the viewer, after resolving relative dates in from, to and since: today, yesterday, or -Nd for N days before today.","operationId":"list_dashboards_api_v1_dashboards_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DashboardOut"},"type":"array","title":"Response List Dashboards Api V1 Dashboards Get"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Dashboards"],"x-protyus-risk":"read"},"post":{"summary":"Create dashboard","description":"A new named dashboard for the whole organization, last in the list unless a position is given. Each card is a saved call: card (which card draws it), operation (a read-only MCP tool: query_metrics, list_recent_analyses, list_quotes, get_analysis, get_quote or view_part), params (that tool's arguments) and layout (x, y, w, h on a 12-column grid). Cards that don't suit their operation are refused with CARD_DOES_NOT_FIT, overlapping cards with CARDS_OVERLAP, dates that aren't dates with INVALID_DATE, and a view card whose params aren't an analysis_id and a part view with INVALID_VIEW. Needs the dashboard:write permission, which admins and the dashboard_editor role hold; others get 403 MISSING_PERMISSION.","operationId":"create_dashboard_api_v1_dashboards_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Dashboards"],"x-protyus-risk":"change"}},"/api/v1/dashboards/order":{"put":{"summary":"Reorder dashboards","description":"Lists the organization's dashboards in the order given. Give every dashboard id once, or it's refused with ORDER_MISMATCH. To move one dashboard, PATCH /api/v1/dashboards/{dashboard_id} with a position is simpler. Needs the dashboard:write permission, which admins and the dashboard_editor role hold; others get 403 MISSING_PERMISSION.","operationId":"reorder_dashboards_api_v1_dashboards_order_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOrder"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DashboardOut"},"type":"array","title":"Response Reorder Dashboards Api V1 Dashboards Order Put"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Dashboards"],"x-protyus-risk":"change"}},"/api/v1/dashboards/{dashboard_id}":{"get":{"summary":"Get dashboard","description":"One dashboard with its cards. Any member may read it.","operationId":"get_dashboard_api_v1_dashboards__dashboard_id__get","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","description":"The dashboard's id, a UUID from GET /api/v1/dashboards.","title":"Dashboard Id"},"description":"The dashboard's id, a UUID from GET /api/v1/dashboards."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Dashboards"],"x-protyus-risk":"read"},"patch":{"summary":"Update dashboard","description":"Renames it, moves it in the list, or replaces its cards. Only what's given changes. Sending cards replaces every card: give a kept card its id, and leave a card out to remove it. Each card is a saved call: card (which card draws it), operation (a read-only MCP tool: query_metrics, list_recent_analyses, list_quotes, get_analysis, get_quote or view_part), params (that tool's arguments) and layout (x, y, w, h on a 12-column grid). Cards that don't suit their operation are refused with CARD_DOES_NOT_FIT, overlapping cards with CARDS_OVERLAP, dates that aren't dates with INVALID_DATE, and a view card whose params aren't an analysis_id and a part view with INVALID_VIEW. Needs the dashboard:write permission, which admins and the dashboard_editor role hold; others get 403 MISSING_PERMISSION.","operationId":"update_dashboard_api_v1_dashboards__dashboard_id__patch","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","description":"The dashboard's id, a UUID from GET /api/v1/dashboards.","title":"Dashboard Id"},"description":"The dashboard's id, a UUID from GET /api/v1/dashboards."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardChange"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Dashboards"],"x-protyus-risk":"change"},"delete":{"summary":"Delete dashboard","description":"Deletes it and its cards for everyone in the organization; the dashboards after it move up. It can't be undone. Needs the dashboard:write permission, which admins and the dashboard_editor role hold; others get 403 MISSING_PERMISSION.","operationId":"delete_dashboard_api_v1_dashboards__dashboard_id__delete","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","description":"The dashboard's id, a UUID from GET /api/v1/dashboards.","title":"Dashboard Id"},"description":"The dashboard's id, a UUID from GET /api/v1/dashboards."}],"responses":{"204":{"description":"Successful Response"},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Dashboards"],"x-protyus-risk":"destructive"}},"/api/v1/dashboards/{dashboard_id}/cards":{"post":{"summary":"Add card to dashboard","description":"Saves one read-only call as a card, such as an answer someone pinned from the chat. Without a layout it goes below every other card. Returns the whole dashboard. Each card is a saved call: card (which card draws it), operation (a read-only MCP tool: query_metrics, list_recent_analyses, list_quotes, get_analysis, get_quote or view_part), params (that tool's arguments) and layout (x, y, w, h on a 12-column grid). Cards that don't suit their operation are refused with CARD_DOES_NOT_FIT, overlapping cards with CARDS_OVERLAP, dates that aren't dates with INVALID_DATE, and a view card whose params aren't an analysis_id and a part view with INVALID_VIEW. Needs the dashboard:write permission, which admins and the dashboard_editor role hold; others get 403 MISSING_PERMISSION.","operationId":"add_card_api_v1_dashboards__dashboard_id__cards_post","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","description":"The dashboard's id, a UUID from GET /api/v1/dashboards.","title":"Dashboard Id"},"description":"The dashboard's id, a UUID from GET /api/v1/dashboards."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Dashboards"],"x-protyus-risk":"change"}},"/api/v1/organization/usage":{"get":{"summary":"Get organization usage","description":"The organization's usage by day and by person (needs usage:read). Every billable action in the active organization over the last `days` days: analyses run and files extracted, through the app, the API or the MCP server, with the compute and storage they took, and Protyus AI messages with the tokens they used, counted apart in `ai`. `analyses` is the analyses used this billing month, as the plan's allowance counts them: each distinct STEP file once a month.","operationId":"organization_usage_api_v1_organization_usage_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":366,"minimum":1,"description":"How many days to count, ending today (UTC).","default":30,"title":"Days"},"description":"How many days to count, ending today (UTC)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUsage"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Usage"],"x-protyus-risk":"read"}},"/api/v1/organization/members/{user_id}/ai-access":{"put":{"summary":"Switch on AI access","description":"Switch Protyus AI back on for one member an admin switched it off for (admins). AI is on for everyone unless switched off. Switching on someone already on changes nothing.","operationId":"switch_on_ai_access_api_v1_organization_members__user_id__ai_access_put","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberAiAccessOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"change"},"delete":{"summary":"Switch off AI access","description":"Switch Protyus AI off for one member (admins): their messages are refused with AI_SWITCHED_OFF until an admin switches it back on.","operationId":"switch_off_ai_access_api_v1_organization_members__user_id__ai_access_delete","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","description":"A person's Clerk user id, from GET /api/v1/organization/members.","title":"User Id"},"description":"A person's Clerk user id, from GET /api/v1/organization/members."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberAiAccessOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Members and roles"],"x-protyus-risk":"destructive"}},"/api/v1/ai/messages":{"post":{"summary":"Start AI message","description":"Count one Protyus AI message before the model is called (Protyus AI's server only). Refused unless the caller may use AI: AI_SWITCHED_OFF (403) when an admin switched it off for them; NO_LICENCE or READ_ONLY (402) without a plan that works; AI_LIMIT_REACHED (402) once the company's lifetime 50 messages on Hobbyist or in the trial are used, since Protyus AI comes with Pro; and AI_RATE_LIMITED or AI_DAILY_LIMIT (429, with Retry-After) past one person's messages for the minute or the day. Needs a signed-in session: an API key or MCP call is refused with PROTYUS_AI_ONLY.","operationId":"start_ai_message_api_v1_ai_messages_post","responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiMessageStarted"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Protyus AI"],"x-protyus-risk":"change"}},"/api/v1/ai/messages/{message_id}/finish":{"post":{"summary":"Finish AI message","description":"Record the model, tokens and cost of a started Protyus AI message (Protyus AI's server only). Only the caller's own message, once: a second finish is refused with AI_MESSAGE_FINISHED.","operationId":"finish_ai_message_api_v1_ai_messages__message_id__finish_post","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","description":"The AI message's id, from POST /api/v1/ai/messages.","title":"Message Id"},"description":"The AI message's id, from POST /api/v1/ai/messages."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiMessageFinishIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiMessageOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Protyus AI"],"x-protyus-risk":"change"}},"/api/v1/organization/credits":{"get":{"summary":"Get credits","description":"The organization's credits (needs usage:read): analyses beyond the plan's month, used only once the month's are gone, the soonest to expire first. Each grant, bought or from Protyus, with its analyses, how many are used and left, and when it runs out; what a pack is now; and whether the company can buy more (`on_sale`).","operationId":"organization_credits_api_v1_organization_credits_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditsOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Usage"],"x-protyus-risk":"read"}},"/api/v1/organization/credits/checkout":{"post":{"summary":"Buy credits","description":"Start buying packs of credits (admins): answers Stripe's payment page, where the person pays by card and comes back to Organization > Credits & usage. The credits are added once the payment goes through, and last a pack's months from then. Only a company whose plan is active or past due can buy them: CREDITS_NEED_A_PLAN (402) in the trial, with no plan or read-only. CREDITS_NOT_AVAILABLE (503) where payments aren't set up. Credits aren't refundable.","operationId":"buy_credits_api_v1_organization_credits_checkout_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"external","tags":["Usage"]}},"/api/v1/public/plans":{"get":{"summary":"List plans and prices","description":"Public, no sign-in: every plan a company can subscribe to, smallest first, with what it allows (users, analyses a month, Protyus AI, quotes per part and submission links) and its price; the free trial; and what a pack of credits is. These are what a new subscriber gets: a company keeps the values it subscribed on. A price is null where none is set. The same for everyone, so it's cached for an hour. Rate limited per IP (RATE_LIMITED, 429).","operationId":"list_plans_api_v1_public_plans_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPlansOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"security":[],"tags":["Plans"],"x-protyus-risk":"read"}},"/api/v1/organization/deletion":{"get":{"summary":"Get company deletion","description":"Whether the company's data is due to be deleted, and when: 6 months after its plan ended and it became read-only, or 7 days after an admin asked for a purge or deleted the company. Also says whether the caller may ask for either: admins only, a purge once the plan is set to cancel or has ended, and deleting the company once no plan is running. Any member may read it.","operationId":"get_company_deletion_api_v1_organization_deletion_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeavingOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Account"],"x-protyus-risk":"read"},"post":{"summary":"Delete company data","description":"Ask for everything the company keeps in Protyus to be deleted 7 days from now: its projects, part files, analyses, quotes, leads, settings and libraries. kind purge keeps the company until its plan ends; delete_company also takes everyone out of it. confirm_name must be the company's name (NAME_DOES_NOT_MATCH). Every admin is emailed at once. A purge needs the plan set to cancel or ended, and deleting the company needs no plan running (PLAN_STILL_LIVE); asking twice is DELETION_ALREADY_ASKED. Admins only, signed in to the app: a request with an API key is refused with SIGN_IN_TO_DELETE. Only Protyus can stop it once asked.","operationId":"ask_company_deletion_api_v1_organization_deletion_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletionIn"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeavingOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"x-protyus-risk":"destructive","tags":["Account"]}},"/api/v1/organization/export":{"get":{"summary":"Export company data","description":"Everything the company would take with it, as one zip built now: quotes.csv (every quote's every version with its price and terms), leads.csv (every lead, as GET /api/v1/leads/export gives them) and parts/, each part analysed as it was uploaded, by project. Admins only, in any billing state.","operationId":"export_company_data_api_v1_organization_export_get","responses":{"200":{"description":"The zip file.","content":{"application/zip":{}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Account"],"x-protyus-risk":"read"}},"/api/v1/metrics/query":{"post":{"summary":"Query metrics","description":"Counts or averages one measure across the organization, and changes nothing: a measure such as findings, analyses, average_score or quote_value, split by up to two dimensions (a time grain such as week, and a category such as severity or project), over the filters given. It runs as the caller: only projects they can see count, an admin sees every project, and the usage measures (compute_seconds, ai_messages) need usage:read. The response names its measure, unit and each dimension's kind, so it can be drawn as it comes: no dimensions is one number, a time dimension a trend, a category a ranked list. Nothing matching gives rows [] and total 0, never an error. Call list_metrics first to see every measure, dimension and filter. Errors: UNKNOWN_MEASURE, UNKNOWN_DIMENSION, UNSUPPORTED_COMBINATION (a dimension or filter the measure doesn't take, or two time dimensions) and INVALID_FILTER (a date or value it can't read), each 422 with the field at fault.","operationId":"query_metrics_api_v1_metrics_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsQuery"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsResult"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Metrics"],"x-protyus-risk":"read"}},"/api/v1/metrics/catalog":{"get":{"summary":"List metrics","description":"Lists every measure the metrics query can ask for, with its unit, how it adds up, the dimensions and filters it takes and whether the caller may ask for it now; every dimension, with its kind and any fixed values; every filter; and which dimensions go together. Read it before building a query_metrics call.","operationId":"metrics_catalog_api_v1_metrics_catalog_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsCatalog"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Metrics"],"x-protyus-risk":"read"}},"/api/v1/uploads":{"post":{"summary":"Create upload URL","description":"Get somewhere to send a file: a STEP file to analyse, a file to import (a CSV or XLSX of machines or materials, or a tool file), or a PNG or SVG logo. The web app uploads every file this way too. Send it straight to the file store with client_token, up to max_bytes (50 MB, the most the engine reads), using put() from @vercel/blob/client; or send its bytes to put_url with HTTP PUT, up to put_url_max_bytes (4.5 MB), such as with the curl command in the answer. Either answers with the url to pass as upload_url to POST /api/v1/projects/{project_id}/analyses, or to an import's preview and commit. Both work for 15 minutes. It's made in an organization, the one you'll use it in: with none active, it's refused with NO_ORGANIZATION.","operationId":"create_upload_api_v1_uploads_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"}},"/api/v1/uploads/{token}":{"put":{"summary":"Upload file","description":"Send a file's bytes to a signed upload URL. The URL comes from POST /api/v1/uploads and is its own credential: no Authorization header. The body is the file's raw bytes. Answers with the upload_url to start an analysis or an import with.","operationId":"receive_upload_api_v1_uploads__token__put","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","description":"The signed part of put_url, from POST /api/v1/uploads.","title":"Token"},"description":"The signed part of put_url, from POST /api/v1/uploads."}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedOut"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"}},"/api/v1/health":{"get":{"summary":"Get health","description":"Whether this deployment reaches its database, which one, and its last migration.","operationId":"health_api_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[],"tags":["Service"],"x-protyus-risk":"read"}},"/api/v1/extract":{"post":{"summary":"Analyse file once","description":"Analyse a STEP file once, without keeping it. Returns the result, in the same shape as an analysis's, and deletes the upload. Nothing is stored: to keep an analysis, create it in a project with POST /api/v1/projects/{project_id}/analyses instead. It runs in an organization and counts against its allowance like any analysis: with none active, it's refused with NO_ORGANIZATION.","operationId":"extract_api_v1_extract_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}}},"4XX":{"description":"The request was refused. The body says why, with a stable code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}},"5XX":{"description":"Protyus or a service it uses failed. Try again later.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBody"}}}}},"tags":["Analyses"],"x-protyus-risk":"change"}}},"components":{"schemas":{"Access":{"properties":{"user_id":{"type":"string","title":"User Id","description":"The caller's Clerk user id."},"org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Id","description":"The active organization's Clerk id, or null if none is chosen."},"role":{"anyOf":[{"type":"string","enum":["admin","member"]},{"type":"null"}],"title":"Role","description":"The caller's role in the active organization."},"can_create_projects":{"type":"boolean","title":"Can Create Projects","description":"Whether the caller may create projects here (`projects:create`)."},"staff":{"type":"boolean","title":"Staff","description":"Whether the caller is Protyus staff, who create organizations."},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","description":"The permissions the caller holds across the active organization, such as tools:write. A project can add more: see `permissions` on GET /api/v1/projects/{project_id}. Empty with no organization."},"plan":{"anyOf":[{"$ref":"#/components/schemas/PlanOut"},{"type":"null"}],"description":"The active organization's plan and the features it includes, or null with no organization."},"ai":{"$ref":"#/components/schemas/AiAccessOut","description":"Whether the caller may use Protyus AI here, why, and how much of the organization's trial is left."},"licence":{"anyOf":[{"$ref":"#/components/schemas/LicenceOut"},{"type":"null"}],"description":"The company's licence: its billing state, plan and the dates that matter. Null with no organization, or while billing isn't on for it."}},"additionalProperties":false,"type":"object","required":["user_id","org_id","role","can_create_projects","staff","permissions","plan","ai"],"title":"Access","description":"What the caller is and may do in their active organization."},"AddedFromList":{"properties":{"added":{"items":{"$ref":"#/components/schemas/ResolvedMachine"},"type":"array","title":"Added","description":"The machines it added, each numbered #1, in the list's order."},"already_had":{"type":"integer","title":"Already Had","description":"How many reference mills the organization already had, by make and model, archived or not, so weren't added."}},"additionalProperties":false,"type":"object","required":["added","already_had"],"title":"AddedFromList","description":"What adding every reference machine did."},"AiAccessOut":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether the caller may use Protyus AI now."},"reason":{"type":"string","enum":["on","switched_off","no_organization","not_licensed","limit_reached","paused"],"title":"Reason","description":"Why: on (they may use it), switched_off (an admin switched it off for them), no_organization, not_licensed (the company has no plan, or is read-only) or limit_reached (the company's messages under its plan's cap are used: on Hobbyist and in the trial, Protyus AI comes with Pro; on Pro and Enterprise, it's back when the month resets) or paused (the company has reached this month's limit on AI use, whatever its plan: it's back on the 1st, `spend.resets_on`)."},"message":{"type":"string","title":"Message","description":"The reason in a sentence a person can read."},"switched_on":{"type":"boolean","title":"Switched On","description":"Whether AI is switched on for the caller: on unless an admin switched it off."},"messages":{"anyOf":[{"$ref":"#/components/schemas/AiMessagesOut"},{"type":"null"}],"description":"The company's messages under its plan's cap: for its life on Hobbyist and in the trial, or this billing month on Pro and Enterprise. Null when no cap applies (the billing flag off, or no plan)."},"spend":{"anyOf":[{"$ref":"#/components/schemas/AiSpendOut"},{"type":"null"}],"description":"How much of this month's Protyus AI use the company has used, as a share, and whether it's paused: it holds whatever the plan. Null with no organization, or when no limit applies to the company."}},"additionalProperties":false,"type":"object","required":["enabled","reason","message","switched_on","messages"],"title":"AiAccessOut","description":"Whether the caller may use Protyus AI in their active organization, and why."},"AiDay":{"properties":{"messages":{"type":"integer","title":"Messages","description":"How many messages were sent to Protyus AI, whatever their outcome.","default":0},"tokens_in":{"type":"integer","title":"Tokens In","description":"Input tokens the model read for them, prompts and tool results included.","default":0},"tokens_out":{"type":"integer","title":"Tokens Out","description":"Output tokens the model wrote.","default":0},"day":{"type":"string","format":"date","title":"Day","description":"The day, in UTC."}},"additionalProperties":false,"type":"object","required":["day"],"title":"AiDay","description":"One day's Protyus AI messages, in UTC."},"AiMessageFinishIn":{"properties":{"outcome":{"type":"string","enum":["succeeded","failed"],"title":"Outcome","description":"Whether the model answered.","default":"succeeded"},"model":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Model","description":"The model that answered, such as anthropic/claude-haiku-4.5."},"tokens_in":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Tokens In","description":"Input tokens the model read, prompt and tool results included."},"tokens_out":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Tokens Out","description":"Output tokens the model wrote."},"cost_usd":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Cost Usd","description":"What the call cost in US dollars, if the gateway said."},"cache_read_tokens":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Cache Read Tokens","description":"Of tokens_in, how many the model read from its prompt cache, if the gateway said."},"cache_write_tokens":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Cache Write Tokens","description":"Of tokens_in, how many the model wrote to its prompt cache, if the gateway said."},"error_code":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Error Code","description":"Why it failed, as a stable code, when outcome is failed."}},"additionalProperties":false,"type":"object","title":"AiMessageFinishIn","description":"What one Protyus AI message used, once the model has answered."},"AiMessageOut":{"properties":{"message_id":{"type":"string","format":"uuid","title":"Message Id","description":"The message's id."},"outcome":{"type":"string","enum":["running","succeeded","failed"],"title":"Outcome","description":"running until it's finished, then whether the model answered."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"The model that answered, if known."},"tokens_in":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tokens In","description":"Input tokens, if known."},"tokens_out":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tokens Out","description":"Output tokens, if known."},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost Usd","description":"Its cost in US dollars, if known."},"cache_read_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cache Read Tokens","description":"Of tokens_in, those read from the prompt cache, if known."},"cache_write_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cache Write Tokens","description":"Of tokens_in, those written to the prompt cache, if known."},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"When it was started."},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At","description":"When it was finished, or null while running."}},"additionalProperties":false,"type":"object","required":["message_id","outcome","model","tokens_in","tokens_out","cost_usd","cache_read_tokens","cache_write_tokens","started_at","finished_at"],"title":"AiMessageOut","description":"A Protyus AI message, as metered."},"AiMessageStarted":{"properties":{"message_id":{"type":"string","format":"uuid","title":"Message Id","description":"The message's id, for POST /api/v1/ai/messages/{message_id}/finish."},"access":{"$ref":"#/components/schemas/AiAccessOut","description":"The caller's AI access, this message counted."}},"additionalProperties":false,"type":"object","required":["message_id","access"],"title":"AiMessageStarted","description":"A Protyus AI message the caller may send, counted from now."},"AiMessagesOut":{"properties":{"kind":{"type":"string","enum":["lifetime","month"],"title":"Kind","description":"lifetime: the company's 50 for its life, on Hobbyist and in the trial. month: the plan's a billing month."},"limit":{"type":"integer","title":"Limit","description":"How many messages the company has: for its life, or this billing month."},"used":{"type":"integer","title":"Used","description":"How many it has sent under this cap, by anyone."},"left":{"type":"integer","title":"Left","description":"How many are left. At 0, Protyus AI pauses: until Pro for a lifetime cap, until `resets_on` for a month's."},"resets_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Resets On","description":"For a month's cap, the day it starts again from zero, in UTC. Null for a lifetime cap."}},"additionalProperties":false,"type":"object","required":["kind","limit","used","left","resets_on"],"title":"AiMessagesOut","description":"The company's Protyus AI messages under its plan's cap: for its life on Hobbyist and in the trial (50, never\nrefreshed), or a billing month on Pro and Enterprise."},"AiPerson":{"properties":{"messages":{"type":"integer","title":"Messages","description":"How many messages were sent to Protyus AI, whatever their outcome.","default":0},"tokens_in":{"type":"integer","title":"Tokens In","description":"Input tokens the model read for them, prompts and tool results included.","default":0},"tokens_out":{"type":"integer","title":"Tokens Out","description":"Output tokens the model wrote.","default":0},"user_id":{"type":"string","title":"User Id","description":"Their Clerk user id."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Their name or email, if they're still in the organization."}},"additionalProperties":false,"type":"object","required":["user_id","name"],"title":"AiPerson","description":"One person's Protyus AI messages in the window."},"AiSpendOut":{"properties":{"used_percent":{"type":"integer","title":"Used Percent","description":"How much of this month's Protyus AI use the company has used, 0 to 100."},"paused":{"type":"boolean","title":"Paused","description":"Whether Protyus AI is paused for the company until `resets_on`: at 100."},"resets_on":{"type":"string","format":"date","title":"Resets On","description":"The day it starts again from zero: the 1st of next month, in UTC."}},"additionalProperties":false,"type":"object","required":["used_percent","paused","resets_on"],"title":"AiSpendOut","description":"How much of the company's Protyus AI use this month is used, as a share: never what it costs."},"AiTotals":{"properties":{"messages":{"type":"integer","title":"Messages","description":"How many messages were sent to Protyus AI, whatever their outcome.","default":0},"tokens_in":{"type":"integer","title":"Tokens In","description":"Input tokens the model read for them, prompts and tool results included.","default":0},"tokens_out":{"type":"integer","title":"Tokens Out","description":"Output tokens the model wrote.","default":0}},"additionalProperties":false,"type":"object","title":"AiTotals","description":"Protyus AI messages added up, with the tokens the model used on them."},"AiUsage":{"properties":{"totals":{"$ref":"#/components/schemas/AiTotals","description":"Every message in the window."},"by_day":{"items":{"$ref":"#/components/schemas/AiDay"},"type":"array","title":"By Day","description":"Each day in the window, oldest first, including days with no messages."},"by_person":{"items":{"$ref":"#/components/schemas/AiPerson"},"type":"array","title":"By Person","description":"Each person with messages in the window, most messages first."}},"additionalProperties":false,"type":"object","required":["totals","by_day","by_person"],"title":"AiUsage","description":"Protyus AI messages over the window, kept apart from runs."},"Allowed":{"properties":{"machine":{"anyOf":[{"$ref":"#/components/schemas/AllowedList"},{"type":"null"}],"description":"The machines its analyses may plan for."},"material":{"anyOf":[{"$ref":"#/components/schemas/AllowedList"},{"type":"null"}],"description":"The materials its analyses may pick."},"tool":{"anyOf":[{"$ref":"#/components/schemas/AllowedList"},{"type":"null"}],"description":"The tools its analyses may plan with."}},"additionalProperties":false,"type":"object","title":"Allowed","description":"A project's narrowed lists. A kind left out or null allows everything the organization has."},"AllowedChange":{"properties":{"machine":{"anyOf":[{"$ref":"#/components/schemas/AllowedList"},{"type":"null"}],"description":"The machines its analyses may plan for."},"material":{"anyOf":[{"$ref":"#/components/schemas/AllowedList"},{"type":"null"}],"description":"The materials its analyses may pick."},"tool":{"anyOf":[{"$ref":"#/components/schemas/AllowedList"},{"type":"null"}],"description":"The tools its analyses may plan with."}},"additionalProperties":false,"type":"object","title":"AllowedChange","description":"Lists to change. Leave a kind out to keep it; send null to allow everything again."},"AllowedList":{"properties":{"keys":{"items":{"type":"string"},"type":"array","maxItems":200,"title":"Keys","description":"Built-in choices by key, such as 3_axis or 6061.","default":[]},"item_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":500,"title":"Item Ids","description":"The organization's library items.","default":[]},"collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Collection Id","description":"A collection, whose items are allowed as it changes."}},"additionalProperties":false,"type":"object","title":"AllowedList","description":"What a project allows for one kind: built-in keys, library items, and a collection's items."},"AnalysedOut":{"properties":{"version":{"$ref":"#/components/schemas/PartVersionOut","description":"The version that was analysed: a final snapshot of the working version, or the finalised version."},"analysis_id":{"type":"string","format":"uuid","title":"Analysis Id","description":"The analysis; poll GET /api/v1/analyses/{analysis_id} until it's ready."}},"additionalProperties":false,"type":"object","required":["version","analysis_id"],"title":"AnalysedOut","description":"The version an analysis was started on, and the analysis."},"AnalysesUsed":{"properties":{"used":{"type":"integer","title":"Used","description":"Analyses used this billing month: each distinct STEP file analysed counts once, whoever ran it and however, including parts sent through submission links. Running the same file again in the month, on another machine or as an iteration, is free. A run that failed doesn't count."},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"How many analyses the company may use in the period: the plan's a month (or the trial's in all), plus the credits it has used this month and those it has left. Null when no limit applies. A new part past it is refused with ALLOWANCE_REACHED or TRIAL_LIMIT_REACHED; a part already counted is still free."},"plan_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Plan Limit","description":"The plan's analyses a month, or the trial's in all, without credits. Null when no limit applies."},"credits_left":{"type":"integer","title":"Credits Left","description":"Credits the company has left: analyses beyond the plan's, used only once the month's are gone, the soonest to expire first. GET /api/v1/organization/credits lists them with their expiry.","default":0},"credits_on_sale":{"type":"boolean","title":"Credits On Sale","description":"Whether the company can buy credits now: it is on a paid plan (not Free), active or past due, and payments are set up. An admin buys them in Organization > Credits & usage.","default":false},"kind":{"type":"string","enum":["month","trial"],"title":"Kind","description":"month: the count is for this billing month and starts again on `resets_on`. trial: it's the free trial's, in all, and the trial ends on `resets_on`.","default":"month"},"since":{"type":"string","format":"date","title":"Since","description":"The first day counted, in UTC: this billing month's, or the trial's."},"resets_on":{"type":"string","format":"date","title":"Resets On","description":"The day the count starts again from zero, or the trial ends, in UTC."},"waiting":{"type":"integer","title":"Waiting","description":"Parts from submission links waiting for room: each is analysed by itself, oldest first, once there's room (credits, a new month, a bigger plan or the plan restarted).","default":0}},"additionalProperties":false,"type":"object","required":["used","since","resets_on"],"title":"AnalysesUsed","description":"The analyses the organization has used this billing month, as its allowance counts them."},"AnalysisDetail":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The analysis's id."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project it belongs to."},"file_name":{"type":"string","title":"File Name","description":"The STEP file's original name."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of whoever ran it."},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name","description":"Their name, if known."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was run."},"machine":{"type":"string","title":"Machine","description":"The machine it was planned for: the organization's machine id, or a machine type's key for older analyses."},"machine_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine Label","description":"That machine's name for people, such as Haas VF-2 or 3-axis. Null if it's no longer known."},"best_fit":{"type":"boolean","title":"Best Fit","description":"Whether Best Fit picked the machine (machine auto): machine is the one it picked once the analysis is ready, and auto until then.","default":false},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material it picked: the organization's grade by id, or a reference grade's key for older analyses. Null before materials were picked."},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"The batch quantity it picked, or null for analyses run before quantities were picked."},"annual_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Annual Volume","description":"The parts a year it was costed at, as picked. Null for Protyus's defaults: 1,000 a year for sheet metal, 10,000 for moulding."},"process_machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Machine","description":"For sheet metal or moulding, the machine picked to make it on, such as SM-FL6 or M-110E. Null for Best Fit, and for milling, whose machine is machine. The result names the machine it was made on either way."},"process_material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Material","description":"For sheet metal or moulding, the grade or resin picked, such as SM-07 or IM-04. Null for the default."},"process":{"type":"string","enum":["milling","sheet_metal","moulding"],"title":"Process","description":"The process it was analysed for: milling, sheet_metal or moulding. Analyses run before processes are milling."},"parting_plane":{"anyOf":[{"$ref":"#/components/schemas/PartingPlane"},{"type":"null"}],"description":"For moulding, the parting plane set by hand it ran with, whose normal is its pull. Null where the engine found the plane."},"findings_count":{"type":"integer","title":"Findings Count","description":"How many DFM findings it raised on that machine."},"findings":{"items":{"$ref":"#/components/schemas/FindingSummary"},"type":"array","title":"Findings","description":"Each finding's id, rule, severity, title and surfaces, on that machine."},"can_delete":{"type":"boolean","title":"Can Delete","description":"Whether the caller may delete it."},"status":{"type":"string","enum":["running","ready","failed"],"title":"Status","description":"running while the engine works on it; ready once its result is kept; failed if it couldn't be analysed. Poll GET /api/v1/analyses/{analysis_id} until it isn't running."},"error":{"anyOf":[{"$ref":"#/components/schemas/AnalysisError"},{"type":"null"}],"description":"Why it failed, when status is failed. Otherwise null."},"part_id":{"type":"string","format":"uuid","title":"Part Id","description":"The part it's an analysis of. Every iteration of a part has the same one; for a part made before parts were kept, it's the id of the part's first analysis."},"part_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Part Version Id","description":"The part version it analysed: one STEP file of the part. Null only for an analysis outside a project."},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"That version's number in its part, from 1 (v1, v2), in the order versions were made. Unlike iteration, it never changes: a failed upload leaves its number unused."},"iteration_group":{"type":"string","format":"uuid","title":"Iteration Group","description":"Deprecated: the same as part_id, which replaces it. It goes in a later release.","deprecated":true},"iteration":{"type":"integer","title":"Iteration","description":"Its number among its part's ready analyses, from 1, in upload order."},"iterations":{"type":"integer","title":"Iterations","description":"How many ready analyses its part has, counting it. 1 when it has no other iterations."},"tool_overrides":{"items":{"$ref":"#/components/schemas/ToolOverride"},"type":"array","title":"Tool Overrides","description":"Each Time tab line whose tool was chosen by hand, as its latest run applied it. A new iteration keeps them where they still fit. Empty for none.","default":[]},"rerun":{"anyOf":[{"$ref":"#/components/schemas/Rerun"},{"type":"null"}],"description":"The re-run a change to a line's tool started: running while it runs, failed if it couldn't finish. The analysis stays ready, with its last result, meanwhile. Null when none is running and the last worked."},"machine_detail":{"anyOf":[{"$ref":"#/components/schemas/ResolvedMachine"},{"type":"null"}],"description":"The machine it planned with, every value marked as the machine's own or its class's. Null for analyses run before machines."},"result":{"anyOf":[{"$ref":"#/components/schemas/Result"},{"type":"null"}],"description":"What the engine concluded, as /api/v1/extract returns it: the part, its display mesh, features, setups, findings, scorecard and estimate. Null until status is ready."}},"additionalProperties":false,"type":"object","required":["id","project_id","file_name","created_by","created_by_name","created_at","machine","machine_label","material","quantity","process","findings_count","findings","can_delete","status","part_id","part_version_id","version","iteration_group","iteration","iterations","machine_detail","result"],"title":"AnalysisDetail","description":"An analysis with the machine it planned with and its result."},"AnalysisError":{"properties":{"code":{"type":"string","title":"Code","description":"A stable code, such as NOT_A_SOLID or TIMED_OUT."},"message":{"type":"string","title":"Message","description":"What went wrong, in a sentence a person can read."}},"additionalProperties":false,"type":"object","required":["code","message"],"title":"AnalysisError","description":"Why an analysis failed."},"AnalysisIn":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"The STEP file's Vercel Blob URL: the upload_url from sending it to the put_url that POST /api/v1/uploads gives, or from the web app's own upload. It must be your own upload, made by you: in your folder, uploads/{org_id}/{user_id}/. Anything else is refused with NOT_YOUR_UPLOAD."},"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's original name, such as bracket.step."},"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine to plan for, from the project's choices (GET /api/v1/projects/{project_id}/settings). auto for Best Fit: of the project's milling machines whose type's plan reaches every feature, the cheapest per part, a tie going to the simpler type (3-axis, then 4-axis, 3+2 and 5-axis); the analysis keeps the one it picks. Null for its default."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material: one the organization offers, by id, or a reference grade such as 6061. Null for the project's default."},"quantity":{"anyOf":[{"type":"integer","maximum":1000000.0,"minimum":1.0},{"type":"null"}],"title":"Quantity","description":"How many parts in the batch. Null for the project's default."},"annual_volume":{"anyOf":[{"type":"integer","maximum":100000000.0,"minimum":1.0},{"type":"null"}],"title":"Annual Volume","description":"How many parts a year, which sheet metal's progressive die and moulding's mould are costed over. Null for Protyus's defaults: 1,000 a year for sheet metal, 10,000 for moulding. Milling doesn't use it."},"process_machine":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Process Machine","description":"For sheet metal or moulding, the machine to make it on: one of Protyus's cutting machines (such as SM-FL6) or presses (such as M-110E), from the project's choices (choices.sheet_metal or choices.moulding in GET /api/v1/projects/{project_id}/settings). auto or null for Best Fit, the cheapest that can make it. One that isn't the process's is refused with PROCESS_MACHINE_NOT_FOUND. Milling picks its machine with machine."},"process_material":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Process Material","description":"For sheet metal or moulding, the grade or resin: one of Protyus's sheet grades (such as SM-07) or resins (such as IM-04), from the same choices. Null for the default, SM-01 or ABS. One that isn't the process's is refused with PROCESS_MATERIAL_NOT_FOUND. Milling picks its material with material."},"process":{"type":"string","enum":["milling","sheet_metal","moulding"],"title":"Process","description":"How the part is made: milling (the default), sheet_metal or moulding. Sheet metal and moulding aren't available to everyone yet: asking for one that isn't open to you is refused with PROCESS_NOT_AVAILABLE. Their result says what they'll check, in its sheet_metal or moulding section, until they're built.","default":"milling"},"parting_plane":{"anyOf":[{"$ref":"#/components/schemas/PartingPlaneIn"},{"type":"null"}],"description":"For moulding, a parting plane set by hand, given one way (point and normal, three points, a flat face or two edges); its normal sets the pull. Null for the plane the engine finds where the draft turns round the outside of the part. On any other process it's refused with PARTING_PLANE_NOT_MOULDING. A face or edges can't be named yet: the part isn't read until it runs."},"app_version":{"$ref":"#/components/schemas/AppVersion","description":"The version of the app making the request.","default":{"number":"unknown","commit":"local"}}},"additionalProperties":false,"type":"object","required":["upload_url","file_name"],"title":"AnalysisIn","description":"An uploaded STEP file to analyse, and the three things an analysis picks.\n\nEverything else comes from the project's settings."},"AnalysisOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The analysis's id."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project it belongs to."},"file_name":{"type":"string","title":"File Name","description":"The STEP file's original name."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of whoever ran it."},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name","description":"Their name, if known."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was run."},"machine":{"type":"string","title":"Machine","description":"The machine it was planned for: the organization's machine id, or a machine type's key for older analyses."},"machine_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine Label","description":"That machine's name for people, such as Haas VF-2 or 3-axis. Null if it's no longer known."},"best_fit":{"type":"boolean","title":"Best Fit","description":"Whether Best Fit picked the machine (machine auto): machine is the one it picked once the analysis is ready, and auto until then.","default":false},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material it picked: the organization's grade by id, or a reference grade's key for older analyses. Null before materials were picked."},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"The batch quantity it picked, or null for analyses run before quantities were picked."},"annual_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Annual Volume","description":"The parts a year it was costed at, as picked. Null for Protyus's defaults: 1,000 a year for sheet metal, 10,000 for moulding."},"process_machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Machine","description":"For sheet metal or moulding, the machine picked to make it on, such as SM-FL6 or M-110E. Null for Best Fit, and for milling, whose machine is machine. The result names the machine it was made on either way."},"process_material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Material","description":"For sheet metal or moulding, the grade or resin picked, such as SM-07 or IM-04. Null for the default."},"process":{"type":"string","enum":["milling","sheet_metal","moulding"],"title":"Process","description":"The process it was analysed for: milling, sheet_metal or moulding. Analyses run before processes are milling."},"parting_plane":{"anyOf":[{"$ref":"#/components/schemas/PartingPlane"},{"type":"null"}],"description":"For moulding, the parting plane set by hand it ran with, whose normal is its pull. Null where the engine found the plane."},"findings_count":{"type":"integer","title":"Findings Count","description":"How many DFM findings it raised on that machine."},"findings":{"items":{"$ref":"#/components/schemas/FindingSummary"},"type":"array","title":"Findings","description":"Each finding's id, rule, severity, title and surfaces, on that machine."},"can_delete":{"type":"boolean","title":"Can Delete","description":"Whether the caller may delete it."},"status":{"type":"string","enum":["running","ready","failed"],"title":"Status","description":"running while the engine works on it; ready once its result is kept; failed if it couldn't be analysed. Poll GET /api/v1/analyses/{analysis_id} until it isn't running."},"error":{"anyOf":[{"$ref":"#/components/schemas/AnalysisError"},{"type":"null"}],"description":"Why it failed, when status is failed. Otherwise null."},"part_id":{"type":"string","format":"uuid","title":"Part Id","description":"The part it's an analysis of. Every iteration of a part has the same one; for a part made before parts were kept, it's the id of the part's first analysis."},"part_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Part Version Id","description":"The part version it analysed: one STEP file of the part. Null only for an analysis outside a project."},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"That version's number in its part, from 1 (v1, v2), in the order versions were made. Unlike iteration, it never changes: a failed upload leaves its number unused."},"iteration_group":{"type":"string","format":"uuid","title":"Iteration Group","description":"Deprecated: the same as part_id, which replaces it. It goes in a later release.","deprecated":true},"iteration":{"type":"integer","title":"Iteration","description":"Its number among its part's ready analyses, from 1, in upload order."},"iterations":{"type":"integer","title":"Iterations","description":"How many ready analyses its part has, counting it. 1 when it has no other iterations."},"tool_overrides":{"items":{"$ref":"#/components/schemas/ToolOverride"},"type":"array","title":"Tool Overrides","description":"Each Time tab line whose tool was chosen by hand, as its latest run applied it. A new iteration keeps them where they still fit. Empty for none.","default":[]},"rerun":{"anyOf":[{"$ref":"#/components/schemas/Rerun"},{"type":"null"}],"description":"The re-run a change to a line's tool started: running while it runs, failed if it couldn't finish. The analysis stays ready, with its last result, meanwhile. Null when none is running and the last worked."}},"additionalProperties":false,"type":"object","required":["id","project_id","file_name","created_by","created_by_name","created_at","machine","machine_label","material","quantity","process","findings_count","findings","can_delete","status","part_id","part_version_id","version","iteration_group","iteration","iterations"],"title":"AnalysisOut","description":"An analysis in a project, without its full result."},"Answers":{"properties":{"first_name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"First Name","description":"Their first name."},"last_name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Last Name","description":"Their last name."},"company":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Company","description":"Their company."},"phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Phone","description":"Their phone number."},"due_date":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Due Date","description":"When they need the parts, as they put it, such as 2026-12-15 or end of January."},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes","description":"Anything else they want the shop to know."}},"additionalProperties":false,"type":"object","title":"Answers","description":"What a lead says about themselves and their request. Each is optional here; the form decides which it asks for."},"ApiKeyIn":{"properties":{"name":{"type":"string","maxLength":60,"minLength":3,"title":"Name","description":"What the key is for, 3 to 60 characters, such as 'Claude on my laptop' or 'CI uploads'. Shown in the list of keys."},"description":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Description","description":"A longer note about the key, if wanted."},"expires_in_days":{"anyOf":[{"type":"integer","maximum":365.0,"minimum":1.0},{"type":"null"}],"title":"Expires In Days","description":"Days until the key stops working, 1 to 365. Leave out for a key that works until it's revoked."}},"additionalProperties":false,"type":"object","required":["name"],"title":"ApiKeyIn","description":"A new API key for the caller's own agents."},"ApiKeyOut":{"properties":{"id":{"type":"string","title":"Id","description":"The key's id (ak_ and 32 hex digits). Not the secret: it can't sign anything in."},"name":{"type":"string","title":"Name","description":"What the key is for."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A longer note about the key, if one was given."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the key was made."},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At","description":"When the key last signed a request in, if Clerk has recorded it."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When the key stops working, or null if it doesn't expire."},"revoked":{"type":"boolean","title":"Revoked","description":"Whether the key was revoked. A revoked key is refused at once."},"expired":{"type":"boolean","title":"Expired","description":"Whether the key has passed its expiry."}},"additionalProperties":false,"type":"object","required":["id","name","description","created_at","last_used_at","expires_at","revoked","expired"],"title":"ApiKeyOut","description":"One API key. The secret itself is never shown here."},"AppVersion":{"properties":{"number":{"type":"string","maxLength":40,"title":"Number","description":"The web app's version number.","default":"unknown"},"commit":{"type":"string","maxLength":64,"title":"Commit","description":"The web app's deployed commit, or 'local'.","default":"local"}},"additionalProperties":false,"type":"object","title":"AppVersion","description":"Which build of the web app sent a request."},"AttachmentIn":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name","description":"The file's name, shown back to the person. Never sent to the model."},"data":{"type":"string","maxLength":4194312,"minLength":4,"title":"Data","description":"The file, base64: a PDF drawing, or a PNG, JPEG or WebP picture, of at most 3 MB. A PDF of at most 10 pages, a picture at most 8000 pixels a side."}},"additionalProperties":false,"type":"object","required":["name","data"],"title":"AttachmentIn","description":"A drawing, sketch or photo to read before a turn builds from it."},"AttachmentOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Its id, for read_design_attachment and a turn's attachment."},"name":{"type":"string","title":"Name","description":"The file's name."},"media_type":{"type":"string","enum":["image/png","image/jpeg","image/webp","application/pdf"],"title":"Media Type","description":"Its type, from its own bytes."},"bytes":{"type":"integer","title":"Bytes","description":"Its size as kept, with a picture's metadata (EXIF, GPS, XMP) cut out."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was attached."},"read":{"type":"boolean","title":"Read","description":"Whether Protyus AI has read it yet."}},"additionalProperties":false,"type":"object","required":["id","name","media_type","bytes","created_at","read"],"title":"AttachmentOut","description":"A file attached to the working version. Its bytes never come back."},"Band":{"properties":{"id":{"type":"string","title":"Id","description":"green, yellow or red, from the organization's settings. Analyses run before 0.65.0 have easy, moderate or hard."},"title":{"type":"string","title":"Title","description":"Its name for people."}},"type":"object","required":["id","title"],"title":"Band","description":"A score's colour."},"BatchOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The batch's id."},"kind":{"type":"string","title":"Kind","description":"The kind of item it changed."},"action":{"type":"string","enum":["import","archive"],"title":"Action","description":"import adds and updates items; archive archives them."},"source_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Name","description":"The imported file's name, or null."},"source_format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Format","description":"The imported file's format, such as fusion or csv, or null."},"status":{"type":"string","enum":["running","ready","failed","undone"],"title":"Status","description":"running, ready (done), failed, or undone."},"counts":{"additionalProperties":{"type":"integer"},"type":"object","title":"Counts","description":"How many items it added, updated and archived, and any counts its importer adds."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Why it failed, or null."},"created_by":{"type":"string","title":"Created By","description":"Who made it."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it started."},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At","description":"When it finished, or null while running."},"undone_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Undone By","description":"Who undid it, or null."},"undone_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Undone At","description":"When it was undone, or null."}},"additionalProperties":false,"type":"object","required":["id","kind","action","source_name","source_format","status","counts","error","created_by","created_at","finished_at","undone_by","undone_at"],"title":"BatchOut","description":"A set of changes that can be undone together: an import or a bulk archive."},"BlankSetup":{"properties":{"number":{"type":"integer","title":"Number","description":"Its number, from 1, in the order they're done."},"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"The direction facing away from the table, as a unit vector x, y, z."},"kind":{"type":"string","title":"Kind","description":"main (axial), side (radial) or tilted."},"angled_fixture":{"type":"boolean","title":"Angled Fixture","description":"Whether it needs an angled fixture, as its direction isn't square to the stock.","default":false},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces cut in it.","default":[]},"holes":{"type":"integer","title":"Holes","description":"How many holes are cut in it.","default":0},"pockets":{"type":"integer","title":"Pockets","description":"How many pockets are cut in it.","default":0},"holdable":{"type":"boolean","title":"Holdable","description":"Whether two opposite flat faces of the finished part are free to hold it by, or, on a blank a lathe turned, its turned diameter. When false, uncut stock or a fixture may still hold it."},"directions":{"items":{"$ref":"#/components/schemas/ToolDirection"},"type":"array","title":"Directions","description":"Each direction the tool comes from in it.","default":[]},"holding":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Holding","description":"How it's held, such as V-block jaws, on its turned diameter."}},"type":"object","required":["number","direction","kind","holdable"],"title":"BlankSetup","description":"One clamping of the turned blank on the mill."},"BlankSetupPlan":{"properties":{"machine":{"type":"string","title":"Machine","description":"The machine planned for: the organization's machine id, or a machine type such as 3_axis."},"machine_label":{"type":"string","title":"Machine Label","description":"Its name for people."},"machine_description":{"type":"string","title":"Machine Description","description":"What that machine reaches in one clamping.","default":""},"setups":{"items":{"$ref":"#/components/schemas/BlankSetup"},"type":"array","title":"Setups","description":"Each setup, in order."},"stock_surfaces":{"items":{"type":"string"},"type":"array","title":"Stock Surfaces","description":"Faces left as raw stock, needing no setup. Empty for analyses run since every face is machined.","default":[]},"unreachable_surfaces":{"items":{"type":"string"},"type":"array","title":"Unreachable Surfaces","description":"Faces a plain tool can't reach on this machine.","default":[]},"back_bored_surfaces":{"items":{"type":"string"},"type":"array","title":"Back Bored Surfaces","description":"The unreachable faces a back-boring tool can reach, passed through their hole from its other end.","default":[]},"sliver_surfaces":{"items":{"type":"string"},"type":"array","title":"Sliver Surfaces","description":"Faces too small to plan for.","default":[]},"cleanup_spaces":{"items":{"$ref":"#/components/schemas/CleanupSpace"},"type":"array","title":"Cleanup Spaces","description":"Each face cut in two, its bulk in one setup and the rest in another, with where the rest lies, then each obstructed face, which no tool reaches. Empty for analyses run before they were drawn.","default":[]}},"type":"object","required":["machine","machine_label","setups"],"title":"BlankSetupPlan","description":"How the mill sets up the turned blank to cut what the lathe leaves."},"CameraOut":{"properties":{"view":{"anyOf":[{"type":"string","enum":["auto","top","bottom","front","back","left","right","iso","profile"]},{"$ref":"#/components/schemas/SetupCamera"},{"$ref":"#/components/schemas/StepCamera"}],"title":"View","description":"What was asked."},"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"A unit vector from the target towards the camera."},"up":{"items":{"type":"number"},"type":"array","title":"Up","description":"Which way is up on the screen."}},"additionalProperties":false,"type":"object","required":["view","direction","up"],"title":"CameraOut","description":"Where the frame looks from."},"Card":{"properties":{"card":{"type":"string","enum":["number","trend","bars","table","analyses","quotes","attention","part","view","quote"],"title":"Card","description":"Which card draws the response. number, trend, bars and table draw query_metrics; analyses and attention draw list_recent_analyses; quotes draws list_quotes; part draws get_analysis; view draws view_part; quote draws get_quote; table also draws either list."},"title":{"type":"string","maxLength":120,"minLength":1,"title":"Title","description":"The card's heading, such as Findings per week."},"operation":{"type":"string","enum":["query_metrics","list_recent_analyses","list_quotes","get_analysis","get_quote","view_part"],"title":"Operation","description":"The MCP tool the card calls each time it's viewed, as the viewer. Only read-only operations may be saved: query_metrics, list_recent_analyses, list_quotes, get_analysis, get_quote and view_part."},"params":{"additionalProperties":true,"type":"object","title":"Params","description":"The operation's arguments, as its MCP tool takes them, such as {\"measure\": \"findings\", \"dimensions\": [\"week\"], \"filters\": {\"from\": \"-84d\"}}. Dates under from, to and since may be relative: today, yesterday, or -Nd for N days before today. They're kept as given and resolved each time the card runs.","default":{}},"id":{"type":"string","format":"uuid","title":"Id","description":"The card's id, unique on its dashboard."},"layout":{"$ref":"#/components/schemas/Layout","description":"Where it sits on the 12-column grid."}},"additionalProperties":false,"type":"object","required":["card","title","operation","id","layout"],"title":"Card","description":"A saved card: a read-only call that runs as whoever views it, and where it sits."},"CardIn":{"properties":{"card":{"type":"string","enum":["number","trend","bars","table","analyses","quotes","attention","part","view","quote"],"title":"Card","description":"Which card draws the response. number, trend, bars and table draw query_metrics; analyses and attention draw list_recent_analyses; quotes draws list_quotes; part draws get_analysis; view draws view_part; quote draws get_quote; table also draws either list."},"title":{"type":"string","maxLength":120,"minLength":1,"title":"Title","description":"The card's heading, such as Findings per week."},"operation":{"type":"string","enum":["query_metrics","list_recent_analyses","list_quotes","get_analysis","get_quote","view_part"],"title":"Operation","description":"The MCP tool the card calls each time it's viewed, as the viewer. Only read-only operations may be saved: query_metrics, list_recent_analyses, list_quotes, get_analysis, get_quote and view_part."},"params":{"additionalProperties":true,"type":"object","title":"Params","description":"The operation's arguments, as its MCP tool takes them, such as {\"measure\": \"findings\", \"dimensions\": [\"week\"], \"filters\": {\"from\": \"-84d\"}}. Dates under from, to and since may be relative: today, yesterday, or -Nd for N days before today. They're kept as given and resolved each time the card runs.","default":{}},"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id","description":"The card's id. Leave out for a new card; give an existing card's to keep it."},"layout":{"anyOf":[{"$ref":"#/components/schemas/Layout"},{"type":"null"}],"description":"Where it sits on the grid. Leave out to place it below every other card, at a size that suits the card."}},"additionalProperties":false,"type":"object","required":["card","title","operation"],"title":"CardIn","description":"A card to save on a dashboard: a read-only call and where it sits."},"Characteristic":{"properties":{"id":{"type":"string","title":"Id","description":"Its id within this result, such as C007."},"source":{"type":"string","const":"pmi","title":"Source","description":"Where it was read from: pmi, the tolerances inside the STEP AP242 file."},"kind":{"type":"string","enum":["size","location","geometric"],"title":"Kind","description":"size (a diameter, radius, width or thickness), location (a distance or angle between features) or geometric (a feature control frame: position, flatness, profile and the like)."},"type":{"type":"string","title":"Type","description":"What it is, such as diameter, linear_distance, angular, position, flatness or profile_of_surface."},"unit":{"type":"string","enum":["mm","deg"],"title":"Unit","description":"The unit of nominal, upper, lower and zone: mm, or deg for an angle."},"nominal":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Nominal","description":"A dimension's nominal value. Null for one given as two limits, and for a geometric tolerance."},"upper":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Upper","description":"A dimension's upper limit. Null when it has none: a basic or reference dimension, a minimum, or one toleranced by a fit alone."},"lower":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lower","description":"A dimension's lower limit. Null when it has none, as for a maximum (R0.1 MAX)."},"qualifier":{"anyOf":[{"type":"string","enum":["maximum","minimum","average"]},{"type":"null"}],"title":"Qualifier","description":"What a dimension's value is when the print says MAX, MIN or AVG. A maximum is also its upper limit, a minimum its lower."},"fit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fit","description":"A dimension's fit class as written, such as G6 or H7. Its limits are null unless the file gives them."},"basic":{"type":"boolean","title":"Basic","description":"Whether a dimension is basic (boxed on the print): theoretically exact, toleranced by a feature control frame.","default":false},"reference":{"type":"boolean","title":"Reference","description":"Whether a dimension is for reference only (in brackets on the print) and carries no tolerance.","default":false},"zone":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Zone","description":"A geometric tolerance's zone: its width, or its diameter when zone_shape is diameter."},"zone_shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zone Shape","description":"diameter or spherical_diameter for a round zone. Null for one between two planes or surfaces."},"material_condition":{"anyOf":[{"type":"string","enum":["maximum","least"]},{"type":"null"}],"title":"Material Condition","description":"maximum (M) or least (L) material condition on the zone. Null for regardless of feature size."},"projected_zone":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Projected Zone","description":"How far a projected zone stands off the part, mm (the P in a frame). Null without one."},"unequal":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unequal","description":"For an unequally disposed profile, the value after the U in a frame: how much of the zone lies outside the material, mm. Null for an equal one."},"per_unit":{"anyOf":[{"$ref":"#/components/schemas/PerUnit"},{"type":"null"}],"description":"For a tolerance per unit length or area (flatness 0.1 over any 25 x 25): what the zone applies over. Null otherwise."},"zone_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Zone Max","description":"The most the zone may grow to with its material condition, mm (MAX in a frame). Null without one."},"refines":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refines","description":"For the lower segment of a composite frame: the id of the segment above it, which it refines. Null for any other frame."},"modifiers":{"items":{"type":"string"},"type":"array","title":"Modifiers","description":"Its other modifiers as written, such as all_around, free_state, projected, statistical_tolerance or controlled_radius.","default":[]},"datums":{"items":{"$ref":"#/components/schemas/DatumReference"},"type":"array","title":"Datums","description":"The datums it's measured from, primary first.","default":[]},"faces":{"items":{"type":"string"},"type":"array","title":"Faces","description":"The faces it controls, every member of a pattern included. Empty when the file ties it to none.","default":[]},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"The edges it's attached to, when it names edges rather than faces.","default":[]}},"type":"object","required":["id","source","kind","type","unit"],"title":"Characteristic","description":"One requirement the part's print makes: a toleranced dimension or a geometric tolerance, on its faces.\n\nIt says what is asked, as the file's author wrote it, and nothing about whether a shop holds it."},"Characteristics":{"properties":{"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units","description":"The unit the part's geometry is written in, as part.units says: mm, in, cm, m or ft. A file can write its tolerances in another. Every value here is in mm or degrees whichever they were written in."},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/Characteristic"},"type":"array"},{"type":"null"}],"title":"Items","description":"Each characteristic, sizes first, then locations, then geometric tolerances."},"datums":{"anyOf":[{"items":{"$ref":"#/components/schemas/DatumFeature"},"type":"array"},{"type":"null"}],"title":"Datums","description":"Each datum, by letter."}},"type":"object","title":"Characteristics","description":"The tolerances the part's file carries: each dimension and geometric tolerance, and the datums."},"Check":{"properties":{"id":{"type":"string","title":"Id","description":"Which check."},"title":{"type":"string","title":"Title","description":"What it checks, for people."},"level":{"type":"string","title":"Level","description":"required (the part can't be made if it fails) or advisory."},"passed":{"type":"boolean","title":"Passed","description":"Whether it passed."},"findings":{"items":{"type":"integer"},"type":"array","title":"Findings","description":"The findings that failed it, by position in the plan's findings.","default":[]}},"type":"object","required":["id","title","level","passed"],"title":"Check","description":"One named check on the part."},"CheckFeature":{"properties":{"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces."},"passed":{"type":"boolean","title":"Passed","description":"Whether it passed."},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent","description":"The machined feature it's part of, such as pocket or hole."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"What was measured, such as 4.5:1 or R6.35 mm."},"threshold":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Threshold","description":"The limit it was held to, from the organization's or project's settings."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Why it failed, in plain words. Null when it passed."},"inch":{"anyOf":[{"$ref":"#/components/schemas/CheckFeatureInch"},{"type":"null"}],"description":"The same words with lengths in inches, where they differ."}},"type":"object","required":["surfaces","passed"],"title":"CheckFeature","description":"One feature a score check applied to, and how it did: the measured value, the limit it was held to and the\nreason, in words."},"CheckFeatureInch":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"What was measured, in inches."},"threshold":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Threshold","description":"The limit it was held to, in inches."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Why it failed, in inches."}},"type":"object","title":"CheckFeatureInch","description":"A checked feature's words with lengths in inches."},"CheckOut":{"properties":{"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine it planned for."},"verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict","description":"Whether it can be made, in words."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","description":"The DFM score, 0 to 100."},"failing_checks":{"items":{"type":"string"},"type":"array","title":"Failing Checks","description":"The checks it fails.","default":[]},"findings":{"items":{"$ref":"#/components/schemas/FindingOut"},"type":"array","title":"Findings","description":"Its findings, grouped.","default":[]},"size":{"anyOf":[{"$ref":"#/components/schemas/PartSize"},{"type":"null"}],"description":"The part's size."},"travel":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Travel","description":"Whether it fits the machine's travel: a flag on the machine, never a part fail."},"part":{"anyOf":[{"$ref":"#/components/schemas/Part"},{"type":"null"}],"description":"The part's faces and edges, as an analysis's part. Null for an older turn's check."},"display":{"anyOf":[{"$ref":"#/components/schemas/Display"},{"type":"null"}],"description":"The part's triangles and edges, for a 3D viewer."},"roles":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Roles","description":"Each face's role, by face, as an analysis's recognition.roles."},"dfm":{"anyOf":[{"$ref":"#/components/schemas/Dfm"},{"type":"null"}],"description":"That machine's findings and scorecard, as an analysis's recognition.dfm has them."}},"additionalProperties":false,"type":"object","title":"CheckOut","description":"A quick check's conclusions: the verdict, the score and the findings. Nothing is stored as an analysis."},"CheckRef":{"properties":{"check":{"type":"string","maxLength":60,"minLength":1,"title":"Check","description":"The check's code, such as CHK-03, or its id, such as sharp_corners."},"failing_only":{"type":"boolean","title":"Failing Only","description":"False to highlight every feature it applied to, not only the failing ones.","default":true}},"additionalProperties":false,"type":"object","required":["check"],"title":"CheckRef","description":"A score check: the faces of its failing features."},"CheckoutIn":{"properties":{"packs":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Packs","description":"How many packs, 1 to 100.","default":1}},"additionalProperties":false,"type":"object","title":"CheckoutIn","description":"How many packs to buy."},"CheckoutOut":{"properties":{"url":{"type":"string","title":"Url","description":"Stripe's payment page. Send the person there; they come back to Organization > Credits & usage."},"packs":{"type":"integer","title":"Packs","description":"How many packs."},"analyses":{"type":"integer","title":"Analyses","description":"Analyses they'll get once the payment goes through."},"price_usd":{"type":"number","title":"Price Usd","description":"What they'll pay, in US dollars."},"months":{"type":"integer","title":"Months","description":"How many months the credits last from the payment."}},"additionalProperties":false,"type":"object","required":["url","packs","analyses","price_usd","months"],"title":"CheckoutOut","description":"Where to pay."},"CheckpointOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The checkpoint's id."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was saved."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","description":"The quick check's score then."},"verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict","description":"The quick check's verdict then."}},"additionalProperties":false,"type":"object","required":["id","created_at"],"title":"CheckpointOut","description":"A checkpoint: its id and the quick check then. Never its recipe."},"ChipLoad":{"properties":{"group":{"type":"string","title":"Group","description":"The material's cutting group code, as cutting_groups in GET /api/v1/organization/settings lists them, such as N1.2.Z.AG. Every material of that group takes it."},"slot":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Slot","description":"Its chip load slotting, at full width, mm a tooth: more than 0, up to 2.54 (0.1 in). Null cuts at Protyus's for slotting."},"rough":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Rough","description":"Its chip load roughing, mm a tooth: more than 0, up to 2.54 (0.1 in). Null cuts at Protyus's for roughing."},"finish":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Finish","description":"Its chip load finishing, and in 3D profiling, mm a tooth: more than 0, up to 2.54 (0.1 in). Null cuts at Protyus's for finishing and profiling."},"face":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Face","description":"Its chip load facing, mm a tooth: more than 0, up to 2.54 (0.1 in). Null cuts at Protyus's for facing."}},"additionalProperties":false,"type":"object","required":["group"],"title":"ChipLoad","description":"This tool's own chip load in one material's cutting group, for each milling operation it's given for. Each\nreplaces Protyus's for this tool in that operation in that material, and the chip load aggression still scales it."},"Choice":{"properties":{"key":{"type":"string","title":"Key","description":"What to send in the analysis request: a machine's id, or a material such as 6061."},"name":{"type":"string","title":"Name","description":"What the screen calls it."},"default":{"type":"boolean","title":"Default","description":"Whether it's the project's default."},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group","description":"For a machine, its class key, such as 3_axis; for a material, its reference grade, such as 6061."}},"additionalProperties":false,"type":"object","required":["key","name","default"],"title":"Choice","description":"One machine or material an analysis may pick."},"Choices":{"properties":{"machines":{"items":{"$ref":"#/components/schemas/Choice"},"type":"array","title":"Machines","description":"The machines its milling analyses may plan for, from the library. machine auto asks for Best Fit, the cheapest per part of these machines whose type reaches the part."},"materials":{"items":{"$ref":"#/components/schemas/Choice"},"type":"array","title":"Materials","description":"The materials its milling analyses may pick, from the library."},"quantity":{"type":"integer","title":"Quantity","description":"The default quantity, for every process."},"sheet_metal":{"$ref":"#/components/schemas/ProcessChoices","description":"What a sheet metal analysis may pick in place of machines and materials."},"moulding":{"$ref":"#/components/schemas/ProcessChoices","description":"What a moulding analysis may pick in place of machines and materials."}},"additionalProperties":false,"type":"object","required":["machines","materials","quantity","sheet_metal","moulding"],"title":"Choices","description":"What a new analysis in a project may pick."},"ChosenRoute":{"properties":{"key":{"type":"string","enum":["mill","lathe","lathe_then_mill","mill_turn"],"title":"Key","description":"The route's key, as in routes."},"auto":{"type":"boolean","title":"Auto","description":"Whether Protyus chose it, rather than a person."}},"type":"object","required":["key","auto"],"title":"ChosenRoute","description":"The route the part is made by, which Price this prices."},"CleanupSpace":{"properties":{"surface":{"type":"string","title":"Surface","description":"An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."},"setup":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Setup","description":"The setup that cuts most of the face, by number. For an obstructed flat face, the setup with a direction it looks along, which material blocks; null where there's none."},"cleanup_setup":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cleanup Setup","description":"The setup that cleans up the rest, by number. The same setup when it does so from another direction. Null for an obstructed face: no setup reaches it."},"cut":{"type":"string","enum":["faced","side milled","profiled","obstructed"],"title":"Cut","description":"How the cleanup cuts it: faced or side milled with an end mill, or profiled with a ball end mill. Obstructed where no tool reaches the face at all, so it can't be machined as modeled."},"region":{"$ref":"#/components/schemas/Mesh","description":"Where it lies on the face: the face's own triangles, cut finer, that are cleaned up, in mm as display draws the part. An obstructed face's is the whole face."},"volume":{"anyOf":[{"$ref":"#/components/schemas/Mesh"},{"type":"null"}],"description":"The space over it that the cleanup clears, from the face to the material in the way, as a closed mesh in mm. Null where the face runs along the direction it's cut from, as a wall cut with the side of the tool does, and for an obstructed face."}},"type":"object","required":["surface","setup","cleanup_setup","cut","region"],"title":"CleanupSpace","description":"A face cut in two: most of it is cut efficiently in one setup, and the part other material hides from there,\nits shadow, is cleaned up in another, a second operation for one face.\n\nA face no tool reaches is obstructed material, left to clean up later: a space cut `obstructed`, the whole face,\nthat no setup cleans up."},"CollectionChange":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Name","description":"The new name."},"description":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Description","description":"The new description."}},"additionalProperties":false,"type":"object","title":"CollectionChange","description":"A new name or description. Leave out what stays the same."},"CollectionIn":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name","description":"Its name."},"description":{"type":"string","maxLength":2000,"title":"Description","description":"What it's for.","default":""},"item_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":500,"title":"Item Ids","description":"Items to put in it, of the collection's kind.","default":[]},"from_filter":{"anyOf":[{"$ref":"#/components/schemas/ItemFilter"},{"type":"null"}],"description":"Also put in every item matching this filter now. The result is kept as a fixed list: items that match later aren't added."}},"additionalProperties":false,"type":"object","required":["name"],"title":"CollectionIn","description":"A new collection, empty, from a list of items, or from a filter."},"CollectionItemsIn":{"properties":{"item_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":500,"minItems":1,"title":"Item Ids","description":"The items, of the collection's kind."}},"additionalProperties":false,"type":"object","required":["item_ids"],"title":"CollectionItemsIn","description":"Items to add to or take out of a collection."},"CollectionOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The collection's id."},"kind":{"type":"string","title":"Kind","description":"The kind of item it holds, such as tool."},"name":{"type":"string","title":"Name","description":"Its name, unique among the organization's collections of that kind."},"description":{"type":"string","title":"Description","description":"What it's for, or an empty string."},"item_count":{"type":"integer","title":"Item Count","description":"How many of its items are in the library, not archived."},"archived_item_count":{"type":"integer","title":"Archived Item Count","description":"How many of its items are archived. They're kept, but left out of its listing."},"archived":{"type":"boolean","title":"Archived","description":"Whether the collection itself is archived."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of who made it."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was made."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When its name, description or items last changed."}},"additionalProperties":false,"type":"object","required":["id","kind","name","description","item_count","archived_item_count","archived","created_by","created_at","updated_at"],"title":"CollectionOut","description":"A named set of library items."},"ColumnMapping":{"properties":{"columns":{"additionalProperties":{"type":"string"},"type":"object","title":"Columns","description":"Tool field to CSV column header, such as {\"DC\": \"Diameter\"}. Fields are the template's headers.","default":{}},"default_unit":{"anyOf":[{"type":"string","enum":["inches","millimeters"]},{"type":"null"}],"title":"Default Unit","description":"The unit of rows with no unit column or an empty one. Without it such rows are invalid."}},"additionalProperties":false,"type":"object","title":"ColumnMapping","description":"Which CSV column holds each tool field. Remembered per organization."},"ColumnRead":{"properties":{"header":{"type":"string","title":"Header","description":"The header, as in the sheet."},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field","description":"The field it fills, or null when it isn't imported."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"What the screen calls that field."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"How it's read, such as a unit converted, or why it isn't imported."}},"additionalProperties":false,"type":"object","required":["header","field","label","note"],"title":"ColumnRead","description":"One of the sheet's column headers, and the field it was read as."},"ComparedIteration":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The analysis's id."},"file_name":{"type":"string","title":"File Name","description":"The STEP file's original name."},"iteration":{"type":"integer","title":"Iteration","description":"Its number among its part's ready analyses."},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"Its part version's number, from 1. Null only outside a project."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was run."},"machine_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine Label","description":"The machine it planned for, for people."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material it picked."},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"The batch quantity it picked."},"annual_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Annual Volume","description":"The parts a year it picked. Null for Protyus's defaults."},"can_be_made":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Can Be Made","description":"The verdict: false when a required check fails. Null for analyses run before scorecards."},"verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict","description":"The verdict, for people, such as Can be made."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","description":"The general score, 0 to 100; higher is easier to make. Null before scorecards."},"band":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Band","description":"The score's colour: Green, Yellow or Red, from the organization's settings (Easy, Moderate or Hard before 0.65.0)."},"findings_count":{"type":"integer","title":"Findings Count","description":"How many findings it raised."},"setups":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Setups","description":"How many setups its plan takes. Null if it has no plan."},"cycle_minutes":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cycle Minutes","description":"Machining minutes a part, from its estimate. Null without an estimate."},"unit_cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unit Cost","description":"US dollars a part at its quantity, from its estimate. Null without an estimate."}},"additionalProperties":false,"type":"object","required":["id","file_name","iteration","created_at","machine_label","material","quantity","can_be_made","verdict","score","band","findings_count","setups","cycle_minutes","unit_cost"],"title":"ComparedIteration","description":"One side of a comparison: an analysis's conclusions on the machine it planned for."},"ComparedMachine":{"properties":{"machine":{"type":"string","title":"Machine","description":"The machine's id."},"label":{"type":"string","title":"Label","description":"Its name for people."},"machine_class":{"type":"string","title":"Machine Class","description":"Its class."},"class_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Class Label","description":"Its class's name for people."},"setups":{"type":"integer","title":"Setups","description":"How many setups."},"tools":{"type":"integer","title":"Tools","description":"How many tools."},"tools_to_buy":{"type":"integer","title":"Tools To Buy","description":"How many of them are to buy."},"part_min":{"type":"number","title":"Part Min","description":"Minutes every part."},"batch_min":{"type":"number","title":"Batch Min","description":"Minutes once a batch."},"order_min":{"type":"number","title":"Order Min","description":"Minutes once an order."},"hourly_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Hourly Rate","description":"Its hourly rate, US dollars."},"each":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Each","description":"US dollars a part."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total","description":"US dollars for the order."},"cheapest":{"type":"boolean","title":"Cheapest","description":"Whether it's the cheapest a part.","default":false}},"type":"object","required":["machine","label","machine_class","setups","tools","tools_to_buy","part_min","batch_min","order_min"],"title":"ComparedMachine","description":"The part planned on one machine, at the estimate's quantity."},"Comparison":{"properties":{"quantity":{"type":"integer","title":"Quantity","description":"The quantity compared at."},"machines":{"items":{"$ref":"#/components/schemas/ComparedMachine"},"type":"array","title":"Machines","description":"One a machine, the estimate's first.","default":[]}},"type":"object","required":["quantity"],"title":"Comparison","description":"Every machine side by side."},"CopyIn":{"properties":{"guids":{"items":{"type":"string"},"type":"array","maxItems":500,"minItems":1,"title":"Guids","description":"The standard sizes' guids."}},"additionalProperties":false,"type":"object","required":["guids"],"title":"CopyIn","description":"Standard sizes to copy into the organization's library."},"Cost":{"properties":{"per_order":{"type":"number","title":"Per Order","description":"US dollars once an order."},"per_batch":{"type":"number","title":"Per Batch","description":"US dollars once a batch."},"per_part":{"type":"number","title":"Per Part","description":"US dollars every part."},"quantity":{"type":"integer","title":"Quantity","description":"How many parts."},"total":{"type":"number","title":"Total","description":"US dollars for the order: the batch cost when the order is one batch."},"each":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Each","description":"Burdened cost per part: US dollars a part with the order's one-off costs (setup, programming, tools to buy, the mould or the die) spread over its quantity."},"piece_part":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Piece Part","description":"Piece Part Cost: US dollars to make one part, with nothing spread over the order: material, machine time, operator and overhead, and in milling handling and tool wear too. Null for estimates made before it was added."}},"type":"object","required":["per_order","per_batch","per_part","quantity","total"],"title":"Cost","description":"What the order costs at its quantity."},"CostLine":{"properties":{"key":{"type":"string","title":"Key","description":"Which line: material, machine, operator, handling, setup, programming, fixtures, tooling, inspection, secondary, overhead or tools_to_buy."},"label":{"type":"string","title":"Label","description":"Its name for people, such as Machine time."},"quantity":{"type":"number","title":"Quantity","description":"How much of the unit, such as 0.42 hours."},"unit":{"type":"string","title":"Unit","description":"The unit, such as h, piece or tool. Overhead's is dollar: the time lines' dollars it's a share of."},"rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate","description":"US dollars per unit. Null when the line has no rate yet, so it costs nothing."},"own_rate":{"type":"boolean","title":"Own Rate","description":"Whether the rate is the organization's own, rather than Protyus's default.","default":false},"per_order":{"type":"number","title":"Per Order","description":"US dollars paid once an order."},"per_batch":{"type":"number","title":"Per Batch","description":"US dollars paid once a batch."},"per_part":{"type":"number","title":"Per Part","description":"US dollars paid for every part."},"quantities":{"anyOf":[{"$ref":"#/components/schemas/PaidQuantities"},{"type":"null"}],"description":"The quantity paid at each time, in unit. Null when it's all paid at one time."},"machine":{"anyOf":[{"$ref":"#/components/schemas/CostLineMachine"},{"type":"null"}],"description":"The machine the line runs on: every line of a lathe estimate names its lathe. Null in a milling estimate, whose machine is the estimate's."}},"type":"object","required":["key","label","quantity","unit","per_order","per_batch","per_part"],"title":"CostLine","description":"One cost line: a quantity times a rate."},"CostLineMachine":{"properties":{"id":{"type":"string","title":"Id","description":"The organization's machine's id, or its class's, such as lathe, for a typical one."},"label":{"type":"string","title":"Label","description":"Its name for people."}},"type":"object","required":["id","label"],"title":"CostLineMachine","description":"The machine a cost line runs on."},"CreatedApiKey":{"properties":{"id":{"type":"string","title":"Id","description":"The key's id (ak_ and 32 hex digits). Not the secret: it can't sign anything in."},"name":{"type":"string","title":"Name","description":"What the key is for."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A longer note about the key, if one was given."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the key was made."},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At","description":"When the key last signed a request in, if Clerk has recorded it."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When the key stops working, or null if it doesn't expire."},"revoked":{"type":"boolean","title":"Revoked","description":"Whether the key was revoked. A revoked key is refused at once."},"expired":{"type":"boolean","title":"Expired","description":"Whether the key has passed its expiry."},"secret":{"type":"string","title":"Secret","description":"The key itself (ak_...). Send it as `Authorization: Bearer <secret>`, with `X-Protyus-Org: <organization id>` to act in an organization. Shown only in this response: store it now, it can't be read again."}},"additionalProperties":false,"type":"object","required":["id","name","description","created_at","last_used_at","expires_at","revoked","expired","secret"],"title":"CreatedApiKey","description":"A key just made, with its secret. This is the only response that ever holds it."},"CreatedSubmissionLink":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The link's id."},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"The project its submissions land in. Null once that project is deleted."},"name":{"type":"string","title":"Name","description":"What the shop calls it."},"status":{"type":"string","enum":["active","paused","revoked"],"title":"Status","description":"active, paused (by hand or by itself; paused_reason says which) or revoked, for good."},"paused_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paused Reason","description":"Why it's paused: turned_off, daily_cap, traffic_jump or project_archived. Null unless paused."},"paused_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Paused At","description":"When it was paused, by hand or by itself. Null unless paused."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When it stops taking requests. Null for never."},"taking_requests":{"type":"boolean","title":"Taking Requests","description":"Whether its form takes requests now: active and not expired."},"config":{"$ref":"#/components/schemas/LinkConfig","description":"Its settings, with defaults filled in."},"created_by":{"type":"string","title":"Created By","description":"Who made it, a Clerk user id. Replies and notices go to them unless the settings say otherwise."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was made."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When it last changed."},"can_manage":{"type":"boolean","title":"Can Manage","description":"Whether the caller may change it (submission_links:manage on its project)."},"token":{"type":"string","title":"Token","description":"The link's secret token. Shown only now: Protyus keeps only its hash."},"url":{"type":"string","title":"Url","description":"The URL to share, which carries the token. Shown only now."}},"additionalProperties":false,"type":"object","required":["id","project_id","name","status","paused_reason","paused_at","expires_at","taking_requests","config","created_by","created_at","updated_at","can_manage","token","url"],"title":"CreatedSubmissionLink","description":"A submission link with its new token. This is the only response that holds it."},"CreditGrantOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The grant's id."},"source":{"type":"string","enum":["purchase","staff"],"title":"Source","description":"purchase (bought in Organization > Credits & usage) or staff (added by Protyus)."},"analyses":{"type":"integer","title":"Analyses","description":"Analyses it gave."},"used":{"type":"integer","title":"Used","description":"How many of them have paid for a part."},"left":{"type":"integer","title":"Left","description":"How many can still be used: 0 once it has expired or been refunded."},"state":{"type":"string","enum":["active","used","expired","refunded"],"title":"State","description":"active (some left), used (none left), expired, or refunded (its unused credits removed)."},"packs":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Packs","description":"For a purchase: how many packs."},"paid_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Paid Usd","description":"For a purchase: what was paid, in US dollars."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was bought or added."},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"When its unused credits run out."}},"additionalProperties":false,"type":"object","required":["id","source","analyses","used","left","state","packs","paid_usd","created_at","expires_at"],"title":"CreditGrantOut","description":"Credits the company was given or bought in one go."},"CreditsOut":{"properties":{"credits_left":{"type":"integer","title":"Credits Left","description":"Credits the company can use now, from every grant that hasn't expired."},"on_sale":{"type":"boolean","title":"On Sale","description":"Whether the company can buy credits now: it is on a paid plan (not Free), active or past due, and payments are set up. Only an admin buys them, with POST /api/v1/organization/credits/checkout."},"pack":{"$ref":"#/components/schemas/plans__credits__CreditPackOut","description":"What one pack is now."},"grants":{"items":{"$ref":"#/components/schemas/CreditGrantOut"},"type":"array","title":"Grants","description":"Every grant, newest first: purchases and credits from Protyus."}},"additionalProperties":false,"type":"object","required":["credits_left","on_sale","pack","grants"],"title":"CreditsOut","description":"The company's credits: analyses beyond the plan's month, used only once the month's are gone."},"Cutter":{"properties":{"type":{"type":"string","enum":["flat end mill","bull nose end mill","ball end mill","drill","slot mill","face mill","od turn","id boring bar","od groove","id groove","face groove","od thread","id thread","part-off"],"title":"Type","description":"flat end mill, bull nose end mill, ball end mill, drill, slot mill for a T-slot cutter, or face mill; or, for a lathe, od turn, id boring bar, od groove, id groove, face groove, od thread, id thread or part-off, which milling never plans with."},"description":{"type":"string","maxLength":200,"minLength":1,"title":"Description","description":"What the shop calls it, such as 1/4 in 3FL carbide end mill."},"unit":{"type":"string","enum":["inches","millimeters"],"title":"Unit","description":"The unit it's sold in, so it's shown as the machinist knows it. Lengths are stored in mm."},"vendor":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Vendor","description":"Who makes it, such as Harvey."},"product-id":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Product-Id","description":"The vendor's product number."},"product-link":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Product-Link","description":"A link to the vendor's page for it."},"coating":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"title":"Coating","description":"Its coating, such as TiAlN or uncoated."},"tool_material":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"title":"Tool Material","description":"What it's made of, such as carbide or HSS."},"stickout":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Stickout","description":"How far it sticks out of its holder, mm. Reach uses it in place of an assembly until assemblies are planned with."},"stepover_pct":{"anyOf":[{"type":"number","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Stepover Pct","description":"Ball end mills only: this ball's stepover for 3D profiling, percent of its diameter, 1 to 50, in place of the organization's ball stepover. Null, the default, takes the organization's."},"standard_guid":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Standard Guid","description":"The standard size it was copied from, if any."},"geometry":{"oneOf":[{"$ref":"#/components/schemas/CutterGeometry"},{"$ref":"#/components/schemas/InsertGeometry"}],"title":"Geometry","description":"Its sizes, in mm: a cutter's (DC, LCF, OAL, SFDM and the rest) for a milling tool, or its insert's and holder's for a turning tool."},"chip_loads":{"items":{"$ref":"#/components/schemas/ChipLoad"},"type":"array","maxItems":18,"title":"Chip Loads","description":"End mills, T-slot cutters and face mills only: this tool's own chip load in each material's cutting group the shop gives one for, one entry a group, with a figure for each of slot, rough, finish and face it sets, mm a tooth. Where it has one for the material and operation cut, it replaces Protyus's for this tool; the chip load aggression still scales it, a long reach still reduces it, and the machine's limits still hold it. An operation it leaves out, and a material with no entry, cut at Protyus's. Empty, the default, cuts at Protyus's everywhere. A drill's feed is the material's Drill row in the organization's cutting numbers.","default":[]}},"additionalProperties":false,"type":"object","required":["type","description","unit","geometry"],"title":"Cutter","description":"One cutting tool in an organization's library: an end mill, a drill or a T-slot cutter, or a lathe's turning,\nboring, grooving, threading or part-off tool."},"CutterGeometry":{"properties":{"DC":{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"title":"Dc","description":"Cutting diameter, mm.","unit":"mm"},"LCF":{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"title":"Lcf","description":"Flute length, mm.","unit":"mm"},"OAL":{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"title":"Oal","description":"Overall length, mm.","unit":"mm"},"SFDM":{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"title":"Sfdm","description":"Shank diameter, mm.","unit":"mm"},"LB":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Lb","description":"Body length below the holder, mm, for a necked tool."},"shoulder-length":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Shoulder-Length","description":"Shoulder length, mm."},"RE":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Re","description":"Corner radius, mm. Half DC for a ball, 0 or empty for a flat."},"SIG":{"anyOf":[{"type":"number","maximum":180.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Sig","description":"Drill point angle, degrees. Drills only."},"NOF":{"anyOf":[{"type":"integer","maximum":20.0,"minimum":1.0},{"type":"null"}],"title":"Nof","description":"Number of flutes."},"rated-depth":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Rated-Depth","description":"Drills only: the depth it's rated for, mm, such as 5 x DC for a carbide 5 x D drill. Reach uses it in place of the longer flute length."},"neck-diameter":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Neck-Diameter","description":"Slot mills (T-slot cutters) only: the neck between the teeth and the shank, mm, which has to clear a T-slot's neck."}},"additionalProperties":false,"type":"object","required":["DC","LCF","OAL","SFDM"],"title":"CutterGeometry","description":"A cutter's sizes, in mm whatever unit it's sold in. Field names are Fusion's."},"CuttingGroup":{"properties":{"code":{"type":"string","title":"Code","description":"Its code, the key of its numbers in cutting.groups, such as N1.2.Z.AG."},"name":{"type":"string","title":"Name","description":"Its general material name, which the screen shows."},"defaults":{"$ref":"#/components/schemas/GroupDefaults","description":"Protyus's number for each field a shop can set, to show beside it. What a null field takes."},"default_notes":{"additionalProperties":{"type":"string"},"type":"object","title":"Default Notes","description":"What to say beside a Protyus default that isn't a plain number, by row and field, such as finish.ap_pct: the tool's flute length."}},"additionalProperties":false,"type":"object","required":["code","name","defaults","default_notes"],"title":"CuttingGroup","description":"One cutting group in the menu."},"CuttingGroups":{"properties":{"N1.2.Z.AG":{"$ref":"#/components/schemas/GroupNumbers","description":"Wrought aluminium: 6061, 7075, 2024, 2011, 6082.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"N1.2.Z.UT":{"$ref":"#/components/schemas/GroupNumbers","description":"Wrought aluminium, not heat treated: 5052-H32.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"M1.0.Z.AQ":{"$ref":"#/components/schemas/GroupNumbers","description":"Austenitic stainless: 304, 316L.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"M1.2.Z.AQ":{"$ref":"#/components/schemas/GroupNumbers","description":"Free-cutting austenitic stainless: 303.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"P1.1.Z.AN":{"$ref":"#/components/schemas/GroupNumbers","description":"Low-carbon steel: 1018, 12L14.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"P1.2.Z.AN":{"$ref":"#/components/schemas/GroupNumbers","description":"Medium-carbon steel: 1045.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"P2.2.Z.AN":{"$ref":"#/components/schemas/GroupNumbers","description":"Low-alloy steel, annealed: 4140 annealed.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"P2.5.Z.HT":{"$ref":"#/components/schemas/GroupNumbers","description":"Low-alloy steel, pre-hardened: 4140 pre-hard.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"P3.0.Z.AN":{"$ref":"#/components/schemas/GroupNumbers","description":"High-alloy steel, annealed: A2 tool steel.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"P5.0.Z.PH":{"$ref":"#/components/schemas/GroupNumbers","description":"Precipitation-hardening stainless: 17-4 PH.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"S4.3.Z.AN":{"$ref":"#/components/schemas/GroupNumbers","description":"Titanium alloy: Ti-6Al-4V, Ti-6Al-4V ELI.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"S4.1.Z.UT":{"$ref":"#/components/schemas/GroupNumbers","description":"Commercially pure titanium: Ti Grade 2.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"S2.0.Z.AN":{"$ref":"#/components/schemas/GroupNumbers","description":"Nickel alloys, annealed: Inconel 625, Hastelloy C-276.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"S2.0.Z.AG":{"$ref":"#/components/schemas/GroupNumbers","description":"Nickel alloys, aged: Inconel 718.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"N3.3.U.UT":{"$ref":"#/components/schemas/GroupNumbers","description":"Free-cutting brass: C360.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"O.THERMOPLASTIC":{"$ref":"#/components/schemas/GroupNumbers","description":"Unfilled thermoplastics: POM, nylon, PC, UHMW, ABS, acrylic, HDPE.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"O.PEEK":{"$ref":"#/components/schemas/GroupNumbers","description":"High-temperature thermoplastics: PEEK, Ultem.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}},"O.PTFE":{"$ref":"#/components/schemas/GroupNumbers","description":"PTFE.","default":{"slot":{},"rough":{},"finish":{},"face":{},"profile":{},"drill":{}}}},"additionalProperties":false,"type":"object","title":"CuttingGroups","description":"A shop's own cutting numbers, by cutting group code. A group left as it is takes Protyus's throughout."},"CuttingSettings":{"properties":{"chip_load_aggression_pct":{"type":"number","maximum":100.0,"minimum":10.0,"title":"Chip Load Aggression Pct","description":"Chip load aggression, percent: the share of its chip load every end mill cuts at, the tool's own where the tool library gives it one for the material and the catalogue's otherwise, and of every drill's feed per rev, so a shop can back off the figures to what its machines take. 10 to 100; 100, the default, cuts at them. The catalogue's chip loads are tool makers' published figures, for the material's group.","default":100},"ball_stepover_pct":{"type":"number","maximum":50.0,"minimum":1.0,"title":"Ball Stepover Pct","description":"Ball stepover for 3D profiling, percent of the ball's diameter: 6, the default, steps 0.03 in on a 0.5 in ball, and 20 steps 0.10 in. A smaller step leaves a smoother surface in more passes. 1 to 50. A ball end mill in the tool library can set its own, which wins.","default":6},"groups":{"$ref":"#/components/schemas/CuttingGroups","description":"The shop's own cutting numbers for each operation in each material, by cutting group code: SFM and width and depth of cut for slot, rough, finish and face; the profiling feed share; and the drill's SFM, feed per rev and peck depth. A null field takes Protyus's, which cutting_groups shows. A value more than 50% off Protyus's is saved and listed in cutting_warnings.","default":{"N1.2.Z.AG":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N1.2.Z.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"M1.0.Z.AQ":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"M1.2.Z.AQ":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P1.1.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P1.2.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P2.2.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P2.5.Z.HT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P3.0.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P5.0.Z.PH":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S4.3.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S4.1.Z.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S2.0.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S2.0.Z.AG":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N3.3.U.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.THERMOPLASTIC":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.PEEK":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.PTFE":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}}}}},"additionalProperties":false,"type":"object","title":"CuttingSettings","description":"How hard the shop's end mills cut, how far a ball steps over in 3D profiling, and its own cutting numbers for\neach operation in each material. The organization's alone: a project can't set them."},"CuttingWarning":{"properties":{"field":{"type":"string","title":"Field","description":"The setting, as a dotted path such as cutting.groups.N1.2.Z.AG.rough.sfm."},"value":{"type":"number","title":"Value","description":"The shop's value."},"default":{"type":"number","title":"Default","description":"Protyus's default for it, in the same unit."},"message":{"type":"string","title":"Message","description":"The warning, as a sentence."}},"additionalProperties":false,"type":"object","required":["field","value","default","message"],"title":"CuttingWarning","description":"A number more than 50% off Protyus's. It is saved and used as it is."},"DashboardChange":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":80,"minLength":1},{"type":"null"}],"title":"Name","description":"A new name. Leave out to keep it."},"position":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Position","description":"Where to move it in the organization's list, from 0. The others close up around it. Leave out to keep it."},"cards":{"anyOf":[{"items":{"$ref":"#/components/schemas/CardIn"},"type":"array","maxItems":48},{"type":"null"}],"title":"Cards","description":"Every card it should have, replacing the ones it has. Give a kept card its id. Leave out to keep the cards. To add one card, POST /api/v1/dashboards/{dashboard_id}/cards is simpler."}},"additionalProperties":false,"type":"object","title":"DashboardChange","description":"A change to a dashboard. Only what's given changes."},"DashboardIn":{"properties":{"name":{"type":"string","maxLength":80,"minLength":1,"title":"Name","description":"Its name, such as Overview or Quoting."},"position":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Position","description":"Where it goes in the organization's list, from 0. Leave out to put it last; those after it move down one."},"cards":{"items":{"$ref":"#/components/schemas/CardIn"},"type":"array","maxItems":48,"title":"Cards","description":"Its cards, at most 48.","default":[]}},"additionalProperties":false,"type":"object","required":["name"],"title":"DashboardIn","description":"A new dashboard."},"DashboardOrder":{"properties":{"ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Ids","description":"Every one of the organization's dashboard ids, each once, in the order they should be listed."}},"additionalProperties":false,"type":"object","required":["ids"],"title":"DashboardOrder","description":"The organization's dashboards in a new order."},"DashboardOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The dashboard's id."},"name":{"type":"string","title":"Name","description":"Its name."},"position":{"type":"integer","title":"Position","description":"Where it is in the organization's list, from 0."},"cards":{"items":{"$ref":"#/components/schemas/Card"},"type":"array","title":"Cards","description":"Its cards. Each runs its operation as the viewer, so it shows only what they may see."},"created_by":{"type":"string","title":"Created By","description":"Who made it: a Clerk user id, or protyus for the Overview every organization starts with."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was made."},"updated_by":{"type":"string","title":"Updated By","description":"Who last changed it, a Clerk user id or protyus."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When it was last changed."}},"additionalProperties":false,"type":"object","required":["id","name","position","cards","created_by","created_at","updated_by","updated_at"],"title":"DashboardOut","description":"A named dashboard of cards, shared by everyone in the organization."},"DatumFeature":{"properties":{"letter":{"type":"string","title":"Letter","description":"Its letter, such as A."},"faces":{"items":{"type":"string"},"type":"array","title":"Faces","description":"The faces that are the datum feature. Empty when the file ties it to none.","default":[]},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"The edges it's attached to, when it names edges rather than faces.","default":[]},"target":{"type":"boolean","title":"Target","description":"True when the file gives it datum targets (points, lines or areas), which targets lists. A file can give one datum both targets and a whole feature: this is true then too, and faces has the feature's.","default":false},"targets":{"items":{"$ref":"#/components/schemas/DatumTarget"},"type":"array","title":"Targets","description":"Its datum targets, in number order. Empty for a datum with none.","default":[]}},"type":"object","required":["letter"],"title":"DatumFeature","description":"A datum: the letter, the faces that carry it and its targets."},"DatumLetter":{"properties":{"letter":{"type":"string","title":"Letter","description":"The datum's letter, such as A. A common datum reads as on the print, such as A-B."},"modifiers":{"items":{"type":"string"},"type":"array","title":"Modifiers","description":"Its modifiers as written, such as maximum_material_requirement.","default":[]}},"type":"object","required":["letter"],"title":"DatumLetter","description":"One datum in a feature control frame, with its own modifiers."},"DatumReference":{"properties":{"letter":{"type":"string","title":"Letter","description":"The datum's letter, such as A. A common datum reads as on the print, such as A-B."},"modifiers":{"items":{"type":"string"},"type":"array","title":"Modifiers","description":"Its modifiers as written, such as maximum_material_requirement.","default":[]},"common":{"items":{"$ref":"#/components/schemas/DatumLetter"},"type":"array","title":"Common","description":"For a common datum (A-B in one compartment), each datum in it with its own modifiers. Empty for a single datum.","default":[]}},"type":"object","required":["letter"],"title":"DatumReference","description":"A datum a geometric tolerance is measured from, at its place in the feature control frame."},"DatumTarget":{"properties":{"number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number","description":"Its number within its datum: 1 for A1."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind","description":"What it is as written, such as point, line, circle, rectangle or area."},"size":{"items":{"type":"number"},"type":"array","title":"Size","description":"A circle's diameter, a line's length, or a rectangle's length and width, mm. Empty when the file gives none.","default":[]},"faces":{"items":{"type":"string"},"type":"array","title":"Faces","description":"The faces it sits on. Empty when the file ties it to none.","default":[]}},"type":"object","title":"DatumTarget","description":"One datum target: a point, line or area of the part that a datum is taken from."},"DayUsage":{"properties":{"runs":{"type":"integer","title":"Runs","description":"How many billable actions: analyses run and files extracted, whatever their outcome.","default":0},"succeeded":{"type":"integer","title":"Succeeded","description":"How many of them succeeded.","default":0},"failed":{"type":"integer","title":"Failed","description":"How many failed. Runs still running, or deleted while running, are neither.","default":0},"by_source":{"$ref":"#/components/schemas/SourceCounts","description":"The runs, split by the surface they came through.","default":{"ui":0,"api":0,"mcp":0,"intake":0}},"compute_seconds":{"type":"number","title":"Compute Seconds","description":"The engine's time on them, in seconds: download, analysis and saving.","default":0},"storage_bytes_added":{"type":"integer","title":"Storage Bytes Added","description":"What they added to file storage, in bytes, whether or not it's been deleted since.","default":0},"day":{"type":"string","format":"date","title":"Day","description":"The day, in UTC."}},"additionalProperties":false,"type":"object","required":["day"],"title":"DayUsage","description":"One day's usage, in UTC."},"DeclineIn":{"properties":{"subject":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Subject","description":"A subject for this email only, plain text with {{fields}}."},"body":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Body","description":"A body for this email only, plain text with {{fields}}."},"message":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Message","description":"The same as body: your own words for this email, plain text with {{fields}}. body wins if both are given."}},"additionalProperties":false,"type":"object","title":"DeclineIn","description":"What to say in declining. Leave both out for the decline template (the link's, project's or organization's)."},"DeepHoleLimits":{"properties":{"max_ratio":{"type":"number","maximum":30.0,"minimum":2.0,"title":"Max Ratio","description":"Largest ratio of a drilled hole's depth to its diameter before it's flagged and fails the length-to-diameter check. Default 6.","default":6}},"additionalProperties":false,"type":"object","title":"DeepHoleLimits","description":"When a drilled hole is deep for its drill."},"Defaults":{"properties":{"machine":{"type":"string","title":"Machine","description":"The machine to plan with: one of the organization's machines by id, or a class key such as 3_axis for its machine of that class.","default":"3_axis"},"material":{"type":"string","title":"Material","description":"The material, such as 6061, from the project's choices.","default":"6061"},"quantity":{"type":"integer","maximum":1000000.0,"minimum":1.0,"title":"Quantity","description":"How many parts in a batch.","default":1}},"additionalProperties":false,"type":"object","title":"Defaults","description":"What a new analysis picks when it doesn't say."},"DeletionIn":{"properties":{"kind":{"type":"string","enum":["purge","delete_company"],"title":"Kind","description":"purge: delete everything, keeping the company until its plan ends; delete_company: delete everything and the company, whose members lose access."},"confirm_name":{"type":"string","maxLength":300,"title":"Confirm Name","description":"The company's name, typed out, to confirm."}},"additionalProperties":false,"type":"object","required":["kind","confirm_name"],"title":"DeletionIn","description":"Asking for the company's data to be deleted."},"DesignFeedbackIn":{"properties":{"text":{"type":"string","maxLength":20000,"minLength":1,"title":"Text","description":"What looks wrong or missing about this turn."}},"additionalProperties":false,"type":"object","required":["text"],"title":"DesignFeedbackIn","description":"Feedback on one Design turn, for the Protyus team."},"DesignFeedbackSent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The feedback's id."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was received."}},"additionalProperties":false,"type":"object","required":["id","created_at"],"title":"DesignFeedbackSent","description":"Design feedback that was received."},"DesignOut":{"properties":{"version":{"$ref":"#/components/schemas/PartVersionOut","description":"The version."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"Its project."},"built":{"type":"boolean","title":"Built","description":"Whether it has a STEP file yet."},"picks":{"$ref":"#/components/schemas/Picks","description":"The quick check's machine, material and quantity."},"check":{"anyOf":[{"$ref":"#/components/schemas/CheckOut"},{"type":"null"}],"description":"The latest quick check, or null before one."},"checkpoints":{"items":{"$ref":"#/components/schemas/CheckpointOut"},"type":"array","title":"Checkpoints","description":"Its checkpoints, oldest first, at most 25.","default":[]},"features":{"items":{"$ref":"#/components/schemas/FeatureOut"},"type":"array","title":"Features","description":"The part's features in order, each with what may be changed about it (edit_design_feature).","default":[]}},"additionalProperties":false,"type":"object","required":["version","project_id","built","picks"],"title":"DesignOut","description":"A part version Design works on, with its latest quick check and its checkpoints. Never its recipe."},"Dfm":{"properties":{"findings":{"items":{"$ref":"#/components/schemas/Finding"},"type":"array","title":"Findings","description":"Each finding, in the report's order.","default":[]},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/Scorecard"},{"type":"null"}],"description":"Its scorecard. Null for analyses run before scorecards."}},"type":"object","title":"Dfm","description":"One plan's DFM findings and scorecard."},"DimensionInfo":{"properties":{"key":{"type":"string","title":"Key","description":"Its key, for dimensions in query_metrics."},"label":{"type":"string","title":"Label","description":"Its name."},"kind":{"type":"string","enum":["time","category"],"title":"Kind","description":"time (values are ISO dates) or category (values are {id, label})."},"grain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grain","description":"day, week or month for a time dimension; null for a category."},"description":{"type":"string","title":"Description","description":"What it groups by."},"values":{"anyOf":[{"items":{"$ref":"#/components/schemas/DimensionValue"},"type":"array"},{"type":"null"}],"title":"Values","description":"Its values, when they're a fixed set. Null when they come from the organization's data."}},"additionalProperties":false,"type":"object","required":["key","label","kind","grain","description","values"],"title":"DimensionInfo","description":"One dimension a measure can be split by."},"DimensionRef":{"properties":{"key":{"type":"string","title":"Key","description":"The dimension's key, which is also its key in each row."},"label":{"type":"string","title":"Label","description":"Its name, for an axis or a column heading."},"kind":{"type":"string","enum":["time","category"],"title":"Kind","description":"time: each row's value for it is an ISO date, the start of its bucket. category: each row's value for it is an object with an id and a label."},"grain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Grain","description":"day, week or month for a time dimension; null for a category."}},"additionalProperties":false,"type":"object","required":["key","label","kind","grain"],"title":"DimensionRef","description":"A dimension a response is split by."},"DimensionValue":{"properties":{"id":{"type":"string","title":"Id","description":"The value, as rows and filters give it."},"label":{"type":"string","title":"Label","description":"Its name."}},"additionalProperties":false,"type":"object","required":["id","label"],"title":"DimensionValue","description":"One of a dimension's fixed values."},"Display":{"properties":{"surfaces":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Mesh"},"type":"object"},{"type":"null"}],"title":"Surfaces","description":"Each face's triangles, by face."},"edges":{"anyOf":[{"additionalProperties":{"items":{"type":"number"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Edges","description":"Each edge as a polyline, x, y, z after one another, by edge."}},"type":"object","title":"Display","description":"The part as a 3D viewer draws it, in mm. Each key is here unless sections leaves it out."},"DrillDefaults":{"properties":{"sfm":{"type":"number","title":"Sfm","description":"Surface speed, SFM."},"feed_per_rev_mm":{"type":"number","title":"Feed Per Rev Mm","description":"Feed per rev, mm, for a 0.5 in drill: Protyus's rises with the drill's diameter."},"peck_depth_pct":{"type":"number","title":"Peck Depth Pct","description":"How deep each peck goes, percent of the drill's diameter."}},"additionalProperties":false,"type":"object","required":["sfm","feed_per_rev_mm","peck_depth_pct"],"title":"DrillDefaults","description":"Protyus's numbers for an HSS drill in one material."},"DrillNumbers":{"properties":{"sfm":{"anyOf":[{"type":"number","maximum":10000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Sfm","description":"Surface speed, SFM. Null for Protyus's."},"feed_per_rev_mm":{"anyOf":[{"type":"number","maximum":2.54,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Feed Per Rev Mm","description":"Feed per rev, mm, one figure for every drill size. The chip load aggression still scales it. Null for Protyus's, which rises with the drill's diameter."},"peck_depth_pct":{"anyOf":[{"type":"number","maximum":1000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Peck Depth Pct","description":"How deep each peck goes in a hole deeper than 3 times its diameter, percent of the drill's diameter; it may pass 100. Null for Protyus's 100."}},"additionalProperties":false,"type":"object","title":"DrillNumbers","description":"HSS drilling in one material. A drill marked carbide keeps Protyus's carbide figures."},"DrillingLimits":{"properties":{"hole_tolerance_mm":{"type":"number","maximum":1.0,"exclusiveMinimum":0.0,"title":"Hole Tolerance Mm","description":"The tolerance every hole is held to, plus or minus, mm. The hole is drilled with the standard drill nearest its size within it. A hole that isn't a standard drill's size is flagged as non-standard. Default 0.002 in.","default":0.0508},"drill_oversize_mm":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Drill Oversize Mm","description":"No longer used: a hole takes the drill nearest its size within its tolerance. Accepted and ignored.","deprecated":true},"drilling_limit_mm":{"type":"number","maximum":101.6,"exclusiveMinimum":0.0,"title":"Drilling Limit Mm","description":"The largest hole drilled, mm. Every hole up to it is drilled, with the nearest drill where none matches; larger holes are milled, unless they end in a drill point and a drill matches. Default 1 in.","default":25.4}},"additionalProperties":false,"type":"object","title":"DrillingLimits","description":"How a hole is matched to a drill, and up to what size holes are drilled."},"Dropped":{"properties":{"ref":{"anyOf":[{"$ref":"#/components/schemas/FindingRef"},{"$ref":"#/components/schemas/CheckRef"},{"$ref":"#/components/schemas/SetupRef"},{"$ref":"#/components/schemas/HoleRef"},{"$ref":"#/components/schemas/PocketRef"},{"$ref":"#/components/schemas/RoleRef"},{"$ref":"#/components/schemas/SurfacesRef"},{"$ref":"#/components/schemas/TurnedRef"},{"$ref":"#/components/schemas/analyses__views__StepRef"}],"title":"Ref","description":"The reference."},"reason":{"type":"string","title":"Reason","description":"Why, in a sentence a person can read."}},"additionalProperties":false,"type":"object","required":["ref","reason"],"title":"Dropped","description":"A reference that couldn't be shown, and why."},"Edge":{"properties":{"id":{"type":"string","title":"Id","description":"An opaque reference to the edge, as display.edges names it, such as E0034."},"type":{"type":"string","title":"Type","description":"Its curve: line, circle, ellipse or freeform."},"concavity":{"type":"string","title":"Concavity","description":"convex, concave, smooth or unknown: how its two faces meet."},"length":{"type":"number","title":"Length","description":"Its length, mm."},"dihedral_angle_deg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dihedral Angle Deg","description":"The angle between its two faces, degrees. Null where it varies along the edge."},"adjacent_surfaces":{"items":{"type":"string"},"type":"array","title":"Adjacent Surfaces","description":"The faces either side of it.","default":[]}},"type":"object","required":["id","type","concavity","length"],"title":"Edge","description":"One edge of the part, where two faces meet."},"EmailTestIn":{"properties":{"kind":{"type":"string","enum":["acknowledgement","quote","decline","upload_link","new_submission","held_submission","link_paused"],"title":"Kind","description":"The email: acknowledgement, quote or decline (editable), or upload_link, new_submission, held_submission or link_paused (fixed, to see what they say)."},"link_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Link Id","description":"A submission link whose own template, sender name, reply-to and logo to use. Leave it out for the organization's. Needs submission_links:manage on its project rather than in the organization."},"subject":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Subject","description":"A draft subject to try, plain text with {{fields}}, in place of the saved one. Editable emails only."},"body":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Body","description":"A draft body to try, plain text with {{fields}}, in place of the saved one. Editable emails only."}},"additionalProperties":false,"type":"object","required":["kind"],"title":"EmailTestIn","description":"Which email to send yourself as a test, filled in with sample data."},"EmailTestOut":{"properties":{"sent_to":{"type":"string","title":"Sent To","description":"Where it went: the caller's own email address, always."},"state":{"type":"string","enum":["sent","queued","failed"],"title":"State","description":"sent; queued, when today's email limit is reached or the provider is down, to go later; or failed, with error saying why."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Why it's queued or failed. Null once sent."},"test_mode":{"type":"boolean","title":"Test Mode","description":"Whether email is in test mode on this deployment: it's sent from Resend's test sender, which delivers only to the Resend account's own address."},"subject":{"type":"string","title":"Subject","description":"The subject, filled in."},"text":{"type":"string","title":"Text","description":"The plain-text version, filled in, footer included."},"html":{"type":"string","title":"Html","description":"The HTML version, for a preview. The email carries the logo as an inline attachment; here it's a data: URI, so a browser can show it."}},"additionalProperties":false,"type":"object","required":["sent_to","state","error","test_mode","subject","text","html"],"title":"EmailTestOut","description":"The test email, as sent to the caller."},"EntitlementOut":{"properties":{"key":{"type":"string","title":"Key","description":"The entitlement's key, such as analyses or submission_links."},"name":{"type":"string","title":"Name","description":"What the screen calls it, such as Analyses."},"kind":{"type":"string","enum":["switch","limit","monthly_limit","per_part_limit","lifetime_limit","rate_limit","cost_ceiling"],"title":"Kind","description":"switch (on or off), limit (a number held at once), monthly_limit (a number a billing month), per_part_limit (a number for each part), lifetime_limit (a number for the company's life), rate_limit (a number each person may use in a time window) or cost_ceiling (staff's, never in a customer's licence)."},"on":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"On","description":"For a switch: whether it's on. Null for a limit."},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"For a limit: the number allowed. Null for a switch, or for a limit that's unlimited."},"unlimited":{"type":"boolean","title":"Unlimited","description":"Whether a limit has no number: it's included without a cap."},"comes_with":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comes With","description":"The key of the lowest plan (hobbyist, pro or enterprise) with this on, or with more of it, than the company has: the plan to offer when it's off or used up. Null when no plan has more."}},"additionalProperties":false,"type":"object","required":["key","name","kind","on","limit","unlimited"],"title":"EntitlementOut","description":"One thing the company's licence allows."},"ErrorBody":{"properties":{"code":{"type":"string","title":"Code","description":"A stable, upper-case code such as PROJECT_NOT_FOUND or INVALID."},"message":{"type":"string","title":"Message","description":"What went wrong, in a sentence a person can read."},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field","description":"The request field at fault, when there is one, such as upload_url."},"comes_with":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comes With","description":"On a 402 for something the plan leaves out or has used up: the key of the lowest plan with it on, or with more of it (hobbyist, pro or enterprise), to offer a move to. Null when no plan has more. Absent on every other error."}},"type":"object","required":["code","message"],"title":"ErrorBody","description":"Every error the API returns. Branch on `code`: it stays the same between versions; `message` may change."},"Estimate":{"properties":{"status":{"type":"string","title":"Status","description":"rough: a should-cost from the plan, not a shop's quote."},"material":{"$ref":"#/components/schemas/analyses__customer__Material","description":"The material."},"quantity":{"type":"integer","title":"Quantity","description":"How many parts."},"batch":{"type":"integer","title":"Batch","description":"Parts in a batch."},"machine":{"$ref":"#/components/schemas/EstimateMachine","description":"The machine."},"stock":{"$ref":"#/components/schemas/Stock","description":"The stock."},"time":{"$ref":"#/components/schemas/Time","description":"The machining time."},"cost_lines":{"items":{"$ref":"#/components/schemas/CostLine"},"type":"array","title":"Cost Lines","description":"Every cost line."},"cost":{"$ref":"#/components/schemas/Cost","description":"The totals."},"tools":{"$ref":"#/components/schemas/EstimateTools","description":"Tools to buy, suggested and shared.","default":{"to_buy":[],"suggested":[],"merges":[],"none_fits":[]}}},"type":"object","required":["status","material","quantity","batch","machine","stock","time","cost_lines","cost"],"title":"Estimate","description":"A rough estimate for the chosen plan: stock, time and cost lines."},"EstimateMachine":{"properties":{"id":{"type":"string","title":"Id","description":"Its id: the organization's machine, or a machine type."},"label":{"type":"string","title":"Label","description":"Its name for people."},"machine_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine Class","description":"Its class: 3_axis, 4_axis, 3_2 or 5_axis."},"class_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Class Label","description":"Its class's name for people."}},"type":"object","required":["id","label"],"title":"EstimateMachine","description":"The machine estimated on."},"EstimateTools":{"properties":{"assumed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Assumed","description":"Whether the plan assumed its tooling: none of the organization's tools were allowed for the project, or it has none, so every tool is a standard size and none reads as to buy. Null for analyses run before this was recorded, and in quote versions."},"to_buy":{"items":{"$ref":"#/components/schemas/ToolToBuy"},"type":"array","title":"To Buy","description":"Tools to buy.","default":[]},"suggested":{"items":{"$ref":"#/components/schemas/SuggestedTool"},"type":"array","title":"Suggested","description":"Suggested tools.","default":[]},"merges":{"items":{"$ref":"#/components/schemas/ToolShared"},"type":"array","title":"Merges","description":"Tools shared.","default":[]},"none_fits":{"items":{"$ref":"#/components/schemas/NoToolFits"},"type":"array","title":"None Fits","description":"Faces no tool fits.","default":[]}},"type":"object","title":"EstimateTools","description":"The tools behind the estimate."},"ExtractRequest":{"properties":{"machine":{"type":"string","title":"Machine","description":"The machine type to plan for, such as 3_axis.","default":"3_axis"},"url":{"type":"string","title":"Url","description":"The STEP file's Vercel Blob URL: the upload_url from POST /api/v1/uploads and its put_url, or from the web app's own upload. It must be your own upload, in uploads/{org_id}/{user_id}/; anything else is refused with NOT_YOUR_UPLOAD. The upload is deleted afterwards."},"filename":{"type":"string","title":"Filename","description":"The file's original name, such as bracket.step."}},"type":"object","required":["url","filename"],"title":"ExtractRequest","description":"A STEP file to analyse once, without keeping anything."},"Face":{"properties":{"id":{"type":"string","pattern":"^[A-Za-z0-9_.-]{1,40}$","title":"Id","description":"The face's id in the latest quick check, such as S0012."},"role":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9 ._·×()/-]{1,40}$"},{"type":"null"}],"title":"Role","description":"Its role, such as Wall or Floor."},"type":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9 ._-]{1,40}$"},{"type":"null"}],"title":"Type","description":"Its surface type, such as plane or cylinder."},"position":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Position","description":"A point on it, mm."},"normal":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Normal","description":"Its normal there."},"size_mm":{"anyOf":[{"type":"number","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Size Mm","description":"Its size: a wall's thickness, a hole's diameter."}},"additionalProperties":false,"type":"object","required":["id"],"title":"Face","description":"A face the person picked on the part, as the viewer names it: geometry and its role, nothing else."},"Failed":{"properties":{"status":{"type":"string","const":"failed","title":"Status","description":"Always failed."},"code":{"type":"string","title":"Code","description":"A stable code, such as ESTIMATE_FAILED."},"message":{"type":"string","title":"Message","description":"What it means, for people."}},"type":"object","required":["status","code","message"],"title":"Failed","description":"A part of the result the engine couldn't work out. The rest of the result stands."},"FeatureChanged":{"properties":{"change":{"type":"string","enum":["added","changed","removed"],"title":"Change","description":"What the turn did to it."},"number":{"type":"integer","title":"Number","description":"The feature's number after the turn; for one removed, the number it had."},"name":{"type":"string","title":"Name","description":"What it is."},"summary":{"type":"string","title":"Summary","description":"Its sizes after the turn; for one removed, the sizes it had."},"was":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Was","description":"For one changed, its sizes before."}},"additionalProperties":false,"type":"object","required":["change","number","name","summary"],"title":"FeatureChanged","description":"One feature a turn added, changed or removed."},"FeatureEditIn":{"properties":{"values":{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"type":"null"}]},"type":"object","maxProperties":40,"minProperties":1,"title":"Values","description":"Each field's key from get_design's features and its new value, such as {\"depth\": 8}. Null clears an optional field."}},"additionalProperties":false,"type":"object","required":["values"],"title":"FeatureEditIn","description":"New values for some of a feature's fields."},"FeatureField":{"properties":{"key":{"type":"string","title":"Key","description":"The field's key within its feature, such as depth or size.0: what edit_design_feature takes."},"label":{"type":"string","title":"Label","description":"What it is, in words, such as Depth or Corner radius."},"kind":{"type":"string","enum":["length","angle","count","text","choice","toggle"],"title":"Kind","description":"What it takes: a length in its unit, an angle in degrees, a whole number, a size as it's written (M6, 1/4-20, 6004), one of its options, or true or false."},"group":{"type":"string","enum":["size","position"],"title":"Group","description":"size, or position: where the feature is on the part."},"value":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Value","description":"Its value now. Null for an optional one that's left out: `empty` says what it is then."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"mm, in or deg, where it has a unit."},"required":{"type":"boolean","title":"Required","description":"Whether it must have a value. An optional one is cleared with null."},"options":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Options","description":"What a choice may be."},"empty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Empty","description":"What it is when left out, in words, such as Through."}},"additionalProperties":false,"type":"object","required":["key","label","kind","group","required"],"title":"FeatureField","description":"One thing about a feature a person may change: a size, a position, a thread or screw, a choice or a switch."},"FeatureOut":{"properties":{"number":{"type":"integer","title":"Number","description":"Its place in the part's features, from 1. The first starts the part."},"name":{"type":"string","title":"Name","description":"What it is, such as Pocket or 6 × Tapped hole."},"summary":{"type":"string","title":"Summary","description":"Its main sizes in a line."},"fields":{"items":{"$ref":"#/components/schemas/FeatureField"},"type":"array","title":"Fields","description":"What may be changed about it.","default":[]},"removable":{"type":"boolean","title":"Removable","description":"Whether it can be removed: every feature but the first."}},"additionalProperties":false,"type":"object","required":["number","name","summary","removable"],"title":"FeatureOut","description":"One feature of the part, as the person reads it: never the operation or the arguments it was built with."},"FeedbackContext":{"properties":{"report_tab":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Report Tab","description":"The report tab that was open, such as setups."},"selected_surfaces":{"items":{"type":"string"},"type":"array","maxItems":2000,"title":"Selected Surfaces","description":"The surfaces selected in the viewer.","default":[]},"finding":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Finding","description":"The finding selected, if any."},"setup":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Setup","description":"The setup open, if any."},"hole":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Hole","description":"The hole group selected, if any."},"edge":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Edge","description":"The edge selected, if any."},"machine":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Machine","description":"The machine type shown."},"app_version":{"anyOf":[{"$ref":"#/components/schemas/AppVersion"},{"type":"null"}],"description":"The version of the app it was sent from."}},"additionalProperties":true,"type":"object","title":"FeedbackContext","description":"What the person was looking at. Every field is optional; unknown ones are kept."},"FeedbackIn":{"properties":{"text":{"type":"string","maxLength":20000,"minLength":1,"title":"Text","description":"What looks wrong or missing."},"type":{"type":"string","enum":["analysis_feedback","feature_request","ui_change_request"],"title":"Type","description":"analysis_feedback (the default), feature_request or ui_change_request.","default":"analysis_feedback"},"context":{"$ref":"#/components/schemas/FeedbackContext","description":"What the person was looking at.","default":{"selected_surfaces":[]}}},"additionalProperties":false,"type":"object","required":["text"],"title":"FeedbackIn","description":"Feedback on an analysis, for the Protyus team."},"FeedbackSent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The feedback's id."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was received."}},"additionalProperties":false,"type":"object","required":["id","created_at"],"title":"FeedbackSent","description":"Feedback that was received."},"FeedbackSharingIn":{"properties":{"shared":{"type":"boolean","title":"Shared","description":"Whether the company's people may send feedback to the Protyus team."}},"additionalProperties":false,"type":"object","required":["shared"],"title":"FeedbackSharingIn","description":"Turn feedback sharing on or off."},"FeedbackSharingOut":{"properties":{"shared":{"type":"boolean","title":"Shared","description":"Whether its people may send feedback to the Protyus team. Off until an admin turns it on."},"changed_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Changed By","description":"The Clerk user id of the admin who last set it, existing_company for a company that was on when feedback sharing came, or null if it was never set."},"changed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Changed At","description":"When it was last set, or null if never."},"can_edit":{"type":"boolean","title":"Can Edit","description":"Whether the caller may change it: admins only."},"ask":{"type":"boolean","title":"Ask","description":"Whether the app should ask the caller to turn it on: they're an admin, it's off, and they haven't been asked before. Asked once per admin."}},"additionalProperties":false,"type":"object","required":["shared","changed_by","changed_at","can_edit","ask"],"title":"FeedbackSharingOut","description":"Whether the company shares feedback with the Protyus team."},"FileIn":{"properties":{"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's name, ending .step or .stp."},"size_bytes":{"type":"integer","minimum":1.0,"title":"Size Bytes","description":"The file's size in bytes, at most 25 MB."}},"additionalProperties":false,"type":"object","required":["file_name","size_bytes"],"title":"FileIn","description":"One file the lead is about to upload."},"FileLimits":{"properties":{"max_files":{"type":"integer","title":"Max Files","description":"How many files one submission takes."},"max_file_bytes":{"type":"integer","title":"Max File Bytes","description":"The largest file, in bytes."},"extensions":{"items":{"type":"string"},"type":"array","title":"Extensions","description":"The file name endings taken."}},"additionalProperties":false,"type":"object","required":["max_files","max_file_bytes","extensions"],"title":"FileLimits","description":"Which files the upload page takes."},"FileUploadOut":{"properties":{"pathname":{"type":"string","title":"Pathname","description":"Where to put the file: pass it as the pathname to @vercel/blob/client's put()."},"client_token":{"type":"string","title":"Client Token","description":"The token to pass to put(), with access private. It allows this pathname only, up to max_bytes."},"max_bytes":{"type":"integer","title":"Max Bytes","description":"The largest file it takes, in bytes."},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"When the token stops working."}},"additionalProperties":false,"type":"object","required":["pathname","client_token","max_bytes","expires_at"],"title":"FileUploadOut","description":"A signed upload for one file, straight to the file store. It works for this file name only, for 15 minutes."},"FilterInfo":{"properties":{"key":{"type":"string","title":"Key","description":"Its key in filters."},"label":{"type":"string","title":"Label","description":"Its name."},"kind":{"type":"string","enum":["date","id","value"],"title":"Kind","description":"date: an ISO date or today, yesterday or -Nd. id: an id, or a list of them. value: one of values, or a list."},"description":{"type":"string","title":"Description","description":"What it keeps."},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values","description":"The values it takes, for kind value. Otherwise null."}},"additionalProperties":false,"type":"object","required":["key","label","kind","description","values"],"title":"FilterInfo","description":"One filter the query takes."},"Finding":{"properties":{"id":{"type":"string","title":"Id","description":"Its id in this plan's list, <rule>-<position> such as angled_setup-1, as feedback names it."},"rule":{"type":"string","title":"Rule","description":"What kind of finding it is, such as thin_wall or sharp_internal_corner."},"kind":{"type":"string","title":"Kind","description":"Its kind for people, plural, such as Deep holes. The app shows the findings of one kind as one card, titled with how many features they're about.","default":""},"severity":{"type":"string","title":"Severity","description":"hard_fail, shown as Blocker (it can't be made as modeled), scored, shown as Risk (it costs more), or flag_only, shown as Consider (worth a look)."},"title":{"type":"string","title":"Title","description":"Its heading."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"What broke the rule, as measured, such as 6.7:1, Ø15.48 or R2.54. Null where its title says it, and for analyses run before 0.125.0."},"features":{"items":{"$ref":"#/components/schemas/FindingFeature"},"type":"array","title":"Features","description":"Each feature it's about, such as each hole of a row the same size or each crease of the sharp corners. Empty for analyses run before 0.125.0: then it's about one feature, its surfaces.","default":[]},"explanation":{"type":"string","title":"Explanation","description":"What's wrong.","default":""},"fix":{"type":"string","title":"Fix","description":"An easy change to the design, such as a corner radius, or how it will be made as drawn. Empty where neither: a change to the part's form isn't recommended.","default":""},"fix_kind":{"type":"string","title":"Fix Kind","description":"What the fix asks of the design: easy (a radius or drill point a tool forms), model_only (the model changes, the made part doesn't), as_made (how it will be made, no design change) or none (the fix changes the part's form). Empty for analyses run before it was given.","default":""},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it's about.","default":[]},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"The edges it's about, as part.edges and display.edges name them, such as E0034, where the edge is what's wrong rather than its faces: a sharp internal corner's creases. Empty for other findings and for analyses run before they were named; show the faces then.","default":[]},"limit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit","description":"The limit it broke, such as 0.8 mm, or null."},"inch":{"anyOf":[{"$ref":"#/components/schemas/FindingInch"},{"type":"null"}],"description":"The same words with lengths in inches. Null for analyses run before they were written."}},"type":"object","required":["id","rule","severity","title"],"title":"Finding","description":"One DFM finding, in plain words, with the faces it's about. Lengths in its words are mm."},"FindingFeature":{"properties":{"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces.","default":[]},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"Its edges, where the edge is what's wrong, as a sharp corner's crease. Empty otherwise.","default":[]},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"What broke the rule on this feature, where it differs from the finding's value. Null otherwise."},"inch":{"anyOf":[{"$ref":"#/components/schemas/FindingFeatureInch"},{"type":"null"}],"description":"Its value with lengths in inches, where it has its own."}},"type":"object","title":"FindingFeature","description":"One feature a finding is about, such as one hole of a row the same size: its faces and edges, and its value\nin words."},"FindingFeatureInch":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"Its value, in inches."}},"type":"object","title":"FindingFeatureInch","description":"A finding feature's value with lengths in inches."},"FindingInch":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Its heading, in inches."},"explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Explanation","description":"What's wrong, in inches."},"fix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fix","description":"The fix, in inches."},"limit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit","description":"The limit it broke, in inches."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"What broke the rule, in inches."}},"type":"object","title":"FindingInch","description":"A finding's words with lengths in inches."},"FindingOut":{"properties":{"rule":{"type":"string","title":"Rule","description":"What kind of finding it is, such as sharp_internal_corner."},"severity":{"type":"string","title":"Severity","description":"hard_fail (Blocker), scored (Risk) or flag_only (Consider)."},"title":{"type":"string","title":"Title","description":"The finding, in words."},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Value","description":"Its measured value, where it has one."},"fix":{"type":"string","title":"Fix","description":"How to fix it, in words.","default":""},"fix_kind":{"type":"string","title":"Fix Kind","description":"easy or model_only (Protyus AI may fix it), as_made (how it's made as drawn) or none (it changes the form).","default":""},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it's on.","default":[]},"count":{"type":"integer","title":"Count","description":"How many there were before grouping.","default":1}},"additionalProperties":false,"type":"object","required":["rule","severity","title"],"title":"FindingOut","description":"A finding of the quick check, grouped: one rule and value, with its faces together."},"FindingRef":{"properties":{"finding":{"type":"string","maxLength":120,"minLength":1,"title":"Finding","description":"The finding's id, <rule>-<position> such as min_internal_radius-3, as get_analysis gives it in recognition.dfm."}},"additionalProperties":false,"type":"object","required":["finding"],"title":"FindingRef","description":"A DFM finding, on the analysis's machine."},"FindingSummary":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The finding's id in the report, such as angled_setup-1, as feedback's context.finding names it."},"rule":{"type":"string","title":"Rule","description":"The DFM rule that raised it."},"severity":{"type":"string","title":"Severity","description":"How serious it is: hard_fail (shown as Blocker), scored (Risk) or flag_only (Consider)."},"title":{"type":"string","title":"Title","description":"The finding's heading, as the report shows it.","default":""},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The surfaces it's about, such as S0006.","default":[]}},"additionalProperties":false,"type":"object","required":["rule","severity"],"title":"FindingSummary","description":"One DFM finding, in brief."},"Fit":{"properties":{"center":{"items":{"type":"number"},"type":"array","title":"Center","description":"Its centre, x, y, z in mm."},"radius":{"type":"number","title":"Radius","description":"Its radius, mm."}},"additionalProperties":false,"type":"object","required":["center","radius"],"title":"Fit","description":"The sphere to frame."},"FlagCheck":{"properties":{"key":{"type":"string","title":"Key","description":"The flag asked about."},"enabled":{"type":"boolean","title":"Enabled","description":"Whether it's on for you. A flag that doesn't exist is off."}},"additionalProperties":false,"type":"object","required":["key","enabled"],"title":"FlagCheck","description":"Whether one flag is on for the caller, and nothing else about it."},"FloorRecord":{"properties":{"surface":{"type":"string","title":"Surface","description":"An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."},"setup":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Setup","description":"The setup that cuts it, by number. Null where no setup reaches it."},"fillet_radii":{"items":{"$ref":"#/components/schemas/RadiusCount"},"type":"array","title":"Fillet Radii","description":"Each fillet radius round it, smallest first, with how many fillet faces have it.","default":[]},"corner_radii":{"items":{"$ref":"#/components/schemas/RadiusCount"},"type":"array","title":"Corner Radii","description":"Each wall corner radius round it, smallest first, with how many corners have it.","default":[]},"tightest_corner":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tightest Corner","description":"Its tightest wall corner radius, mm, which the tool cutting its walls has to fit. Null for none."},"tallest_wall":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tallest Wall","description":"Its tallest wall, mm. Null for none."},"cut":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cut","description":"How it's finished, as the estimate's time item names it, such as faces and floors."},"tool":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool","description":"The tool that finishes it, by size and type. Null where none does."},"to_buy":{"type":"boolean","title":"To Buy","description":"Whether that tool isn't one of the organization's, so it's to buy.","default":false}},"type":"object","required":["surface"],"title":"FloorRecord","description":"A floor, with what sizes the tool that finishes it, and that tool."},"FormAccepted":{"properties":{"email":{"type":"string","title":"Email","description":"The address given, lowercased."},"message":{"type":"string","title":"Message","description":"What to tell them: check that inbox for the upload link."},"expires_in_hours":{"type":"integer","title":"Expires In Hours","description":"How long the emailed upload link works, in hours."}},"additionalProperties":false,"type":"object","required":["email","message","expires_in_hours"],"title":"FormAccepted","description":"Check your inbox. The same answer whether or not an email went, so it says nothing about the address."},"FormFactors":{"properties":{"plate":{"type":"number","maximum":10.0,"exclusiveMinimum":0.0,"title":"Plate","description":"Plate, cut to size. 1.0 prices it at the material's price per pound.","default":1.0},"rectangular_bar":{"type":"number","maximum":10.0,"exclusiveMinimum":0.0,"title":"Rectangular Bar","description":"Rectangular or flat bar. 1.0 prices it at the material's price per pound.","default":1.0},"round_bar":{"type":"number","maximum":10.0,"exclusiveMinimum":0.0,"title":"Round Bar","description":"Round bar. 1.0 prices it at the material's price per pound.","default":1.0},"block":{"type":"number","maximum":10.0,"exclusiveMinimum":0.0,"title":"Block","description":"An unstocked block, where no stocked size holds the part. 1.0 prices it at the material's price per pound.","default":1.0},"tube":{"type":"number","maximum":10.0,"exclusiveMinimum":0.0,"title":"Tube","description":"Tube, round or square. Not bought yet. 1.0 prices it at the material's price per pound.","default":1.0}},"additionalProperties":false,"type":"object","title":"FormFactors","description":"What scales the material's stock price for each stock form.\n\nA piece of stock costs its weight x the price x the factor for its form, so bar can cost more a pound than\nplate. Every factor is 1.0 until the shop sets its own."},"FormFields":{"properties":{"email":{"type":"string","const":"required","title":"Email","description":"Always required: it's where the upload link and the quote go.","default":"required"},"first_name":{"type":"string","enum":["off","optional","required"],"title":"First Name","description":"First name: off, optional or required. Default required.","default":"required"},"last_name":{"type":"string","enum":["off","optional","required"],"title":"Last Name","description":"Last name: off, optional or required. Default required.","default":"required"},"company":{"type":"string","enum":["off","optional","required"],"title":"Company","description":"Company: off, optional or required. Default optional.","default":"optional"},"phone":{"type":"string","enum":["off","optional","required"],"title":"Phone","description":"Phone: off, optional or required. Default off.","default":"off"},"due_date":{"type":"string","enum":["off","optional","required"],"title":"Due Date","description":"When they need the parts: off, optional or required. Default off.","default":"off"},"notes":{"type":"string","enum":["off","optional","required"],"title":"Notes","description":"Notes for the shop: off, optional or required. Default off.","default":"off"}},"additionalProperties":false,"type":"object","title":"FormFields","description":"Which fields the lead form asks for. Each is off, optional or required; email is always required."},"FrameIn":{"properties":{"caption":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Caption","description":"A sentence under the picture."},"highlights":{"items":{"$ref":"#/components/schemas/HighlightIn"},"type":"array","maxItems":8,"title":"Highlights","description":"What to highlight, at most 8.","default":[]},"camera":{"anyOf":[{"type":"string","enum":["auto","top","bottom","front","back","left","right","iso","profile"]},{"$ref":"#/components/schemas/SetupCamera"},{"$ref":"#/components/schemas/StepCamera"}],"title":"Camera","description":"Where to look from: auto (the side that shows the highlights best), top, bottom, front, back, left, right, iso, or {setup: n} down that setup's tool direction. bottom shows it from underneath. On a lathe part, profile looks side on to its turning axis, so the turned profile reads, and {step: n} as that route operation sees it.","default":"auto"},"fit":{"anyOf":[{"type":"string","enum":["highlights","part"]},{"type":"null"}],"title":"Fit","description":"Frame the highlights (the default when there are any) or the whole part."},"layers":{"$ref":"#/components/schemas/LayersIn","description":"The viewer's layers.","default":{"roles":false,"setup_arrows":[],"turning_axis":false,"step_arrows":[]}}},"additionalProperties":false,"type":"object","title":"FrameIn","description":"One frame to step through."},"FrameOut":{"properties":{"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Caption","description":"Its caption, or null."},"highlights":{"items":{"$ref":"#/components/schemas/HighlightOut"},"type":"array","title":"Highlights","description":"What's highlighted. A ref that didn't resolve is in dropped instead."},"camera":{"$ref":"#/components/schemas/CameraOut","description":"Where it looks from."},"fit":{"$ref":"#/components/schemas/Fit","description":"The sphere the picture frames: the highlights', or the whole part's."},"layers":{"$ref":"#/components/schemas/LayersOut","description":"The viewer's layers."}},"additionalProperties":false,"type":"object","required":["caption","highlights","camera","fit","layers"],"title":"FrameOut","description":"One frame, resolved."},"GeneralTolerance":{"properties":{"plus_minus_mm":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Plus Minus Mm","description":"± tolerance, mm. Default ±0.005 in. Holding tighter takes extra finishing passes or a secondary operation.","default":0.127},"iso_2768":{"anyOf":[{"type":"string","enum":["f","m","c","v"]},{"type":"null"}],"title":"Iso 2768","description":"An ISO 2768 class: f, m, c or v. When set, it's used in place of the ± value."}},"additionalProperties":false,"type":"object","title":"GeneralTolerance","description":"The tolerance applied wherever nothing tighter is said."},"GroupDefaults":{"properties":{"slot":{"$ref":"#/components/schemas/MillDefaults","description":"Slotting."},"rough":{"$ref":"#/components/schemas/MillDefaults","description":"Roughing."},"finish":{"$ref":"#/components/schemas/MillDefaults","description":"Finishing."},"face":{"$ref":"#/components/schemas/MillDefaults","description":"Facing."},"profile":{"$ref":"#/components/schemas/ProfileDefaults","description":"3D profiling."},"drill":{"$ref":"#/components/schemas/DrillDefaults","description":"Drilling with HSS drills."}},"additionalProperties":false,"type":"object","required":["slot","rough","finish","face","profile","drill"],"title":"GroupDefaults","description":"Protyus's numbers for one cutting group, what a null field in the shop's own takes."},"GroupNumbers":{"properties":{"slot":{"$ref":"#/components/schemas/MillNumbers","description":"Slotting: a full-width cut, T-slot cutters and plunged counterbores too.","default":{}},"rough":{"$ref":"#/components/schemas/MillNumbers","description":"Roughing.","default":{}},"finish":{"$ref":"#/components/schemas/MillNumbers","description":"Finishing walls and floors; profiling passes take its speed.","default":{}},"face":{"$ref":"#/components/schemas/MillNumbers","description":"Facing.","default":{}},"profile":{"$ref":"#/components/schemas/ProfileNumbers","description":"3D profiling: the share of the calculated feed.","default":{}},"drill":{"$ref":"#/components/schemas/DrillNumbers","description":"Drilling with HSS drills.","default":{}}},"additionalProperties":false,"type":"object","title":"GroupNumbers","description":"A shop's own cutting numbers for one cutting group: a row for each operation. A null field takes Protyus's."},"HiddenProcessMachines":{"properties":{"sheet_metal":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Sheet Metal","description":"The cutting machines hidden, by id, such as SM-PL.","default":[]},"moulding":{"items":{"type":"string"},"type":"array","maxItems":20,"title":"Moulding","description":"The presses hidden, by id, such as M-220H.","default":[]}},"additionalProperties":false,"type":"object","title":"HiddenProcessMachines","description":"Protyus's sheet metal cutting machines and molding presses the organization hides: in no project's choices, not\nto be picked, and not weighed by Best Fit."},"HighlightIn":{"properties":{"ref":{"anyOf":[{"$ref":"#/components/schemas/FindingRef"},{"$ref":"#/components/schemas/CheckRef"},{"$ref":"#/components/schemas/SetupRef"},{"$ref":"#/components/schemas/HoleRef"},{"$ref":"#/components/schemas/PocketRef"},{"$ref":"#/components/schemas/RoleRef"},{"$ref":"#/components/schemas/SurfacesRef"},{"$ref":"#/components/schemas/TurnedRef"},{"$ref":"#/components/schemas/StepRef-Input"}],"title":"Ref","description":"What to highlight: one of {finding}, {check}, {setup}, {hole}, {pocket}, {role}, {surfaces}, or on a lathe part {turned} or {step}."},"tone":{"anyOf":[{"type":"string","enum":["critical","warning","info","neutral"]},{"type":"null"}],"title":"Tone","description":"critical, warning, info or neutral. Leave out for the ref's own: a finding's by its severity, warning for a check, info for a setup, hole, pocket, role, turned feature or step, neutral for faces."},"label":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Label","description":"Its name in the legend. Leave out for the finding's or check's title, Setup 2, Op 10, and so on."},"callout":{"type":"boolean","title":"Callout","description":"Whether it gets a numbered marker.","default":true}},"additionalProperties":false,"type":"object","required":["ref"],"title":"HighlightIn","description":"Something to highlight."},"HighlightOut":{"properties":{"ref":{"anyOf":[{"$ref":"#/components/schemas/FindingRef"},{"$ref":"#/components/schemas/CheckRef"},{"$ref":"#/components/schemas/SetupRef"},{"$ref":"#/components/schemas/HoleRef"},{"$ref":"#/components/schemas/PocketRef"},{"$ref":"#/components/schemas/RoleRef"},{"$ref":"#/components/schemas/SurfacesRef"},{"$ref":"#/components/schemas/TurnedRef"},{"$ref":"#/components/schemas/analyses__views__StepRef"}],"title":"Ref","description":"What was asked for."},"tone":{"type":"string","enum":["critical","warning","info","neutral"],"title":"Tone","description":"Its tone."},"label":{"type":"string","title":"Label","description":"Its name in the legend: the given label, else the finding's or check's title, Setup 2, and so on."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces."},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"The edges it's about, as display.edges names them, such as E0034: a sharp internal corner's creases. Where there are any, draw these in its tone in place of its faces. Empty for the rest."},"number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number","description":"Its callout's number, from 1 in each frame, or null for no callout."},"anchor":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Anchor","description":"Where the callout sits, on the highlight, x, y, z in mm. Null with no callout."}},"additionalProperties":false,"type":"object","required":["ref","tone","label","surfaces","edges","number","anchor"],"title":"HighlightOut","description":"A highlight, resolved to faces."},"HoldReason":{"properties":{"code":{"type":"string","title":"Code","description":"A stable code, such as SCORE_UNDER, CANT_BE_MADE, ANALYSIS_FAILED or OVER_MAX_PRICE."},"message":{"type":"string","title":"Message","description":"The reason for people, such as Score 64, under 80."},"part_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Part Id","description":"The part it's about, or null for the whole submission."},"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name","description":"That part's file name, or null."}},"additionalProperties":false,"type":"object","required":["code","message","part_id","file_name"],"title":"HoldReason","description":"Why a submission was held: one part's reason, or the submission's own (part_id null), such as REVIEW_FIRST."},"HoldRules":{"properties":{"min_score":{"anyOf":[{"type":"integer","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Min Score","description":"Hold a part whose general score is under this, from 0 to 100. Default 80; null turns the rule off.","default":80},"hold_on_flags":{"type":"boolean","title":"Hold On Flags","description":"Hold a part with any finding to consider (flag_only). Default off.","default":false},"max_order_price":{"anyOf":[{"type":"number","maximum":100000000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Max Order Price","description":"Hold an order priced above this, US dollars. Default null: no limit."},"hold_below_minimum_charge":{"type":"boolean","title":"Hold Below Minimum Charge","description":"Hold an order whose price is under the project's minimum charge. Default off.","default":false}},"additionalProperties":false,"type":"object","title":"HoldRules","description":"When a quote is held for the team rather than sent. A part that didn't finish, or can't be made, is always held."},"Hole":{"properties":{"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces."},"diameters":{"items":{"type":"number"},"type":"array","title":"Diameters","description":"Its diameters, mm, widest first for a stepped hole."},"depth":{"type":"number","title":"Depth","description":"Its depth, mm."},"through":{"type":"boolean","title":"Through","description":"Whether it goes right through."},"bottom":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bottom","description":"A blind hole's bottom: flat or cone (a drill point). Null for a through hole."},"thread":{"anyOf":[{"$ref":"#/components/schemas/LiningThread"},{"type":"null"}],"description":"The thread modeled into it, if any. The hole's own diameters are what is drilled."}},"type":"object","required":["surfaces","diameters","depth","through"],"title":"Hole","description":"A round hole, maybe stepped."},"HoleRef":{"properties":{"hole":{"type":"integer","minimum":0.0,"title":"Hole","description":"The hole's index in recognition.holes, from 0."}},"additionalProperties":false,"type":"object","required":["hole"],"title":"HoleRef","description":"One hole."},"ImportCommit":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"The file's Vercel Blob URL, from an upload through /upload. It must be your own upload, in uploads/{org_id}/{user_id}/; anything else is refused with NOT_YOUR_UPLOAD."},"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's original name, such as shop.tools or tools.csv."},"format":{"type":"string","enum":["auto","fusion","csv"],"title":"Format","description":"fusion (.tools or its JSON), csv, or auto to tell from the file.","default":"auto"},"mapping":{"anyOf":[{"$ref":"#/components/schemas/ColumnMapping"},{"type":"null"}],"description":"For CSV: the column mapping. Null uses the organization's last one, then the column names."},"group_actions":{"additionalProperties":{"type":"string","enum":["add","skip","update","keep_both"]},"propertyNames":{"enum":["new","exact_duplicate","likely_duplicate","changed","invalid"]},"type":"object","title":"Group Actions","description":"An action for every row of a status, such as {\"likely_duplicate\": \"keep_both\"}.","default":{}},"actions":{"additionalProperties":{"type":"string","enum":["add","skip","update","keep_both"]},"type":"object","title":"Actions","description":"An action for one row, by its row number, over its group's.","default":{}}},"additionalProperties":false,"type":"object","required":["upload_url","file_name"],"title":"ImportCommit","description":"Import a file as one batch. Rows take their status's default unless an action says otherwise."},"ImportPreview":{"properties":{"format":{"type":"string","enum":["fusion","csv"],"title":"Format","description":"The format it was read as."},"file_name":{"type":"string","title":"File Name","description":"The file's name."},"columns":{"items":{"type":"string"},"type":"array","title":"Columns","description":"For CSV, the file's column headers. Empty for Fusion."},"mapping":{"anyOf":[{"$ref":"#/components/schemas/ColumnMapping"},{"type":"null"}],"description":"For CSV, the mapping used."},"counts":{"additionalProperties":{"type":"integer"},"type":"object","title":"Counts","description":"How many rows have each status."},"defaults":{"additionalProperties":{"anyOf":[{"type":"string","enum":["add","skip","update","keep_both"]},{"type":"null"}]},"type":"object","title":"Defaults","description":"The default action for each status."},"rows":{"items":{"$ref":"#/components/schemas/PreviewRow"},"type":"array","title":"Rows","description":"Every row, in file order."}},"additionalProperties":false,"type":"object","required":["format","file_name","columns","mapping","counts","defaults","rows"],"title":"ImportPreview","description":"What importing a file would do."},"ImportSource":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"The file's Vercel Blob URL, from an upload through /upload. It must be your own upload, in uploads/{org_id}/{user_id}/; anything else is refused with NOT_YOUR_UPLOAD."},"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's original name, such as shop.tools or tools.csv."},"format":{"type":"string","enum":["auto","fusion","csv"],"title":"Format","description":"fusion (.tools or its JSON), csv, or auto to tell from the file.","default":"auto"},"mapping":{"anyOf":[{"$ref":"#/components/schemas/ColumnMapping"},{"type":"null"}],"description":"For CSV: the column mapping. Null uses the organization's last one, then the column names."}},"additionalProperties":false,"type":"object","required":["upload_url","file_name"],"title":"ImportSource","description":"An uploaded tool file and how to read it."},"InsertGeometry":{"properties":{"SC":{"anyOf":[{"type":"string","enum":["A","B","C","D","E","K","L","M","R","S","T","V","W","custom","thread iso double","thread iso triple"]},{"type":"null"}],"title":"Sc","description":"Insert shape: its ISO letter for a turning or boring insert, such as C for an 80 degree diamond, D for 55 degrees or V for 35; or thread iso double or thread iso triple for a threading insert."},"INSD":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Insd","description":"Insert size: its inscribed circle, mm, such as 12.7 for a CNMG 432."},"RE":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Re","description":"Nose radius, mm, such as 0.8."},"tool_grooveWidth":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Tool Groovewidth","description":"Grooves and part-off: the insert's or blade's cutting width, mm."},"max-depth":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Max-Depth","description":"Grooves and part-off: how deep it cuts, mm, such as half the largest bar a part-off blade parts."},"min-bore":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Min-Bore","description":"Boring bars and inside grooving and threading tools: the smallest bore it fits, mm."},"max-reach":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Max-Reach","description":"Boring bars and inside grooving and threading tools: how deep into a bore it reaches, mm."},"W":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"W","description":"Shank width, mm; a boring bar's diameter."},"H":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"H","description":"Shank height, mm. Outside tools only."},"HAND":{"anyOf":[{"type":"string","enum":["R","L","N"]},{"type":"null"}],"title":"Hand","description":"Hand: R, L or N for neutral."},"TPN":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Tpn","description":"Threading tools: the finest pitch it cuts, mm from one thread to the next, such as 1.5875 for 16 threads per inch."},"TPX":{"anyOf":[{"type":"number","minimum":0.0,"exclusiveMinimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Tpx","description":"Threading tools: the coarsest pitch it cuts, mm from one thread to the next, such as 3.175 for 8 threads per inch."}},"additionalProperties":false,"type":"object","title":"InsertGeometry","description":"A turning tool's insert or blade and its holder, in mm whatever unit it's sold in. Each type takes only its own fields."},"InvitationOut":{"properties":{"id":{"type":"string","title":"Id","description":"Clerk's id for the invitation."},"email":{"type":"string","title":"Email","description":"Who it was sent to."},"role":{"type":"string","enum":["admin","member"],"title":"Role","description":"The role they'll have once they accept."},"status":{"type":"string","title":"Status","description":"Clerk's status for it, usually 'pending'."}},"additionalProperties":false,"type":"object","required":["id","email","role","status"],"title":"InvitationOut","description":"An invitation to join the organization that hasn't been accepted yet."},"InviteIn":{"properties":{"email":{"type":"string","maxLength":254,"pattern":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$","title":"Email","description":"The email address to invite."},"role":{"type":"string","enum":["admin","member"],"title":"Role","description":"The role they'll have in the organization.","default":"member"}},"additionalProperties":false,"type":"object","required":["email"],"title":"InviteIn","description":"An invitation to join the caller's organization."},"ItemDetail":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The item's id, which stays the same across edits."},"kind":{"type":"string","title":"Kind","description":"Its kind, such as tool."},"revision":{"$ref":"#/components/schemas/RevisionOut","description":"Its current revision."},"archived":{"type":"boolean","title":"Archived","description":"Whether it's archived: out of the library, but still readable."},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At","description":"When it was archived, or null."},"archived_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archived By","description":"Who archived it, or null."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of who added it."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was added."},"history":{"items":{"$ref":"#/components/schemas/RevisionOut"},"type":"array","title":"History","description":"Every revision of the item, newest first, including any an undone import made."}},"additionalProperties":false,"type":"object","required":["id","kind","revision","archived","archived_at","archived_by","created_by","created_at","history"],"title":"ItemDetail","description":"A library item with every revision, newest first."},"ItemEdit":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data","description":"Every field of the item after the change, matching its kind's schema. Lengths in mm."},"base_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Base Revision Id","description":"The revision this edit was made from. If the item has changed since, the edit is refused with REVISION_CONFLICT."}},"additionalProperties":false,"type":"object","required":["data"],"title":"ItemEdit","description":"A change to a library item. It becomes a new revision."},"ItemFilter":{"properties":{"ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":500},{"type":"null"}],"title":"Ids","description":"Only these items."},"collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Collection Id","description":"Only items in this collection, from GET /api/v1/library/{kind}/collections."},"where":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Where","description":"Fields of the current revision's data that must equal these values, such as {\"flutes\": 3}. Lengths in mm."},"archived":{"type":"string","enum":["no","yes","any"],"title":"Archived","description":"Whether to include archived items: no, only them, or any.","default":"no"}},"additionalProperties":false,"type":"object","title":"ItemFilter","description":"Which items to list or archive. Every condition given must hold."},"ItemIn":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The item's fields, matching its kind's schema from GET /api/v1/library/kinds. Lengths in mm."}},"additionalProperties":false,"type":"object","required":["data"],"title":"ItemIn","description":"A new library item."},"ItemOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The item's id, which stays the same across edits."},"kind":{"type":"string","title":"Kind","description":"Its kind, such as tool."},"revision":{"$ref":"#/components/schemas/RevisionOut","description":"Its current revision."},"archived":{"type":"boolean","title":"Archived","description":"Whether it's archived: out of the library, but still readable."},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At","description":"When it was archived, or null."},"archived_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archived By","description":"Who archived it, or null."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of who added it."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was added."}},"additionalProperties":false,"type":"object","required":["id","kind","revision","archived","archived_at","archived_by","created_by","created_at"],"title":"ItemOut","description":"A library item at its current revision."},"ItemPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ItemOut"},"type":"array","title":"Items","description":"The items, oldest first."},"total":{"type":"integer","title":"Total","description":"How many items match, across every page."}},"additionalProperties":false,"type":"object","required":["items","total"],"title":"ItemPage","description":"One page of a library's items."},"IterationComparison":{"properties":{"before":{"$ref":"#/components/schemas/ComparedIteration","description":"The earlier of the two, by when it was run."},"after":{"$ref":"#/components/schemas/ComparedIteration","description":"The later of the two."},"changed_picks":{"items":{"type":"string","enum":["machine","material","quantity","annual_volume"]},"type":"array","title":"Changed Picks","description":"Which picks differ between them. Time and cost move with these as well as with the design."},"fixed":{"items":{"$ref":"#/components/schemas/FindingSummary"},"type":"array","title":"Fixed","description":"Findings before that have no pair after, as before raised them."},"added":{"items":{"$ref":"#/components/schemas/FindingSummary"},"type":"array","title":"Added","description":"Findings after that have no pair before, as after raised them."},"kept":{"items":{"$ref":"#/components/schemas/FindingSummary"},"type":"array","title":"Kept","description":"Findings after that pair with one before."}},"additionalProperties":false,"type":"object","required":["before","after","changed_picks","fixed","added","kept"],"title":"IterationComparison","description":"How one iteration differs from another: the conclusions side by side, and the findings fixed and added.\n\nFindings are paired by rule and heading, then by rule, so a finding that moved to other faces still pairs."},"IterationIn":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"The STEP file's Vercel Blob URL: the upload_url from sending it to the put_url that POST /api/v1/uploads gives, or from the web app's own upload. It must be your own upload, made by you: in your folder, uploads/{org_id}/{user_id}/. Anything else is refused with NOT_YOUR_UPLOAD."},"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's original name, such as bracket-v2.step."},"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine to plan for, from the project's choices; auto for Best Fit. Null for the latest iteration's machine, the one Best Fit picked included."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material, by id or reference grade. Null for the latest iteration's material."},"quantity":{"anyOf":[{"type":"integer","maximum":1000000.0,"minimum":1.0},{"type":"null"}],"title":"Quantity","description":"How many parts in the batch. Null for the latest iteration's quantity."},"annual_volume":{"anyOf":[{"type":"integer","maximum":100000000.0,"minimum":1.0},{"type":"null"}],"title":"Annual Volume","description":"How many parts a year, which sheet metal's progressive die and moulding's mould are costed over. Null for the latest iteration's, or Protyus's defaults if it had none."},"process_machine":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Process Machine","description":"For sheet metal or moulding, the machine to make it on, from the project's choices for its part's process; auto for Best Fit. Null for the latest iteration's. One that isn't the process's is refused with PROCESS_MACHINE_NOT_FOUND."},"process_material":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Process Material","description":"For sheet metal or moulding, the grade or resin, from the same choices. Null for the latest iteration's. One that isn't the process's is refused with PROCESS_MATERIAL_NOT_FOUND."},"parting_plane":{"anyOf":[{"$ref":"#/components/schemas/PartingPlaneIn"},{"type":"null"}],"description":"For moulding, a parting plane set by hand, given one way (point and normal, three points, a flat face or two edges); its normal sets the pull. Null for the plane the engine finds where the draft turns round the outside of the part. On any other process it's refused with PARTING_PLANE_NOT_MOULDING. A plane set by hand isn't carried from the latest iteration, as the changed part's faces may be elsewhere. A face or edges can't be named: the changed part isn't read until it runs."},"app_version":{"$ref":"#/components/schemas/AppVersion","description":"The version of the app making the request.","default":{"number":"unknown","commit":"local"}}},"additionalProperties":false,"type":"object","required":["upload_url","file_name"],"title":"IterationIn","description":"A changed STEP file of the same part, to analyse as a new iteration.\n\nEach pick left out is the one the group's latest iteration made, if the project still allows it, else the project's default."},"KindOut":{"properties":{"key":{"type":"string","title":"Key","description":"The kind's key, used in library routes, such as tool."},"name":{"type":"string","title":"Name","description":"What the screen calls it."},"permission":{"type":"string","title":"Permission","description":"The permission that writing items of this kind needs, such as tools:write."},"ready":{"type":"boolean","title":"Ready","description":"Whether items of this kind can be created yet. A kind is ready once its section ships."},"collections":{"type":"boolean","title":"Collections","description":"Whether items of this kind can be grouped in collections."},"length_fields":{"items":{"type":"string"},"type":"array","title":"Length Fields","description":"The fields of `data` that are lengths, always stored in mm."},"data_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data Schema","description":"The JSON schema `data` must match, or null while the kind isn't ready."}},"additionalProperties":false,"type":"object","required":["key","name","permission","ready","collections","length_fields","data_schema"],"title":"KindOut","description":"A kind of library item."},"LatestVersionOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The version's id."},"number":{"type":"integer","title":"Number","description":"Its number in the part (v1, v2)."},"status":{"type":"string","enum":["working","final"],"title":"Status","description":"working while it's being changed; final once finalised."},"origin":{"type":"string","enum":["uploaded","built","optimised"],"title":"Origin","description":"Where it came from: uploaded, built in Design, or optimised from another version."}},"additionalProperties":false,"type":"object","required":["id","number","status","origin"],"title":"LatestVersionOut","description":"A part's newest version."},"LayersIn":{"properties":{"fade":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fade","description":"Fade the rest of the part. Default true when there are highlights."},"edges":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Edges","description":"Draw the edges. Default true."},"roles":{"type":"boolean","title":"Roles","description":"Colour faces by role.","default":false},"setup_arrows":{"items":{"type":"integer"},"type":"array","maxItems":8,"title":"Setup Arrows","description":"The setup numbers whose tool arrows show.","default":[]},"section":{"anyOf":[{"$ref":"#/components/schemas/Section"},{"type":"null"}],"description":"A section cut. Default none."},"turning_axis":{"type":"boolean","title":"Turning Axis","description":"Draw a lathe part's turning axis, dashed, through the part.","default":false},"step_arrows":{"items":{"$ref":"#/components/schemas/StepRef-Input"},"type":"array","maxItems":8,"title":"Step Arrows","description":"The route operations whose tool arrows show: along the axis from the end a lathe or mill-turn operation's tools come from, or a mill setup's tool direction.","default":[]}},"additionalProperties":false,"type":"object","title":"LayersIn","description":"The viewer's layers. All optional."},"LayersOut":{"properties":{"fade":{"type":"boolean","title":"Fade","description":"Whether the rest of the part is faded."},"edges":{"type":"boolean","title":"Edges","description":"Whether edges are drawn."},"roles":{"type":"boolean","title":"Roles","description":"Whether faces are coloured by role."},"setup_arrows":{"items":{"$ref":"#/components/schemas/SetupArrow"},"type":"array","title":"Setup Arrows","description":"The setups whose arrows show."},"section":{"anyOf":[{"$ref":"#/components/schemas/Section"},{"type":"null"}],"description":"The section cut, or null."},"turning_axis":{"anyOf":[{"$ref":"#/components/schemas/TurningAxis"},{"type":"null"}],"description":"The turning axis to draw, or null: not asked for, or not a lathe part."},"step_arrows":{"items":{"$ref":"#/components/schemas/StepArrow"},"type":"array","title":"Step Arrows","description":"The route operations whose arrows show.","default":[]}},"additionalProperties":false,"type":"object","required":["fade","edges","roles","setup_arrows","section"],"title":"LayersOut","description":"The viewer's layers, resolved."},"Layout":{"properties":{"x":{"type":"integer","exclusiveMaximum":12.0,"minimum":0.0,"title":"X","description":"The column its left edge is in, from 0 to 11."},"y":{"type":"integer","maximum":1000.0,"minimum":0.0,"title":"Y","description":"The row its top edge is in, from 0."},"w":{"type":"integer","maximum":12.0,"minimum":1.0,"title":"W","description":"How many columns wide it is, from 1 to 12. x + w is at most 12."},"h":{"type":"integer","maximum":12.0,"minimum":1.0,"title":"H","description":"How many rows tall it is, from 1 to 12."}},"additionalProperties":false,"type":"object","required":["x","y","w","h"],"title":"Layout","description":"Where a card sits on the dashboard's 12-column grid. Rows have no fixed height; cards may not overlap."},"LeadDeleted":{"properties":{"lead_id":{"type":"string","format":"uuid","title":"Lead Id","description":"The lead deleted."},"submissions":{"type":"integer","title":"Submissions","description":"How many submissions went with them."},"parts":{"type":"integer","title":"Parts","description":"How many parts went. Their analyses and quotes stay, without the lead's name."},"upload_links":{"type":"integer","title":"Upload Links","description":"How many upload links went, each with its files."},"emails_emptied":{"type":"integer","title":"Emails Emptied","description":"How many emails to or about them were emptied of everything they said."}},"additionalProperties":false,"type":"object","required":["lead_id","submissions","parts","upload_links","emails_emptied"],"title":"LeadDeleted","description":"What deleting a lead removed. Nothing of theirs is kept."},"LeadDetail":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The lead's id."},"email":{"type":"string","title":"Email","description":"Their email address, lowercased."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Their first name, if known."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Their last name, if known."},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"Their company, if known."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Their phone number, if known."},"verified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Verified At","description":"When they first opened an upload link, proving the address is theirs. Null: unverified."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the lead was made: their first upload link or form."},"status":{"type":"string","enum":["unverified","verified","submitted","analysed","held","quoted","declined","won","lost"],"title":"Status","description":"Where they are, worked out from their events: unverified (never opened an upload link), verified (opened one, nothing submitted), submitted, analysed, held (waiting for the team), quoted (sent their quote), declined, or won and lost, set by hand."},"status_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Status At","description":"When the event that set the status happened. Null for unverified and verified."},"last_activity_at":{"type":"string","format":"date-time","title":"Last Activity At","description":"When anything last happened to them. Lists are newest activity first."},"submission_count":{"type":"integer","title":"Submission Count","description":"How many submissions they've made, in projects the caller sees."},"held_count":{"type":"integer","title":"Held Count","description":"How many of those are held for the team to send, edit or decline."},"first_submission_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Submission At","description":"When they first submitted. Null if they haven't."},"last_submission_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Submission At","description":"When they last submitted. Null if they haven't."},"projects":{"items":{"$ref":"#/components/schemas/Named"},"type":"array","title":"Projects","description":"The projects their submissions and upload links are in, that the caller sees."},"submission_links":{"items":{"$ref":"#/components/schemas/Named"},"type":"array","title":"Submission Links","description":"The submission links they came through, in projects the caller sees."},"submissions":{"items":{"$ref":"#/components/schemas/SubmissionOut"},"type":"array","title":"Submissions","description":"Their submissions in projects the caller sees, newest first."},"events":{"items":{"$ref":"#/components/schemas/LeadEventOut"},"type":"array","title":"Events","description":"Their timeline, oldest first, in projects the caller sees."},"can_set_status":{"type":"boolean","title":"Can Set Status","description":"Whether the caller may mark them won or lost (quotes:write on a project their submissions are in)."},"can_delete":{"type":"boolean","title":"Can Delete","description":"Whether the caller may delete them: organization admins only."},"send_to":{"anyOf":[{"$ref":"#/components/schemas/SendTarget"},{"type":"null"}],"description":"Where to send them a new upload link with POST /api/v1/upload-links, if the caller may (submission_links:manage). Null otherwise."}},"additionalProperties":false,"type":"object","required":["id","email","first_name","last_name","company","phone","verified_at","created_at","status","status_at","last_activity_at","submission_count","held_count","first_submission_at","last_submission_at","projects","submission_links","submissions","events","can_set_status","can_delete","send_to"],"title":"LeadDetail","description":"A lead with their submissions, parts and quotes, and their timeline."},"LeadEventOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The event's id."},"kind":{"type":"string","title":"Kind","description":"What happened: upload_link_sent, verified, submitted, analysed, held, quoted, sent, declined, won, lost or status_cleared. More kinds may be added; show an unknown one by its name."},"at":{"type":"string","format":"date-time","title":"At","description":"When it happened."},"actor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actor","description":"Who did it, a Clerk user id. Null for the lead or Protyus itself."},"submission_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Submission Id","description":"The submission it's about, if any."},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"What's known of it, by kind: such as part_count and file_names for submitted."}},"additionalProperties":false,"type":"object","required":["id","kind","at","actor","submission_id","data"],"title":"LeadEventOut","description":"One thing that happened to a lead. Events are never changed."},"LeadOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The lead's id."},"email":{"type":"string","title":"Email","description":"Their email address, lowercased."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Their first name, if known."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Their last name, if known."},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"Their company, if known."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Their phone number, if known."},"verified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Verified At","description":"When they first opened an upload link, proving the address is theirs. Null: unverified."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the lead was made: their first upload link or form."},"status":{"type":"string","enum":["unverified","verified","submitted","analysed","held","quoted","declined","won","lost"],"title":"Status","description":"Where they are, worked out from their events: unverified (never opened an upload link), verified (opened one, nothing submitted), submitted, analysed, held (waiting for the team), quoted (sent their quote), declined, or won and lost, set by hand."},"status_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Status At","description":"When the event that set the status happened. Null for unverified and verified."},"last_activity_at":{"type":"string","format":"date-time","title":"Last Activity At","description":"When anything last happened to them. Lists are newest activity first."},"submission_count":{"type":"integer","title":"Submission Count","description":"How many submissions they've made, in projects the caller sees."},"held_count":{"type":"integer","title":"Held Count","description":"How many of those are held for the team to send, edit or decline."},"first_submission_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Submission At","description":"When they first submitted. Null if they haven't."},"last_submission_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Submission At","description":"When they last submitted. Null if they haven't."},"projects":{"items":{"$ref":"#/components/schemas/Named"},"type":"array","title":"Projects","description":"The projects their submissions and upload links are in, that the caller sees."},"submission_links":{"items":{"$ref":"#/components/schemas/Named"},"type":"array","title":"Submission Links","description":"The submission links they came through, in projects the caller sees."}},"additionalProperties":false,"type":"object","required":["id","email","first_name","last_name","company","phone","verified_at","created_at","status","status_at","last_activity_at","submission_count","held_count","first_submission_at","last_submission_at","projects","submission_links"],"title":"LeadOut","description":"A lead: one person, by email address, in the organization, with where they are."},"LeadPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/LeadOut"},"type":"array","title":"Items","description":"The leads on this page."},"total":{"type":"integer","title":"Total","description":"How many leads match, across every page."}},"additionalProperties":false,"type":"object","required":["items","total"],"title":"LeadPage","description":"One page of leads, most recent activity first."},"LeavingOut":{"properties":{"deletion":{"anyOf":[{"$ref":"#/components/schemas/ScheduledDeletionOut"},{"type":"null"}],"description":"The deletion waiting to run, or null."},"can_purge":{"type":"boolean","title":"Can Purge","description":"Whether the caller may ask for everything to be deleted now, 7 days on, keeping the company: admins, once its plan is set to cancel or has ended."},"can_delete_company":{"type":"boolean","title":"Can Delete Company","description":"Whether the caller may delete the company, 7 days on: admins, when it has no plan that's still running."},"why_not":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Why Not","description":"Why an admin can't delete the company yet, in words to show them. Null otherwise."}},"additionalProperties":false,"type":"object","required":["deletion","can_purge","can_delete_company","why_not"],"title":"LeavingOut","description":"What happens to the company's data if it leaves: any deletion waiting, and what an admin may ask for."},"LeftOrganization":{"properties":{"org_id":{"type":"string","title":"Org Id","description":"The organization they left. Their next request needs another active organization."},"projects_reassigned":{"type":"integer","title":"Projects Reassigned","description":"How many of their projects now belong to `projects_to`."},"projects_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Projects To","description":"The Clerk user id of the admin who took their projects, or null if they owned none."}},"additionalProperties":false,"type":"object","required":["org_id","projects_reassigned","projects_to"],"title":"LeftOrganization","description":"The result of the caller leaving the organization."},"LicenceOut":{"properties":{"state":{"type":"string","enum":["no_licence","trialing","active","past_due","read_only"],"title":"State","description":"no_licence (no plan started: no analyses), trialing, active, past_due (a payment failed: everything works until read_only_from) or read_only (view, download and export only)."},"plan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan","description":"The plan's key: hobbyist, pro or enterprise. Null with no licence."},"plan_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Name","description":"What the screen calls the plan, such as Pro."},"free":{"type":"boolean","title":"Free","description":"Whether it's a free plan from Protyus rather than a paid one."},"licence_type":{"type":"string","enum":["paid","free","invoiced"],"title":"Licence Type","description":"paid (through Organization > Plan & billing), free (from Protyus) or invoiced (paid by invoice to Protyus)."},"ended":{"type":"boolean","title":"Ended","description":"Whether a free or invoiced licence has passed its end date. The company becomes read-only on read_only_from unless it's renewed."},"users":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Users","description":"How many users the plan allows: members plus pending invitations."},"analyses_per_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Analyses Per Month","description":"How many distinct parts the plan analyses in a billing month; while trialing, the trial's in all."},"period_ends_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Period Ends At","description":"When the current billing period ends, if there is one."},"trial_ends_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Trial Ends At","description":"When the trial ends, while trialing."},"read_only_from":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Read Only From","description":"While past due: when the company becomes read-only unless the payment goes through. Once a free or invoiced licence has ended: when it becomes read-only unless it's renewed."},"free_until":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Free Until","description":"When a free or invoiced licence from Protyus ends. Null if it doesn't."},"entitlements":{"items":{"$ref":"#/components/schemas/EntitlementOut"},"type":"array","title":"Entitlements","description":"Everything the licence allows, one entry each: the plan's, or the trial's while trialing. Empty with no licence or read-only."}},"additionalProperties":false,"type":"object","required":["state","plan","plan_name","free","licence_type","ended","users","analyses_per_month","period_ends_at","trial_ends_at","read_only_from","free_until","entitlements"],"title":"LicenceOut","description":"The company's licence: its billing state and the dates that matter to it."},"LineAmount":{"properties":{"key":{"type":"string","title":"Key","description":"Which line."},"label":{"type":"string","title":"Label","description":"Its name for people."},"amount":{"type":"number","title":"Amount","description":"US dollars: per order + per batch x batches + per part x quantity, to the cent."},"machine":{"anyOf":[{"$ref":"#/components/schemas/CostLineMachine"},{"type":"null"}],"description":"The machine the line runs on, as its cost line names it: a route over two machines has a line of each key on each. Null in a milling estimate."}},"additionalProperties":false,"type":"object","required":["key","label","amount"],"title":"LineAmount","description":"What one cost line comes to at one quantity."},"LineTools":{"properties":{"line":{"type":"string","title":"Line","description":"The line's id."},"setup":{"type":"integer","title":"Setup","description":"The setup it's in."},"kind":{"type":"string","title":"Kind","description":"What it is, such as walls."},"manual":{"type":"boolean","title":"Manual","description":"Whether its tool was chosen by hand."},"current":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Current","description":"The key of the tool it uses now, or null where that tool isn't one it may take by hand, such as one ground to order."},"max_diameter_in":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Diameter In","description":"The largest tool diameter its feature allows, inches. Null for no limit."},"required_flute_length_in":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Required Flute Length In","description":"How far its tool has to reach, inches. Null where it needs none to speak of."},"tools":{"items":{"$ref":"#/components/schemas/ToolChoice"},"type":"array","title":"Tools","description":"The tools it may take, the organization's first, each group largest first."}},"additionalProperties":false,"type":"object","required":["line","setup","kind","manual","current","max_diameter_in","required_flute_length_in","tools"],"title":"LineTools","description":"The tools valid for one Time tab line, the organization's first."},"LiningThread":{"properties":{"major_diameter":{"type":"number","title":"Major Diameter","description":"Its major diameter, mm."},"minor_diameter":{"type":"number","title":"Minor Diameter","description":"Its minor diameter, mm."},"pitch":{"type":"number","title":"Pitch","description":"How far it climbs a turn, mm."},"internal":{"type":"boolean","title":"Internal","description":"Whether it's cut into a bore, rather than round a shaft or stud."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces, which aren't the hole's."}},"type":"object","required":["major_diameter","minor_diameter","pitch","internal","surfaces"],"title":"LiningThread","description":"The modeled thread lining a hole."},"LinkConfig":{"properties":{"form":{"$ref":"#/components/schemas/FormFields","description":"Which fields the lead form asks for.","default":{"email":"required","first_name":"required","last_name":"required","company":"optional","phone":"off","due_date":"off","notes":"off"}},"auto_send":{"type":"boolean","title":"Auto Send","description":"Email a quote at once when every part is clean. Default off: every submission is held for review.","default":false},"hold":{"$ref":"#/components/schemas/HoldRules","description":"When a quote is held for the team rather than sent.","default":{"min_score":80,"hold_on_flags":false,"hold_below_minimum_charge":false}},"sender_name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Sender Name","description":"The from name on every email. Null for the organization's name."},"reply_to":{"anyOf":[{"type":"string","maxLength":254,"pattern":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$"},{"type":"null"}],"title":"Reply To","description":"Where the lead's replies go. Null for the email of whoever made the link."},"notify":{"anyOf":[{"items":{"type":"string","maxLength":254,"pattern":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$"},"type":"array","maxItems":20,"minItems":1},{"type":"null"}],"title":"Notify","description":"Who's emailed of new submissions, held quotes and a paused link. Null for whoever made the link."},"logo_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Logo Url","description":"An https URL to the logo heading the emails and the upload page. Null for the organization's."},"templates":{"$ref":"#/components/schemas/Templates","description":"The link's own email templates, each null for the organization's.","default":{"acknowledgement":{},"quote":{},"decline":{}}},"privacy_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Privacy Url","description":"The privacy policy the lead form's consent box links to. Null for the organization's."},"daily_cap":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Daily Cap","description":"How many submissions a day before the link pauses itself. Default 25.","default":25},"allowed_domains":{"items":{"type":"string","maxLength":253,"pattern":"^([A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+[A-Za-z]{2,63}$"},"type":"array","maxItems":100,"title":"Allowed Domains","description":"Only email addresses at these domains may use the link, such as bigcustomer.com. Empty for any.","default":[]},"blocked_domains":{"items":{"type":"string","maxLength":253,"pattern":"^([A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+[A-Za-z]{2,63}$"},"type":"array","maxItems":500,"title":"Blocked Domains","description":"Email domains refused, on top of Protyus's list of throwaway ones. Empty for none.","default":[]}},"additionalProperties":false,"type":"object","title":"LinkConfig","description":"A submission link's settings. Every field has a default; a field left out takes it."},"LiveCut":{"properties":{"kind":{"type":"string","enum":["c_index","live_drill","live_mill","y_mill"],"title":"Kind","description":"c_index: the C axis turns the part to an angle and holds it; live_drill: a live drill along the axis or square to it; live_mill: a live end mill; y_mill: a live tool moved off center by the Y axis."},"features":{"items":{"type":"string"},"type":"array","title":"Features","description":"The milled features it makes, by id, such as M2; for c_index, those cut at its angle."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Their faces; none for c_index. An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."},"direction":{"type":"string","enum":["axial","radial"],"title":"Direction","description":"axial: the tool along the turning axis, into an end; radial: square to it, pointing at it."},"c_angle":{"type":"number","title":"C Angle","description":"The angle around the axis it cuts at, in degrees."},"y_offset":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"How far off center the Y axis moves the tool; null where it needs none."},"tool":{"anyOf":[{"$ref":"#/components/schemas/LiveTool"},{"type":"null"}],"description":"Its tool; null for c_index."},"assumed":{"type":"boolean","title":"Assumed","description":"Whether the tool is a stand-in."}},"type":"object","required":["kind","features","surfaces","direction","c_angle","assumed"],"title":"LiveCut","description":"One cut of a mill-turn's live tools, or the C axis turning the part to the angle the next ones cut at."},"LiveTool":{"properties":{"type":{"type":"string","enum":["drill","flat end mill"],"title":"Type","description":"Its tool type, as the tool library names it."},"description":{"type":"string","title":"Description","description":"What it is."},"diameter":{"$ref":"#/components/schemas/TurnLength","description":"Its diameter."}},"type":"object","required":["type","description","diameter"],"title":"LiveTool","description":"A live tool: a stand-in drill or end mill in the mill-turn's turret."},"LongReachLimits":{"properties":{"max_ratio":{"type":"number","maximum":10.0,"minimum":2.0,"title":"Max Ratio","description":"Largest ratio of depth to tool diameter before it's flagged. Default 4.","default":4}},"additionalProperties":false,"type":"object","title":"LongReachLimits","description":"When a corner needs a long tool."},"Machine":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name","description":"What the shop calls it, such as Haas VF-2 #3."},"machine_class":{"type":"string","enum":["3_axis","4_axis","3_2","5_axis","lathe","mill_turn"],"title":"Machine Class","description":"Its class: 3_axis, 4_axis, 3_2 or 5_axis for a mill, lathe or mill_turn for a turning machine. Fills in every empty field. Each class takes only its own fields, which GET /api/v1/machine-classes lists: a lathe has no max tilt, and a mill no turret."},"make":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Make","description":"Its maker, such as Haas."},"model":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Model","description":"Its model, such as VF-2."},"generic":{"type":"boolean","title":"Generic","description":"Whether Protyus made it as the organization's stand-in for its class.","default":false},"rapid_mm_min":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Rapid Mm Min","description":"Rapid traverse rate, mm per minute."},"rapid_accel_g":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Rapid Accel G","description":"Rapid acceleration, in g."},"rotary_rapid_deg_s":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Rotary Rapid Deg S","description":"Rotary axis rapid, degrees per second."},"index_s":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Index S","description":"Time to index 90 degrees and clamp, seconds."},"max_tilt_deg":{"anyOf":[{"type":"number","maximum":90.0,"minimum":0.0},{"type":"null"}],"title":"Max Tilt Deg","description":"How far one clamping leans the tool from straight down, degrees. Planning uses it."},"travel_x":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Travel X","description":"X travel, mm."},"travel_y":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Travel Y","description":"Y travel, mm. A mill-turn's is its live tools' Y axis."},"travel_z":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Travel Z","description":"Z travel, mm."},"spindle_max_rpm":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Spindle Max Rpm","description":"Top spindle speed, rpm."},"spindle_hp":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Spindle Hp","description":"Spindle power, peak, horsepower."},"spindle_torque_nm":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Spindle Torque Nm","description":"Spindle torque, N·m."},"taper":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Taper","description":"Spindle taper, such as CAT40, BT30 or HSK63, which says which holders fit."},"magazine_size":{"anyOf":[{"type":"integer","maximum":1000.0,"minimum":1.0},{"type":"null"}],"title":"Magazine Size","description":"How many tools the magazine holds."},"tool_change_s":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Tool Change S","description":"Chip-to-chip tool change time, seconds."},"has_tool_setter":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Tool Setter","description":"Whether it has a tool setter."},"has_spindle_probe":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Spindle Probe","description":"Whether it has a spindle probe."},"loaded_tools_collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Loaded Tools Collection Id","description":"The tool collection kept in its magazine. It's kept for reference: analyses don't plan from it yet."},"max_swing":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Max Swing","description":"Lathes and mill-turns: the largest diameter that swings over the bed, mm."},"max_turning_length":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Max Turning Length","description":"Lathes and mill-turns: the longest length it turns, mm."},"bar_capacity":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Bar Capacity","description":"Lathes and mill-turns: the largest bar through the spindle, mm."},"chuck_size":{"anyOf":[{"type":"number","minimum":0.0,"unit":"mm"},{"type":"null"}],"title":"Chuck Size","description":"Lathes and mill-turns: the standard chuck's size, mm, such as 210 for an 8.3 in chuck."},"turret_stations":{"anyOf":[{"type":"integer","maximum":200.0,"minimum":1.0},{"type":"null"}],"title":"Turret Stations","description":"Lathes and mill-turns: how many tools its turret holds, or its tool changer on a mill-turn that has one."},"turret_index_s":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Turret Index S","description":"Lathes and mill-turns: time to index the turret one station, seconds."},"has_tailstock":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Tailstock","description":"Lathes and mill-turns: whether it has a tailstock to hold a long part's end."},"has_bar_feeder":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Bar Feeder","description":"Lathes and mill-turns: whether a bar feeder feeds it."},"live_tool_max_rpm":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Live Tool Max Rpm","description":"Mill-turns: the live tools' top speed, rpm."},"live_tool_hp":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"null"}],"title":"Live Tool Hp","description":"Mill-turns: the live tools' power, peak, horsepower."},"has_c_axis":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has C Axis","description":"Mill-turns: whether the spindle indexes as a C axis for milling and drilling."},"has_y_axis":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Y Axis","description":"Mill-turns: whether the live tools move off the spindle's center on a Y axis."},"has_sub_spindle":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Sub Spindle","description":"Mill-turns: whether a second spindle takes the part to cut its back."},"has_b_axis":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has B Axis","description":"Mill-turns: whether a milling head tilts on a B axis, as a multitasking machine's does (an INTEGREX, MULTUS or NTX). One without is a lathe with live tools, Auto's first route where they reach every feature; one with is a mill-turn, which Auto never picks."},"hourly_rate":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Hourly Rate","description":"Machine hourly rate, US dollars, with overhead and without the operator."},"labour_rate":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Labour Rate","description":"Blended labour rate for this machine, US dollars per hour: one rate for setting it up, loading and unloading parts and running it. Empty uses the organization's operator and setup rates if it set them, else the class's."},"operators_per_machine":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Operators Per Machine","description":"Operators per machine while it cuts, such as 0.5 when one operator runs two machines. Empty uses the class's."},"overhead_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Overhead Pct","description":"Overhead for this machine, in percent of machine and labour time, as its own cost line. Empty uses the organization's overhead if it set one, else the class's."}},"additionalProperties":false,"type":"object","required":["name","machine_class"],"title":"Machine","description":"One of an organization's real machines. Leave a field empty to use its class's value."},"MachineClassOut":{"properties":{"key":{"type":"string","enum":["3_axis","4_axis","3_2","5_axis","lathe","mill_turn"],"title":"Key","description":"The class's key."},"label":{"type":"string","title":"Label","description":"What the screen calls it."},"process":{"type":"string","enum":["milling","turning"],"title":"Process","description":"What it does: milling for a mill, which an analysis plans milling on; turning for a lathe or mill-turn, which is never a milling plan's machine."},"description":{"type":"string","title":"Description","description":"What it can reach in one clamping."},"fields":{"items":{"$ref":"#/components/schemas/MachineField"},"type":"array","title":"Fields","description":"Its machines' fields, in the screen's order, each with what the screen calls it. A machine of this class takes no others."},"values":{"additionalProperties":true,"type":"object","title":"Values","description":"Its default for each field it fills in. A field it lacks is left empty."}},"additionalProperties":false,"type":"object","required":["key","label","process","description","fields","values"],"title":"MachineClassOut","description":"A machine class and the values it fills in."},"MachineEdit":{"properties":{"machine":{"$ref":"#/components/schemas/Machine","description":"Every field after the change. Leave a field empty to use the class's value."},"base_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Base Revision Id","description":"The revision this edit was made from. If the machine has changed since, it's refused with REVISION_CONFLICT."}},"additionalProperties":false,"type":"object","required":["machine"],"title":"MachineEdit","description":"A machine's new state. It becomes a new revision."},"MachineField":{"properties":{"field":{"type":"string","title":"Field","description":"The field, as in the machine's schema."},"label":{"type":"string","title":"Label","description":"What the screen calls it."},"unit":{"type":"string","title":"Unit","description":"Its unit, or empty."}},"additionalProperties":false,"type":"object","required":["field","label","unit"],"title":"MachineField","description":"One field a class's machines have, as the screen names it."},"MachineFromReference":{"properties":{"reference":{"type":"string","maxLength":80,"minLength":1,"title":"Reference","description":"The reference machine's key, from GET /api/v1/reference-machines, such as haas-vf-2."},"name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Name","description":"What the shop calls it, such as Haas VF-2 #3. Empty uses the model's name."}},"additionalProperties":false,"type":"object","required":["reference"],"title":"MachineFromReference","description":"A machine to add, filled in from a reference machine."},"MachineIds":{"properties":{"ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":500,"minItems":1,"title":"Ids","description":"The machines' library item ids, from GET /api/v1/organization/machines."}},"additionalProperties":false,"type":"object","required":["ids"],"title":"MachineIds","description":"The machines to hide, show or reset."},"MachineImportPreview":{"properties":{"format":{"type":"string","enum":["csv","xlsx"],"title":"Format","description":"csv or xlsx."},"file_name":{"type":"string","title":"File Name","description":"The file's name."},"sheets":{"items":{"type":"string"},"type":"array","title":"Sheets","description":"For an XLSX, every sheet in it. Empty for a CSV."},"sheet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sheet","description":"For an XLSX, the sheet read."},"header_row":{"type":"integer","title":"Header Row","description":"The row the headers were read from, numbered as the spreadsheet numbers it."},"columns":{"items":{"$ref":"#/components/schemas/ColumnRead"},"type":"array","title":"Columns","description":"Every column header, in the sheet's order, with the field it was read as."},"notes":{"items":{"type":"string"},"type":"array","title":"Notes","description":"What the import does with the file as a whole, in words a person can read."},"counts":{"additionalProperties":{"type":"integer"},"type":"object","title":"Counts","description":"How many rows have each status: new, changed, unchanged and invalid."},"defaults":{"additionalProperties":{"anyOf":[{"type":"string","enum":["add","update","skip"]},{"type":"null"}]},"type":"object","title":"Defaults","description":"The default action for each status."},"rows":{"items":{"$ref":"#/components/schemas/MachineImportRow"},"type":"array","title":"Rows","description":"Every row of the table, in the sheet's order."}},"additionalProperties":false,"type":"object","required":["format","file_name","sheets","sheet","header_row","columns","notes","counts","defaults","rows"],"title":"MachineImportPreview","description":"What importing a machine spreadsheet would do."},"MachineImportRow":{"properties":{"row":{"type":"integer","title":"Row","description":"Its row number in the sheet, as the spreadsheet numbers it. Send it in a commit's actions to change what happens to it."},"status":{"type":"string","enum":["new","changed","unchanged","invalid"],"title":"Status","description":"new (no machine has its name), changed, unchanged, or invalid with the reason."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The machine's name, if the row has one."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Why it's invalid, in words a person can read."},"notes":{"items":{"type":"string"},"type":"array","title":"Notes","description":"What the import did with the row's values, such as a tilt left out."},"changed":{"items":{"type":"string"},"type":"array","title":"Changed","description":"For a changed machine, what the screen calls each value that changes."},"machine":{"anyOf":[{"$ref":"#/components/schemas/Machine"},{"type":"null"}],"description":"The machine as it would be stored, in mm. Null when invalid."},"match_item_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Match Item Id","description":"The machine it updates, matched by name."},"action":{"anyOf":[{"type":"string","enum":["add","update","skip"]},{"type":"null"}],"title":"Action","description":"What committing does with it unless told otherwise. Null for an invalid row."},"choices":{"items":{"type":"string","enum":["add","update","skip"]},"type":"array","title":"Choices","description":"The actions this row can take."}},"additionalProperties":false,"type":"object","required":["row","status","name","reason","notes","changed","machine","match_item_id","action","choices"],"title":"MachineImportRow","description":"One row of the sheet, what it is, and what committing does with it by default."},"MachineOut":{"properties":{"id":{"type":"string","title":"Id","description":"The machine type's id, as analyses take it, such as 3_axis."},"label":{"type":"string","title":"Label","description":"Its name for people, such as 3-axis."},"description":{"type":"string","title":"Description","description":"What it can reach in one clamping."},"default":{"type":"boolean","title":"Default","description":"Whether an analysis uses it when none is given."}},"additionalProperties":false,"type":"object","required":["id","label","description","default"],"title":"MachineOut","description":"A machine type an analysis can plan for."},"MachineValue":{"properties":{"field":{"type":"string","title":"Field","description":"The field, as in the machine's schema."},"label":{"type":"string","title":"Label","description":"What the screen calls it."},"unit":{"type":"string","title":"Unit","description":"Its unit, or empty."},"value":{"title":"Value","description":"The value, or null when neither the machine nor its class has one."},"from_class":{"type":"boolean","title":"From Class","description":"True for the class's default, as the machine leaves it empty; false for the machine's own."}},"type":"object","required":["field","label","unit","value","from_class"],"title":"MachineValue","description":"One of a machine's values, and whether it's the machine's own or its class's default."},"Material-Input":{"properties":{"reference":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Reference","description":"The reference grade it offers, such as 6061. Null for a custom grade."},"name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Name","description":"A custom grade's name. Ignored for a reference grade, which keeps its own."},"cutting_group":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Cutting Group","description":"A custom grade's cutting group: one a reference grade uses, such as N1.2.Z.AG. Required for a custom grade."},"family":{"anyOf":[{"type":"string","enum":["metal","plastic"]},{"type":"null"}],"title":"Family","description":"A custom grade's family. A reference grade keeps its own."},"stock_price":{"anyOf":[{"type":"number","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Stock Price","description":"The shop's raw stock price, US dollars per kg, whatever the form. Needs price_as_of. Null uses Protyus's list price."},"price_as_of":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Price As Of","description":"When the stock price was set."},"form_factors":{"$ref":"#/components/schemas/FormFactors","description":"What scales the stock price for each stock form: a piece costs its weight x the price x its form's factor. Each 1.0 unless set."}},"additionalProperties":false,"type":"object","title":"Material","description":"A grade the organization offers: a reference grade, or a custom one that names the cutting group it machines like."},"MaterialEdit":{"properties":{"material":{"$ref":"#/components/schemas/Material-Input","description":"Every field after the change."},"base_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Base Revision Id","description":"The revision this edit was made from, to refuse it with REVISION_CONFLICT if it changed since."}},"additionalProperties":false,"type":"object","required":["material"],"title":"MaterialEdit","description":"A grade's new state. It becomes a new revision."},"MaterialImportPreview":{"properties":{"format":{"type":"string","enum":["csv","xlsx"],"title":"Format","description":"csv or xlsx."},"file_name":{"type":"string","title":"File Name","description":"The file's name."},"sheets":{"items":{"type":"string"},"type":"array","title":"Sheets","description":"For an XLSX, every sheet in it. Empty for a CSV."},"sheet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sheet","description":"For an XLSX, the sheet read."},"header_row":{"type":"integer","title":"Header Row","description":"The row the headers were read from, numbered as the spreadsheet numbers it."},"columns":{"items":{"$ref":"#/components/schemas/ColumnRead"},"type":"array","title":"Columns","description":"Every column header, in the sheet's order, with the field it was read as."},"notes":{"items":{"type":"string"},"type":"array","title":"Notes","description":"What the import does with the file as a whole, in words a person can read."},"counts":{"additionalProperties":{"type":"integer"},"type":"object","title":"Counts","description":"How many rows have each status: new, changed, unchanged and invalid."},"defaults":{"additionalProperties":{"anyOf":[{"type":"string","enum":["add","update","skip"]},{"type":"null"}]},"type":"object","title":"Defaults","description":"The default action for each status."},"rows":{"items":{"$ref":"#/components/schemas/MaterialImportRow"},"type":"array","title":"Rows","description":"Every row of the table, in the sheet's order."}},"additionalProperties":false,"type":"object","required":["format","file_name","sheets","sheet","header_row","columns","notes","counts","defaults","rows"],"title":"MaterialImportPreview","description":"What importing a material spreadsheet would do."},"MaterialImportRow":{"properties":{"row":{"type":"integer","title":"Row","description":"Its row number in the sheet, as the spreadsheet numbers it. Send it in a commit's actions to change what happens to it."},"status":{"type":"string","enum":["new","changed","unchanged","invalid"],"title":"Status","description":"new (a grade the organization doesn't offer yet), changed, unchanged, or invalid with the reason."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The grade's name: the reference grade's own, or the custom name."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"The reference grade it was read as, by key, or null for a custom grade."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Why it's invalid, in words a person can read."},"notes":{"items":{"type":"string"},"type":"array","title":"Notes","description":"How the row was read, such as the reference grade a name was taken as."},"changed":{"items":{"type":"string"},"type":"array","title":"Changed","description":"For a changed grade, what the screen calls each value that changes."},"material":{"anyOf":[{"$ref":"#/components/schemas/library__materials__Material"},{"type":"null"}],"description":"The grade as it would be stored, its price in US dollars per kg. Null when invalid."},"match_item_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Match Item Id","description":"The grade it updates."},"action":{"anyOf":[{"type":"string","enum":["add","update","skip"]},{"type":"null"}],"title":"Action","description":"What committing does with it unless told otherwise. Null for an invalid row."},"choices":{"items":{"type":"string","enum":["add","update","skip"]},"type":"array","title":"Choices","description":"The actions this row can take."}},"additionalProperties":false,"type":"object","required":["row","status","name","reference","reason","notes","changed","material","match_item_id","action","choices"],"title":"MaterialImportRow","description":"One row of the sheet, what it is, and what committing does with it by default."},"MeasureInfo":{"properties":{"key":{"type":"string","title":"Key","description":"Its key, for measure in query_metrics."},"label":{"type":"string","title":"Label","description":"Its name."},"unit":{"type":"string","title":"Unit","description":"What its values are in: count, score (0 to 100), usd, minutes or seconds."},"aggregation":{"type":"string","enum":["count","sum","average"],"title":"Aggregation","description":"How a group's value is made. Counts and sums add up across groups; averages don't."},"description":{"type":"string","title":"Description","description":"What it counts, in a sentence."},"permission":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Permission","description":"The permission it needs in the organization, such as usage:read, or null."},"available":{"type":"boolean","title":"Available","description":"Whether the caller may ask for it now."},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","description":"The dimensions it can be split by."},"filters":{"items":{"type":"string"},"type":"array","title":"Filters","description":"The filters it takes. Others are refused with UNSUPPORTED_COMBINATION."}},"additionalProperties":false,"type":"object","required":["key","label","unit","aggregation","description","permission","available","dimensions","filters"],"title":"MeasureInfo","description":"One measure the query can ask for."},"MeasureRef":{"properties":{"key":{"type":"string","title":"Key","description":"The measure's key, as asked for."},"label":{"type":"string","title":"Label","description":"Its name, for a card's heading."},"unit":{"type":"string","title":"Unit","description":"What each value is in: count, score (0 to 100), usd, minutes or seconds."}},"additionalProperties":false,"type":"object","required":["key","label","unit"],"title":"MeasureRef","description":"The measure a response holds."},"MemberAiAccessOut":{"properties":{"user_id":{"type":"string","title":"User Id","description":"The member's Clerk user id."},"ai_access":{"type":"boolean","title":"Ai Access","description":"Whether AI is switched on for them: on unless an admin switched it off."}},"additionalProperties":false,"type":"object","required":["user_id","ai_access"],"title":"MemberAiAccessOut","description":"Whether Protyus AI is switched on for one member: on unless an admin switched it off."},"MemberOut":{"properties":{"user_id":{"type":"string","title":"User Id","description":"Their Clerk user id."},"role":{"type":"string","enum":["admin","member"],"title":"Role","description":"Their role in the organization."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Their email address, if Clerk shares it."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Their name, if they gave one."},"can_create_projects":{"type":"boolean","title":"Can Create Projects","description":"Whether they may create projects. Admins always may."},"roles":{"items":{"type":"string"},"type":"array","title":"Roles","description":"The role keys they hold at organization scope, from GET /api/v1/roles, default roles included. An admin holds every permission whatever this says."},"ai_access":{"type":"boolean","title":"Ai Access","description":"Whether Protyus AI is switched on for them: on unless an admin switched it off (see `ai` on GET /api/v1/me).","default":true}},"additionalProperties":false,"type":"object","required":["user_id","role","email","name","can_create_projects","roles"],"title":"MemberOut","description":"A person in the organization."},"MemberRoleIn":{"properties":{"role":{"type":"string","enum":["admin","member"],"title":"Role","description":"admin to make them an admin, member to make them a member."}},"additionalProperties":false,"type":"object","required":["role"],"title":"MemberRoleIn","description":"Whether someone is an admin or a member of the organization."},"MemberRolesOut":{"properties":{"user_id":{"type":"string","title":"User Id","description":"Their Clerk user id."},"scope":{"type":"string","enum":["organization","project"],"title":"Scope","description":"The scope these roles apply to."},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"The project, or null at organization scope."},"roles":{"items":{"type":"string"},"type":"array","title":"Roles","description":"The role keys they now hold at this scope, default roles included at organization scope."}},"additionalProperties":false,"type":"object","required":["user_id","scope","project_id","roles"],"title":"MemberRolesOut","description":"A person's roles at one scope, after a grant or revoke."},"MemberSettingsIn":{"properties":{"can_create_projects":{"type":"boolean","title":"Can Create Projects","description":"Whether this member may create projects."}},"additionalProperties":false,"type":"object","required":["can_create_projects"],"title":"MemberSettingsIn","description":"What an admin may change about a member."},"Mesh":{"properties":{"positions":{"items":{"type":"number"},"type":"array","title":"Positions","description":"Vertex positions, x, y, z after one another, in mm."},"indices":{"items":{"type":"integer"},"type":"array","title":"Indices","description":"Three vertex indices a triangle."}},"type":"object","required":["positions","indices"],"title":"Mesh","description":"One face as triangles, for drawing it."},"MetricFilters":{"properties":{"from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From","description":"The first day counted, inclusive: an ISO date such as 2026-11-01, or today, yesterday or -Nd for N days before today, such as -30d. Days are UTC. Omit for no first day."},"to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To","description":"The last day counted, inclusive, in the same forms as from. Omit for no last day."},"project_id":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Project Id","description":"A project id, or a list of them. A project you can't see counts nothing."},"person_id":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Person Id","description":"A Clerk user id, or a list: only what those people did."},"machine":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Machine","description":"A machine id, or a list, from GET /api/v1/organization/machines: only analyses planned for it."},"material":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Material","description":"A material id, or a list, from GET /api/v1/organization/materials: only analyses that picked it."},"verdict":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Verdict","description":"can_be_made or cant_be_made, or a list: only parts with that verdict."},"severity":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Severity","description":"hard_fail (Blocker), scored (Risk) or flag_only (Consider), or a list: only findings that serious. For analysis measures, only analyses with such a finding."},"finding":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Finding","description":"A finding's rule, such as deep_hole, or a list: only findings of that kind. For analysis measures, only analyses with such a finding."},"outcome":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Outcome","description":"won, lost or open, or a list: only quotes whose lead is marked won or lost, or open (neither, or a quote made for no lead). For quotes and quote_value."}},"additionalProperties":false,"type":"object","title":"MetricFilters","description":"What to count. Every filter is optional; those given all apply. Call list_metrics for which filters each measure takes."},"MetricsCatalog":{"properties":{"measures":{"items":{"$ref":"#/components/schemas/MeasureInfo"},"type":"array","title":"Measures","description":"Every measure, with the dimensions and filters it takes."},"dimensions":{"items":{"$ref":"#/components/schemas/DimensionInfo"},"type":"array","title":"Dimensions","description":"Every dimension."},"filters":{"items":{"$ref":"#/components/schemas/FilterInfo"},"type":"array","title":"Filters","description":"Every filter."},"max_dimensions":{"type":"integer","title":"Max Dimensions","description":"The most dimensions one query may ask for."},"combinations":{"type":"string","title":"Combinations","description":"Which dimensions can be asked for together."}},"additionalProperties":false,"type":"object","required":["measures","dimensions","filters","max_dimensions","combinations"],"title":"MetricsCatalog","description":"Everything query_metrics can ask for, so an agent can build a query without guessing."},"MetricsQuery":{"properties":{"measure":{"type":"string","title":"Measure","description":"What to count or average: analyses, parts_cant_be_made, findings, average_score, quotes, quote_value, won_value, leads_won, cycle_time, compute_seconds or ai_messages. list_metrics describes each, with its unit."},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","description":"Up to two dimensions to split it by, at most one of them time: day, week or month; project, person, machine, material, verdict, severity, finding, outcome or source. Empty for one total.","default":[]},"filters":{"$ref":"#/components/schemas/MetricFilters","description":"What to count. Omit for everything you can see.","default":{}},"limit":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Limit","description":"The most groups to return. With only category dimensions, the largest rows are kept; with only time, the latest buckets; with time and a category, the largest categories, each with every bucket it has. truncated says whether any were cut.","default":100}},"additionalProperties":false,"type":"object","required":["measure"],"title":"MetricsQuery","description":"One measure, split by up to two dimensions, over what the filters pick."},"MetricsResult":{"properties":{"measure":{"$ref":"#/components/schemas/MeasureRef","description":"What was measured, and its unit."},"dimensions":{"items":{"$ref":"#/components/schemas/DimensionRef"},"type":"array","title":"Dimensions","description":"The dimensions it's split by, in the order asked for. Empty for one total."},"rows":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Rows","description":"One row per group: each dimension's key with its value (an ISO date for time, an {id, label} object for a category, where id is null for analyses that don't record it), and value, in the measure's unit. Sorted by time, oldest first, or by value, largest first, for category dimensions alone. Groups with nothing in them are left out. With no dimensions, one row holding the total, or none when nothing matched."},"total":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Total","description":"The measure over everything the filters pick, rows cut by limit included: a sum or count, or for an average the average over all of it. 0 when nothing matched."},"filters":{"additionalProperties":true,"type":"object","title":"Filters","description":"The filters applied, as asked for, with from and to as the ISO dates they meant."},"truncated":{"type":"boolean","title":"Truncated","description":"Whether limit cut any groups from rows."}},"additionalProperties":false,"type":"object","required":["measure","dimensions","rows","total","filters","truncated"],"title":"MetricsResult","description":"A measure's values, one row per group, describing itself so a card can draw it."},"MillDefaults":{"properties":{"sfm":{"type":"number","title":"Sfm","description":"Surface speed, SFM."},"ae_pct":{"type":"number","title":"Ae Pct","description":"Radial width of cut, percent of the tool's diameter."},"ap_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ap Pct","description":"Axial depth of cut, percent of the tool's diameter. It can be over 100, deeper than a shop's own may be set. Null where it isn't a share of the diameter: default_notes says what it is."}},"additionalProperties":false,"type":"object","required":["sfm","ae_pct","ap_pct"],"title":"MillDefaults","description":"Protyus's numbers for one milling operation in one material."},"MillNumbers":{"properties":{"sfm":{"anyOf":[{"type":"number","maximum":10000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Sfm","description":"Surface speed, SFM. Null for Protyus's."},"ae_pct":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Ae Pct","description":"Radial width of cut, percent of the tool's diameter, up to 100. Null for Protyus's."},"ap_pct":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Ap Pct","description":"Axial depth of cut, percent of the tool's diameter, up to 100; never past the flute length. Null for Protyus's."}},"additionalProperties":false,"type":"object","title":"MillNumbers","description":"One milling operation's numbers in one material. A null field takes Protyus's."},"MillTurn":{"properties":{"available":{"type":"boolean","title":"Available","description":"Whether Auto may choose it."},"why_not":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Why Not","description":"Why it may not, in words; null where it may."},"machine":{"$ref":"#/components/schemas/MillTurnMachine","description":"The mill-turn it's planned on."},"operations":{"items":{"$ref":"#/components/schemas/MillTurnOperation"},"type":"array","title":"Operations","description":"Its operations in order; empty for a round part that isn't a lathe part."},"findings":{"items":{"$ref":"#/components/schemas/Finding"},"type":"array","title":"Findings","description":"What's hard to make on it, worst first: the lathe's findings on the mill-turn, and what its live tools can't reach."},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/ProcessScorecard"},{"type":"null"}],"description":"Whether it can be made on the mill-turn, and the DFM score; null for a round part that isn't a lathe part."},"estimate":{"anyOf":[{"$ref":"#/components/schemas/TurnEstimate"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Estimate","description":"Its time and cost on the mill-turn, or why there isn't one; null for a round part that isn't a lathe part."}},"type":"object","required":["available","machine","operations","findings"],"title":"MillTurn","description":"The part turned and milled in one holding on a mill-turn, and whether Auto may choose it."},"MillTurnMachine":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The shop's machine's id; null for a typical lathe."},"label":{"type":"string","title":"Label","description":"Its name."},"typical":{"type":"boolean","title":"Typical","description":"Whether it's a typical lathe on the Lathe class's values, because the project has none."},"has_c_axis":{"type":"boolean","title":"Has C Axis","description":"Whether it has a C axis to index the part for its live tools."},"has_y_axis":{"type":"boolean","title":"Has Y Axis","description":"Whether it has a Y axis, to move a live tool off center."},"has_sub_spindle":{"type":"boolean","title":"Has Sub Spindle","description":"Whether a sub-spindle takes the part for its back end."},"has_b_axis":{"type":"boolean","title":"Has B Axis","description":"Whether its milling head tilts on a B axis: a mill-turn, which Auto never picks. Without one it's a lathe with live tools.","default":false}},"type":"object","required":["label","typical","has_c_axis","has_y_axis","has_sub_spindle"],"title":"MillTurnMachine","description":"The mill-turn a part is planned on, and what it has."},"MillTurnOperation":{"properties":{"number":{"type":"integer","title":"Number","description":"10 or 20."},"from":{"type":"string","enum":["near","far"],"title":"From","description":"The end its tools come from: near is where the axis's `at` is 0."},"reasons":{"items":{"type":"string","enum":["back","blank"]},"type":"array","title":"Reasons","description":"Why Op 20 works the other end: back, a feature only that end reaches; blank, it was chucked from a sawn blank. Empty for Op 10."},"spindle":{"type":"string","enum":["main","sub"],"title":"Spindle","description":"The spindle that holds it: sub, the sub-spindle taking it from the main spindle in the same cycle."},"machine":{"$ref":"#/components/schemas/TurnMachine","description":"The mill-turn it runs on."},"holding":{"$ref":"#/components/schemas/TurnHolding","description":"How it holds the part."},"cuts":{"items":{"anyOf":[{"$ref":"#/components/schemas/TurnCut"},{"$ref":"#/components/schemas/LiveCut"}]},"type":"array","title":"Cuts","description":"Its cuts in order: the lathe's, then its live tools', before any part-off."}},"type":"object","required":["number","from","reasons","spindle","machine","holding","cuts"],"title":"MillTurnOperation","description":"A mill-turn operation: Op 10 on the main spindle, and Op 20 on the sub-spindle, or after the part is turned over."},"MilledFeature":{"properties":{"id":{"type":"string","title":"Id","description":"Its id in this analysis, such as M1."},"kind":{"type":"string","enum":["flat","keyway","pocket","cross_hole","off_axis_hole","other"],"title":"Kind","description":"What it looks like."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces. An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."}},"type":"object","required":["id","kind","surfaces"],"title":"MilledFeature","description":"Faces a lathe can't make, left for milling."},"MinWallThicknessLimits":{"properties":{"min_mm":{"type":"number","maximum":25.0,"exclusiveMinimum":0.0,"title":"Min Mm","description":"Minimum wall thickness, mm. A wall thinner than this is flagged and fails the thin-walls check. Default 0.79 mm, or 1.5 mm in a plastic. A value of your own holds for every material.","default":0.79}},"additionalProperties":false,"type":"object","title":"MinWallThicknessLimits","description":"The thinnest wall that can be machined at all."},"MouldAction":{"properties":{"id":{"type":"string","title":"Id","description":"A1, A2 and on, slides first."},"kind":{"type":"string","enum":["slide","lifter","strippable","complex"],"title":"Kind","description":"slide: steel moving out of the side of the mould; lifter: steel moving inward as the part is ejected; strippable: shallow enough to push the part off; complex: a collapsing or unscrewing core, or a design change."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces of its undercut."},"release":{"anyOf":[{"$ref":"#/components/schemas/MouldRelease"},{"type":"null"}],"description":"Which way it moves; null where no direction across the pull releases it."},"depth":{"$ref":"#/components/schemas/MouldLength","description":"How deep the undercut is along that direction."},"stroke":{"anyOf":[{"$ref":"#/components/schemas/MouldLength"},{"type":"null"}],"description":"A slide's stroke, a lifter's travel with the ejectors, or the ejection a strippable undercut needs; null for a complex action."},"explanation":{"type":"string","title":"Explanation","description":"What it is and why it needs this action, for people."}},"type":"object","required":["id","kind","surfaces","release","depth","stroke","explanation"],"title":"MouldAction","description":"A slide, lifter, strippable undercut or complex action, and the undercut it releases."},"MouldAmount":{"properties":{"value":{"type":"number","title":"Value","description":"The value."},"unit":{"type":"string","title":"Unit","description":"Its unit: in, in³, US ton, psi or circuits."}},"type":"object","required":["value","unit"],"title":"MouldAmount","description":"A value in the unit the press is rated in."},"MouldAnnual":{"properties":{"volume":{"type":"integer","title":"Volume","description":"Parts a year."},"hours":{"type":"number","title":"Hours","description":"Press hours a year, changeovers included."},"available_hours":{"type":"number","title":"Available Hours","description":"The press's hours a year."},"utilisation_pct":{"type":"number","title":"Utilisation Pct","description":"Hours over the press's hours, percent."},"changeovers":{"type":"integer","title":"Changeovers","description":"Changeovers a year: one a lot."},"state":{"type":"string","enum":["ok","busy","over"],"title":"State","description":"ok; busy over 80% of the press's hours; over 100%, when it needs more moulds or presses."},"cost":{"type":"number","title":"Cost","description":"US dollars a year."}},"type":"object","required":["volume","hours","available_hours","utilisation_pct","changeovers","state","cost"],"title":"MouldAnnual","description":"The press's hours a year at the annual volume."},"MouldCavities":{"properties":{"press":{"$ref":"#/components/schemas/MouldPress","description":"The press it's laid out on."},"chosen":{"type":"string","enum":["named","auto","smallest","largest"],"title":"Chosen","description":"named when the analysis chose the press; auto when it named none and it's the press that makes the part cheapest; smallest when it named none and it's the smallest that takes one cavity, as in older analyses or when the part can't be costed; largest when none takes one."},"runner":{"type":"string","enum":["cold","hot"],"title":"Runner","description":"The runner."},"recommended":{"type":"integer","title":"Recommended","description":"The most cavities that fit: the recommended count. 0 when one doesn't."},"limited_by":{"anyOf":[{"$ref":"#/components/schemas/MouldLimitedBy"},{"type":"null"}],"description":"What stops the next count; null when 64 fit."},"per_cavity":{"$ref":"#/components/schemas/MouldPerCavity","description":"The clamp and shot one cavity needs."},"layout":{"anyOf":[{"$ref":"#/components/schemas/MouldLayout"},{"type":"null"}],"description":"The recommended count laid out to scale, or the count that doesn't fit when none does."},"checks":{"items":{"$ref":"#/components/schemas/MouldCheck"},"type":"array","title":"Checks","description":"Each machine check at the count laid out, in IM-X order.","default":[]},"suggested":{"anyOf":[{"$ref":"#/components/schemas/MouldPress"},{"type":"null"}],"description":"When one cavity doesn't fit, the smallest of the presses that takes it."},"presses":{"items":{"$ref":"#/components/schemas/MouldPressFit"},"type":"array","title":"Presses","description":"Each of Protyus's five presses and how many cavities fit it.","default":[]}},"type":"object","required":["press","chosen","runner","recommended","per_cavity"],"title":"MouldCavities","description":"The cavities that fit the press."},"MouldCavityCost":{"properties":{"cavities":{"type":"integer","title":"Cavities","description":"Cavities a shot."},"shot_s":{"type":"number","title":"Shot S","description":"Seconds a shot."},"effective_s":{"type":"number","title":"Effective S","description":"Seconds a part, allowing for OEE and scrap."},"mould":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mould","description":"US dollars for the mould with this many cavities."},"each":{"type":"number","title":"Each","description":"US dollars a part, the mould included."},"annual_hours":{"type":"number","title":"Annual Hours","description":"Press hours a year."},"utilisation_pct":{"type":"number","title":"Utilisation Pct","description":"Of the press's hours, percent."}},"type":"object","required":["cavities","shot_s","effective_s","each","annual_hours","utilisation_pct"],"title":"MouldCavityCost","description":"The part at one cavity count."},"MouldCheck":{"properties":{"id":{"type":"string","title":"Id","description":"tie_bars, clamp, shot, injection_pressure, ejector_stroke, stack_height, opening_stroke or core_pulls."},"rule":{"type":"string","title":"Rule","description":"The machine fit rule it's under, IM-X-01 to IM-X-06."},"title":{"type":"string","title":"Title","description":"Its name."},"required":{"$ref":"#/components/schemas/MouldAmount","description":"What the part needs."},"offered":{"$ref":"#/components/schemas/MouldAmount","description":"What the press has."},"limit":{"$ref":"#/components/schemas/MouldAmount","description":"The most the press may be asked for, at its utilisation limit."},"least":{"anyOf":[{"$ref":"#/components/schemas/MouldAmount"},{"type":"null"}],"description":"The least it takes, for shot size and mould height."},"utilisation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Utilisation","description":"Required as a percentage of offered."},"pass":{"type":"boolean","title":"Pass","description":"True when it's within the press's limits."},"blocks":{"type":"boolean","title":"Blocks","description":"True when failing it stops the count: a short shot, a thin mould or too few core pulls don't."}},"type":"object","required":["id","rule","title","required","offered","limit","pass","blocks"],"title":"MouldCheck","description":"One machine check at the count shown."},"MouldComparison":{"properties":{"material":{"$ref":"#/components/schemas/MouldResin","description":"The resin."},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score","description":"The part's DFM score in it, 0 to 100; null when scoring is off."},"band":{"anyOf":[{"$ref":"#/components/schemas/Band"},{"type":"null"}],"description":"The score's colour."},"findings":{"$ref":"#/components/schemas/MouldCounts","description":"How many findings it raises in it, by level."}},"type":"object","required":["material","findings"],"title":"MouldComparison","description":"One resin's score on the part, for Compare materials."},"MouldCounts":{"properties":{"critical":{"type":"integer","title":"Critical","description":"Critical findings."},"major":{"type":"integer","title":"Major","description":"Major findings."},"minor":{"type":"integer","title":"Minor","description":"Minor findings."}},"type":"object","required":["critical","major","minor"],"title":"MouldCounts","description":"How many findings of each level."},"MouldCycle":{"properties":{"press":{"$ref":"#/components/schemas/MouldPress","description":"The press."},"cavities":{"type":"integer","title":"Cavities","description":"Cavities a shot."},"runner":{"type":"string","enum":["cold","hot"],"title":"Runner","description":"The runner."},"phases":{"items":{"$ref":"#/components/schemas/MouldPhase"},"type":"array","title":"Phases","description":"Each phase, in the order it runs; they add up to the shot cycle."},"governing":{"type":"string","title":"Governing","description":"The longest phase's id: usually cooling."},"recovery_limited":{"type":"boolean","title":"Recovery Limited","description":"Whether pack and screw recovery outlast cooling, so a faster screw, not a thinner wall, shortens the cycle."},"in_mould":{"$ref":"#/components/schemas/MouldInMould","description":"What sets the time in the mould after fill."},"shot_s":{"type":"number","title":"Shot S","description":"Seconds a shot: the shot cycle."},"per_part_s":{"type":"number","title":"Per Part S","description":"The shot cycle over the cavities: seconds a part, ideally."},"effective_s":{"type":"number","title":"Effective S","description":"Seconds a part allowing for the press's OEE and scrap."},"oee_pct":{"type":"number","title":"Oee Pct","description":"The press's overall equipment effectiveness, percent."},"scrap_pct":{"type":"number","title":"Scrap Pct","description":"The parts scrapped and remade, percent."}},"type":"object","required":["press","cavities","runner","phases","governing","recovery_limited","in_mould","shot_s","per_part_s","effective_s","oee_pct","scrap_pct"],"title":"MouldCycle","description":"The shot cycle on the press at the cavity count."},"MouldDepths":{"properties":{"cavity":{"$ref":"#/components/schemas/MouldLength","description":"H_A: how far the cavity side's faces run from the parting plane."},"core":{"$ref":"#/components/schemas/MouldLength","description":"H_B: how far the core side's faces run from it."},"height":{"$ref":"#/components/schemas/MouldLength","description":"The part's height along the pull."}},"type":"object","required":["cavity","core","height"],"title":"MouldDepths","description":"How deep the part runs into each half of the mould."},"MouldEstimate":{"properties":{"status":{"type":"string","title":"Status","description":"rough: a should-cost from Protyus's reference rates, not a shop's quote."},"material":{"$ref":"#/components/schemas/analyses__customer__Material","description":"The resin."},"quantity":{"type":"integer","title":"Quantity","description":"Parts in a lot: a month's run, and at least the order."},"batch":{"type":"integer","title":"Batch","description":"Parts a changeover: the lot."},"machine":{"$ref":"#/components/schemas/EstimateMachine","description":"The press."},"cavities":{"type":"integer","title":"Cavities","description":"Cavities a shot."},"cost_lines":{"items":{"$ref":"#/components/schemas/CostLine"},"type":"array","title":"Cost Lines","description":"Every cost line, as a quote prices them: material, machine time, operator, overhead, setup and tooling, the mould."},"cost":{"$ref":"#/components/schemas/Cost","description":"The totals for a lot; each to four places, as moulded parts cost cents."},"per_thousand":{"type":"number","title":"Per Thousand","description":"US dollars a thousand parts."},"annual":{"$ref":"#/components/schemas/MouldAnnual","description":"The press's hours and the cost a year."},"by_cavities":{"items":{"$ref":"#/components/schemas/MouldCavityCost"},"type":"array","title":"By Cavities","description":"The part at every balanced cavity count that fits, fewest first.","default":[]},"lowest_cost":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lowest Cost","description":"The cavities that make a part cheapest with its mould."},"volume_matched":{"type":"integer","title":"Volume Matched","description":"The fewest cavities whose hours are within 80% of the press's."},"mould":{"anyOf":[{"$ref":"#/components/schemas/MouldTool"},{"type":"null"}],"description":"The mould: its cost, what it's made of and what it's spread over."},"drying":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drying","description":"What the resin needs before it's moulded, such as Dry the ABS 3 h at 170 °F before moulding."},"presses":{"items":{"$ref":"#/components/schemas/MouldPressCost"},"type":"array","title":"Presses","description":"Each of Protyus's five presses at its most cavities.","default":[]},"assumptions":{"items":{"type":"string"},"type":"array","title":"Assumptions","description":"What it assumed, such as the default annual volume.","default":[]}},"type":"object","required":["status","material","quantity","batch","machine","cavities","cost_lines","cost","per_thousand","annual","volume_matched"],"title":"MouldEstimate","description":"A rough estimate on the press at a month's run of the annual volume, in milling's cost line shape, with a rough\nmould as its tooling line."},"MouldFinding":{"properties":{"rule":{"type":"string","title":"Rule","description":"Its rule, such as IM-W-01 (wall too thin) or IM-U-01 (slide required)."},"severity":{"type":"string","enum":["scored","flag_only"],"title":"Severity","description":"scored (costs score) or flag_only, shown as Consider (worth a look, never scored). A moulded part has a score and no verdict yet."},"level":{"type":"string","enum":["critical","major","minor"],"title":"Level","description":"How serious it is: critical would stop the part being moulded, major adds cost or risk, minor is advice."},"title":{"type":"string","title":"Title","description":"Its heading."},"explanation":{"type":"string","title":"Explanation","description":"What's wrong. Lengths in mm.","default":""},"fix":{"type":"string","title":"Fix","description":"What to change.","default":""},"fix_kind":{"type":"string","title":"Fix Kind","description":"What the fix asks of the design: easy (a radius or drill point a tool forms), model_only (the model changes, the made part doesn't), as_made (how it will be made, no design change) or none (the fix changes the part's form). Empty for analyses run before it was given.","default":""},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it's about.","default":[]},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"The edges it's about, where an edge is what's wrong, such as a sharp inside corner.","default":[]},"limit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit","description":"The limit it broke, or null."},"features":{"items":{"$ref":"#/components/schemas/FindingFeature"},"type":"array","title":"Features","description":"Each feature it's about, where it's about more than one.","default":[]},"measured":{"anyOf":[{"$ref":"#/components/schemas/MouldMeasure"},{"type":"null"}],"description":"What was measured, or null."},"threshold":{"anyOf":[{"$ref":"#/components/schemas/MouldLimit"},{"type":"null"}],"description":"What it was held to, or null."},"inch":{"anyOf":[{"$ref":"#/components/schemas/FindingInch"},{"type":"null"}],"description":"The same words with lengths in inches."}},"type":"object","required":["rule","severity","level","title"],"title":"MouldFinding","description":"One moulding finding, by its rule id."},"MouldFlow":{"properties":{"runner":{"type":"string","enum":["cold","hot"],"title":"Runner","description":"The runner."},"allowed":{"type":"string","enum":["parting_line","cavity_side"],"title":"Allowed","description":"Where a gate may go: on the parting line for a cold runner, anywhere on the cavity side for a hot one."},"gates":{"items":{"$ref":"#/components/schemas/MouldGate"},"type":"array","title":"Gates","description":"The gates, the fewest that keep the flow within the resin's limit, up to four; empty when none could be placed (IM-G-01).","default":[]},"length":{"anyOf":[{"$ref":"#/components/schemas/MouldLength"},{"type":"null"}],"description":"The longest flow from the gates."},"ratio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ratio","description":"The longest flow over the nominal wall."},"limit":{"type":"number","title":"Limit","description":"The resin's flow ratio limit."},"single":{"anyOf":[{"$ref":"#/components/schemas/MouldFlowLength"},{"type":"null"}],"description":"The longest flow from the best single gate, and its ratio."},"needed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Needed","description":"The gates it needs; null when four still leave the flow too long."},"within":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Within","description":"Whether the flow ratio is within the resin's limit."},"last_fill":{"anyOf":[{"$ref":"#/components/schemas/MouldLastFill"},{"type":"null"}],"description":"The point the flow reaches last."},"welds":{"items":{"$ref":"#/components/schemas/MouldWeld"},"type":"array","title":"Welds","description":"Where weld lines form.","default":[]}},"type":"object","required":["runner","allowed","limit"],"title":"MouldFlow","description":"The gates and the flow from them, estimated."},"MouldFlowLength":{"properties":{"length":{"$ref":"#/components/schemas/MouldLength","description":"The longest flow."},"ratio":{"type":"number","title":"Ratio","description":"The longest flow over the nominal wall."}},"type":"object","required":["length","ratio"],"title":"MouldFlowLength","description":"A flow length and its ratio to the wall."},"MouldGate":{"properties":{"id":{"type":"string","title":"Id","description":"G1, G2 and so on."},"point":{"items":{"type":"number"},"type":"array","title":"Point","description":"Where it is, mm, in the part's own axes."},"surface":{"type":"string","title":"Surface","description":"The face it's on."},"wall":{"$ref":"#/components/schemas/MouldLength","description":"The thickest wall it feeds."}},"type":"object","required":["id","point","surface","wall"],"title":"MouldGate","description":"One gate."},"MouldHistogram":{"properties":{"from":{"$ref":"#/components/schemas/MouldLength","description":"The first bin's start: the thinnest face."},"to":{"$ref":"#/components/schemas/MouldLength","description":"The last bin's end: the thickest face."},"area":{"items":{"type":"number"},"type":"array","title":"Area","description":"Percent of the area in each bin, thinnest first."}},"type":"object","required":["from","to","area"],"title":"MouldHistogram","description":"The part's area by thickness, in 50 equal bins from its thinnest face to its thickest."},"MouldInMould":{"properties":{"cooling_s":{"type":"number","title":"Cooling S","description":"Seconds the thickest wall takes to cool to ejection."},"pack_s":{"type":"number","title":"Pack S","description":"Seconds of pack and hold."},"recovery_s":{"type":"number","title":"Recovery S","description":"Seconds the screw takes to melt the next shot."},"cooled_by":{"type":"string","enum":["part","runner"],"title":"Cooled By","description":"part when the part's thickest wall sets the cooling; runner when a cold runner is slower."}},"type":"object","required":["cooling_s","pack_s","recovery_s","cooled_by"],"title":"MouldInMould","description":"What sets the time in the mould after fill: the longer of cooling, and pack and hold with screw recovery."},"MouldLastFill":{"properties":{"point":{"items":{"type":"number"},"type":"array","title":"Point","description":"Where it is, mm, in the part's own axes."},"surface":{"type":"string","title":"Surface","description":"The face it's on."},"on_parting_line":{"type":"boolean","title":"On Parting Line","description":"Whether it's at the parting line, where a vent lets the air out."},"off_line":{"$ref":"#/components/schemas/MouldLength","description":"How far it is from the parting line."}},"type":"object","required":["point","surface","on_parting_line","off_line"],"title":"MouldLastFill","description":"The point the flow reaches last."},"MouldLayout":{"properties":{"rows":{"type":"integer","title":"Rows","description":"Rows of cavities, across the part's footprint."},"columns":{"type":"integer","title":"Columns","description":"Columns, along its long side."},"cell":{"$ref":"#/components/schemas/MouldSize","description":"The room each cavity takes: the footprint and the spacing."},"part":{"$ref":"#/components/schemas/MouldSize","description":"The part's footprint in the parting plane."},"spacing":{"$ref":"#/components/schemas/MouldLength","description":"Steel between cavities."},"mould":{"$ref":"#/components/schemas/MouldSize","description":"The mould's plates."},"rotated":{"type":"boolean","title":"Rotated","description":"True when it loads turned a quarter, its height across the tie bars."},"cavities":{"items":{"$ref":"#/components/schemas/MouldPoint"},"type":"array","title":"Cavities","description":"Each cavity's centre."},"slides":{"items":{"$ref":"#/components/schemas/MouldSlideEnvelope"},"type":"array","title":"Slides","description":"Each slide's envelope, by the side it faces.","default":[]},"tie_bars":{"$ref":"#/components/schemas/MouldTieBars","description":"How far apart the press's tie bars stand."},"platen":{"$ref":"#/components/schemas/MouldPlaten","description":"The size of the press's platen."}},"type":"object","required":["rows","columns","cell","part","spacing","mould","rotated","cavities","tie_bars","platen"],"title":"MouldLayout","description":"The cavities laid out in the mould, to scale."},"MouldLength":{"properties":{"mm":{"type":"number","title":"Mm","description":"Millimetres."},"in":{"type":"number","title":"In","description":"Inches."}},"type":"object","required":["mm","in"],"title":"MouldLength","description":"A length in both units."},"MouldLimit":{"properties":{"value":{"$ref":"#/components/schemas/MouldLength","description":"What it's held to."},"kind":{"type":"string","enum":["at_least","at_most"],"title":"Kind","description":"at_least or at_most: no less or no more than it."}},"type":"object","required":["value","kind"],"title":"MouldLimit","description":"What a finding held the part to."},"MouldLimitedBy":{"properties":{"cavities":{"type":"integer","title":"Cavities","description":"The count that doesn't fit."},"check":{"type":"string","title":"Check","description":"The check it fails first: tie_bars, clamp, shot, injection_pressure, ejector_stroke, stack_height, opening_stroke, or layout when its slides can't all face out."},"required":{"anyOf":[{"$ref":"#/components/schemas/MouldAmount"},{"type":"null"}],"description":"What that count needs."},"limit":{"anyOf":[{"$ref":"#/components/schemas/MouldAmount"},{"type":"null"}],"description":"What the press allows."},"text":{"type":"string","title":"Text","description":"In a sentence, such as 4 cavities need 174.0 tons of clamp, limit 99.0 tons."}},"type":"object","required":["cavities","check","text"],"title":"MouldLimitedBy","description":"What stops the next cavity count."},"MouldMeasure":{"properties":{"min":{"$ref":"#/components/schemas/MouldLength","description":"The least measured."},"max":{"$ref":"#/components/schemas/MouldLength","description":"The most."}},"type":"object","required":["min","max"],"title":"MouldMeasure","description":"What a finding measured on the part."},"MouldParting":{"properties":{"plane":{"anyOf":[{"$ref":"#/components/schemas/MouldPlane"},{"type":"null"}],"description":"The parting plane, square to the pull: where the parting line runs flat, or where it was set by hand. Null where no flat plane holds the line, which is then the parting line alone."},"offset":{"$ref":"#/components/schemas/MouldLength","description":"How far along the pull the plane is from the part's origin; with no plane, the height that holds most of the line, which the depths are measured from."},"planar":{"type":"boolean","title":"Planar","description":"Whether the whole outline is within 0.010 in of one plane square to the pull, or of the plane set by hand."},"spread":{"$ref":"#/components/schemas/MouldLength","description":"How far the outline's highest point is above its lowest, along the pull."},"closed":{"type":"boolean","title":"Closed","description":"Whether the outline closes round the part."},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"Every edge where the core and cavity sides meet, as display draws them: the outline's, and any shut-off's inside it, such as round a window."},"outline":{"items":{"type":"string"},"type":"array","title":"Outline","description":"The edges of the parting line round the outside of the part, as display draws them: the one continuous line to draw.","default":[]},"length":{"$ref":"#/components/schemas/MouldLength","description":"How long the outline is."}},"type":"object","required":["plane","offset","planar","spread","closed","edges","length"],"title":"MouldParting","description":"The parting line, where the draft turns from one half of the mould to the other round the outside of the part,\nand the parting plane through the part at it."},"MouldPerCavity":{"properties":{"clamp":{"$ref":"#/components/schemas/MouldAmount","description":"Clamp force, with its share of the runner."},"shot":{"$ref":"#/components/schemas/MouldAmount","description":"Shot volume, with its share of the runner."}},"type":"object","required":["clamp","shot"],"title":"MouldPerCavity","description":"What one cavity needs."},"MouldPhase":{"properties":{"id":{"type":"string","enum":["close","fill","cooling","open","eject","removal","core_pulls"],"title":"Id","description":"close and open move the mould; fill injects the shot; cooling is the time in the mould after fill, pack and hold included; eject pushes the parts off the core; removal takes them from the press; core_pulls work the hydraulic actions."},"label":{"type":"string","title":"Label","description":"Its name for people, such as Cooling, or Pack and screw recovery when that outlasts cooling."},"s":{"type":"number","title":"S","description":"Seconds."},"governing":{"type":"boolean","title":"Governing","description":"Whether it's the longest phase, the one to shorten first."}},"type":"object","required":["id","label","s","governing"],"title":"MouldPhase","description":"One phase of the shot cycle, in the order it runs."},"MouldPlane":{"properties":{"point":{"items":{"type":"number"},"type":"array","title":"Point","description":"A point on it, x, y and z in mm: the middle of the part, on the plane."},"normal":{"items":{"type":"number"},"type":"array","title":"Normal","description":"Its normal: the pull direction."}},"type":"object","required":["point","normal"],"title":"MouldPlane","description":"A plane through the part."},"MouldPlaten":{"properties":{"horizontal":{"$ref":"#/components/schemas/MouldLength","description":"Across."},"vertical":{"$ref":"#/components/schemas/MouldLength","description":"Up."}},"type":"object","required":["horizontal","vertical"],"title":"MouldPlaten","description":"The press's platen."},"MouldPoint":{"properties":{"x":{"$ref":"#/components/schemas/MouldLength","description":"Along its width."},"y":{"$ref":"#/components/schemas/MouldLength","description":"Along its height."}},"type":"object","required":["x","y"],"title":"MouldPoint","description":"A point in the mould's own axes, from its corner."},"MouldPress":{"properties":{"id":{"type":"string","title":"Id","description":"Its id, M-055E to M-500H."},"name":{"type":"string","title":"Name","description":"What it is, such as 110-ton all-electric."}},"type":"object","required":["id","name"],"title":"MouldPress","description":"One of Protyus's five presses."},"MouldPressCost":{"properties":{"press":{"$ref":"#/components/schemas/MouldPress","description":"The press."},"cavities":{"type":"integer","title":"Cavities","description":"The most cavities that fit; 0 when one doesn't."},"shot_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Shot S","description":"Seconds a shot; null when it isn't costed."},"effective_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Effective S","description":"Seconds a part; null when it isn't costed."},"each":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Each","description":"US dollars a part, the mould included; null when it isn't costed."},"mould":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mould","description":"US dollars for its mould; null when it isn't costed."},"utilisation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Utilisation Pct","description":"Of the press's hours, percent; null when it isn't costed."},"chosen":{"type":"boolean","title":"Chosen","description":"Whether it's the press costed: the one named, or Auto's, the cheapest."}},"type":"object","required":["press","cavities","chosen"],"title":"MouldPressCost","description":"One of Protyus's presses at the most cavities that fit it."},"MouldPressFit":{"properties":{"press":{"$ref":"#/components/schemas/MouldPress","description":"The press."},"recommended":{"type":"integer","title":"Recommended","description":"The most cavities that fit it; 0 when one doesn't."},"limited_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limited By","description":"What stops the next count, in a sentence; null when 64 fit."}},"type":"object","required":["press","recommended"],"title":"MouldPressFit","description":"How many cavities fit one of the five presses."},"MouldPull":{"properties":{"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"The way the core (B, the moving half) opens, as x, y and z in the part's axes. The cavity (A) opens the other way."},"label":{"type":"string","title":"Label","description":"The same as an axis, such as +Z, where it's along one."},"manual":{"type":"boolean","title":"Manual","description":"Whether it was set by hand, with a parting plane set by hand, rather than chosen as the pull that leaves the fewest undercuts."}},"type":"object","required":["direction","label","manual"],"title":"MouldPull","description":"The pull direction, d: the way the mould opens."},"MouldRelease":{"properties":{"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"x, y and z in the part's axes."},"label":{"type":"string","title":"Label","description":"The same as an axis, such as +Y, where it's along one."}},"type":"object","required":["direction","label"],"title":"MouldRelease","description":"The way an action moves to release its undercut, across the pull."},"MouldResin":{"properties":{"id":{"type":"string","title":"Id","description":"Its id in Protyus's resin library, IM-01 to IM-15; IM-04, ABS, where the analysis names none."},"name":{"type":"string","title":"Name","description":"Its name, such as ABS, Acrylonitrile butadiene styrene."}},"type":"object","required":["id","name"],"title":"MouldResin","description":"The resin the part is held to."},"MouldScorecard":{"properties":{"scored":{"type":"boolean","title":"Scored","description":"False when scoring is off: then there's no score.","default":true},"scores":{"items":{"$ref":"#/components/schemas/ProcessScore"},"type":"array","title":"Scores","description":"The DFM score and its categories. Empty when scoring is off.","default":[]}},"type":"object","title":"MouldScorecard","description":"The part's DFM score by its sixteen categories (IM-W to IM-V), in milling's shape. No verdict yet."},"MouldShare":{"properties":{"below":{"type":"number","title":"Below","description":"Percent of the area thinner than the resin's minimum."},"within":{"type":"number","title":"Within","description":"Percent from its minimum to its maximum."},"above":{"type":"number","title":"Above","description":"Percent thicker than its maximum."}},"type":"object","required":["below","within","above"],"title":"MouldShare","description":"How much of the part's area is below, within and above the resin's walls, in percent."},"MouldSides":{"properties":{"core":{"items":{"type":"string"},"type":"array","title":"Core","description":"Faces the core (B) forms: drawn off as it opens."},"cavity":{"items":{"type":"string"},"type":"array","title":"Cavity","description":"Faces the cavity (A) forms."},"band":{"items":{"type":"string"},"type":"array","title":"Band","description":"Faces along the pull, square to the parting plane, which either side could form."},"undercut":{"items":{"type":"string"},"type":"array","title":"Undercut","description":"Faces neither side can be drawn off: an action forms them."}},"type":"object","required":["core","cavity","band","undercut"],"title":"MouldSides","description":"Each face by the side of the mould that forms it."},"MouldSize":{"properties":{"width":{"$ref":"#/components/schemas/MouldLength","description":"Across, along the mould's x."},"height":{"$ref":"#/components/schemas/MouldLength","description":"Up, along its y."}},"type":"object","required":["width","height"],"title":"MouldSize","description":"A width and a height."},"MouldSlideEnvelope":{"properties":{"side":{"type":"string","title":"Side","description":"The way it slides, in the part's axes, such as +Y."},"envelope":{"$ref":"#/components/schemas/MouldLength","description":"How far it reaches past the cavities: body, stroke, heel and wedge."},"stroke":{"$ref":"#/components/schemas/MouldLength","description":"Its stroke."}},"type":"object","required":["side","envelope","stroke"],"title":"MouldSlideEnvelope","description":"The room a slide takes outside the cavities."},"MouldThickness":{"properties":{"resin":{"$ref":"#/components/schemas/MouldWalls","description":"The resin's minimum, ideal and maximum wall, the map's markers."},"faces":{"additionalProperties":{"$ref":"#/components/schemas/MouldLength"},"type":"object","title":"Faces","description":"Each face's wall thickness, by face id: the mean over the face, or for a face across a wall, such as a rim, the wall it ends."},"nominal":{"$ref":"#/components/schemas/MouldLength","description":"The nominal wall, T: the most common thickness by area, in 0.005 in steps."},"min":{"$ref":"#/components/schemas/MouldLength","description":"The thinnest face."},"max":{"$ref":"#/components/schemas/MouldLength","description":"The thickest face."},"mean":{"$ref":"#/components/schemas/MouldLength","description":"The mean thickness by area."},"deviation":{"$ref":"#/components/schemas/MouldLength","description":"The standard deviation of thickness by area."},"share":{"$ref":"#/components/schemas/MouldShare","description":"How much of the area is below, within and above the resin's walls."},"thick":{"$ref":"#/components/schemas/MouldLength","description":"1.25 T, where a thick section starts: the Thick sections preset."},"histogram":{"$ref":"#/components/schemas/MouldHistogram","description":"The area by thickness."},"spheres":{"anyOf":[{"items":{"$ref":"#/components/schemas/WallSphere"},"type":"array"},{"type":"null"}],"title":"Spheres","description":"Where each thickness is: a sphere at points spread over the part, at most 1,500, those furthest from the nominal wall first, for the slider to show those in its band. Absent for analyses run before they were measured."}},"type":"object","required":["resin","faces","nominal","min","max","mean","deviation","share","thick","histogram"],"title":"MouldThickness","description":"The wall thickness map: how thick the part is behind each face, against the resin's walls."},"MouldTieBars":{"properties":{"horizontal":{"$ref":"#/components/schemas/MouldLength","description":"Between them across."},"vertical":{"$ref":"#/components/schemas/MouldLength","description":"Between them up."},"clear":{"$ref":"#/components/schemas/MouldLength","description":"The widest mould that goes between them, less the clearance each side."}},"type":"object","required":["horizontal","vertical","clear"],"title":"MouldTieBars","description":"The press's tie bars."},"MouldTool":{"properties":{"cost":{"type":"number","title":"Cost","description":"US dollars for the mould."},"cavities":{"type":"integer","title":"Cavities","description":"Its cavities."},"parts":{"items":{"$ref":"#/components/schemas/MouldToolPart"},"type":"array","title":"Parts","description":"What it's made of."},"spread_over":{"type":"integer","title":"Spread Over","description":"The parts its cost is spread over."},"spread_by":{"type":"string","enum":["life","years"],"title":"Spread By","description":"life when its life's shots run out first; years when the years do."},"life_shots":{"type":"integer","title":"Life Shots","description":"Shots it's good for."},"years":{"type":"number","title":"Years","description":"Years it's spread over at most."},"per_part":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Per Part","description":"US dollars a part: its cost over the parts it's spread over."}},"type":"object","required":["cost","cavities","parts","spread_over","spread_by","life_shots","years"],"title":"MouldTool","description":"A rough mould: its base, cavities, actions and hot runner, spread over its life or three years' parts."},"MouldToolPart":{"properties":{"id":{"type":"string","enum":["base","cavities","actions","hot_runner"],"title":"Id","description":"base, cavities, actions or hot_runner."},"label":{"type":"string","title":"Label","description":"Its name, such as Mould base."},"cost":{"type":"number","title":"Cost","description":"US dollars."}},"type":"object","required":["id","label","cost"],"title":"MouldToolPart","description":"One part of the mould's cost."},"MouldWalls":{"properties":{"min":{"$ref":"#/components/schemas/MouldLength","description":"The thinnest wall it fills (wall_min_in): thinner short-shots."},"ideal":{"$ref":"#/components/schemas/MouldLength","description":"The wall it moulds best at (wall_ideal_in)."},"max":{"$ref":"#/components/schemas/MouldLength","description":"The thickest wall it moulds without sinking or voids (wall_max_in)."}},"type":"object","required":["min","ideal","max"],"title":"MouldWalls","description":"The resin's walls, from Protyus's resin library."},"MouldWeld":{"properties":{"id":{"type":"string","title":"Id","description":"W1, W2 and so on."},"cause":{"type":"string","enum":["gates","hole","boss"],"title":"Cause","description":"gates where two gates' flows meet; hole or boss behind a through hole or a cored boss the flow parts round."},"between":{"items":{"type":"string"},"type":"array","title":"Between","description":"The two gates whose flows meet, for gates.","default":[]},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it's on."},"point":{"items":{"type":"number"},"type":"array","title":"Point","description":"About where it is, mm, in the part's own axes."},"load_bearing":{"type":"boolean","title":"Load Bearing","description":"Whether it's on a boss or a rib (IM-G-03)."}},"type":"object","required":["id","cause","surfaces","point","load_bearing"],"title":"MouldWeld","description":"A weld line: where the flow meets itself."},"Moulding":{"properties":{"status":{"anyOf":[{"type":"string","enum":["not_built","ready"]},{"type":"null"}],"title":"Status","description":"not_built while Protyus doesn't analyse this process yet; ready once it has analysed the part."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The section's heading, for people, such as Sheet metal analysis isn't available yet."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"What it means, for people."},"checks":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Checks","description":"What the analysis checks for this process, in words, while it's not built."},"material":{"anyOf":[{"$ref":"#/components/schemas/MouldResin"},{"type":"null"}],"description":"The resin it's held to."},"pull":{"anyOf":[{"$ref":"#/components/schemas/MouldPull"},{"type":"null"}],"description":"The pull direction."},"parting":{"anyOf":[{"$ref":"#/components/schemas/MouldParting"},{"type":"null"}],"description":"The parting line and plane."},"sides":{"anyOf":[{"$ref":"#/components/schemas/MouldSides"},{"type":"null"}],"description":"Which side of the mould forms each face."},"depths":{"anyOf":[{"$ref":"#/components/schemas/MouldDepths"},{"type":"null"}],"description":"How deep the part runs into each half."},"actions":{"anyOf":[{"items":{"$ref":"#/components/schemas/MouldAction"},"type":"array"},{"type":"null"}],"title":"Actions","description":"Its slides, lifters, strippable undercuts and complex actions; empty for a straight-pull part."},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"The actions in a sentence, such as Straight-pull part: no slides or lifters needed."},"thickness":{"anyOf":[{"$ref":"#/components/schemas/MouldThickness"},{"type":"null"}],"description":"How thick the part is behind each face, against the resin's walls."},"findings":{"anyOf":[{"items":{"$ref":"#/components/schemas/MouldFinding"},"type":"array"},{"type":"null"}],"title":"Findings","description":"What's wrong for the resin, by rule id, worst first."},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/MouldScorecard"},{"type":"null"}],"description":"The DFM score by its sixteen categories for the resin. No verdict yet."},"compare":{"anyOf":[{"items":{"$ref":"#/components/schemas/MouldComparison"},"type":"array"},{"type":"null"}],"title":"Compare","description":"Every resin's score on the part, IM-01 to IM-15: Compare materials."},"cavities":{"anyOf":[{"$ref":"#/components/schemas/MouldCavities"},{"type":"null"}],"description":"How many cavities fit the press, what limits the next count, the layout and the machine checks."},"flow":{"anyOf":[{"$ref":"#/components/schemas/MouldFlow"},{"type":"null"}],"description":"Where the gates go, the flow and its ratio to the wall, the last point to fill and the weld lines."},"cycle":{"anyOf":[{"$ref":"#/components/schemas/MouldCycle"},{"type":"null"}],"description":"The shot cycle by phase on the press at the recommended count. Null when it isn't costed."},"estimate":{"anyOf":[{"$ref":"#/components/schemas/MouldEstimate"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Estimate","description":"Its cost a part on the press, as a quote prices it, or why there isn't one."},"caveats":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Caveats","description":"What it couldn't judge yet, such as a lifter's travel against a press."}},"type":"object","title":"Moulding","description":"An injection moulding analysis's conclusions: which way the mould opens, where it parts, and the actions its\nundercuts need, how thick its walls are, its DFM findings and score in each resin, the cavities that fit a press,\nits cycle and cost per part, and its gates, flow and mould. Absent while the section isn't built, and for analyses\nrun before it."},"MouldingScorecard":{"properties":{"green_from":{"type":"number","maximum":100.0,"exclusiveMinimum":0.0,"title":"Green From","description":"The lowest moulding DFM score shown green. Default 85.","default":85},"yellow_from":{"type":"number","maximum":100.0,"exclusiveMinimum":0.0,"title":"Yellow From","description":"The lowest moulding DFM score shown yellow, below green. Lower is red. Default 60.","default":60}},"additionalProperties":false,"type":"object","title":"MouldingScorecard","description":"Where the moulding DFM score's green and yellow start: its own, apart from milling's and sheet metal's. By\ndefault they match milling's."},"MouldingSettings":{"properties":{"scorecard":{"$ref":"#/components/schemas/MouldingScorecard","description":"Where the moulding DFM score's green and yellow start.","default":{"green_from":85.0,"yellow_from":60.0}},"gate_and_flow":{"type":"boolean","title":"Gate And Flow","description":"Whether molding analyses show where the gates go and how the part fills, and judge and score fill and gates. Off by default. The organization's alone, and only an admin changes it. Off, new analyses leave out the fill and gate findings and score without Fill and Gates; the mold's cost still counts its gates.","default":false}},"additionalProperties":false,"type":"object","title":"MouldingSettings","description":"Moulding's own settings: each process's settings are a section of their own, as its result is."},"Named":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Its id."},"name":{"type":"string","title":"Name","description":"Its name."}},"additionalProperties":false,"type":"object","required":["id","name"],"title":"Named","description":"Something the lead came through, by id and name."},"NoToolFits":{"properties":{"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces.","default":[]},"max_diameter_in":{"type":"number","title":"Max Diameter In","description":"The largest tool diameter that would fit them, inches."}},"type":"object","required":["max_diameter_in"],"title":"NoToolFits","description":"Faces no tool fits, in the organization's tools or the standard sizes, so they aren't timed."},"OrgApiKeyOut":{"properties":{"id":{"type":"string","title":"Id","description":"The key's id (ak_ and 32 hex digits). Not the secret: it can't sign anything in."},"name":{"type":"string","title":"Name","description":"What the key is for."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A longer note about the key, if one was given."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the key was made."},"last_used_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used At","description":"When the key last signed a request in, if Clerk has recorded it."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When the key stops working, or null if it doesn't expire."},"revoked":{"type":"boolean","title":"Revoked","description":"Whether the key was revoked. A revoked key is refused at once."},"expired":{"type":"boolean","title":"Expired","description":"Whether the key has passed its expiry."},"user_id":{"type":"string","title":"User Id","description":"The Clerk user id of the person the key acts as, who made it."},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"Their name, if they gave one."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email","description":"Their email address, if Clerk shares it."}},"additionalProperties":false,"type":"object","required":["id","name","description","created_at","last_used_at","expires_at","revoked","expired","user_id","user_name","user_email"],"title":"OrgApiKeyOut","description":"One API key in the organization, with the person it acts as."},"OrgSettings":{"properties":{"units":{"type":"string","enum":["inch","mm"],"title":"Units","description":"Display units, inch or mm. Lengths are always stored in mm.","default":"mm"},"defaults":{"$ref":"#/components/schemas/Defaults","description":"The machine, material and quantity a new analysis starts from.","default":{"machine":"3_axis","material":"6061","quantity":1}},"rates":{"$ref":"#/components/schemas/Rates","description":"Labour rates, programming hours and overhead for costing.","default":{}},"rule_limits":{"$ref":"#/components/schemas/RuleLimits","description":"DFM rule limits the shop has tuned, each defaulting to Protyus's.","default":{"thin_wall":{"min_ratio":8.0},"long_reach":{"max_ratio":4.0},"non_standard_fillet":{"corner_radii_mm":[0.127,0.254,0.762,1.524,1.5875,2.286,2.54,3.175]},"non_standard_hole":{"drill_sizes_mm":[0.3429,0.3683,0.3969,0.4064,0.4572,0.508,0.5334,0.5715,0.6096,0.635,0.6604,0.7112,0.7417,0.7874,0.7937,0.8128,0.8382,0.889,0.9144,0.9398,0.9652,0.9906,1.0,1.016,1.0414,1.0668,1.0922,1.1,1.1811,1.1906,1.2,1.3,1.3208,1.397,1.4,1.5,1.5113,1.5875,1.6,1.6129,1.7,1.7018,1.778,1.8,1.8542,1.9,1.9304,1.9844,1.9939,2.0,2.0574,2.0828,2.1,2.1844,2.2,2.2606,2.3,2.3749,2.3812,2.4,2.4384,2.4892,2.5,2.5273,2.5781,2.6,2.6416,2.7,2.7051,2.7781,2.794,2.8,2.8194,2.8702,2.9,2.9464,3.0,3.048,3.1,3.175,3.2,3.2639,3.3,3.4,3.4544,3.5,3.5687,3.5719,3.6,3.6576,3.7,3.7338,3.7973,3.8,3.8608,3.9,3.9116,3.9688,3.9878,4.0,4.0386,4.0894,4.1,4.2,4.2164,4.3,4.3053,4.3656,4.3942,4.4,4.4958,4.5,4.572,4.6,4.6228,4.699,4.7,4.7625,4.8,4.8006,4.8514,4.9,4.9149,4.9784,5.0,5.0546,5.1,5.1054,5.1594,5.1816,5.2,5.2197,5.3,5.3086,5.4,5.4102,5.5,5.5562,5.6,5.6134,5.7,5.7912,5.8,5.9,5.9436,5.9531,6.0,6.0452,6.1,6.1468,6.2,6.2484,6.3,6.35,6.4,6.5,6.5278,6.6,6.6294,6.7,6.7469,6.7564,6.8,6.9,6.9088,7.0,7.0358,7.1,7.1374,7.1437,7.2,7.3,7.366,7.4,7.493,7.5,7.5406,7.6,7.6708,7.7,7.8,7.9,7.9375,8.0,8.0264,8.1,8.2,8.2042,8.3,8.3344,8.4,8.4328,8.5,8.6,8.6106,8.7,8.7312,8.8,8.8392,8.9,9.0,9.0932,9.1,9.1281,9.2,9.3,9.3472,9.4,9.5,9.525,9.5758,9.6,9.7,9.8,9.8044,9.9,9.9219,10.0,10.0838,10.1,10.2,10.2616,10.3,10.3187,10.4,10.4902,10.5,10.6,10.7,10.7156,10.8,10.9,11.0,11.1,11.1125,11.2,11.3,11.4,11.5,11.5094,11.6,11.7,11.8,11.9,11.9062,12.0,12.1,12.2,12.3,12.3031,12.4,12.5,12.6,12.7,12.8,12.9,13.0,13.0969,13.1,13.2,13.3,13.4,13.4937,13.5,13.6,13.7,13.8,13.8906,13.9,14.0,14.25,14.2875,14.5,14.6844,14.75,15.0,15.0812,15.25,15.4781,15.5,15.75,15.875,16.0,16.2719,16.5,16.6687,17.0,17.0656,17.4625,17.5,17.8594,18.0,18.2562,18.5,18.6531,19.0,19.05,19.4469,19.5,19.8438,20.0,20.2406,20.5,20.6375,21.0,21.0344,21.4312,21.5,21.8281,22.0,22.225,22.5,22.6219,23.0,23.0187,23.4156,23.5,23.8125,24.0,24.2094,24.5,24.6062,25.0,25.0031,25.4]},"drilling":{"drilling_limit_mm":25.4,"hole_tolerance_mm":0.0508},"taper":{"max_lean_deg":0.5},"deep_hole":{"max_ratio":6.0},"min_wall_thickness":{"min_mm":0.79}}},"scorecard":{"$ref":"#/components/schemas/ScorecardSettings","description":"The DFM score: on or off, each check's weight, and where green and yellow start.","default":{"calculate":true,"weights":{"floors":10.0,"holes":10.0,"length_to_diameter":10.0,"obstructed":10.0,"sharp_corners":10.0,"surface_profiling":10.0,"text":0.0,"thin_walls":10.0,"threads":10.0,"transitions":10.0,"walls":10.0},"green_from":85.0,"yellow_from":60.0,"wall_corner_clearance_mm":0.0}},"sheet_metal":{"$ref":"#/components/schemas/SheetMetalSettings","description":"Sheet metal's own settings: where its DFM score's green and yellow start.","default":{"scorecard":{"green_from":85.0,"yellow_from":60.0}}},"moulding":{"$ref":"#/components/schemas/MouldingSettings","description":"Moulding's own settings: where its DFM score's green and yellow start.","default":{"scorecard":{"green_from":85.0,"yellow_from":60.0},"gate_and_flow":false}},"hidden_process_machines":{"$ref":"#/components/schemas/HiddenProcessMachines","description":"The sheet metal cutting machines and molding presses the organization hides. The organization's alone, changed with POST /api/v1/organization/process-machines/hide, /show and /reset (machines:write).","default":{"sheet_metal":[],"moulding":[]}},"stock":{"$ref":"#/components/schemas/StockSettings","description":"How much stock is left around the part.","default":{"min_cleanup_mm":3.175}},"profiling":{"$ref":"#/components/schemas/ProfilingSettings","description":"Profile milling: the target surface finish, which sets a bull nose's stepover, and whether ruled surfaces are flank milled with tapered or straight end mills.","default":{"surface_finish_ra_um":3.2,"ruled_surface_tool":"tapered"}},"cutting":{"$ref":"#/components/schemas/CuttingSettings","description":"The chip load aggression its end mills cut at, a ball's stepover in 3D profiling, and its own cutting numbers for each operation in each material. The organization's alone: a project can't set them.","default":{"chip_load_aggression_pct":100.0,"ball_stepover_pct":6.0,"groups":{"M1.0.Z.AQ":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"M1.2.Z.AQ":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N1.2.Z.AG":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N1.2.Z.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N3.3.U.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.PEEK":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.PTFE":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.THERMOPLASTIC":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P1.1.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P1.2.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P2.2.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P2.5.Z.HT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P3.0.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P5.0.Z.PH":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S2.0.Z.AG":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S2.0.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S4.1.Z.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S4.3.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}}}}},"general_tolerance":{"$ref":"#/components/schemas/GeneralTolerance","description":"What the shop holds wherever nothing tighter is said. Changing it needs tolerances:write.","default":{"plus_minus_mm":0.127}},"quote":{"$ref":"#/components/schemas/QuoteSettings","description":"Margin, material markup, minimum charge, rush and tools to buy, and the lead time, validity and terms the customer's quote states. Changing them needs pricing:write.","default":{"margin_pct":15.0,"material_markup_pct":10.0,"include_tools_to_buy":true,"valid_days":30,"terms_text":"Prices are in US dollars, for the part as drawn in the file named above. Payment, delivery and shipping are agreed when the order is placed."}},"logo_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Logo Url","description":"The organization's logo, an https URL to an image. Heads the emails and the upload page that submission links send; a link can set its own. Null for none, the default."},"sender_name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Sender Name","description":"The from name on the emails submission links send; a link can set its own. Null for the organization's name, the default."},"privacy_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Privacy Url","description":"The privacy policy, an https URL, that submission links' lead forms link from their consent box; a link can set its own. Null for none, the default."},"email_templates":{"$ref":"#/components/schemas/OrgTemplates","description":"The subject and body of the acknowledgement, quote and decline emails that submission links send to leads, plain text with {{fields}}. A link can set its own. Null for Protyus's default, which `defaults` shows.","default":{"acknowledgement":{},"quote":{},"decline":{}}}},"additionalProperties":false,"type":"object","title":"OrgSettings","description":"Every setting, as an organization holds them and as an analysis resolves them."},"OrgSettingsOut":{"properties":{"settings":{"$ref":"#/components/schemas/OrgSettings","description":"Every setting, with defaults filled in."},"choices":{"$ref":"#/components/schemas/Choices","description":"Every machine and material the organization can pick as a default."},"defaults":{"$ref":"#/components/schemas/OrgSettings","description":"Protyus's default for every setting, what a field sent as null goes back to. In rates, the value costing uses while the organization's own is null; in email_templates, the copy the emails use while it's null."},"can_edit":{"type":"boolean","title":"Can Edit","description":"Whether the caller may change them (settings:write)."},"can_edit_pricing":{"type":"boolean","title":"Can Edit Pricing","description":"Whether the caller may change the quote settings (pricing:write)."},"can_edit_branding":{"type":"boolean","title":"Can Edit Branding","description":"Whether the caller may change the logo, sender name, privacy policy and email templates (submission_links:manage)."},"can_edit_gate_and_flow":{"type":"boolean","title":"Can Edit Gate And Flow","description":"Whether the caller may turn molding's gate and flow on or off: an admin only.","default":false},"cutting_groups":{"items":{"$ref":"#/components/schemas/CuttingGroup"},"type":"array","title":"Cutting Groups","description":"The cutting groups a shop sets its own cutting numbers for, in the order to list them: each one's code (the key of its numbers in settings.cutting.groups), its general material name, and Protyus's number for each field, which a null takes. In defaults.cutting.groups every field is null."},"cutting_warnings":{"items":{"$ref":"#/components/schemas/CuttingWarning"},"type":"array","title":"Cutting Warnings","description":"The organization's own cutting numbers that are more than 50% off Protyus's default. Each is saved and used as it is; the warning is there so a slip is noticed."},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"Who last changed them, or null if never."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"When they last changed, or null if never."}},"additionalProperties":false,"type":"object","required":["settings","choices","defaults","can_edit","can_edit_pricing","can_edit_branding","cutting_groups","cutting_warnings","updated_by","updated_at"],"title":"OrgSettingsOut","description":"The organization's settings."},"OrgTemplate":{"properties":{"subject":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Subject","description":"The subject, plain text with {{fields}}. Null for Protyus's default."},"body":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Body","description":"The body, plain text with {{fields}}. Null for Protyus's default."}},"additionalProperties":false,"type":"object","title":"OrgTemplate","description":"One email's subject and body for the organization's submission links. Null for Protyus's default."},"OrgTemplates":{"properties":{"acknowledgement":{"$ref":"#/components/schemas/OrgTemplate","description":"The email saying their parts arrived and will be reviewed.","default":{}},"quote":{"$ref":"#/components/schemas/OrgTemplate","description":"The email carrying the quote PDF.","default":{}},"decline":{"$ref":"#/components/schemas/OrgTemplate","description":"The email saying the shop can't quote this one.","default":{}}},"additionalProperties":false,"type":"object","title":"OrgTemplates","description":"The organization's emails to leads. A submission link can set its own; one left null is Protyus's default."},"OrgTolerancesOut":{"properties":{"general_tolerance":{"additionalProperties":true,"type":"object","title":"General Tolerance","description":"The general tolerance. Change it with PATCH /api/v1/organization/settings (tolerances:write)."},"rows":{"items":{"$ref":"#/components/schemas/ResolvedRow"},"type":"array","title":"Rows","description":"Each operation's row. Provisional rows are Protyus's defaults that no machinist has confirmed yet."},"can_edit":{"type":"boolean","title":"Can Edit","description":"Whether the caller may change them (tolerances:write)."}},"additionalProperties":false,"type":"object","required":["general_tolerance","rows","can_edit"],"title":"OrgTolerancesOut","description":"What the shop can hold: the general tolerance and the capability table."},"OrganizationNameIn":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name","description":"The name people see in the app and in Clerk's emails, 1 to 120 characters."}},"additionalProperties":false,"type":"object","required":["name"],"title":"OrganizationNameIn","description":"The organization's new name."},"OrganizationOut":{"properties":{"id":{"type":"string","title":"Id","description":"The organization's Clerk id."},"name":{"type":"string","title":"Name","description":"Its name."},"members":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Members","description":"How many people belong to it."},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"When it was created, if Clerk says."},"disabled":{"type":"boolean","title":"Disabled","description":"Whether Protyus staff have disabled it, so its people's requests are refused.","default":false}},"additionalProperties":false,"type":"object","required":["id","name","members"],"title":"OrganizationOut","description":"An organization."},"OrganizationUsage":{"properties":{"org_id":{"type":"string","title":"Org Id","description":"The organization's Clerk id."},"since":{"type":"string","format":"date","title":"Since","description":"The first day counted, in UTC."},"days":{"type":"integer","title":"Days","description":"How many days are counted, ending today."},"totals":{"$ref":"#/components/schemas/UsageTotals","description":"Every run in the window: analyses and extracts. AI messages are in `ai`."},"by_day":{"items":{"$ref":"#/components/schemas/DayUsage"},"type":"array","title":"By Day","description":"Each day in the window, oldest first, including days with no runs."},"by_person":{"items":{"$ref":"#/components/schemas/PersonUsage"},"type":"array","title":"By Person","description":"Each person with runs in the window, most runs first."},"ai":{"$ref":"#/components/schemas/AiUsage","description":"Protyus AI messages in the window, by day and by person, with their tokens."},"analyses":{"$ref":"#/components/schemas/AnalysesUsed","description":"Analyses used this billing month, whatever `days` is: what the plan's allowance counts."}},"additionalProperties":false,"type":"object","required":["org_id","since","days","totals","by_day","by_person","ai","analyses"],"title":"OrganizationUsage","description":"An organization's usage over the last `days` days, today included."},"PaidQuantities":{"properties":{"per_order":{"type":"number","title":"Per Order","description":"Once an order.","default":0},"per_batch":{"type":"number","title":"Per Batch","description":"Once a batch.","default":0},"per_part":{"type":"number","title":"Per Part","description":"Every part.","default":0}},"type":"object","title":"PaidQuantities","description":"How much of a line's unit is paid at each time."},"Part":{"properties":{"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name","description":"The file's name."},"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units","description":"The units the file declared, such as mm or inch. Sizes here are in mm whatever it says."},"bounding_box":{"anyOf":[{"$ref":"#/components/schemas/analyses__customer__BoundingBox"},{"type":"null"}],"description":"The part's bounding box, in mm."},"size":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Size","description":"The bounding box's size along X, Y and Z, in mm."},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume","description":"The part's volume, mm³."},"surface_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Surface Count","description":"How many faces it has."},"edge_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Edge Count","description":"How many edges it has."},"surfaces":{"anyOf":[{"items":{"$ref":"#/components/schemas/Surface"},"type":"array"},{"type":"null"}],"title":"Surfaces","description":"Every face."},"edges":{"anyOf":[{"items":{"$ref":"#/components/schemas/Edge"},"type":"array"},{"type":"null"}],"title":"Edges","description":"Every edge."},"warnings":{"anyOf":[{"items":{"$ref":"#/components/schemas/analyses__customer__PartWarning"},"type":"array"},{"type":"null"}],"title":"Warnings","description":"What in the file may affect the results, one line a kind."}},"type":"object","title":"Part","description":"The part as read from the file. Lengths are in mm. Each key is here unless sections leaves it out."},"PartListItem":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The part's id. Quotes name it as part_id."},"name":{"type":"string","title":"Name","description":"Its name."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"The customer's part number, or null."},"customer_revision":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Revision","description":"The customer's own revision, such as Rev C, or null."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project it's in."},"project_name":{"type":"string","title":"Project Name","description":"That project's name."},"latest_version":{"$ref":"#/components/schemas/LatestVersionOut","description":"Its newest version."},"working":{"anyOf":[{"$ref":"#/components/schemas/WorkingOut"},{"type":"null"}],"description":"Its working version and who holds it, or null when every version is final."},"latest_analysis_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Latest Analysis Id","description":"Its newest ready analysis, or null: read it with get_analysis."},"can_design":{"type":"boolean","title":"Can Design","description":"Whether the caller may change it in Design: the Design add-on and the designer role on its project."},"changed_at":{"type":"string","format":"date-time","title":"Changed At","description":"When it last changed: a version made or finalised, or a Design turn."}},"additionalProperties":false,"type":"object","required":["id","name","number","customer_revision","project_id","project_name","latest_version","working","latest_analysis_id","can_design","changed_at"],"title":"PartListItem","description":"One part: its name, numbers, newest version and what opens it."},"PartOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The part's id."},"file_name":{"type":"string","title":"File Name","description":"The STEP file's name, as the lead uploaded it."},"analysis_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Analysis Id","description":"Its analysis, in the submission's project. Null if it couldn't start or was deleted."},"quote":{"anyOf":[{"$ref":"#/components/schemas/PartQuote"},{"type":"null"}],"description":"Its quote, once there is one."},"clean":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Clean","description":"Whether its quote passed every hold rule. Null until the rules have run."},"reasons":{"items":{"$ref":"#/components/schemas/Reason"},"type":"array","title":"Reasons","description":"Why it was held or couldn't be analysed. Empty when clean."},"state":{"type":"string","enum":["analysing","failed","analysed","quoted"],"title":"State","description":"analysing, failed (it couldn't be analysed), analysed (no quote yet) or quoted."}},"additionalProperties":false,"type":"object","required":["id","file_name","analysis_id","quote","clean","reasons","state"],"title":"PartOut","description":"One file of a submission: its own analysis and quote."},"PartPage":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PartListItem"},"type":"array","title":"Items","description":"The parts, the most recently changed first."},"total":{"type":"integer","title":"Total","description":"How many parts match, across every page."}},"additionalProperties":false,"type":"object","required":["items","total"],"title":"PartPage","description":"One page of parts, the most recently changed first."},"PartQuote":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The quote's id: read it with GET /api/v1/quotes/{quote_id}."},"version":{"type":"integer","title":"Version","description":"Its latest version's number."},"price":{"type":"number","title":"Price","description":"The latest version's price for the order at the lead's quantity, US dollars."},"price_each":{"type":"number","title":"Price Each","description":"The same, a part."}},"additionalProperties":false,"type":"object","required":["id","version","price","price_each"],"title":"PartQuote","description":"A part's quote, at its latest version."},"PartReason":{"properties":{"code":{"type":"string","title":"Code","description":"A stable code, such as SCORE_UNDER, CANT_BE_MADE, ANALYSIS_FAILED or OVER_MAX_PRICE."},"message":{"type":"string","title":"Message","description":"The reason for people, such as Score 64, under 80."}},"additionalProperties":false,"type":"object","required":["code","message"],"title":"PartReason","description":"Why a part was held."},"PartSharingIn":{"properties":{"prevent_sharing":{"type":"boolean","title":"Prevent Sharing","description":"True stops every shared link in the company and allows no new one; false lets project owners and admins share parts."}},"additionalProperties":false,"type":"object","required":["prevent_sharing"],"title":"PartSharingIn","description":"Prevent sharing parts, or allow it."},"PartSharingOut":{"properties":{"prevent_sharing":{"type":"boolean","title":"Prevent Sharing","description":"Whether no part in the company can be shared. On until an admin turns it off."},"changed_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Changed By","description":"The Clerk user id of the admin who last set it, or null if it was never set."},"changed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Changed At","description":"When it was last set, or null if never."},"can_edit":{"type":"boolean","title":"Can Edit","description":"Whether the caller may change it: admins only."},"revoked":{"type":"integer","title":"Revoked","description":"How many shared links this change stopped: every live one when Prevent sharing is turned on.","default":0}},"additionalProperties":false,"type":"object","required":["prevent_sharing","changed_by","changed_at","can_edit"],"title":"PartSharingOut","description":"Whether the company prevents sharing parts."},"PartSize":{"properties":{"size_mm":{"items":{"type":"number"},"type":"array","title":"Size Mm","description":"The part's size, x, y and z, mm."},"volume_cm3":{"type":"number","title":"Volume Cm3","description":"Its volume, cm³."},"faces":{"type":"integer","title":"Faces","description":"How many faces it has."},"bodies":{"type":"integer","title":"Bodies","description":"How many solid bodies: one."},"drawing_notes":{"items":{"type":"string"},"type":"array","title":"Drawing Notes","description":"Notes for the drawing, such as an edge break.","default":[]}},"additionalProperties":false,"type":"object","required":["size_mm","volume_cm3","faces","bodies"],"title":"PartSize","description":"The built part's size."},"PartVersionOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The version's id."},"part_id":{"type":"string","format":"uuid","title":"Part Id","description":"The part it's a version of."},"number":{"type":"integer","title":"Number","description":"Its number in the part, from 1 (v1, v2), in the order versions were made. Never reused."},"origin":{"type":"string","enum":["uploaded","built","optimised"],"title":"Origin","description":"Where it came from: uploaded, built in Design, or optimised from another version."},"parent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Id","description":"The version it was made from, or null."},"status":{"type":"string","enum":["working","final"],"title":"Status","description":"working while it's being changed; final once finalised, after which it never changes."},"file_name":{"type":"string","title":"File Name","description":"Its STEP file's name."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of whoever made it."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was made."},"finalized_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finalized By","description":"Who finalised it, or null while it's working. An uploaded file's uploader."},"finalized_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finalized At","description":"When it was finalised, or null while it's working."}},"additionalProperties":false,"type":"object","required":["id","part_id","number","origin","parent_id","status","file_name","created_by","created_at","finalized_by","finalized_at"],"title":"PartVersionOut","description":"One version of a part: one STEP file."},"PartingPlane":{"properties":{"point":{"items":{"type":"number"},"type":"array","title":"Point","description":"A point on it, x, y and z in mm in the part's own axes."},"normal":{"items":{"type":"number"},"type":"array","title":"Normal","description":"Its normal, of length 1: the pull direction."}},"additionalProperties":false,"type":"object","required":["point","normal"],"title":"PartingPlane","description":"A parting plane set by hand, as an analysis ran with it."},"PartingPlaneIn":{"properties":{"point":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Point","description":"A point on the plane, x, y and z in mm in the part's own axes, with normal."},"normal":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Normal","description":"The plane's normal, x, y and z, with point: the way the mould opens."},"points":{"anyOf":[{"items":{"items":{"type":"number"},"type":"array","maxItems":3,"minItems":3},"type":"array","maxItems":3,"minItems":3},{"type":"null"}],"title":"Points","description":"Three points on the plane, each x, y and z in mm, such as three of the part's vertices. Three in a line are refused with PARTING_POINTS_IN_A_LINE."},"face":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Face","description":"A flat face of the part, such as S0012: the plane is that face's. Only on a re-run, whose part is read already. One that isn't flat is refused with PARTING_FACE_NOT_FLAT."},"edges":{"anyOf":[{"items":{"type":"string","maxLength":40},"type":"array","maxItems":2,"minItems":2},{"type":"null"}],"title":"Edges","description":"Two of the part's edges, such as E0003 and E0007: the plane they lie in. Only on a re-run. Two that aren't in one plane, neither on one face nor parallel, are refused with PARTING_EDGES_NOT_COPLANAR."}},"additionalProperties":false,"type":"object","title":"PartingPlaneIn","description":"A moulding analysis's parting plane, set by hand, given one way: a point and its normal, three points on it, one\nflat face, or two edges that lie in one plane. Its normal becomes the pull direction, so the undercuts, draft and\nactions are judged again, and the parting line still runs where the core and cavity sides meet."},"PerUnit":{"properties":{"shape":{"type":"string","enum":["length","circle","square","rectangle"],"title":"Shape","description":"length for a tolerance per unit length (0.2/15), or the shape of the area for one per unit area."},"size":{"items":{"type":"number"},"type":"array","title":"Size","description":"The length; a circle's diameter; or a square's or rectangle's two sides. Millimeters."}},"type":"object","required":["shape","size"],"title":"PerUnit","description":"What a per-unit tolerance applies over: any length of the feature, or any area of its surface."},"PermissionOut":{"properties":{"name":{"type":"string","title":"Name","description":"The permission, named <area>:<verb>, such as tools:write."},"description":{"type":"string","title":"Description","description":"What it allows."},"project_scoped":{"type":"boolean","title":"Project Scoped","description":"Whether it can be held on one project, rather than only organization-wide."}},"additionalProperties":false,"type":"object","required":["name","description","project_scoped"],"title":"PermissionOut","description":"One thing a person may do."},"PersonUsage":{"properties":{"runs":{"type":"integer","title":"Runs","description":"How many billable actions: analyses run and files extracted, whatever their outcome.","default":0},"succeeded":{"type":"integer","title":"Succeeded","description":"How many of them succeeded.","default":0},"failed":{"type":"integer","title":"Failed","description":"How many failed. Runs still running, or deleted while running, are neither.","default":0},"by_source":{"$ref":"#/components/schemas/SourceCounts","description":"The runs, split by the surface they came through.","default":{"ui":0,"api":0,"mcp":0,"intake":0}},"compute_seconds":{"type":"number","title":"Compute Seconds","description":"The engine's time on them, in seconds: download, analysis and saving.","default":0},"storage_bytes_added":{"type":"integer","title":"Storage Bytes Added","description":"What they added to file storage, in bytes, whether or not it's been deleted since.","default":0},"user_id":{"type":"string","title":"User Id","description":"Their Clerk user id. Runs made with an API key count as the person who made it."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Their name or email, if they're still in the organization."},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At","description":"When their latest run started."}},"additionalProperties":false,"type":"object","required":["user_id","name","last_run_at"],"title":"PersonUsage","description":"One person's usage in the window."},"Picks":{"properties":{"machine":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Machine","description":"A machine from the project's choices, or null for its default."},"material":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Material","description":"A material the organization offers, or a reference grade such as 6061; null for the default."},"quantity":{"anyOf":[{"type":"integer","maximum":1000000.0,"minimum":1.0},{"type":"null"}],"title":"Quantity","description":"How many parts in the batch; null for the project's default."}},"additionalProperties":false,"type":"object","title":"Picks","description":"The machine, material and quantity the quick check plans with. Null for the project's default."},"PictureIn":{"properties":{"version":{"type":"integer","const":1,"title":"Version","description":"The view's version, 1.","default":1},"title":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Title","description":"A heading for the card."},"preset":{"anyOf":[{"type":"string","enum":["problems","setups","score","route"]},{"type":"null"}],"title":"Preset","description":"problems: what's wrong, every finding then one frame each. setups: a frame per setup, down its tool direction. score: a frame per failing score check, worst first. route: how a lathe part is made, what the lathe turns about its axis, then a frame per operation of its route with its arrow; on a part that isn't turned, why not."},"frames":{"anyOf":[{"items":{"$ref":"#/components/schemas/FrameIn"},"type":"array","maxItems":8,"minItems":1},{"type":"null"}],"title":"Frames","description":"The frames, 1 to 8, when there's no preset."},"frame":{"type":"integer","exclusiveMaximum":8.0,"minimum":0.0,"title":"Frame","description":"Which frame to draw, from 0: the first frame of a preset is its overview, such as problems' every finding at once.","default":0}},"additionalProperties":false,"type":"object","title":"PictureIn","description":"A part view, and which of its frames to draw as a picture."},"PlanOut":{"properties":{"key":{"type":"string","title":"Key","description":"The plan's slug in Clerk Billing, such as free_org, or free for the placeholder plan."},"name":{"type":"string","title":"Name","description":"What the screen calls it, such as Free."},"features":{"items":{"type":"string"},"type":"array","title":"Features","description":"The features the plan includes, by key, such as ai."},"source":{"type":"string","enum":["clerk","placeholder"],"title":"Source","description":"clerk when the plan came from Clerk Billing in the session token; placeholder when no plan is set up yet, or the caller used an API key, so every feature is on."}},"additionalProperties":false,"type":"object","required":["key","name","features","source"],"title":"PlanOut","description":"The active organization's plan."},"Pocket":{"properties":{"closed":{"type":"boolean","title":"Closed","description":"Whether walls close it all round, rather than opening to a side."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces: floor, walls and fillets.","default":[]}},"type":"object","required":["closed"],"title":"Pocket","description":"A pocket: a floor with walls around it."},"PocketRef":{"properties":{"pocket":{"type":"integer","minimum":0.0,"title":"Pocket","description":"The pocket's index in recognition.pockets, from 0."}},"additionalProperties":false,"type":"object","required":["pocket"],"title":"PocketRef","description":"One pocket."},"PreviewOut":{"properties":{"turn_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Turn Id","description":"The turn it's from; null when no turn has shown one."},"step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Step","description":"How many features the part had."},"part":{"anyOf":[{"$ref":"#/components/schemas/Part"},{"type":"null"}],"description":"The part's faces and edges, as an analysis's part."},"display":{"anyOf":[{"$ref":"#/components/schemas/Display"},{"type":"null"}],"description":"The part's triangles and edges, for a 3D viewer."}},"additionalProperties":false,"type":"object","title":"PreviewOut","description":"The part as a running turn has built it so far, for the viewer: its faces and triangles, with no check yet."},"PreviewRow":{"properties":{"row":{"type":"integer","title":"Row","description":"Its place in the file, from 1. Send it in a commit's actions to change what happens to it."},"status":{"type":"string","enum":["new","exact_duplicate","likely_duplicate","changed","invalid"],"title":"Status","description":"new, exact_duplicate, likely_duplicate (same geometry, no product numbers), changed (same product, different fields) or invalid."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Why it's invalid or a duplicate, in words a person can read."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The tool's description, if the row has one."},"tool":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Tool","description":"The tool as it would be stored, in mm. Null when invalid."},"match_item_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Match Item Id","description":"The library tool it duplicates or changes."},"action":{"anyOf":[{"type":"string","enum":["add","skip","update","keep_both"]},{"type":"null"}],"title":"Action","description":"What committing does with it unless told otherwise. Null for an invalid row."},"choices":{"items":{"type":"string","enum":["add","skip","update","keep_both"]},"type":"array","title":"Choices","description":"The actions this row can take."}},"additionalProperties":false,"type":"object","required":["row","status","reason","description","tool","match_item_id","action","choices"],"title":"PreviewRow","description":"One row of the file, what it is, and what committing does with it by default."},"PriceIn":{"properties":{"rush":{"type":"boolean","title":"Rush","description":"Whether it's a rush order: the rush multiplier and fee apply, where the settings set them.","default":false},"include_tools_to_buy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Tools To Buy","description":"Whether to price in the tools to buy for this quote. Null follows quote.include_tools_to_buy in the settings."},"repeat_job":{"type":"boolean","title":"Repeat Job","description":"Whether it's a repeat job: a part the shop has made before, whose program and first article already exist. True leaves programming and the first article out of the price; setup, machining and everything else stay.","default":false}},"additionalProperties":false,"type":"object","title":"PriceIn","description":"What this price changes from the settings: rush, a repeat job, and whether to price in the tools to buy."},"PriceOut":{"properties":{"currency":{"type":"string","const":"USD","title":"Currency","description":"Every amount is in US dollars."},"quantity":{"type":"integer","title":"Quantity","description":"The quantity asked for: the analysis's."},"batch":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batch","description":"Parts in a batch, when the analysis set one smaller than the quantity. Null: each quantity is one batch."},"rush":{"type":"boolean","title":"Rush","description":"Whether it was priced as a rush order."},"repeat_job":{"type":"boolean","title":"Repeat Job","description":"Whether it was priced as a repeat job: its programming and first article left out, so those lines are nothing. False for a first run, and for every price from before quotes could say.","default":false},"include_tools_to_buy":{"type":"boolean","title":"Include Tools To Buy","description":"Whether the tools-to-buy line was priced in: this quote's choice, else the setting."},"default_rates":{"type":"boolean","title":"Default Rates","description":"True when every rate in the cost lines is Protyus's default: a should-cost, not a shop's price."},"settings":{"$ref":"#/components/schemas/PricingValuesOut","description":"Every pricing value used, each own or default."},"cost_lines":{"items":{"$ref":"#/components/schemas/CostLine"},"type":"array","title":"Cost Lines","description":"The cost lines that were priced, each a quantity times a rate."},"unpriced":{"items":{"$ref":"#/components/schemas/UnpricedLineOut"},"type":"array","title":"Unpriced","description":"Lines that count something but have no rate, so cost nothing here. Price them by setting their rates."},"quantities":{"items":{"$ref":"#/components/schemas/QuantityPriceOut"},"type":"array","title":"Quantities","description":"The price at the quantity asked for, 2x and 5x."}},"type":"object","required":["currency","quantity","batch","rush","include_tools_to_buy","default_rates","settings","cost_lines","unpriced","quantities"],"title":"PriceOut","description":"An analysis's cost lines priced at three quantities, every step shown."},"PriceOverrides":{"properties":{"rush":{"type":"boolean","title":"Rush","description":"Whether it's a rush order: the rush multiplier and fee apply, where the settings set them.","default":false},"include_tools_to_buy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Tools To Buy","description":"Whether to price in the tools to buy for this quote. Null follows quote.include_tools_to_buy in the settings."},"repeat_job":{"type":"boolean","title":"Repeat Job","description":"Whether it's a repeat job: a part the shop has made before, whose program and first article already exist. True leaves programming and the first article out of the price; setup, machining and everything else stay.","default":false}},"additionalProperties":false,"type":"object","title":"PriceOverrides","description":"What one quote changes from the settings."},"PricePreview":{"properties":{"analysis_id":{"type":"string","format":"uuid","title":"Analysis Id","description":"The analysis priced."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"Its project, whose quote settings were used."},"file_name":{"type":"string","title":"File Name","description":"The part's file name."},"price":{"$ref":"#/components/schemas/PriceOut","description":"The price at the quantity asked for, 2x and 5x, every step shown."}},"additionalProperties":false,"type":"object","required":["analysis_id","project_id","file_name","price"],"title":"PricePreview","description":"An analysis priced at today's settings, not saved."},"PricingValueOut":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"boolean"},{"type":"null"}],"title":"Value","description":"The value. Null means none is set, so the step does nothing."},"own":{"type":"boolean","title":"Own","description":"Whether the organization or the project set it, rather than Protyus's default."}},"type":"object","required":["value","own"],"title":"PricingValueOut","description":"One value the price used: the organization's or project's own, or Protyus's default."},"PricingValuesOut":{"properties":{"margin_pct":{"$ref":"#/components/schemas/PricingValueOut","description":"Margin on cost, in percent."},"material_markup_pct":{"$ref":"#/components/schemas/PricingValueOut","description":"Markup on the material line, in percent."},"minimum_charge":{"$ref":"#/components/schemas/PricingValueOut","description":"The least an order is priced at, US dollars."},"rush_multiplier":{"$ref":"#/components/schemas/PricingValueOut","description":"What a rush order's price is multiplied by."},"rush_fee":{"$ref":"#/components/schemas/PricingValueOut","description":"A flat fee added to a rush order, US dollars."},"include_tools_to_buy":{"$ref":"#/components/schemas/PricingValueOut","description":"Whether the tools-to-buy line is priced in, before this quote's own choice."}},"type":"object","required":["margin_pct","material_markup_pct","minimum_charge","rush_multiplier","rush_fee","include_tools_to_buy"],"title":"PricingValuesOut","description":"Every pricing value a price used, each own or default."},"ProcessChoices":{"properties":{"machines":{"items":{"$ref":"#/components/schemas/Choice"},"type":"array","title":"Machines","description":"The machines it may be made on, to send as process_machine: Protyus's cutting machines or presses, then Best Fit (key auto, the default), the cheapest that can make it."},"materials":{"items":{"$ref":"#/components/schemas/Choice"},"type":"array","title":"Materials","description":"The grades or resins it may be made in, to send as process_material; the default is Protyus's."}},"additionalProperties":false,"type":"object","required":["machines","materials"],"title":"ProcessChoices","description":"What a sheet metal or moulding analysis may pick: Protyus's own machines and materials for the process."},"ProcessMachine":{"properties":{"id":{"type":"string","title":"Id","description":"Its id, what an analysis sends as process_machine, such as SM-PL or M-220H."},"name":{"type":"string","title":"Name","description":"What the screen calls it."},"hidden":{"type":"boolean","title":"Hidden","description":"Whether the organization hides it: in no project's choices, and not weighed by Best Fit."}},"additionalProperties":false,"type":"object","required":["id","name","hidden"],"title":"ProcessMachine","description":"One of Protyus's cutting machines or presses, and whether the organization hides it."},"ProcessMachineIds":{"properties":{"process":{"type":"string","enum":["sheet_metal","moulding"],"title":"Process","description":"Whose machines: sheet_metal for cutting machines, moulding for presses."},"ids":{"items":{"type":"string"},"type":"array","maxItems":20,"minItems":1,"title":"Ids","description":"Their ids, from GET /api/v1/organization/process-machines, such as SM-PL or M-220H."}},"additionalProperties":false,"type":"object","required":["process","ids"],"title":"ProcessMachineIds","description":"The cutting machines or presses to hide, show or reset, all of one process."},"ProcessMachinesOut":{"properties":{"sheet_metal":{"items":{"$ref":"#/components/schemas/ProcessMachine"},"type":"array","title":"Sheet Metal","description":"The cutting machines a sheet metal analysis may be made on."},"moulding":{"items":{"$ref":"#/components/schemas/ProcessMachine"},"type":"array","title":"Moulding","description":"The presses a molding analysis may be made on."}},"additionalProperties":false,"type":"object","required":["sheet_metal","moulding"],"title":"ProcessMachinesOut","description":"Protyus's sheet metal cutting machines and molding presses, in Protyus's order, each shown or hidden."},"ProcessScore":{"properties":{"id":{"type":"string","title":"Id","description":"Which score, such as general."},"title":{"type":"string","title":"Title","description":"Its name for people."},"value":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Value","description":"The score, 0 to 100, rounded once from the weighted sum of the checks. Higher is easier to make."},"band":{"$ref":"#/components/schemas/Band","description":"Its colour."},"areas":{"items":{"$ref":"#/components/schemas/ScoreArea"},"type":"array","title":"Areas","description":"Each area it was made of, for analyses run before 0.65.0. Empty since.","default":[]},"checks":{"items":{"$ref":"#/components/schemas/ProcessScoreCheck"},"type":"array","title":"Checks","description":"Each category it's made of, and whether it counts.","default":[]}},"type":"object","required":["id","title","value","band"],"title":"ProcessScore","description":"A process's DFM score (sheet metal, moulding), rounded, with its categories."},"ProcessScoreCheck":{"properties":{"id":{"type":"string","title":"Id","description":"Which check, such as sharp_corners."},"code":{"type":"string","title":"Code","description":"Its code: CHK-01 to CHK-11 for milling, SM-B to SM-X for sheet metal, IM-W to IM-V for moulding."},"title":{"type":"string","title":"Title","description":"Its name for people."},"method":{"type":"string","enum":["ratio","binary"],"title":"Method","description":"ratio: passing features over applicable ones; binary: 0 if any feature fails."},"unit":{"type":"string","title":"Unit","description":"What one applicable feature is, such as surface or hole."},"checked":{"type":"boolean","title":"Checked","description":"False where Protyus can't find these features yet, so it scores 100 with nothing checked."},"applicable":{"type":"integer","title":"Applicable","description":"How many features it applied to."},"passing":{"type":"integer","title":"Passing","description":"How many of them passed."},"value":{"type":"integer","title":"Value","description":"Its score, rounded, 0 to 100. 100 when nothing applies."},"band":{"$ref":"#/components/schemas/Band","description":"Its colour."},"features":{"items":{"$ref":"#/components/schemas/CheckFeature"},"type":"array","title":"Features","description":"Each feature it applied to, failing ones first.","default":[]},"counted":{"type":"boolean","title":"Counted","description":"False for a category that's shown but not counted in the score.","default":true}},"type":"object","required":["id","code","title","method","unit","checked","applicable","passing","value","band"],"title":"ProcessScoreCheck","description":"One of a process's categories, such as SM-B Bends or IM-W Wall thickness, and whether it counts in the score."},"ProcessScorecard":{"properties":{"verdict":{"$ref":"#/components/schemas/Verdict","description":"Whether it can be made as drawn."},"checks":{"items":{"$ref":"#/components/schemas/Check"},"type":"array","title":"Checks","description":"Each named check of the verdict.","default":[]},"scored":{"type":"boolean","title":"Scored","description":"False when the organization or project turned the DFM score off: then there's no score.","default":true},"scores":{"items":{"$ref":"#/components/schemas/ProcessScore"},"type":"array","title":"Scores","description":"Each score. Empty when scoring is off.","default":[]}},"type":"object","required":["verdict"],"title":"ProcessScorecard","description":"A process's verdict, its checks and its scores: sheet metal's, moulding's or the lathe's."},"ProfileDefaults":{"properties":{"feed_pct":{"type":"number","title":"Feed Pct","description":"The share of its calculated feed a profiling pass moves at, percent."}},"additionalProperties":false,"type":"object","required":["feed_pct"],"title":"ProfileDefaults","description":"Protyus's number for 3D profiling."},"ProfileNumbers":{"properties":{"feed_pct":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Feed Pct","description":"The share of its calculated feed a profiling pass moves at, percent, for the finish it leaves. Null for Protyus's 25."}},"additionalProperties":false,"type":"object","title":"ProfileNumbers","description":"3D profiling in one material. Its speed and chip load are the Finish row's, and its stepover the ball's own."},"ProfilingSettings":{"properties":{"surface_finish_ra_um":{"type":"number","maximum":25.0,"minimum":0.1,"title":"Surface Finish Ra Um","description":"Profile milling surface finish: the target Ra, µm, that a bull nose's profiling passes leave. Its stepover between passes is the one that leaves the cusp this finish allows, so a finer finish takes longer. A ball steps by the ball stepover instead (cutting.ball_stepover_pct). Default 3.2 µm (125 µin).","default":3.2},"ruled_surface_tool":{"type":"string","enum":["tapered","straight"],"title":"Ruled Surface Tool","description":"What a 5-axis flank mills ruled surfaces with: tapered, a taper end mill (a tapered ball end mill on a blade), or straight, a straight end mill or ball. Default tapered.","default":"tapered"}},"additionalProperties":false,"type":"object","title":"ProfilingSettings","description":"Profile milling: the finish a bull nose's passes leave, and the tool ruled surfaces are flank milled with. A\nball end mill steps by the ball stepover instead."},"ProgressOut":{"properties":{"kind":{"type":"string","enum":["thinking","step","retry","checking","fixed","reading"],"title":"Kind","description":"thinking: Protyus AI's own few words on what it's about to do; step: a feature added, changed or removed; retry: a change that didn't build, tried another way; checking: the part being quick-checked; fixed: what Protyus fixed itself; reading: Protyus AI reading the check."},"text":{"type":"string","title":"Text","description":"A few words, as the screen shows them."},"seconds":{"type":"number","title":"Seconds","description":"Seconds since the turn began."}},"additionalProperties":false,"type":"object","required":["kind","text","seconds"],"title":"ProgressOut","description":"One thing a turn did, or is doing, in the person's words."},"ProjectDetail":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The project's id."},"name":{"type":"string","title":"Name","description":"Its name."},"owner_id":{"type":"string","title":"Owner Id","description":"The Clerk user id of its owner."},"my_role":{"type":"string","enum":["owner","member","admin"],"title":"My Role","description":"Why the caller sees it: they own it, they're a member, or they're an organization admin."},"can_manage":{"type":"boolean","title":"Can Manage","description":"Whether the caller may delete it and change its members."},"member_count":{"type":"integer","title":"Member Count","description":"How many people are on it, its owner included."},"analysis_count":{"type":"integer","title":"Analysis Count","description":"How many analyses it holds."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was created."},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","description":"The project-scoped permissions the caller holds on this project, such as tools:write: from their roles here and in the organization, or all of them as its owner or an admin."},"members":{"items":{"$ref":"#/components/schemas/ProjectMemberOut"},"type":"array","title":"Members","description":"Everyone on the project."}},"additionalProperties":false,"type":"object","required":["id","name","owner_id","my_role","can_manage","member_count","analysis_count","created_at","permissions","members"],"title":"ProjectDetail","description":"A project with everyone on it."},"ProjectIn":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name","description":"The project's name."}},"additionalProperties":false,"type":"object","required":["name"],"title":"ProjectIn","description":"A new project's name."},"ProjectMemberIn":{"properties":{"user_id":{"type":"string","title":"User Id","description":"The Clerk user id of an organization member to add."}},"additionalProperties":false,"type":"object","required":["user_id"],"title":"ProjectMemberIn","description":"An organization member to add to a project."},"ProjectMemberOut":{"properties":{"user_id":{"type":"string","title":"User Id","description":"Their Clerk user id."},"role":{"type":"string","enum":["owner","member"],"title":"Role","description":"'owner' for the one owner, otherwise 'member'."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Their email address, if known."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Their name, if known."},"roles":{"items":{"type":"string"},"type":"array","title":"Roles","description":"The role keys granted to them on this project only. Organization-scope roles are on the members list."}},"additionalProperties":false,"type":"object","required":["user_id","role","email","name","roles"],"title":"ProjectMemberOut","description":"A person on a project."},"ProjectOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The project's id."},"name":{"type":"string","title":"Name","description":"Its name."},"owner_id":{"type":"string","title":"Owner Id","description":"The Clerk user id of its owner."},"my_role":{"type":"string","enum":["owner","member","admin"],"title":"My Role","description":"Why the caller sees it: they own it, they're a member, or they're an organization admin."},"can_manage":{"type":"boolean","title":"Can Manage","description":"Whether the caller may delete it and change its members."},"member_count":{"type":"integer","title":"Member Count","description":"How many people are on it, its owner included."},"analysis_count":{"type":"integer","title":"Analysis Count","description":"How many analyses it holds."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was created."},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","description":"The project-scoped permissions the caller holds on this project, such as tools:write: from their roles here and in the organization, or all of them as its owner or an admin."}},"additionalProperties":false,"type":"object","required":["id","name","owner_id","my_role","can_manage","member_count","analysis_count","created_at","permissions"],"title":"ProjectOut","description":"A project the caller can see."},"ProjectSettingsIn":{"properties":{"overrides":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverrides"},{"type":"null"}],"description":"Values to set for the project. A field sent as null goes back to the organization's value."},"allowed":{"anyOf":[{"$ref":"#/components/schemas/AllowedChange"},{"type":"null"}],"description":"Lists to narrow, or null per kind to allow everything again."}},"additionalProperties":false,"type":"object","title":"ProjectSettingsIn","description":"A change to a project's settings. Only what's given changes."},"ProjectSettingsOut":{"properties":{"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project."},"organization":{"$ref":"#/components/schemas/OrgSettings","description":"The organization's settings, which the project inherits."},"overrides":{"$ref":"#/components/schemas/SettingsOverrides","description":"What the project sets itself. A null field is inherited."},"allowed":{"$ref":"#/components/schemas/Allowed","description":"The project's narrowed lists. A null kind allows everything."},"resolved":{"$ref":"#/components/schemas/ResolvedSettings","description":"What an analysis in the project uses now."},"choices":{"$ref":"#/components/schemas/Choices","description":"The machines, materials and quantity a new analysis may pick."},"can_edit":{"type":"boolean","title":"Can Edit","description":"Whether the caller may change the project's values (settings:write here)."},"can_edit_pricing":{"type":"boolean","title":"Can Edit Pricing","description":"Whether the caller may change the project's quote settings (pricing:write here)."},"can_edit_lists":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Can Edit Lists","description":"Per kind, whether the caller may narrow its list here."},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"Who last changed them, or null if never."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"When they last changed, or null if never."}},"additionalProperties":false,"type":"object","required":["project_id","organization","overrides","allowed","resolved","choices","can_edit","can_edit_pricing","can_edit_lists","updated_by","updated_at"],"title":"ProjectSettingsOut","description":"A project's settings: what it sets, what it inherits, and what that resolves to."},"ProjectTolerancesIn":{"properties":{"rows":{"additionalProperties":true,"type":"object","title":"Rows","description":"Operation to its own values, such as {\"finish_mill\": {\"plus_minus_mm\": 0.05}}. Null for an operation clears the project's values."}},"additionalProperties":false,"type":"object","required":["rows"],"title":"ProjectTolerancesIn","description":"A project's own values for capability rows, by operation. A row sent as null goes back to the organization's."},"ProjectTolerancesOut":{"properties":{"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project."},"general_tolerance":{"additionalProperties":true,"type":"object","title":"General Tolerance","description":"The general tolerance the project uses, its own or the organization's."},"general_overridden":{"type":"boolean","title":"General Overridden","description":"Whether the project sets its own general tolerance."},"rows":{"items":{},"type":"array","title":"Rows","description":"Each operation's row: the organization's values with the project's own on top."},"can_edit":{"type":"boolean","title":"Can Edit","description":"Whether the caller may change the project's values (tolerances:write here)."}},"additionalProperties":false,"type":"object","required":["project_id","general_tolerance","general_overridden","rows","can_edit"],"title":"ProjectTolerancesOut","description":"What the shop holds, as a project sees it."},"PublicAiOut":{"properties":{"included":{"type":"boolean","title":"Included","description":"Whether the plan comes with Protyus AI."},"messages_a_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Messages A Month","description":"Messages the company can send a billing month, a fair-use limit. Null when there's no monthly limit."},"messages_in_all":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Messages In All","description":"Messages the company can send in all, never refreshed: a taste of Protyus AI. Null when there's no such limit."}},"additionalProperties":false,"type":"object","required":["included","messages_a_month","messages_in_all"],"title":"PublicAiOut","description":"Protyus AI, the chat that works on the company's parts and quotes."},"PublicCreditPackOut":{"properties":{"analyses":{"type":"integer","title":"Analyses","description":"Analyses in a pack. They're used once the month's allowance is gone."},"price_usd":{"type":"number","title":"Price Usd","description":"A pack's price, in US dollars."},"months":{"type":"integer","title":"Months","description":"How many months a pack lasts."}},"additionalProperties":false,"type":"object","required":["analyses","price_usd","months"],"title":"PublicCreditPackOut","description":"Credits: analyses on top of a plan's month, bought in packs on any paid plan (each plan's `credits`)."},"PublicFormIn":{"properties":{"email":{"type":"string","maxLength":320,"title":"Email","description":"Their email address, where the upload link goes. Always required."},"answers":{"$ref":"#/components/schemas/Answers","description":"Their answers to the form's other fields.","default":{}},"consent":{"type":"boolean","title":"Consent","description":"Whether they ticked the consent box. Required.","default":false},"turnstile_token":{"type":"string","maxLength":4096,"title":"Turnstile Token","description":"The token Cloudflare Turnstile's widget gave the page.","default":""}},"additionalProperties":false,"type":"object","required":["email"],"title":"PublicFormIn","description":"What someone sends through a submission link's form."},"PublicFormOut":{"properties":{"sender_name":{"type":"string","title":"Sender Name","description":"Who the form is for: the shop's sender name."},"logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo","description":"The shop's logo as a data: URI, or null. Never the stored URL, which is private."},"form":{"$ref":"#/components/schemas/FormFields","description":"Which fields to ask for: each off, optional or required. Email is always required."},"privacy_url":{"type":"string","title":"Privacy Url","description":"The shop's privacy policy, linked from the consent box, which must be ticked."},"consent_text":{"type":"string","title":"Consent Text","description":"The consent box's words."},"turnstile_site_key":{"type":"string","title":"Turnstile Site Key","description":"The Cloudflare Turnstile site key the form's bot check widget uses."}},"additionalProperties":false,"type":"object","required":["sender_name","logo","form","privacy_url","consent_text","turnstile_site_key"],"title":"PublicFormOut","description":"What a submission link's public form shows. Nothing else: no link name, id, project or settings."},"PublicPlanOut":{"properties":{"key":{"type":"string","enum":["free","hobbyist","pro","enterprise"],"title":"Key","description":"free, hobbyist, pro or enterprise."},"name":{"type":"string","title":"Name","description":"What it's called."},"users":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Users","description":"People in the company, counting pending invitations. Null for no limit."},"analyses_a_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Analyses A Month","description":"Distinct parts the company can analyse a billing month. Re-running the same file is free. Null for no limit."},"ai":{"$ref":"#/components/schemas/PublicAiOut","description":"Protyus AI on this plan."},"quotes_per_part":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quotes Per Part","description":"Quotes the company can keep for each part: 0 means it keeps no quotes. Versions of a quote are free. Null for no limit."},"pricing":{"type":"boolean","title":"Pricing","description":"Whether the company can price a part: the price to charge at its margin, quantity breaks and the quote to send. Every plan shows what a part costs to make."},"submission_links":{"type":"boolean","title":"Submission Links","description":"Whether the company can collect parts and leads from its own website."},"api_and_mcp":{"type":"boolean","title":"Api And Mcp","description":"Whether the company's people can use Protyus with an API key: the REST API, and the MCP server from Claude Code and other agents. The app, Protyus AI included, works on every plan."},"credits":{"type":"boolean","title":"Credits","description":"Whether the company can buy credits, analyses on top of the month's. Every paid plan; not Free."},"price":{"anyOf":[{"$ref":"#/components/schemas/PublicPriceOut"},{"type":"null"}],"description":"What it costs. Null when no price is set for it."}},"additionalProperties":false,"type":"object","required":["key","name","users","analyses_a_month","ai","quotes_per_part","pricing","submission_links","api_and_mcp","credits","price"],"title":"PublicPlanOut","description":"One plan, as the pricing page shows it."},"PublicPlansOut":{"properties":{"plans":{"items":{"$ref":"#/components/schemas/PublicPlanOut"},"type":"array","title":"Plans","description":"Free, Hobbyist, Pro and Enterprise, smallest first."},"trial":{"$ref":"#/components/schemas/PublicTrialOut","description":"The free trial."},"credit_pack":{"$ref":"#/components/schemas/PublicCreditPackOut","description":"What one pack of credits is."}},"additionalProperties":false,"type":"object","required":["plans","trial","credit_pack"],"title":"PublicPlansOut","description":"Every plan a company can subscribe to, the trial and the credit pack."},"PublicPriceOut":{"properties":{"monthly_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Monthly Usd","description":"A month, billed monthly. Null when it isn't set."},"yearly_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yearly Usd","description":"A year, billed yearly. Null when it isn't set."}},"additionalProperties":false,"type":"object","required":["monthly_usd","yearly_usd"],"title":"PublicPriceOut","description":"What a plan costs a company, in US dollars. One price covers every user the plan allows."},"PublicTrialOut":{"properties":{"plan":{"type":"string","enum":["free","hobbyist","pro","enterprise"],"title":"Plan","description":"The plan it's a trial of."},"days":{"type":"integer","title":"Days","description":"How long it lasts."},"analyses":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Analyses","description":"Parts it can analyse in all. Null for no limit."}},"additionalProperties":false,"type":"object","required":["plan","days","analyses"],"title":"PublicTrialOut","description":"The free trial a new company starts with."},"QuantityPriceOut":{"properties":{"quantity":{"type":"integer","title":"Quantity","description":"How many parts."},"multiple":{"type":"integer","title":"Multiple","description":"1 for the quantity asked for, 2 or 5 for the larger columns."},"batches":{"type":"integer","title":"Batches","description":"How many batches the quantity is made in."},"lines":{"items":{"$ref":"#/components/schemas/LineAmount"},"type":"array","title":"Lines","description":"Each cost line at this quantity, in the engine's order."},"steps":{"items":{"$ref":"#/components/schemas/StepOut"},"type":"array","title":"Steps","description":"Cost lines, material markup, tools to buy, margin, rush and minimum, in order."},"cost":{"type":"number","title":"Cost","description":"US dollars before margin: the total after the tools-to-buy step."},"price":{"type":"number","title":"Price","description":"US dollars for the order: the total after the last step."},"price_each":{"type":"number","title":"Price Each","description":"US dollars a part: the price over the quantity, to the cent."},"tool_list_planned_for":{"type":"integer","title":"Tool List Planned For","description":"The quantity the tool list was planned at. Differs from quantity in the 2x and 5x columns, whose prices keep that tool list."}},"type":"object","required":["quantity","multiple","batches","lines","steps","cost","price","price_each","tool_list_planned_for"],"title":"QuantityPriceOut","description":"The price at one quantity."},"QuantityRange":{"properties":{"default":{"type":"integer","title":"Default","description":"The quantity to show first: the project's default quantity."},"min":{"type":"integer","title":"Min","description":"The fewest that can be asked for."},"max":{"type":"integer","title":"Max","description":"The most that can be asked for."}},"additionalProperties":false,"type":"object","required":["default","min","max"],"title":"QuantityRange","description":"The quantity the upload page asks for."},"QuoteDetail":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The quote's id."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project it's in."},"analysis_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Analysis Id","description":"The analysis it prices, or null once that's deleted."},"file_name":{"type":"string","title":"File Name","description":"The part's file name."},"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine it was planned on, from the latest version."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material, from the latest version."},"quantity":{"type":"integer","title":"Quantity","description":"The quantity asked for."},"version":{"type":"integer","title":"Version","description":"The latest version's number."},"price":{"type":"number","title":"Price","description":"The latest version's price for the order at the quantity asked for, US dollars."},"price_each":{"type":"number","title":"Price Each","description":"The same, a part."},"default_rates":{"type":"boolean","title":"Default Rates","description":"Whether every rate is Protyus's default: a should-cost, not a shop's price."},"created_by":{"type":"string","title":"Created By","description":"Who made it, a Clerk user id."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When version 1 was made."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the latest version was made."},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At","description":"When it was archived, or null. Archived quotes are left out of lists."},"can_write":{"type":"boolean","title":"Can Write","description":"Whether the caller may add versions and archive it (quotes:write on the project)."},"versions":{"items":{"$ref":"#/components/schemas/QuoteVersionOut"},"type":"array","title":"Versions","description":"Every version, newest first. None is ever changed or deleted."}},"additionalProperties":false,"type":"object","required":["id","project_id","analysis_id","file_name","machine","material","quantity","version","price","price_each","default_rates","created_by","created_at","updated_at","archived_at","can_write","versions"],"title":"QuoteDetail","description":"A quote with every version, newest first."},"QuoteEstimate":{"properties":{"material":{"anyOf":[{"$ref":"#/components/schemas/analyses__customer__Material"},{"type":"null"}],"description":"The material."},"quantity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity","description":"How many parts."},"batch":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Batch","description":"Parts in a batch."},"machine":{"anyOf":[{"$ref":"#/components/schemas/EstimateMachine"},{"type":"null"}],"description":"The machine."},"stock":{"anyOf":[{"$ref":"#/components/schemas/Stock"},{"type":"null"}],"description":"The stock."},"time":{"anyOf":[{"$ref":"#/components/schemas/RouteTime"},{"type":"null"}],"description":"The machining time, each operation on its machine where a route runs on more than one."},"cost_lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/CostLine"},"type":"array"},{"type":"null"}],"title":"Cost Lines","description":"Every cost line."},"cost":{"anyOf":[{"$ref":"#/components/schemas/Cost"},{"type":"null"}],"description":"The totals."},"tools":{"anyOf":[{"$ref":"#/components/schemas/EstimateTools"},{"type":"null"}],"description":"Tools to buy, suggested and shared."}},"type":"object","title":"QuoteEstimate","description":"The estimate a quote version priced, as it was then. Any part may be missing from an old version."},"QuoteOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The quote's id."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project it's in."},"analysis_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Analysis Id","description":"The analysis it prices, or null once that's deleted."},"file_name":{"type":"string","title":"File Name","description":"The part's file name."},"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine it was planned on, from the latest version."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material, from the latest version."},"quantity":{"type":"integer","title":"Quantity","description":"The quantity asked for."},"version":{"type":"integer","title":"Version","description":"The latest version's number."},"price":{"type":"number","title":"Price","description":"The latest version's price for the order at the quantity asked for, US dollars."},"price_each":{"type":"number","title":"Price Each","description":"The same, a part."},"default_rates":{"type":"boolean","title":"Default Rates","description":"Whether every rate is Protyus's default: a should-cost, not a shop's price."},"created_by":{"type":"string","title":"Created By","description":"Who made it, a Clerk user id."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When version 1 was made."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the latest version was made."},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At","description":"When it was archived, or null. Archived quotes are left out of lists."},"can_write":{"type":"boolean","title":"Can Write","description":"Whether the caller may add versions and archive it (quotes:write on the project)."}},"additionalProperties":false,"type":"object","required":["id","project_id","analysis_id","file_name","machine","material","quantity","version","price","price_each","default_rates","created_by","created_at","updated_at","archived_at","can_write"],"title":"QuoteOut","description":"A quote, with its latest version's price."},"QuoteSettings":{"properties":{"margin_pct":{"type":"number","maximum":1000.0,"minimum":0.0,"title":"Margin Pct","description":"Margin on cost, in percent: price = cost x (1 + margin). Default 15.","default":15},"material_markup_pct":{"type":"number","maximum":1000.0,"minimum":0.0,"title":"Material Markup Pct","description":"Markup on the material line, in percent, added to cost before margin. Default 10.","default":10},"minimum_charge":{"anyOf":[{"type":"number","maximum":10000000.0,"minimum":0.0},{"type":"null"}],"title":"Minimum Charge","description":"The least an order is priced at, US dollars, after margin and rush. Null for none, the default: a shop sets its own."},"rush_multiplier":{"anyOf":[{"type":"number","maximum":10.0,"minimum":1.0},{"type":"null"}],"title":"Rush Multiplier","description":"What a rush order's price is multiplied by, such as 1.5. Null for none, the default: a shop sets its own."},"rush_fee":{"anyOf":[{"type":"number","maximum":10000000.0,"minimum":0.0},{"type":"null"}],"title":"Rush Fee","description":"A flat fee added to a rush order's price, US dollars, after the multiplier. Null for none, the default."},"include_tools_to_buy":{"type":"boolean","title":"Include Tools To Buy","description":"Whether the tools-to-buy line is priced in. Default yes, so a designer's should-cost covers the whole job. A shop that keeps its tools turns it off; one quote can also leave the line out.","default":true},"lead_time_text":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Lead Time Text","description":"The lead time the customer's quote states, as the shop words it, such as \"10 working days from order\". Null for none, the default: the quote leaves the line out."},"valid_days":{"type":"integer","maximum":365.0,"minimum":1.0,"title":"Valid Days","description":"How many days a quote holds, from the moment its version is saved. Default 30.","default":30},"terms_text":{"type":"string","maxLength":2000,"minLength":1,"title":"Terms Text","description":"The terms printed at the foot of the customer's quote. Default: prices in US dollars, for the part as drawn, with payment, delivery and shipping agreed when the order is placed.","default":"Prices are in US dollars, for the part as drawn in the file named above. Payment, delivery and shipping are agreed when the order is placed."}},"additionalProperties":false,"type":"object","title":"QuoteSettings","description":"How a quote turns cost lines into a price, and what the customer's quote says around it. Changing them needs pricing:write."},"QuoteVersionOut":{"properties":{"number":{"type":"integer","title":"Number","description":"Its number, from 1."},"analysis_id":{"type":"string","format":"uuid","title":"Analysis Id","description":"The analysis it priced. It may have been deleted since; the version keeps what it priced."},"part_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Part Version Id","description":"The final part version it priced: the STEP file the analysis was of. Null for a version saved before parts were kept whose analysis was deleted first."},"overrides":{"$ref":"#/components/schemas/PriceOverrides","description":"This version's rush, repeat-job and tools-to-buy choice."},"repriced":{"type":"boolean","title":"Repriced","description":"Whether it took the quote settings of its day. False when it kept the last version's."},"price":{"$ref":"#/components/schemas/PriceOut","description":"The price at three quantities, every step shown, as saved."},"estimate":{"$ref":"#/components/schemas/QuoteEstimate","description":"The analysis's estimate as priced: machine, material, stock, time per setup, cost lines and tools. A repeat job's has no programming or first article. Any part may be missing from an old version."},"terms":{"$ref":"#/components/schemas/VersionTerms","description":"The lead time, validity and terms the customer's quote states, from the quote settings it was priced with. A version saved before these were settings has the defaults: 30 days, the standard terms and no lead time."},"created_by":{"type":"string","title":"Created By","description":"Who made it, a Clerk user id."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was made."}},"additionalProperties":false,"type":"object","required":["number","analysis_id","overrides","repriced","price","estimate","terms","created_by","created_at"],"title":"QuoteVersionOut","description":"One saved version of a quote. It never changes."},"RadiusCount":{"properties":{"radius":{"type":"number","title":"Radius","description":"The radius, mm."},"count":{"type":"integer","title":"Count","description":"How many faces have it."}},"type":"object","required":["radius","count"],"title":"RadiusCount","description":"A radius and how many faces have it."},"Rates":{"properties":{"operator":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Operator","description":"Machine operator, US dollars per hour, loaded, for running, loading and unloading a machine with no labour rate of its own. A machine's own labour rate is blended and covers setup, loading and running. Null for Protyus's default."},"setup_machinist":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Setup Machinist","description":"Setup machinist, US dollars per hour, loaded, for setting up a machine with no labour rate of its own. Null for Protyus's default."},"programming":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Programming","description":"CAM programming, US dollars per hour. Null for Protyus's default."},"programming_hours":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours","description":"CAM programming hours, once per job, whatever the part. Null for Protyus's default, by the part's feature count."},"programming_hours_up_to_100":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Up To 100","description":"CAM programming hours for a part with 100 features or fewer. Null for 3."},"programming_hours_up_to_400":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Up To 400","description":"CAM programming hours for a part with 101 to 400 features. Null for 6."},"programming_hours_over_400":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Over 400","description":"CAM programming hours for a part with more than 400 features. Null for 8."},"setup_minutes":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Setup Minutes","description":"Setup time for each setup, minutes: mounting the fixture and the part and loading the program, before tool setting. No fixture time is added on top of it. Null for Protyus's default, which it works out from the part."},"tool_setting_minutes":{"anyOf":[{"type":"number","maximum":600.0,"minimum":0.0},{"type":"null"}],"title":"Tool Setting Minutes","description":"Minutes to set each tool, every time a program runs. Null for Protyus's default, 3."},"angled_fixture_minutes":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Angled Fixture Minutes","description":"Minutes added to a setup that needs an angled fixture. Null for Protyus's default, 15."},"prove_out_factor":{"anyOf":[{"type":"number","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Prove Out Factor","description":"First article multiplier: the first part of each job takes this many times the cycle time, in total, so 1 is a normal cycle. Null for Protyus's default, 4."},"overhead_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Overhead Pct","description":"Overhead, in percent, added on machine time, operator, handling, setup and programming as its own cost line. Null for Protyus's default, none."},"inspection":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Inspection","description":"Inspection, US dollars per hour. Null until set."}},"additionalProperties":false,"type":"object","title":"Rates","description":"Labour rates, programming time, setup times and overhead for costing. Null until the shop enters them, and\ncosting uses Protyus's default meanwhile (`protyus_defaults`). A machine's own labour rate and overhead win\nover the operator, setup machinist and overhead here."},"ReadIn":{"properties":{"instruction":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Instruction","description":"Their words with it, such as \"make this in 6061\"."}},"additionalProperties":false,"type":"object","title":"ReadIn","description":"What the person said with the attachment, if anything."},"ReadItem":{"properties":{"id":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_-]{1,12}$"},{"type":"null"}],"title":"Id","description":"Its id in the reading, such as r3; none for one the person added."},"kind":{"type":"string","enum":["size","hole","thread","note"],"title":"Kind","description":"size, hole, thread or note."},"label":{"type":"string","maxLength":120,"minLength":1,"title":"Label","description":"What it is, in a shop's words, such as Overall length or Mounting holes."},"value":{"anyOf":[{"type":"number","maximum":100000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Value","description":"Its size: a length, a diameter or an angle."},"unit":{"anyOf":[{"type":"string","enum":["mm","in","deg"]},{"type":"null"}],"title":"Unit","description":"The value's unit."},"count":{"anyOf":[{"type":"integer","maximum":500.0,"minimum":1.0},{"type":"null"}],"title":"Count","description":"How many, for holes and threads."},"spec":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Spec","description":"The rest of the feature as written, such as M6x1, H7, 12 deep, or 1/4-20 UNC."}},"additionalProperties":false,"type":"object","required":["kind","label"],"title":"ReadItem","description":"One size, hole, thread or note read from a drawing: as Protyus AI read it, or as the person corrected it."},"ReadingOut":{"properties":{"attachment":{"$ref":"#/components/schemas/AttachmentOut","description":"The file it read."},"kind":{"type":"string","enum":["drawing","sketch","photo","other"],"title":"Kind","description":"What it read."},"units":{"type":"string","enum":["mm","in","unknown"],"title":"Units","description":"The units the drawing's sizes are in."},"summary":{"type":"string","title":"Summary","description":"What the part is, and the views or sides it shows."},"items":{"items":{"$ref":"#/components/schemas/ReadItem"},"type":"array","title":"Items","description":"Every size, hole, thread and note it will build from.","default":[]},"left_out":{"items":{"type":"string"},"type":"array","title":"Left Out","description":"What it saw but won't build from, and why.","default":[]}},"additionalProperties":false,"type":"object","required":["attachment","kind","units","summary"],"title":"ReadingOut","description":"What Protyus AI read from an attachment, before anything is built: check it, correct a size, then run a turn\nwith the attachment and the items as confirmed."},"Reason":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"A stable code, such as SCORE_UNDER_MINIMUM, or null."},"message":{"type":"string","title":"Message","description":"The reason in plain words, such as Score 64, under 80."}},"additionalProperties":false,"type":"object","required":["code","message"],"title":"Reason","description":"Why a part or submission was held, or why a part couldn't be analysed."},"Recognition":{"properties":{"roles":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Roles","description":"Each face's role, by face: floor, fillet, pocket_wall, wall_corner, open_wall, hole, face_chain, top, planar_face, sliver, text or thread."},"holes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Hole"},"type":"array"},{"type":"null"}],"title":"Holes","description":"Every round hole."},"threads":{"anyOf":[{"items":{"$ref":"#/components/schemas/Thread"},"type":"array"},{"type":"null"}],"title":"Threads","description":"Every thread modeled into the part, which the DFM score fails (CHK-09)."},"pockets":{"anyOf":[{"items":{"$ref":"#/components/schemas/Pocket"},"type":"array"},{"type":"null"}],"title":"Pockets","description":"Every pocket."},"floors":{"anyOf":[{"items":{"$ref":"#/components/schemas/FloorRecord"},"type":"array"},{"type":"null"}],"title":"Floors","description":"Every floor on the chosen plan, with what sizes its tool and the tool. Absent for analyses run before 0.101.0."},"walls":{"anyOf":[{"items":{"$ref":"#/components/schemas/WallRecord"},"type":"array"},{"type":"null"}],"title":"Walls","description":"Every wall on the chosen plan, with what sizes its tool and the tool. Absent for analyses run before 0.101.0."},"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine the analysis planned for, as setup_plan.machine."},"setup_plan":{"anyOf":[{"$ref":"#/components/schemas/SetupPlan"},{"type":"null"}],"description":"The setups on that machine."},"machine_plans":{"anyOf":[{"items":{"$ref":"#/components/schemas/SetupPlan"},"type":"array"},{"type":"null"}],"title":"Machine Plans","description":"The setups on every machine type, that machine first, to compare."},"dfm":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/Dfm"},"type":"object"},{"type":"null"}],"title":"Dfm","description":"Each plan's findings and scorecard, by machine as in machine_plans."},"looks_turned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Looks Turned","description":"Whether it looks like a lathe part, which isn't supported, so the rest may be wrong."},"looks_sheet_metal":{"anyOf":[{"$ref":"#/components/schemas/SheetMetalLook"},{"type":"null"}],"description":"Its thickness and bends where it looks like sheet metal, one thickness all over; null where it doesn't. The rest is still planned as milled. Absent for analyses run before 0.121.0."},"estimate":{"anyOf":[{"$ref":"#/components/schemas/Estimate"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Estimate","description":"The estimate for the chosen plan, or why there isn't one. Absent for analyses run before estimates."},"machine_comparison":{"anyOf":[{"$ref":"#/components/schemas/Comparison"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Machine Comparison","description":"Every machine side by side, or why not."},"thickness_rays":{"anyOf":[{"items":{"$ref":"#/components/schemas/ThicknessRay"},"type":"array"},{"type":"null"}],"title":"Thickness Rays","description":"Lines through the metal, spread over every face with each flat face's shortest among them, thinnest first, at most 1500. Absent for analyses run before it was measured."}},"type":"object","title":"Recognition","description":"What's on the part and how it's made. Each key is here unless sections leaves it out."},"ReferenceGrade":{"properties":{"key":{"type":"string","title":"Key","description":"Its key, such as 6061."},"name":{"type":"string","title":"Name","description":"Its name, such as 6061-T6 aluminium."},"family":{"type":"string","enum":["metal","plastic"],"title":"Family","description":"metal or plastic."},"iso_group":{"type":"string","title":"Iso Group","description":"Its ISO 513 group, such as N."},"cutting_group":{"type":"string","title":"Cutting Group","description":"The cutting group whose speeds and feeds it uses, by its code, such as N1.2.Z.AG."},"density_g_cm3":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Density G Cm3","description":"Its density, g/cm³. Null where it isn't known yet."}},"type":"object","required":["key","name","family","iso_group","cutting_group","density_g_cm3"],"title":"ReferenceGrade","description":"One of Protyus's reference grades."},"ReferenceMachine":{"properties":{"key":{"type":"string","title":"Key","description":"Its key, such as haas-vf-2."},"name":{"type":"string","title":"Name","description":"Its make and model, such as Haas VF-2."},"machine_class":{"type":"string","enum":["3_axis","4_axis","3_2","5_axis","lathe","mill_turn"],"title":"Machine Class","description":"Its class."},"class_label":{"type":"string","title":"Class Label","description":"What the screen calls its class."},"make":{"type":"string","title":"Make","description":"Its maker, such as Haas."},"model":{"type":"string","title":"Model","description":"Its model, such as VF-2."},"verified":{"type":"boolean","title":"Verified","description":"Whether its specs were checked against the maker's or a dealer's spec sheet. Others are approximate: confirm them with the maker."},"rotary_tilt_deg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rotary Tilt Deg","description":"How far its tilting rotary axis travels, degrees, as the maker gives it. Kept for reference: planning uses its class's max tilt."},"machine":{"$ref":"#/components/schemas/Machine","description":"The machine it fills in: its class, make, model and specs, its hourly rate (which includes overhead, so its own overhead is 0) and labour. Change the name to the shop's own, such as Haas VF-2 #3."}},"additionalProperties":false,"type":"object","required":["key","name","machine_class","class_label","make","model","verified","machine"],"title":"ReferenceMachine","description":"One of Protyus's reference machines: a real model with its maker's specs, which fills in a new machine of its class."},"RemovedMember":{"properties":{"user_id":{"type":"string","title":"User Id","description":"Who was removed."},"projects_reassigned":{"type":"integer","title":"Projects Reassigned","description":"How many of their projects now belong to the admin who removed them."}},"additionalProperties":false,"type":"object","required":["user_id","projects_reassigned"],"title":"RemovedMember","description":"The result of removing someone from the organization."},"Rerun":{"properties":{"status":{"type":"string","enum":["running","failed"],"title":"Status","description":"running while the engine works on it; failed if it couldn't finish, with the analysis's last result kept."},"started_at":{"type":"string","format":"date-time","title":"Started At","description":"When it started."},"error":{"anyOf":[{"$ref":"#/components/schemas/AnalysisError"},{"type":"null"}],"description":"Why it failed, when status is failed. Otherwise null."}},"additionalProperties":false,"type":"object","required":["status","started_at"],"title":"Rerun","description":"A re-run of an analysis on its own file, to apply a change to its lines' tools."},"RerunIn":{"properties":{"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine to plan for, from the project's choices; auto for Best Fit. Null for this analysis's."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material, by id or reference grade. Null for this analysis's."},"quantity":{"anyOf":[{"type":"integer","maximum":1000000.0,"minimum":1.0},{"type":"null"}],"title":"Quantity","description":"How many parts in the batch. Null for this analysis's."},"annual_volume":{"anyOf":[{"type":"integer","maximum":100000000.0,"minimum":1.0},{"type":"null"}],"title":"Annual Volume","description":"How many parts a year. Null for this analysis's."},"process_machine":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Process Machine","description":"For sheet metal or moulding, the machine to make it on; auto for Best Fit. Null for this analysis's. One that isn't the process's is refused with PROCESS_MACHINE_NOT_FOUND."},"process_material":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Process Material","description":"For sheet metal or moulding, the grade or resin. Null for this analysis's. One that isn't the process's is refused with PROCESS_MATERIAL_NOT_FOUND."},"parting_plane":{"anyOf":[{"$ref":"#/components/schemas/PartingPlaneIn"},{"type":"null"}],"description":"For moulding, a parting plane set by hand, given one way (point and normal, three points, a flat face or two edges); its normal sets the pull. Null for the plane the engine finds where the draft turns round the outside of the part. On any other process it's refused with PARTING_PLANE_NOT_MOULDING. Null runs it with the plane the engine finds, which is how a plane set by hand is reset. A face or edge named that the part hasn't is refused with PARTING_FACE_NOT_FOUND or PARTING_EDGE_NOT_FOUND."},"app_version":{"$ref":"#/components/schemas/AppVersion","description":"The version of the app making the request.","default":{"number":"unknown","commit":"local"}}},"additionalProperties":false,"type":"object","title":"RerunIn","description":"An analysis's own STEP file to run again as its part's next iteration, with changed picks.\n\nEach pick left out is this analysis's, if the project still allows it, else the project's default. The analysis\nitself keeps its result."},"ResolvedMachine":{"properties":{"id":{"type":"string","title":"Id","description":"The machine's library item id."},"revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Revision Id","description":"The machine's revision these values come from."},"name":{"type":"string","title":"Name","description":"Its name."},"machine_class":{"type":"string","enum":["3_axis","4_axis","3_2","5_axis","lathe","mill_turn"],"title":"Machine Class","description":"Its class."},"class_label":{"type":"string","title":"Class Label","description":"What the screen calls its class."},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Make","description":"Its maker."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Its model."},"generic":{"type":"boolean","title":"Generic","description":"Whether Protyus made it as the organization's stand-in for its class.","default":false},"loaded_tools_collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Loaded Tools Collection Id","description":"The tool collection in its magazine. Stored, not planned from yet."},"values":{"items":{"$ref":"#/components/schemas/MachineValue"},"type":"array","title":"Values","description":"Every value, in the screen's order."}},"additionalProperties":false,"type":"object","required":["id","revision_id","name","machine_class","class_label","values"],"title":"ResolvedMachine","description":"A machine with every value filled in from its class where it leaves one empty."},"ResolvedMaterial":{"properties":{"id":{"type":"string","title":"Id","description":"Its library item id. Send it as an analysis's material."},"revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Revision Id","description":"The revision these values come from."},"name":{"type":"string","title":"Name","description":"Its name."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"The reference grade it is, or null for a custom grade."},"custom":{"type":"boolean","title":"Custom","description":"Whether it's the organization's own grade."},"family":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family","description":"metal or plastic."},"cutting_group":{"type":"string","title":"Cutting Group","description":"The cutting group whose speeds and feeds it uses."},"stock_price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Stock Price","description":"The shop's raw stock price, US dollars per kg, or null for Protyus's list price."},"price_as_of":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Price As Of","description":"When the stock price was set."},"form_factors":{"$ref":"#/components/schemas/FormFactors","description":"What scales the stock price for each stock form, each 1.0 unless set."}},"additionalProperties":false,"type":"object","required":["id","revision_id","name","reference","custom","family","cutting_group","stock_price","price_as_of","form_factors"],"title":"ResolvedMaterial","description":"A grade the organization offers, with its reference grade's values filled in."},"ResolvedRow":{"properties":{"operation":{"type":"string","enum":["rough_mill","finish_mill","drill_hss","drill_carbide","ream","bore","tap"],"title":"Operation","description":"The operation: rough_mill, finish_mill, drill_hss, drill_carbide, ream, bore or tap."},"label":{"type":"string","maxLength":80,"minLength":1,"title":"Label","description":"What the screen calls it."},"plus_minus_mm":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Plus Minus Mm","description":"The ± tolerance it holds, mm. Null when it's given as limits, an IT grade or not known."},"plus_mm":{"anyOf":[{"type":"number","maximum":10.0,"minimum":0.0},{"type":"null"}],"title":"Plus Mm","description":"When it holds a one-sided tolerance: how far over size, mm, such as 0.127 for +0.005 in."},"minus_mm":{"anyOf":[{"type":"number","maximum":10.0,"minimum":0.0},{"type":"null"}],"title":"Minus Mm","description":"When it holds a one-sided tolerance: how far under size, mm, such as 0 for -0.000 in."},"it_grade":{"anyOf":[{"type":"integer","maximum":18.0,"minimum":1.0},{"type":"null"}],"title":"It Grade","description":"The ISO 286 IT grade it holds, such as 7 for H7. Null when not known."},"thread_class":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Thread Class","description":"For tapping: the thread class it holds, such as 6H."},"ra_um":{"anyOf":[{"type":"number","maximum":50.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Ra Um","description":"The surface finish it leaves, Ra in µm. Null when not known."},"leaves_mm":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Leaves Mm","description":"For roughing: the stock it leaves for the finish pass, mm."},"plastics_factor":{"type":"number","maximum":10.0,"minimum":1.0,"title":"Plastics Factor","description":"How much looser it holds in plastics: the tolerance times this.","default":2.0},"provisional":{"type":"boolean","title":"Provisional","description":"Whether the values are Protyus's seed, not yet confirmed by a machinist.","default":false},"from_protyus":{"type":"boolean","title":"From Protyus","description":"Whether the values are Protyus's default, not the shop's own. Defaults follow the seed until the shop edits them.","default":false},"id":{"type":"string","title":"Id","description":"The row's library item id."},"revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Revision Id","description":"The row's revision these values come from."},"overridden":{"items":{"type":"string"},"type":"array","title":"Overridden","description":"The fields the project sets itself.","default":[]}},"additionalProperties":false,"type":"object","required":["operation","label","id","revision_id"],"title":"ResolvedRow","description":"A row as an analysis uses it: the organization's, with the project's own values on top."},"ResolvedSettings":{"properties":{"units":{"type":"string","enum":["inch","mm"],"title":"Units","description":"Display units, inch or mm. Lengths are always stored in mm.","default":"mm"},"defaults":{"$ref":"#/components/schemas/Defaults","description":"The machine, material and quantity a new analysis starts from.","default":{"machine":"3_axis","material":"6061","quantity":1}},"rates":{"$ref":"#/components/schemas/Rates","description":"Labour rates, programming hours and overhead for costing.","default":{}},"rule_limits":{"$ref":"#/components/schemas/RuleLimits","description":"DFM rule limits the shop has tuned, each defaulting to Protyus's.","default":{"thin_wall":{"min_ratio":8.0},"long_reach":{"max_ratio":4.0},"non_standard_fillet":{"corner_radii_mm":[0.127,0.254,0.762,1.524,1.5875,2.286,2.54,3.175]},"non_standard_hole":{"drill_sizes_mm":[0.3429,0.3683,0.3969,0.4064,0.4572,0.508,0.5334,0.5715,0.6096,0.635,0.6604,0.7112,0.7417,0.7874,0.7937,0.8128,0.8382,0.889,0.9144,0.9398,0.9652,0.9906,1.0,1.016,1.0414,1.0668,1.0922,1.1,1.1811,1.1906,1.2,1.3,1.3208,1.397,1.4,1.5,1.5113,1.5875,1.6,1.6129,1.7,1.7018,1.778,1.8,1.8542,1.9,1.9304,1.9844,1.9939,2.0,2.0574,2.0828,2.1,2.1844,2.2,2.2606,2.3,2.3749,2.3812,2.4,2.4384,2.4892,2.5,2.5273,2.5781,2.6,2.6416,2.7,2.7051,2.7781,2.794,2.8,2.8194,2.8702,2.9,2.9464,3.0,3.048,3.1,3.175,3.2,3.2639,3.3,3.4,3.4544,3.5,3.5687,3.5719,3.6,3.6576,3.7,3.7338,3.7973,3.8,3.8608,3.9,3.9116,3.9688,3.9878,4.0,4.0386,4.0894,4.1,4.2,4.2164,4.3,4.3053,4.3656,4.3942,4.4,4.4958,4.5,4.572,4.6,4.6228,4.699,4.7,4.7625,4.8,4.8006,4.8514,4.9,4.9149,4.9784,5.0,5.0546,5.1,5.1054,5.1594,5.1816,5.2,5.2197,5.3,5.3086,5.4,5.4102,5.5,5.5562,5.6,5.6134,5.7,5.7912,5.8,5.9,5.9436,5.9531,6.0,6.0452,6.1,6.1468,6.2,6.2484,6.3,6.35,6.4,6.5,6.5278,6.6,6.6294,6.7,6.7469,6.7564,6.8,6.9,6.9088,7.0,7.0358,7.1,7.1374,7.1437,7.2,7.3,7.366,7.4,7.493,7.5,7.5406,7.6,7.6708,7.7,7.8,7.9,7.9375,8.0,8.0264,8.1,8.2,8.2042,8.3,8.3344,8.4,8.4328,8.5,8.6,8.6106,8.7,8.7312,8.8,8.8392,8.9,9.0,9.0932,9.1,9.1281,9.2,9.3,9.3472,9.4,9.5,9.525,9.5758,9.6,9.7,9.8,9.8044,9.9,9.9219,10.0,10.0838,10.1,10.2,10.2616,10.3,10.3187,10.4,10.4902,10.5,10.6,10.7,10.7156,10.8,10.9,11.0,11.1,11.1125,11.2,11.3,11.4,11.5,11.5094,11.6,11.7,11.8,11.9,11.9062,12.0,12.1,12.2,12.3,12.3031,12.4,12.5,12.6,12.7,12.8,12.9,13.0,13.0969,13.1,13.2,13.3,13.4,13.4937,13.5,13.6,13.7,13.8,13.8906,13.9,14.0,14.25,14.2875,14.5,14.6844,14.75,15.0,15.0812,15.25,15.4781,15.5,15.75,15.875,16.0,16.2719,16.5,16.6687,17.0,17.0656,17.4625,17.5,17.8594,18.0,18.2562,18.5,18.6531,19.0,19.05,19.4469,19.5,19.8438,20.0,20.2406,20.5,20.6375,21.0,21.0344,21.4312,21.5,21.8281,22.0,22.225,22.5,22.6219,23.0,23.0187,23.4156,23.5,23.8125,24.0,24.2094,24.5,24.6062,25.0,25.0031,25.4]},"drilling":{"drilling_limit_mm":25.4,"hole_tolerance_mm":0.0508},"taper":{"max_lean_deg":0.5},"deep_hole":{"max_ratio":6.0},"min_wall_thickness":{"min_mm":0.79}}},"scorecard":{"$ref":"#/components/schemas/ScorecardSettings","description":"The DFM score: on or off, each check's weight, and where green and yellow start.","default":{"calculate":true,"weights":{"floors":10.0,"holes":10.0,"length_to_diameter":10.0,"obstructed":10.0,"sharp_corners":10.0,"surface_profiling":10.0,"text":0.0,"thin_walls":10.0,"threads":10.0,"transitions":10.0,"walls":10.0},"green_from":85.0,"yellow_from":60.0,"wall_corner_clearance_mm":0.0}},"sheet_metal":{"$ref":"#/components/schemas/SheetMetalSettings","description":"Sheet metal's own settings: where its DFM score's green and yellow start.","default":{"scorecard":{"green_from":85.0,"yellow_from":60.0}}},"moulding":{"$ref":"#/components/schemas/MouldingSettings","description":"Moulding's own settings: where its DFM score's green and yellow start.","default":{"scorecard":{"green_from":85.0,"yellow_from":60.0},"gate_and_flow":false}},"hidden_process_machines":{"$ref":"#/components/schemas/HiddenProcessMachines","description":"The sheet metal cutting machines and molding presses the organization hides. The organization's alone, changed with POST /api/v1/organization/process-machines/hide, /show and /reset (machines:write).","default":{"sheet_metal":[],"moulding":[]}},"stock":{"$ref":"#/components/schemas/StockSettings","description":"How much stock is left around the part.","default":{"min_cleanup_mm":3.175}},"profiling":{"$ref":"#/components/schemas/ProfilingSettings","description":"Profile milling: the target surface finish, which sets a bull nose's stepover, and whether ruled surfaces are flank milled with tapered or straight end mills.","default":{"surface_finish_ra_um":3.2,"ruled_surface_tool":"tapered"}},"cutting":{"$ref":"#/components/schemas/CuttingSettings","description":"The chip load aggression its end mills cut at, a ball's stepover in 3D profiling, and its own cutting numbers for each operation in each material. The organization's alone: a project can't set them.","default":{"chip_load_aggression_pct":100.0,"ball_stepover_pct":6.0,"groups":{"M1.0.Z.AQ":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"M1.2.Z.AQ":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N1.2.Z.AG":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N1.2.Z.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"N3.3.U.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.PEEK":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.PTFE":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"O.THERMOPLASTIC":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P1.1.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P1.2.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P2.2.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P2.5.Z.HT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P3.0.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"P5.0.Z.PH":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S2.0.Z.AG":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S2.0.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S4.1.Z.UT":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}},"S4.3.Z.AN":{"drill":{},"face":{},"finish":{},"profile":{},"rough":{},"slot":{}}}}},"general_tolerance":{"$ref":"#/components/schemas/GeneralTolerance","description":"What the shop holds wherever nothing tighter is said. Changing it needs tolerances:write.","default":{"plus_minus_mm":0.127}},"quote":{"$ref":"#/components/schemas/QuoteSettings","description":"Margin, material markup, minimum charge, rush and tools to buy, and the lead time, validity and terms the customer's quote states. Changing them needs pricing:write.","default":{"margin_pct":15.0,"material_markup_pct":10.0,"include_tools_to_buy":true,"valid_days":30,"terms_text":"Prices are in US dollars, for the part as drawn in the file named above. Payment, delivery and shipping are agreed when the order is placed."}},"logo_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Logo Url","description":"The organization's logo, an https URL to an image. Heads the emails and the upload page that submission links send; a link can set its own. Null for none, the default."},"sender_name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Sender Name","description":"The from name on the emails submission links send; a link can set its own. Null for the organization's name, the default."},"privacy_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Privacy Url","description":"The privacy policy, an https URL, that submission links' lead forms link from their consent box; a link can set its own. Null for none, the default."},"email_templates":{"$ref":"#/components/schemas/OrgTemplates","description":"The subject and body of the acknowledgement, quote and decline emails that submission links send to leads, plain text with {{fields}}. A link can set its own. Null for Protyus's default, which `defaults` shows.","default":{"acknowledgement":{},"quote":{},"decline":{}}},"allowed":{"$ref":"#/components/schemas/Allowed","description":"The project's narrowed lists; a null kind allows everything.","default":{}},"overridden":{"items":{"type":"string"},"type":"array","title":"Overridden","description":"The fields the project set, as dotted paths such as defaults.machine.","default":[]},"tolerance_rows":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Tolerance Rows","description":"The capability table as the analysis used it: each row with the project's own values on top. Empty in project and organization reads.","default":[]}},"additionalProperties":false,"type":"object","title":"ResolvedSettings","description":"Settings as an analysis uses them, with where each overridden field came from."},"Result":{"properties":{"process":{"anyOf":[{"type":"string","enum":["milling","sheet_metal","moulding"]},{"type":"null"}],"title":"Process","description":"The process it was analysed for: milling (with recognition), sheet_metal or moulding (with their own section). Analyses run before processes are milling."},"part":{"anyOf":[{"$ref":"#/components/schemas/Part"},{"type":"null"}],"description":"The part: its size, faces, edges and file warnings."},"display":{"anyOf":[{"$ref":"#/components/schemas/Display"},{"type":"null"}],"description":"The part's triangles and edges, for a 3D viewer."},"recognition":{"anyOf":[{"$ref":"#/components/schemas/Recognition"},{"type":"null"}],"description":"Milling's features, setups, findings, scorecard and estimate."},"sheet_metal":{"anyOf":[{"$ref":"#/components/schemas/SheetMetal"},{"type":"null"}],"description":"Sheet metal's conclusions, when process is sheet_metal."},"moulding":{"anyOf":[{"$ref":"#/components/schemas/Moulding"},{"type":"null"}],"description":"Injection moulding's conclusions, when process is moulding."},"turning":{"anyOf":[{"$ref":"#/components/schemas/Turning"},{"type":"null"}],"description":"Whether the part turns on a lathe, and what a lathe turns, beside milling's recognition. Only a milling analysis started with turning on has it."},"characteristics":{"anyOf":[{"$ref":"#/components/schemas/Characteristics"},{"type":"null"}],"description":"The tolerances the file carries, each on its faces: dimensions, geometric tolerances and datums. Only a STEP AP242 file with semantic PMI has it."}},"type":"object","title":"Result","description":"An analysis's result, as a customer sees it: what the engine concluded, never how.\n\nEach key is here unless sections leaves it out."},"RevertedTool":{"properties":{"line":{"type":"string","title":"Line","description":"The line's id."},"setup":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Setup","description":"The setup it was in. Null where it isn't in the plan any more."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind","description":"What the line is, such as walls. Null where it isn't known."},"tool":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool","description":"The manual tool, by size and type."},"reason":{"type":"string","title":"Reason","description":"Why it went back, as a clause such as: the tool no longer fits the line."}},"type":"object","required":["line","reason"],"title":"RevertedTool","description":"A line's manual tool that no longer fits it, so the line went back to its automatic tool."},"RevisionOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The revision's id. Analyses point at this."},"item_id":{"type":"string","format":"uuid","title":"Item Id","description":"The item it belongs to."},"number":{"type":"integer","title":"Number","description":"1 for the item's first revision, counting up with each edit."},"previous_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Previous Revision Id","description":"The revision this one was made from, or null for the first."},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"The item's fields at this revision, matching its kind's schema. Lengths are in mm."},"import_batch_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Import Batch Id","description":"The import that made it, or null if it was made by hand."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of who made it."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was made."}},"additionalProperties":false,"type":"object","required":["id","item_id","number","previous_revision_id","data","import_batch_id","created_by","created_at"],"title":"RevisionOut","description":"One saved state of a library item. Revisions never change."},"RoleAssignmentOut":{"properties":{"user_id":{"type":"string","title":"User Id","description":"The Clerk user id of who holds it."},"role":{"type":"string","title":"Role","description":"The role's key, from GET /api/v1/roles."},"scope":{"type":"string","enum":["organization","project"],"title":"Scope","description":"Whether it applies to the whole organization or one project."},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"The project it applies to, or null at organization scope."},"created_by":{"type":"string","title":"Created By","description":"The Clerk user id of who granted it."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was granted."}},"additionalProperties":false,"type":"object","required":["user_id","role","scope","project_id","created_by","created_at"],"title":"RoleAssignmentOut","description":"One role granted to one person, at organization scope or on one project."},"RoleOut":{"properties":{"key":{"type":"string","title":"Key","description":"The role's stable key, used in the role routes, such as tool_manager."},"name":{"type":"string","title":"Name","description":"What the screen calls it, such as Tool manager."},"description":{"type":"string","title":"Description","description":"What holding it lets someone do."},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","description":"The permissions it gives, such as tools:write."},"project_scoped":{"type":"boolean","title":"Project Scoped","description":"Whether it can be granted on one project as well as the organization."},"default":{"type":"boolean","title":"Default","description":"Whether every member holds it unless an admin takes it away."}},"additionalProperties":false,"type":"object","required":["key","name","description","permissions","project_scoped","default"],"title":"RoleOut","description":"A named set of permissions that can be granted to a person."},"RoleRef":{"properties":{"role":{"type":"string","maxLength":40,"minLength":1,"title":"Role","description":"A role, as recognition.roles gives it, such as floor or pocket_wall."}},"additionalProperties":false,"type":"object","required":["role"],"title":"RoleRef","description":"Every face with a role."},"RolesOut":{"properties":{"roles":{"items":{"$ref":"#/components/schemas/RoleOut"},"type":"array","title":"Roles","description":"The roles that can be granted."},"permissions":{"items":{"$ref":"#/components/schemas/PermissionOut"},"type":"array","title":"Permissions","description":"The permissions roles are made of."}},"additionalProperties":false,"type":"object","required":["roles","permissions"],"title":"RolesOut","description":"Every role and permission Protyus defines."},"Route":{"properties":{"key":{"type":"string","enum":["mill","lathe","lathe_then_mill","mill_turn"],"title":"Key","description":"Which route: mill (mill only), lathe (lathe only), lathe_then_mill, or mill_turn (turned and milled in one holding, on a lathe with live tools or a mill-turn with a B axis)."},"label":{"type":"string","title":"Label","description":"Its name for people, such as Lathe, then mill."},"operations":{"items":{"$ref":"#/components/schemas/RouteOperation"},"type":"array","title":"Operations","description":"Its operations in order, each on its machine.","default":[]},"estimate":{"anyOf":[{"$ref":"#/components/schemas/RouteEstimate"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Estimate","description":"Its time and cost, over every machine it runs on; null where it couldn't be planned."},"findings_count":{"type":"integer","title":"Findings Count","description":"How many findings it has, on every machine.","default":0},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/ProcessScorecard"},{"type":"null"}],"description":"Whether it can be made this way, and its score: a route over two machines fails where either fails, and scores as the lower."},"available":{"type":"boolean","title":"Available","description":"Whether Protyus may choose it: false where the part doesn't fit the project's lathes, a Blocker stops it, the project has no lathe, or its estimate couldn't be worked out."},"why_not":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Why Not","description":"Why it isn't available, for people; null when it is."},"mill":{"anyOf":[{"$ref":"#/components/schemas/RouteMill"},{"type":"null"}],"description":"The mill's setups and findings, for a route that turns the part first and then mills it."}},"type":"object","required":["key","label","available"],"title":"Route","description":"One way to make the part: milled, turned, or turned and then milled."},"RouteEstimate":{"properties":{"status":{"type":"string","title":"Status","description":"rough: a should-cost from the plan, not a shop's quote."},"material":{"$ref":"#/components/schemas/analyses__customer__Material","description":"The material."},"quantity":{"type":"integer","title":"Quantity","description":"How many parts."},"batch":{"type":"integer","title":"Batch","description":"Parts in a batch."},"machine":{"$ref":"#/components/schemas/EstimateMachine","description":"The machine."},"stock":{"$ref":"#/components/schemas/Stock","description":"The stock."},"time":{"$ref":"#/components/schemas/RouteTime","description":"The time, every operation on every machine."},"cost_lines":{"items":{"$ref":"#/components/schemas/CostLine"},"type":"array","title":"Cost Lines","description":"Every cost line."},"cost":{"$ref":"#/components/schemas/Cost","description":"The totals."},"tools":{"$ref":"#/components/schemas/EstimateTools","description":"Tools to buy, suggested and shared.","default":{"to_buy":[],"suggested":[],"merges":[],"none_fits":[]}},"bar":{"anyOf":[{"$ref":"#/components/schemas/TurnBarUse"},{"type":"null"}],"description":"How much bar a part takes, where the route starts on a lathe; null for mill only."}},"type":"object","required":["status","material","quantity","batch","machine","stock","time","cost_lines","cost"],"title":"RouteEstimate","description":"A route's estimate: its stock, time and cost lines over every machine it runs on, each line naming its machine."},"RouteMill":{"properties":{"machine":{"type":"string","title":"Machine","description":"The mill it's planned on: the organization's machine id, or a machine type such as 3_axis."},"setup_plan":{"$ref":"#/components/schemas/BlankSetupPlan","description":"Its setups, from the turned blank."},"findings":{"items":{"$ref":"#/components/schemas/Finding"},"type":"array","title":"Findings","description":"What's hard to mill in them, as milling's findings are.","default":[]}},"type":"object","required":["machine","setup_plan"],"title":"RouteMill","description":"The mill's share of a route that turns the part first: its setups and findings for the faces the lathe leaves."},"RouteOperation":{"properties":{"machine":{"$ref":"#/components/schemas/CostLineMachine","description":"The machine it runs on."},"kind":{"type":"string","enum":["lathe_op","mill_setup","mill_turn_op"],"title":"Kind","description":"lathe_op: a lathe operation, Op 10 or Op 20; mill_setup: a mill's setup; mill_turn_op: a mill-turn operation, Op 10 or Op 20."},"number":{"type":"integer","title":"Number","description":"Its number: 10 or 20 on the lathe, and from 1 on the mill, as its setups are numbered."}},"type":"object","required":["machine","kind","number"],"title":"RouteOperation","description":"One operation of a route, in order, on its machine."},"RouteSetupTime":{"properties":{"number":{"type":"integer","title":"Number","description":"The setup's number, as in the setup plan."},"part_min":{"type":"number","title":"Part Min","description":"Minutes every part."},"batch_min":{"type":"number","title":"Batch Min","description":"Minutes once a batch."},"tools":{"items":{"type":"string"},"type":"array","title":"Tools","description":"The tools it uses, by size and type.","default":[]},"items":{"items":{"$ref":"#/components/schemas/TimeItem"},"type":"array","title":"Items","description":"What the minutes are made of.","default":[]},"machine":{"anyOf":[{"$ref":"#/components/schemas/CostLineMachine"},{"type":"null"}],"description":"The machine it runs on. Null where the route runs on one machine."},"kind":{"anyOf":[{"type":"string","enum":["lathe_op","mill_setup","mill_turn_op"]},{"type":"null"}],"title":"Kind","description":"lathe_op: a lathe operation, numbered 10 or 20; mill_setup: a mill's setup; mill_turn_op: a mill-turn operation. Null where the route runs on one machine."}},"type":"object","required":["number","part_min","batch_min"],"title":"RouteSetupTime","description":"One operation's time, on its machine."},"RouteTime":{"properties":{"setups":{"items":{"$ref":"#/components/schemas/RouteSetupTime"},"type":"array","title":"Setups","description":"Each operation's time, in the route's order.","default":[]},"job":{"items":{"$ref":"#/components/schemas/TimeItem"},"type":"array","title":"Job","description":"Time once an order, whatever the quantity, such as programming.","default":[]},"reverted":{"items":{"$ref":"#/components/schemas/RevertedTool"},"type":"array","title":"Reverted","description":"Manual tools that no longer fit their lines after this run, so those lines went back to their automatic tools.","default":[]},"part_min":{"type":"number","title":"Part Min","description":"Minutes every part."},"batch_min":{"type":"number","title":"Batch Min","description":"Minutes once a batch."},"order_min":{"type":"number","title":"Order Min","description":"Minutes once an order."}},"type":"object","required":["part_min","batch_min","order_min"],"title":"RouteTime","description":"A route's time, every operation on every machine and the job."},"RowEdit":{"properties":{"row":{"$ref":"#/components/schemas/ToleranceRow","description":"Every field of the row after the change."},"base_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Base Revision Id","description":"The revision this edit was made from, to refuse it with REVISION_CONFLICT if it changed since."}},"additionalProperties":false,"type":"object","required":["row"],"title":"RowEdit","description":"A row's new values. They become the shop's own."},"RuleLimits":{"properties":{"thin_wall":{"$ref":"#/components/schemas/ThinWallLimits","description":"Thin wall: depth over thinnest thickness.","default":{"min_ratio":8.0}},"long_reach":{"$ref":"#/components/schemas/LongReachLimits","description":"Long reach: depth over tool diameter.","default":{"max_ratio":4.0}},"non_standard_fillet":{"$ref":"#/components/schemas/StandardRadii","description":"Non-standard fillet: the standard bullnose corner radii.","default":{"corner_radii_mm":[0.127,0.254,0.762,1.524,1.5875,2.286,2.54,3.175]}},"non_standard_hole":{"$ref":"#/components/schemas/StandardDrills","description":"Non-standard hole: the standard drill sizes.","default":{"drill_sizes_mm":[0.3429,0.3683,0.3969,0.4064,0.4572,0.508,0.5334,0.5715,0.6096,0.635,0.6604,0.7112,0.7417,0.7874,0.7937,0.8128,0.8382,0.889,0.9144,0.9398,0.9652,0.9906,1.0,1.016,1.0414,1.0668,1.0922,1.1,1.1811,1.1906,1.2,1.3,1.3208,1.397,1.4,1.5,1.5113,1.5875,1.6,1.6129,1.7,1.7018,1.778,1.8,1.8542,1.9,1.9304,1.9844,1.9939,2.0,2.0574,2.0828,2.1,2.1844,2.2,2.2606,2.3,2.3749,2.3812,2.4,2.4384,2.4892,2.5,2.5273,2.5781,2.6,2.6416,2.7,2.7051,2.7781,2.794,2.8,2.8194,2.8702,2.9,2.9464,3.0,3.048,3.1,3.175,3.2,3.2639,3.3,3.4,3.4544,3.5,3.5687,3.5719,3.6,3.6576,3.7,3.7338,3.7973,3.8,3.8608,3.9,3.9116,3.9688,3.9878,4.0,4.0386,4.0894,4.1,4.2,4.2164,4.3,4.3053,4.3656,4.3942,4.4,4.4958,4.5,4.572,4.6,4.6228,4.699,4.7,4.7625,4.8,4.8006,4.8514,4.9,4.9149,4.9784,5.0,5.0546,5.1,5.1054,5.1594,5.1816,5.2,5.2197,5.3,5.3086,5.4,5.4102,5.5,5.5562,5.6,5.6134,5.7,5.7912,5.8,5.9,5.9436,5.9531,6.0,6.0452,6.1,6.1468,6.2,6.2484,6.3,6.35,6.4,6.5,6.5278,6.6,6.6294,6.7,6.7469,6.7564,6.8,6.9,6.9088,7.0,7.0358,7.1,7.1374,7.1437,7.2,7.3,7.366,7.4,7.493,7.5,7.5406,7.6,7.6708,7.7,7.8,7.9,7.9375,8.0,8.0264,8.1,8.2,8.2042,8.3,8.3344,8.4,8.4328,8.5,8.6,8.6106,8.7,8.7312,8.8,8.8392,8.9,9.0,9.0932,9.1,9.1281,9.2,9.3,9.3472,9.4,9.5,9.525,9.5758,9.6,9.7,9.8,9.8044,9.9,9.9219,10.0,10.0838,10.1,10.2,10.2616,10.3,10.3187,10.4,10.4902,10.5,10.6,10.7,10.7156,10.8,10.9,11.0,11.1,11.1125,11.2,11.3,11.4,11.5,11.5094,11.6,11.7,11.8,11.9,11.9062,12.0,12.1,12.2,12.3,12.3031,12.4,12.5,12.6,12.7,12.8,12.9,13.0,13.0969,13.1,13.2,13.3,13.4,13.4937,13.5,13.6,13.7,13.8,13.8906,13.9,14.0,14.25,14.2875,14.5,14.6844,14.75,15.0,15.0812,15.25,15.4781,15.5,15.75,15.875,16.0,16.2719,16.5,16.6687,17.0,17.0656,17.4625,17.5,17.8594,18.0,18.2562,18.5,18.6531,19.0,19.05,19.4469,19.5,19.8438,20.0,20.2406,20.5,20.6375,21.0,21.0344,21.4312,21.5,21.8281,22.0,22.225,22.5,22.6219,23.0,23.0187,23.4156,23.5,23.8125,24.0,24.2094,24.5,24.6062,25.0,25.0031,25.4]}},"drilling":{"$ref":"#/components/schemas/DrillingLimits","description":"Drilling: the hole tolerance and the drilling limit.","default":{"hole_tolerance_mm":0.0508,"drilling_limit_mm":25.4}},"taper":{"$ref":"#/components/schemas/TaperLimits","description":"Taper: how far a wall leans off square before it's warned about.","default":{"max_lean_deg":0.5}},"deep_hole":{"$ref":"#/components/schemas/DeepHoleLimits","description":"Deep hole: depth over drill diameter.","default":{"max_ratio":6.0}},"min_wall_thickness":{"$ref":"#/components/schemas/MinWallThicknessLimits","description":"Minimum wall thickness.","default":{"min_mm":0.79}}},"additionalProperties":false,"type":"object","title":"RuleLimits","description":"DFM limits a shop can tune. Each defaults to Protyus's value, with where it comes from."},"ScheduledDeletionOut":{"properties":{"kind":{"type":"string","enum":["retention","purge","delete_company"],"title":"Kind","description":"retention: the plan ended, and the read-only company's data is kept 6 months; purge: an admin asked for everything to be deleted; delete_company: an admin deleted the company, whose members lose access too."},"deletes_at":{"type":"string","format":"date-time","title":"Deletes At","description":"When everything is deleted. It can't be brought back after that."},"asked_at":{"type":"string","format":"date-time","title":"Asked At","description":"When it was asked for, or scheduled."},"asked_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asked By","description":"The Clerk user id of the admin who asked for it. Null for retention."},"read_only_since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Read Only Since","description":"For retention: when the company became read-only."}},"additionalProperties":false,"type":"object","required":["kind","deletes_at","asked_at","asked_by","read_only_since"],"title":"ScheduledDeletionOut","description":"A deletion of the company's data that's waiting to run."},"Score":{"properties":{"id":{"type":"string","title":"Id","description":"Which score, such as general."},"title":{"type":"string","title":"Title","description":"Its name for people."},"value":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Value","description":"The score, 0 to 100, rounded once from the weighted sum of the checks. Higher is easier to make."},"band":{"$ref":"#/components/schemas/Band","description":"Its colour."},"areas":{"items":{"$ref":"#/components/schemas/ScoreArea"},"type":"array","title":"Areas","description":"Each area it was made of, for analyses run before 0.65.0. Empty since.","default":[]},"exact":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Exact","description":"The score before rounding. Null for analyses run before 0.65.0."},"checks":{"items":{"$ref":"#/components/schemas/ScoreCheck"},"type":"array","title":"Checks","description":"Each check it's made of, with its weight. Empty for analyses run before 0.65.0.","default":[]}},"type":"object","required":["id","title","value","band"],"title":"Score","description":"A score out of 100."},"ScoreArea":{"properties":{"id":{"type":"string","title":"Id","description":"Which area."},"title":{"type":"string","title":"Title","description":"Its name for people."},"unit":{"type":"string","title":"Unit","description":"What it counts, such as hole."},"value":{"anyOf":[{"type":"integer"},{"type":"number"}],"title":"Value","description":"Its score, 0 to 100."},"band":{"$ref":"#/components/schemas/Band","description":"How hard it reads."},"features":{"type":"integer","title":"Features","description":"How many of its unit the part has."},"clean":{"type":"integer","title":"Clean","description":"How many of them raised no finding."}},"type":"object","required":["id","title","unit","value","band","features","clean"],"title":"ScoreArea","description":"One area of a score."},"ScoreCheck":{"properties":{"id":{"type":"string","title":"Id","description":"Which check, such as sharp_corners."},"code":{"type":"string","title":"Code","description":"Its code: CHK-01 to CHK-11 for milling, SM-B to SM-X for sheet metal, IM-W to IM-V for moulding."},"title":{"type":"string","title":"Title","description":"Its name for people."},"method":{"type":"string","enum":["ratio","binary"],"title":"Method","description":"ratio: passing features over applicable ones; binary: 0 if any feature fails."},"unit":{"type":"string","title":"Unit","description":"What one applicable feature is, such as surface or hole."},"checked":{"type":"boolean","title":"Checked","description":"False where Protyus can't find these features yet, so it scores 100 with nothing checked."},"applicable":{"type":"integer","title":"Applicable","description":"How many features it applied to."},"passing":{"type":"integer","title":"Passing","description":"How many of them passed."},"value":{"type":"integer","title":"Value","description":"Its score, rounded, 0 to 100. 100 when nothing applies."},"band":{"$ref":"#/components/schemas/Band","description":"Its colour."},"features":{"items":{"$ref":"#/components/schemas/CheckFeature"},"type":"array","title":"Features","description":"Each feature it applied to, failing ones first.","default":[]},"exact":{"type":"number","title":"Exact","description":"Its score before rounding, 0 to 100."},"weight":{"type":"number","title":"Weight","description":"Its weight in the score, percent, from the organization's or project's settings."}},"type":"object","required":["id","code","title","method","unit","checked","applicable","passing","value","band","exact","weight"],"title":"ScoreCheck","description":"One check of milling's DFM score, such as CHK-01 Sharp corners."},"ScoreWeights":{"properties":{"sharp_corners":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Sharp Corners","description":"CHK-01 Sharp corners, percent. Default 10.","default":10},"length_to_diameter":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Length To Diameter","description":"CHK-02 Length to diameter, percent. Default 10.","default":10},"floors":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Floors","description":"CHK-03 Floors, percent. Default 10.","default":10},"walls":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Walls","description":"CHK-04 Walls, percent. Default 10.","default":10},"transitions":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Transitions","description":"CHK-05 Transitions, percent. Default 10.","default":10},"surface_profiling":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Surface Profiling","description":"CHK-06 Surface profiling, percent. Default 10.","default":10},"holes":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Holes","description":"CHK-07 Holes, percent. Default 10.","default":10},"thin_walls":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Thin Walls","description":"CHK-08 Thin walls, percent. Default 10.","default":10},"threads":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Threads","description":"CHK-09 Threads, percent. Default 10.","default":10},"text":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Text","description":"CHK-10 Text, percent. Default 0.","default":0},"obstructed":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Obstructed","description":"CHK-11 Obstructed surfaces, percent. Default 10.","default":10}},"additionalProperties":false,"type":"object","title":"ScoreWeights","description":"How much each check counts towards the DFM score, in percent. They must add up to 100."},"Scorecard":{"properties":{"verdict":{"$ref":"#/components/schemas/Verdict","description":"Whether it can be made as drawn."},"checks":{"items":{"$ref":"#/components/schemas/Check"},"type":"array","title":"Checks","description":"Each named check of the verdict.","default":[]},"scored":{"type":"boolean","title":"Scored","description":"False when the organization or project turned the DFM score off: then there's no score.","default":true},"scores":{"items":{"$ref":"#/components/schemas/Score"},"type":"array","title":"Scores","description":"Each score. Empty when scoring is off.","default":[]}},"type":"object","required":["verdict"],"title":"Scorecard","description":"A plan's verdict, its checks and its scores. Checks point at findings by position."},"ScorecardSettings":{"properties":{"calculate":{"type":"boolean","title":"Calculate","description":"Calculate DFM score. Off, no score or check scores are worked out or shown; the verdict stays.","default":true},"weights":{"$ref":"#/components/schemas/ScoreWeights","description":"Each check's weight, percent. They must add up to exactly 100.","default":{"sharp_corners":10.0,"length_to_diameter":10.0,"floors":10.0,"walls":10.0,"transitions":10.0,"surface_profiling":10.0,"holes":10.0,"thin_walls":10.0,"threads":10.0,"text":0.0,"obstructed":10.0}},"green_from":{"type":"number","maximum":100.0,"exclusiveMinimum":0.0,"title":"Green From","description":"The lowest score shown green. Default 85.","default":85},"yellow_from":{"type":"number","maximum":100.0,"exclusiveMinimum":0.0,"title":"Yellow From","description":"The lowest score shown yellow, below green. Lower is red. Default 60.","default":60},"wall_corner_clearance_mm":{"type":"number","maximum":5.0,"minimum":0.0,"title":"Wall Corner Clearance Mm","description":"How much larger than the nearest standard cutter's radius a wall corner must be, mm, so the tool sweeps through it. Default 0: only a corner at a cutter's exact radius fails.","default":0.0}},"additionalProperties":false,"type":"object","title":"ScorecardSettings","description":"The DFM score: whether it's worked out, each check's weight, and its colours."},"Section":{"properties":{"axis":{"type":"string","enum":["x","y","z"],"title":"Axis","description":"The axis the cut is across."},"at":{"type":"number","maximum":1.0,"minimum":0.0,"title":"At","description":"Where along the part, from 0 (its lowest) to 1 (its highest) on that axis."},"flip":{"type":"boolean","title":"Flip","description":"True to keep the other side of the cut.","default":false}},"additionalProperties":false,"type":"object","required":["axis","at"],"title":"Section","description":"A section cut across the part."},"SendTarget":{"properties":{"project":{"$ref":"#/components/schemas/Named","description":"The project their parts would go to."},"submission_link":{"anyOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}],"description":"The submission link to use, whose form fields and branding it takes. Null: the project's."}},"additionalProperties":false,"type":"object","required":["project","submission_link"],"title":"SendTarget","description":"Where Send an upload link sends one for this lead: their latest project the caller may send for."},"SettingsChange":{"properties":{"units":{"anyOf":[{"type":"string","enum":["inch","mm"]},{"type":"null"}],"title":"Units","description":"Display units, inch or mm. Lengths are always stored in mm."},"defaults":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeDefaults"},{"type":"null"}],"description":"The machine, material and quantity a new analysis starts from."},"rates":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRates"},{"type":"null"}],"description":"Labour rates, programming hours and overhead for costing."},"rule_limits":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimits"},{"type":"null"}],"description":"DFM rule limits the shop has tuned, each defaulting to Protyus's."},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeScorecardSettings"},{"type":"null"}],"description":"The DFM score: on or off, each check's weight, and where green and yellow start."},"sheet_metal":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeSheetMetalSettings"},{"type":"null"}],"description":"Sheet metal's own settings: where its DFM score's green and yellow start."},"moulding":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeMouldingSettings"},{"type":"null"}],"description":"Moulding's own settings: where its DFM score's green and yellow start."},"stock":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeStockSettings"},{"type":"null"}],"description":"How much stock is left around the part."},"profiling":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeProfilingSettings"},{"type":"null"}],"description":"Profile milling: the target surface finish, which sets a bull nose's stepover, and whether ruled surfaces are flank milled with tapered or straight end mills."},"cutting":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettings"},{"type":"null"}],"description":"The chip load aggression its end mills cut at, a ball's stepover in 3D profiling, and its own cutting numbers for each operation in each material. The organization's alone: a project can't set them."},"general_tolerance":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeGeneralTolerance"},{"type":"null"}],"description":"What the shop holds wherever nothing tighter is said. Changing it needs tolerances:write."},"quote":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeQuoteSettings"},{"type":"null"}],"description":"Margin, material markup, minimum charge, rush and tools to buy, and the lead time, validity and terms the customer's quote states. Changing them needs pricing:write."},"logo_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Logo Url","description":"The organization's logo, an https URL to an image. Heads the emails and the upload page that submission links send; a link can set its own. Null for none, the default."},"sender_name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Sender Name","description":"The from name on the emails submission links send; a link can set its own. Null for the organization's name, the default."},"privacy_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Privacy Url","description":"The privacy policy, an https URL, that submission links' lead forms link from their consent box; a link can set its own. Null for none, the default."},"email_templates":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeOrgTemplates"},{"type":"null"}],"description":"The subject and body of the acknowledgement, quote and decline emails that submission links send to leads, plain text with {{fields}}. A link can set its own. Null for Protyus's default, which `defaults` shows."}},"additionalProperties":false,"type":"object","title":"SettingsChange","description":"Settings to change. Only the fields given change; null puts a field back to its default."},"SettingsChangeCuttingSettings":{"properties":{"chip_load_aggression_pct":{"anyOf":[{"type":"number","maximum":100.0,"minimum":10.0},{"type":"null"}],"title":"Chip Load Aggression Pct","description":"Chip load aggression, percent: the share of its chip load every end mill cuts at, the tool's own where the tool library gives it one for the material and the catalogue's otherwise, and of every drill's feed per rev, so a shop can back off the figures to what its machines take. 10 to 100; 100, the default, cuts at them. The catalogue's chip loads are tool makers' published figures, for the material's group."},"ball_stepover_pct":{"anyOf":[{"type":"number","maximum":50.0,"minimum":1.0},{"type":"null"}],"title":"Ball Stepover Pct","description":"Ball stepover for 3D profiling, percent of the ball's diameter: 6, the default, steps 0.03 in on a 0.5 in ball, and 20 steps 0.10 in. A smaller step leaves a smoother surface in more passes. 1 to 50. A ball end mill in the tool library can set its own, which wins."},"groups":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroups"},{"type":"null"}],"description":"The shop's own cutting numbers for each operation in each material, by cutting group code: SFM and width and depth of cut for slot, rough, finish and face; the profiling feed share; and the drill's SFM, feed per rev and peck depth. A null field takes Protyus's, which cutting_groups shows. A value more than 50% off Protyus's is saved and listed in cutting_warnings."}},"additionalProperties":false,"type":"object","title":"SettingsChangeCuttingSettings","description":"Settings to change: cutting."},"SettingsChangeCuttingSettingsCuttingGroups":{"properties":{"N1.2.Z.AG":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Wrought aluminium: 6061, 7075, 2024, 2011, 6082."},"N1.2.Z.UT":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Wrought aluminium, not heat treated: 5052-H32."},"M1.0.Z.AQ":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Austenitic stainless: 304, 316L."},"M1.2.Z.AQ":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Free-cutting austenitic stainless: 303."},"P1.1.Z.AN":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Low-carbon steel: 1018, 12L14."},"P1.2.Z.AN":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Medium-carbon steel: 1045."},"P2.2.Z.AN":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Low-alloy steel, annealed: 4140 annealed."},"P2.5.Z.HT":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Low-alloy steel, pre-hardened: 4140 pre-hard."},"P3.0.Z.AN":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"High-alloy steel, annealed: A2 tool steel."},"P5.0.Z.PH":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Precipitation-hardening stainless: 17-4 PH."},"S4.3.Z.AN":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Titanium alloy: Ti-6Al-4V, Ti-6Al-4V ELI."},"S4.1.Z.UT":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Commercially pure titanium: Ti Grade 2."},"S2.0.Z.AN":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Nickel alloys, annealed: Inconel 625, Hastelloy C-276."},"S2.0.Z.AG":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Nickel alloys, aged: Inconel 718."},"N3.3.U.UT":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Free-cutting brass: C360."},"O.THERMOPLASTIC":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"Unfilled thermoplastics: POM, nylon, PC, UHMW, ABS, acrylic, HDPE."},"O.PEEK":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"High-temperature thermoplastics: PEEK, Ultem."},"O.PTFE":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers"},{"type":"null"}],"description":"PTFE."}},"additionalProperties":false,"type":"object","title":"SettingsChangeCuttingSettingsCuttingGroups","description":"Settings to change: cutting: groups."},"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers":{"properties":{"slot":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersMillNumbers"},{"type":"null"}],"description":"Slotting: a full-width cut, T-slot cutters and plunged counterbores too."},"rough":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersMillNumbers"},{"type":"null"}],"description":"Roughing."},"finish":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersMillNumbers"},{"type":"null"}],"description":"Finishing walls and floors; profiling passes take its speed."},"face":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersMillNumbers"},{"type":"null"}],"description":"Facing."},"profile":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersProfileNumbers"},{"type":"null"}],"description":"3D profiling: the share of the calculated feed."},"drill":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersDrillNumbers"},{"type":"null"}],"description":"Drilling with HSS drills."}},"additionalProperties":false,"type":"object","title":"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbers","description":"Settings to change: cutting: groups: N1.2.Z.AG."},"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersDrillNumbers":{"properties":{"sfm":{"anyOf":[{"type":"number","maximum":10000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Sfm","description":"Surface speed, SFM. Null for Protyus's."},"feed_per_rev_mm":{"anyOf":[{"type":"number","maximum":2.54,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Feed Per Rev Mm","description":"Feed per rev, mm, one figure for every drill size. The chip load aggression still scales it. Null for Protyus's, which rises with the drill's diameter."},"peck_depth_pct":{"anyOf":[{"type":"number","maximum":1000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Peck Depth Pct","description":"How deep each peck goes in a hole deeper than 3 times its diameter, percent of the drill's diameter; it may pass 100. Null for Protyus's 100."}},"additionalProperties":false,"type":"object","title":"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersDrillNumbers","description":"Settings to change: cutting: groups: N1: drill."},"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersMillNumbers":{"properties":{"sfm":{"anyOf":[{"type":"number","maximum":10000.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Sfm","description":"Surface speed, SFM. Null for Protyus's."},"ae_pct":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Ae Pct","description":"Radial width of cut, percent of the tool's diameter, up to 100. Null for Protyus's."},"ap_pct":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Ap Pct","description":"Axial depth of cut, percent of the tool's diameter, up to 100; never past the flute length. Null for Protyus's."}},"additionalProperties":false,"type":"object","title":"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersMillNumbers","description":"Settings to change: cutting: groups: N1: slot."},"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersProfileNumbers":{"properties":{"feed_pct":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Feed Pct","description":"The share of its calculated feed a profiling pass moves at, percent, for the finish it leaves. Null for Protyus's 25."}},"additionalProperties":false,"type":"object","title":"SettingsChangeCuttingSettingsCuttingGroupsGroupNumbersProfileNumbers","description":"Settings to change: cutting: groups: N1: profile."},"SettingsChangeDefaults":{"properties":{"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine to plan with: one of the organization's machines by id, or a class key such as 3_axis for its machine of that class."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material, such as 6061, from the project's choices."},"quantity":{"anyOf":[{"type":"integer","maximum":1000000.0,"minimum":1.0},{"type":"null"}],"title":"Quantity","description":"How many parts in a batch."}},"additionalProperties":false,"type":"object","title":"SettingsChangeDefaults","description":"Settings to change: defaults."},"SettingsChangeGeneralTolerance":{"properties":{"plus_minus_mm":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Plus Minus Mm","description":"± tolerance, mm. Default ±0.005 in. Holding tighter takes extra finishing passes or a secondary operation."},"iso_2768":{"anyOf":[{"type":"string","enum":["f","m","c","v"]},{"type":"null"}],"title":"Iso 2768","description":"An ISO 2768 class: f, m, c or v. When set, it's used in place of the ± value."}},"additionalProperties":false,"type":"object","title":"SettingsChangeGeneralTolerance","description":"Settings to change: general_tolerance."},"SettingsChangeMouldingSettings":{"properties":{"scorecard":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeMouldingSettingsMouldingScorecard"},{"type":"null"}],"description":"Where the moulding DFM score's green and yellow start."},"gate_and_flow":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Gate And Flow","description":"Whether molding analyses show where the gates go and how the part fills, and judge and score fill and gates. Off by default. The organization's alone, and only an admin changes it. Off, new analyses leave out the fill and gate findings and score without Fill and Gates; the mold's cost still counts its gates."}},"additionalProperties":false,"type":"object","title":"SettingsChangeMouldingSettings","description":"Settings to change: moulding."},"SettingsChangeMouldingSettingsMouldingScorecard":{"properties":{"green_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Green From","description":"The lowest moulding DFM score shown green. Default 85."},"yellow_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Yellow From","description":"The lowest moulding DFM score shown yellow, below green. Lower is red. Default 60."}},"additionalProperties":false,"type":"object","title":"SettingsChangeMouldingSettingsMouldingScorecard","description":"Settings to change: moulding: scorecard."},"SettingsChangeOrgTemplates":{"properties":{"acknowledgement":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeOrgTemplatesOrgTemplate"},{"type":"null"}],"description":"The email saying their parts arrived and will be reviewed."},"quote":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeOrgTemplatesOrgTemplate"},{"type":"null"}],"description":"The email carrying the quote PDF."},"decline":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeOrgTemplatesOrgTemplate"},{"type":"null"}],"description":"The email saying the shop can't quote this one."}},"additionalProperties":false,"type":"object","title":"SettingsChangeOrgTemplates","description":"Settings to change: email_templates."},"SettingsChangeOrgTemplatesOrgTemplate":{"properties":{"subject":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Subject","description":"The subject, plain text with {{fields}}. Null for Protyus's default."},"body":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Body","description":"The body, plain text with {{fields}}. Null for Protyus's default."}},"additionalProperties":false,"type":"object","title":"SettingsChangeOrgTemplatesOrgTemplate","description":"Settings to change: email_templates: acknowledgement."},"SettingsChangeProfilingSettings":{"properties":{"surface_finish_ra_um":{"anyOf":[{"type":"number","maximum":25.0,"minimum":0.1},{"type":"null"}],"title":"Surface Finish Ra Um","description":"Profile milling surface finish: the target Ra, µm, that a bull nose's profiling passes leave. Its stepover between passes is the one that leaves the cusp this finish allows, so a finer finish takes longer. A ball steps by the ball stepover instead (cutting.ball_stepover_pct). Default 3.2 µm (125 µin)."},"ruled_surface_tool":{"anyOf":[{"type":"string","enum":["tapered","straight"]},{"type":"null"}],"title":"Ruled Surface Tool","description":"What a 5-axis flank mills ruled surfaces with: tapered, a taper end mill (a tapered ball end mill on a blade), or straight, a straight end mill or ball. Default tapered."}},"additionalProperties":false,"type":"object","title":"SettingsChangeProfilingSettings","description":"Settings to change: profiling."},"SettingsChangeQuoteSettings":{"properties":{"margin_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Margin Pct","description":"Margin on cost, in percent: price = cost x (1 + margin). Default 15."},"material_markup_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Material Markup Pct","description":"Markup on the material line, in percent, added to cost before margin. Default 10."},"minimum_charge":{"anyOf":[{"type":"number","maximum":10000000.0,"minimum":0.0},{"type":"null"}],"title":"Minimum Charge","description":"The least an order is priced at, US dollars, after margin and rush. Null for none, the default: a shop sets its own."},"rush_multiplier":{"anyOf":[{"type":"number","maximum":10.0,"minimum":1.0},{"type":"null"}],"title":"Rush Multiplier","description":"What a rush order's price is multiplied by, such as 1.5. Null for none, the default: a shop sets its own."},"rush_fee":{"anyOf":[{"type":"number","maximum":10000000.0,"minimum":0.0},{"type":"null"}],"title":"Rush Fee","description":"A flat fee added to a rush order's price, US dollars, after the multiplier. Null for none, the default."},"include_tools_to_buy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Tools To Buy","description":"Whether the tools-to-buy line is priced in. Default yes, so a designer's should-cost covers the whole job. A shop that keeps its tools turns it off; one quote can also leave the line out."},"lead_time_text":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Lead Time Text","description":"The lead time the customer's quote states, as the shop words it, such as \"10 working days from order\". Null for none, the default: the quote leaves the line out."},"valid_days":{"anyOf":[{"type":"integer","maximum":365.0,"minimum":1.0},{"type":"null"}],"title":"Valid Days","description":"How many days a quote holds, from the moment its version is saved. Default 30."},"terms_text":{"anyOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null"}],"title":"Terms Text","description":"The terms printed at the foot of the customer's quote. Default: prices in US dollars, for the part as drawn, with payment, delivery and shipping agreed when the order is placed."}},"additionalProperties":false,"type":"object","title":"SettingsChangeQuoteSettings","description":"Settings to change: quote."},"SettingsChangeRates":{"properties":{"operator":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Operator","description":"Machine operator, US dollars per hour, loaded, for running, loading and unloading a machine with no labour rate of its own. A machine's own labour rate is blended and covers setup, loading and running. Null for Protyus's default."},"setup_machinist":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Setup Machinist","description":"Setup machinist, US dollars per hour, loaded, for setting up a machine with no labour rate of its own. Null for Protyus's default."},"programming":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Programming","description":"CAM programming, US dollars per hour. Null for Protyus's default."},"programming_hours":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours","description":"CAM programming hours, once per job, whatever the part. Null for Protyus's default, by the part's feature count."},"programming_hours_up_to_100":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Up To 100","description":"CAM programming hours for a part with 100 features or fewer. Null for 3."},"programming_hours_up_to_400":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Up To 400","description":"CAM programming hours for a part with 101 to 400 features. Null for 6."},"programming_hours_over_400":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Over 400","description":"CAM programming hours for a part with more than 400 features. Null for 8."},"setup_minutes":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Setup Minutes","description":"Setup time for each setup, minutes: mounting the fixture and the part and loading the program, before tool setting. No fixture time is added on top of it. Null for Protyus's default, which it works out from the part."},"tool_setting_minutes":{"anyOf":[{"type":"number","maximum":600.0,"minimum":0.0},{"type":"null"}],"title":"Tool Setting Minutes","description":"Minutes to set each tool, every time a program runs. Null for Protyus's default, 3."},"angled_fixture_minutes":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Angled Fixture Minutes","description":"Minutes added to a setup that needs an angled fixture. Null for Protyus's default, 15."},"prove_out_factor":{"anyOf":[{"type":"number","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Prove Out Factor","description":"First article multiplier: the first part of each job takes this many times the cycle time, in total, so 1 is a normal cycle. Null for Protyus's default, 4."},"overhead_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Overhead Pct","description":"Overhead, in percent, added on machine time, operator, handling, setup and programming as its own cost line. Null for Protyus's default, none."},"inspection":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Inspection","description":"Inspection, US dollars per hour. Null until set."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRates","description":"Settings to change: rates."},"SettingsChangeRuleLimits":{"properties":{"thin_wall":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsThinWallLimits"},{"type":"null"}],"description":"Thin wall: depth over thinnest thickness."},"long_reach":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsLongReachLimits"},{"type":"null"}],"description":"Long reach: depth over tool diameter."},"non_standard_fillet":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsStandardRadii"},{"type":"null"}],"description":"Non-standard fillet: the standard bullnose corner radii."},"non_standard_hole":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsStandardDrills"},{"type":"null"}],"description":"Non-standard hole: the standard drill sizes."},"drilling":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsDrillingLimits"},{"type":"null"}],"description":"Drilling: the hole tolerance and the drilling limit."},"taper":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsTaperLimits"},{"type":"null"}],"description":"Taper: how far a wall leans off square before it's warned about."},"deep_hole":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsDeepHoleLimits"},{"type":"null"}],"description":"Deep hole: depth over drill diameter."},"min_wall_thickness":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeRuleLimitsMinWallThicknessLimits"},{"type":"null"}],"description":"Minimum wall thickness."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimits","description":"Settings to change: rule_limits."},"SettingsChangeRuleLimitsDeepHoleLimits":{"properties":{"max_ratio":{"anyOf":[{"type":"number","maximum":30.0,"minimum":2.0},{"type":"null"}],"title":"Max Ratio","description":"Largest ratio of a drilled hole's depth to its diameter before it's flagged and fails the length-to-diameter check. Default 6."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsDeepHoleLimits","description":"Settings to change: rule_limits: deep_hole."},"SettingsChangeRuleLimitsDrillingLimits":{"properties":{"hole_tolerance_mm":{"anyOf":[{"type":"number","maximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Hole Tolerance Mm","description":"The tolerance every hole is held to, plus or minus, mm. The hole is drilled with the standard drill nearest its size within it. A hole that isn't a standard drill's size is flagged as non-standard. Default 0.002 in."},"drill_oversize_mm":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Drill Oversize Mm","description":"No longer used: a hole takes the drill nearest its size within its tolerance. Accepted and ignored.","deprecated":true},"drilling_limit_mm":{"anyOf":[{"type":"number","maximum":101.6,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Drilling Limit Mm","description":"The largest hole drilled, mm. Every hole up to it is drilled, with the nearest drill where none matches; larger holes are milled, unless they end in a drill point and a drill matches. Default 1 in."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsDrillingLimits","description":"Settings to change: rule_limits: drilling."},"SettingsChangeRuleLimitsLongReachLimits":{"properties":{"max_ratio":{"anyOf":[{"type":"number","maximum":10.0,"minimum":2.0},{"type":"null"}],"title":"Max Ratio","description":"Largest ratio of depth to tool diameter before it's flagged. Default 4."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsLongReachLimits","description":"Settings to change: rule_limits: long_reach."},"SettingsChangeRuleLimitsMinWallThicknessLimits":{"properties":{"min_mm":{"anyOf":[{"type":"number","maximum":25.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Min Mm","description":"Minimum wall thickness, mm. A wall thinner than this is flagged and fails the thin-walls check. Default 0.79 mm, or 1.5 mm in a plastic. A value of your own holds for every material."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsMinWallThicknessLimits","description":"Settings to change: rule_limits: min_wall_thickness."},"SettingsChangeRuleLimitsStandardDrills":{"properties":{"drill_sizes_mm":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":600,"minItems":1},{"type":"null"}],"title":"Drill Sizes Mm","description":"Standard drill sizes, mm. A plan drills a hole with the one nearest its size, and a hole that isn't one of these sizes (within 0.0005 in) is flagged as non-standard. Default: the drill chart up to 1 in, fractional drills 1/64 to 1 in, number drills #1 to #80, letter drills A to Z, and metric drills 1 to 14 mm in 0.1 mm steps, 14 to 16 mm in 0.25 mm steps and 16 to 25 mm in 0.5 mm steps."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsStandardDrills","description":"Settings to change: rule_limits: non_standard_hole."},"SettingsChangeRuleLimitsStandardRadii":{"properties":{"corner_radii_mm":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":40,"minItems":1},{"type":"null"}],"title":"Corner Radii Mm","description":"Standard bullnose corner radii, mm. The standard bull nose end mills carry these, and a tool with another radius is a non-standard tool. A concave fillet not within 0.002 in of one of these, or of a standard ball's radius, is flagged as non-standard, and a floor fillet not within 0.002 in of one of these fails the floors check. Default 0.005, 0.010, 0.030, 0.060, 0.090, 0.100 and 0.125 in."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsStandardRadii","description":"Settings to change: rule_limits: non_standard_fillet."},"SettingsChangeRuleLimitsTaperLimits":{"properties":{"max_lean_deg":{"anyOf":[{"type":"number","maximum":5.0,"minimum":0.01},{"type":"null"}],"title":"Max Lean Deg","description":"Largest lean off a setup's direction, in degrees, that's still cut as square. A wall leaning more gets a taper warning. Default 0.5."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsTaperLimits","description":"Settings to change: rule_limits: taper."},"SettingsChangeRuleLimitsThinWallLimits":{"properties":{"min_ratio":{"anyOf":[{"type":"number","maximum":20.0,"minimum":3.0},{"type":"null"}],"title":"Min Ratio","description":"Smallest ratio of a wall's depth to its thinnest thickness that's flagged. Default 8."}},"additionalProperties":false,"type":"object","title":"SettingsChangeRuleLimitsThinWallLimits","description":"Settings to change: rule_limits: thin_wall."},"SettingsChangeScorecardSettings":{"properties":{"calculate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Calculate","description":"Calculate DFM score. Off, no score or check scores are worked out or shown; the verdict stays."},"weights":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeScorecardSettingsScoreWeights"},{"type":"null"}],"description":"Each check's weight, percent. They must add up to exactly 100."},"green_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Green From","description":"The lowest score shown green. Default 85."},"yellow_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Yellow From","description":"The lowest score shown yellow, below green. Lower is red. Default 60."},"wall_corner_clearance_mm":{"anyOf":[{"type":"number","maximum":5.0,"minimum":0.0},{"type":"null"}],"title":"Wall Corner Clearance Mm","description":"How much larger than the nearest standard cutter's radius a wall corner must be, mm, so the tool sweeps through it. Default 0: only a corner at a cutter's exact radius fails."}},"additionalProperties":false,"type":"object","title":"SettingsChangeScorecardSettings","description":"Settings to change: scorecard."},"SettingsChangeScorecardSettingsScoreWeights":{"properties":{"sharp_corners":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Sharp Corners","description":"CHK-01 Sharp corners, percent. Default 10."},"length_to_diameter":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Length To Diameter","description":"CHK-02 Length to diameter, percent. Default 10."},"floors":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Floors","description":"CHK-03 Floors, percent. Default 10."},"walls":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Walls","description":"CHK-04 Walls, percent. Default 10."},"transitions":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Transitions","description":"CHK-05 Transitions, percent. Default 10."},"surface_profiling":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Surface Profiling","description":"CHK-06 Surface profiling, percent. Default 10."},"holes":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Holes","description":"CHK-07 Holes, percent. Default 10."},"thin_walls":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Thin Walls","description":"CHK-08 Thin walls, percent. Default 10."},"threads":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Threads","description":"CHK-09 Threads, percent. Default 10."},"text":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Text","description":"CHK-10 Text, percent. Default 0."},"obstructed":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Obstructed","description":"CHK-11 Obstructed surfaces, percent. Default 10."}},"additionalProperties":false,"type":"object","title":"SettingsChangeScorecardSettingsScoreWeights","description":"Settings to change: scorecard: weights."},"SettingsChangeSheetMetalSettings":{"properties":{"scorecard":{"anyOf":[{"$ref":"#/components/schemas/SettingsChangeSheetMetalSettingsSheetMetalScorecard"},{"type":"null"}],"description":"Where the sheet metal DFM score's green and yellow start."}},"additionalProperties":false,"type":"object","title":"SettingsChangeSheetMetalSettings","description":"Settings to change: sheet_metal."},"SettingsChangeSheetMetalSettingsSheetMetalScorecard":{"properties":{"green_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Green From","description":"The lowest sheet metal DFM score shown green. Default 85."},"yellow_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Yellow From","description":"The lowest sheet metal DFM score shown yellow, below green. Lower is red. Default 60."}},"additionalProperties":false,"type":"object","title":"SettingsChangeSheetMetalSettingsSheetMetalScorecard","description":"Settings to change: sheet_metal: scorecard."},"SettingsChangeStockSettings":{"properties":{"min_cleanup_mm":{"anyOf":[{"type":"number","maximum":12.7,"minimum":0.0},{"type":"null"}],"title":"Min Cleanup Mm","description":"Minimum clean-up: the least stock cut off each face, mm. Default 0.125 in."}},"additionalProperties":false,"type":"object","title":"SettingsChangeStockSettings","description":"Settings to change: stock."},"SettingsIn":{"properties":{"view":{"anyOf":[{"$ref":"#/components/schemas/ViewSettingsIn"},{"type":"null"}],"description":"View settings to change."}},"additionalProperties":false,"type":"object","title":"SettingsIn","description":"A partial change: only the fields given change."},"SettingsOut":{"properties":{"view":{"$ref":"#/components/schemas/ViewSettings","description":"How the app opens.","default":{"data_panel":"open","first_tab":"findings","reopen_tabs":true,"theme":"system","project_runs":"cards","viewer_edges":true,"viewer_roles":true,"viewer_surface_ids":false,"length_units":"organization","viewer_xray":false,"viewer_projection":"perspective","hidden_menu_items":[]}},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"When they last changed, or null if never."}},"additionalProperties":false,"type":"object","required":["updated_at"],"title":"SettingsOut","description":"The caller's settings, with every field filled in."},"SettingsOverrides":{"properties":{"units":{"anyOf":[{"type":"string","enum":["inch","mm"]},{"type":"null"}],"title":"Units","description":"Display units, inch or mm. Lengths are always stored in mm."},"defaults":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesDefaults"},{"type":"null"}],"description":"The machine, material and quantity a new analysis starts from."},"rates":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRates"},{"type":"null"}],"description":"Labour rates, programming hours and overhead for costing."},"rule_limits":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimits"},{"type":"null"}],"description":"DFM rule limits the shop has tuned, each defaulting to Protyus's."},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesScorecardSettings"},{"type":"null"}],"description":"The DFM score: on or off, each check's weight, and where green and yellow start."},"sheet_metal":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesSheetMetalSettings"},{"type":"null"}],"description":"Sheet metal's own settings: where its DFM score's green and yellow start."},"moulding":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesMouldingSettings"},{"type":"null"}],"description":"Moulding's own settings: where its DFM score's green and yellow start."},"stock":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesStockSettings"},{"type":"null"}],"description":"How much stock is left around the part."},"profiling":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesProfilingSettings"},{"type":"null"}],"description":"Profile milling: the target surface finish, which sets a bull nose's stepover, and whether ruled surfaces are flank milled with tapered or straight end mills."},"general_tolerance":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesGeneralTolerance"},{"type":"null"}],"description":"What the shop holds wherever nothing tighter is said. Changing it needs tolerances:write."},"quote":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesQuoteSettings"},{"type":"null"}],"description":"Margin, material markup, minimum charge, rush and tools to buy, and the lead time, validity and terms the customer's quote states. Changing them needs pricing:write."},"logo_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Logo Url","description":"The organization's logo, an https URL to an image. Heads the emails and the upload page that submission links send; a link can set its own. Null for none, the default."},"sender_name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Sender Name","description":"The from name on the emails submission links send; a link can set its own. Null for the organization's name, the default."},"privacy_url":{"anyOf":[{"type":"string","maxLength":2048,"pattern":"^https://\\S+$"},{"type":"null"}],"title":"Privacy Url","description":"The privacy policy, an https URL, that submission links' lead forms link from their consent box; a link can set its own. Null for none, the default."},"email_templates":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesOrgTemplates"},{"type":"null"}],"description":"The subject and body of the acknowledgement, quote and decline emails that submission links send to leads, plain text with {{fields}}. A link can set its own. Null for Protyus's default, which `defaults` shows."}},"additionalProperties":false,"type":"object","title":"SettingsOverrides","description":"Settings a project sets for itself. A field left out or null comes from the organization."},"SettingsOverridesDefaults":{"properties":{"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine to plan with: one of the organization's machines by id, or a class key such as 3_axis for its machine of that class."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The material, such as 6061, from the project's choices."},"quantity":{"anyOf":[{"type":"integer","maximum":1000000.0,"minimum":1.0},{"type":"null"}],"title":"Quantity","description":"How many parts in a batch."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesDefaults","description":"Settings a project sets for itself: defaults."},"SettingsOverridesGeneralTolerance":{"properties":{"plus_minus_mm":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Plus Minus Mm","description":"± tolerance, mm. Default ±0.005 in. Holding tighter takes extra finishing passes or a secondary operation."},"iso_2768":{"anyOf":[{"type":"string","enum":["f","m","c","v"]},{"type":"null"}],"title":"Iso 2768","description":"An ISO 2768 class: f, m, c or v. When set, it's used in place of the ± value."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesGeneralTolerance","description":"Settings a project sets for itself: general_tolerance."},"SettingsOverridesMouldingSettings":{"properties":{"scorecard":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesMouldingSettingsMouldingScorecard"},{"type":"null"}],"description":"Where the moulding DFM score's green and yellow start."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesMouldingSettings","description":"Settings a project sets for itself: moulding."},"SettingsOverridesMouldingSettingsMouldingScorecard":{"properties":{"green_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Green From","description":"The lowest moulding DFM score shown green. Default 85."},"yellow_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Yellow From","description":"The lowest moulding DFM score shown yellow, below green. Lower is red. Default 60."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesMouldingSettingsMouldingScorecard","description":"Settings a project sets for itself: moulding: scorecard."},"SettingsOverridesOrgTemplates":{"properties":{"acknowledgement":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesOrgTemplatesOrgTemplate"},{"type":"null"}],"description":"The email saying their parts arrived and will be reviewed."},"quote":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesOrgTemplatesOrgTemplate"},{"type":"null"}],"description":"The email carrying the quote PDF."},"decline":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesOrgTemplatesOrgTemplate"},{"type":"null"}],"description":"The email saying the shop can't quote this one."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesOrgTemplates","description":"Settings a project sets for itself: email_templates."},"SettingsOverridesOrgTemplatesOrgTemplate":{"properties":{"subject":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Subject","description":"The subject, plain text with {{fields}}. Null for Protyus's default."},"body":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Body","description":"The body, plain text with {{fields}}. Null for Protyus's default."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesOrgTemplatesOrgTemplate","description":"Settings a project sets for itself: email_templates: acknowledgement."},"SettingsOverridesProfilingSettings":{"properties":{"surface_finish_ra_um":{"anyOf":[{"type":"number","maximum":25.0,"minimum":0.1},{"type":"null"}],"title":"Surface Finish Ra Um","description":"Profile milling surface finish: the target Ra, µm, that a bull nose's profiling passes leave. Its stepover between passes is the one that leaves the cusp this finish allows, so a finer finish takes longer. A ball steps by the ball stepover instead (cutting.ball_stepover_pct). Default 3.2 µm (125 µin)."},"ruled_surface_tool":{"anyOf":[{"type":"string","enum":["tapered","straight"]},{"type":"null"}],"title":"Ruled Surface Tool","description":"What a 5-axis flank mills ruled surfaces with: tapered, a taper end mill (a tapered ball end mill on a blade), or straight, a straight end mill or ball. Default tapered."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesProfilingSettings","description":"Settings a project sets for itself: profiling."},"SettingsOverridesQuoteSettings":{"properties":{"margin_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Margin Pct","description":"Margin on cost, in percent: price = cost x (1 + margin). Default 15."},"material_markup_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Material Markup Pct","description":"Markup on the material line, in percent, added to cost before margin. Default 10."},"minimum_charge":{"anyOf":[{"type":"number","maximum":10000000.0,"minimum":0.0},{"type":"null"}],"title":"Minimum Charge","description":"The least an order is priced at, US dollars, after margin and rush. Null for none, the default: a shop sets its own."},"rush_multiplier":{"anyOf":[{"type":"number","maximum":10.0,"minimum":1.0},{"type":"null"}],"title":"Rush Multiplier","description":"What a rush order's price is multiplied by, such as 1.5. Null for none, the default: a shop sets its own."},"rush_fee":{"anyOf":[{"type":"number","maximum":10000000.0,"minimum":0.0},{"type":"null"}],"title":"Rush Fee","description":"A flat fee added to a rush order's price, US dollars, after the multiplier. Null for none, the default."},"include_tools_to_buy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Tools To Buy","description":"Whether the tools-to-buy line is priced in. Default yes, so a designer's should-cost covers the whole job. A shop that keeps its tools turns it off; one quote can also leave the line out."},"lead_time_text":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Lead Time Text","description":"The lead time the customer's quote states, as the shop words it, such as \"10 working days from order\". Null for none, the default: the quote leaves the line out."},"valid_days":{"anyOf":[{"type":"integer","maximum":365.0,"minimum":1.0},{"type":"null"}],"title":"Valid Days","description":"How many days a quote holds, from the moment its version is saved. Default 30."},"terms_text":{"anyOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null"}],"title":"Terms Text","description":"The terms printed at the foot of the customer's quote. Default: prices in US dollars, for the part as drawn, with payment, delivery and shipping agreed when the order is placed."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesQuoteSettings","description":"Settings a project sets for itself: quote."},"SettingsOverridesRates":{"properties":{"operator":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Operator","description":"Machine operator, US dollars per hour, loaded, for running, loading and unloading a machine with no labour rate of its own. A machine's own labour rate is blended and covers setup, loading and running. Null for Protyus's default."},"setup_machinist":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Setup Machinist","description":"Setup machinist, US dollars per hour, loaded, for setting up a machine with no labour rate of its own. Null for Protyus's default."},"programming":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Programming","description":"CAM programming, US dollars per hour. Null for Protyus's default."},"programming_hours":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours","description":"CAM programming hours, once per job, whatever the part. Null for Protyus's default, by the part's feature count."},"programming_hours_up_to_100":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Up To 100","description":"CAM programming hours for a part with 100 features or fewer. Null for 3."},"programming_hours_up_to_400":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Up To 400","description":"CAM programming hours for a part with 101 to 400 features. Null for 6."},"programming_hours_over_400":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Programming Hours Over 400","description":"CAM programming hours for a part with more than 400 features. Null for 8."},"setup_minutes":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Setup Minutes","description":"Setup time for each setup, minutes: mounting the fixture and the part and loading the program, before tool setting. No fixture time is added on top of it. Null for Protyus's default, which it works out from the part."},"tool_setting_minutes":{"anyOf":[{"type":"number","maximum":600.0,"minimum":0.0},{"type":"null"}],"title":"Tool Setting Minutes","description":"Minutes to set each tool, every time a program runs. Null for Protyus's default, 3."},"angled_fixture_minutes":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Angled Fixture Minutes","description":"Minutes added to a setup that needs an angled fixture. Null for Protyus's default, 15."},"prove_out_factor":{"anyOf":[{"type":"number","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Prove Out Factor","description":"First article multiplier: the first part of each job takes this many times the cycle time, in total, so 1 is a normal cycle. Null for Protyus's default, 4."},"overhead_pct":{"anyOf":[{"type":"number","maximum":1000.0,"minimum":0.0},{"type":"null"}],"title":"Overhead Pct","description":"Overhead, in percent, added on machine time, operator, handling, setup and programming as its own cost line. Null for Protyus's default, none."},"inspection":{"anyOf":[{"type":"number","maximum":10000.0,"minimum":0.0},{"type":"null"}],"title":"Inspection","description":"Inspection, US dollars per hour. Null until set."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRates","description":"Settings a project sets for itself: rates."},"SettingsOverridesRuleLimits":{"properties":{"thin_wall":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsThinWallLimits"},{"type":"null"}],"description":"Thin wall: depth over thinnest thickness."},"long_reach":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsLongReachLimits"},{"type":"null"}],"description":"Long reach: depth over tool diameter."},"non_standard_fillet":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsStandardRadii"},{"type":"null"}],"description":"Non-standard fillet: the standard bullnose corner radii."},"non_standard_hole":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsStandardDrills"},{"type":"null"}],"description":"Non-standard hole: the standard drill sizes."},"drilling":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsDrillingLimits"},{"type":"null"}],"description":"Drilling: the hole tolerance and the drilling limit."},"taper":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsTaperLimits"},{"type":"null"}],"description":"Taper: how far a wall leans off square before it's warned about."},"deep_hole":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsDeepHoleLimits"},{"type":"null"}],"description":"Deep hole: depth over drill diameter."},"min_wall_thickness":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesRuleLimitsMinWallThicknessLimits"},{"type":"null"}],"description":"Minimum wall thickness."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimits","description":"Settings a project sets for itself: rule_limits."},"SettingsOverridesRuleLimitsDeepHoleLimits":{"properties":{"max_ratio":{"anyOf":[{"type":"number","maximum":30.0,"minimum":2.0},{"type":"null"}],"title":"Max Ratio","description":"Largest ratio of a drilled hole's depth to its diameter before it's flagged and fails the length-to-diameter check. Default 6."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsDeepHoleLimits","description":"Settings a project sets for itself: rule_limits: deep_hole."},"SettingsOverridesRuleLimitsDrillingLimits":{"properties":{"hole_tolerance_mm":{"anyOf":[{"type":"number","maximum":1.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Hole Tolerance Mm","description":"The tolerance every hole is held to, plus or minus, mm. The hole is drilled with the standard drill nearest its size within it. A hole that isn't a standard drill's size is flagged as non-standard. Default 0.002 in."},"drill_oversize_mm":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Drill Oversize Mm","description":"No longer used: a hole takes the drill nearest its size within its tolerance. Accepted and ignored.","deprecated":true},"drilling_limit_mm":{"anyOf":[{"type":"number","maximum":101.6,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Drilling Limit Mm","description":"The largest hole drilled, mm. Every hole up to it is drilled, with the nearest drill where none matches; larger holes are milled, unless they end in a drill point and a drill matches. Default 1 in."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsDrillingLimits","description":"Settings a project sets for itself: rule_limits: drilling."},"SettingsOverridesRuleLimitsLongReachLimits":{"properties":{"max_ratio":{"anyOf":[{"type":"number","maximum":10.0,"minimum":2.0},{"type":"null"}],"title":"Max Ratio","description":"Largest ratio of depth to tool diameter before it's flagged. Default 4."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsLongReachLimits","description":"Settings a project sets for itself: rule_limits: long_reach."},"SettingsOverridesRuleLimitsMinWallThicknessLimits":{"properties":{"min_mm":{"anyOf":[{"type":"number","maximum":25.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Min Mm","description":"Minimum wall thickness, mm. A wall thinner than this is flagged and fails the thin-walls check. Default 0.79 mm, or 1.5 mm in a plastic. A value of your own holds for every material."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsMinWallThicknessLimits","description":"Settings a project sets for itself: rule_limits: min_wall_thickness."},"SettingsOverridesRuleLimitsStandardDrills":{"properties":{"drill_sizes_mm":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":600,"minItems":1},{"type":"null"}],"title":"Drill Sizes Mm","description":"Standard drill sizes, mm. A plan drills a hole with the one nearest its size, and a hole that isn't one of these sizes (within 0.0005 in) is flagged as non-standard. Default: the drill chart up to 1 in, fractional drills 1/64 to 1 in, number drills #1 to #80, letter drills A to Z, and metric drills 1 to 14 mm in 0.1 mm steps, 14 to 16 mm in 0.25 mm steps and 16 to 25 mm in 0.5 mm steps."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsStandardDrills","description":"Settings a project sets for itself: rule_limits: non_standard_hole."},"SettingsOverridesRuleLimitsStandardRadii":{"properties":{"corner_radii_mm":{"anyOf":[{"items":{"type":"number"},"type":"array","maxItems":40,"minItems":1},{"type":"null"}],"title":"Corner Radii Mm","description":"Standard bullnose corner radii, mm. The standard bull nose end mills carry these, and a tool with another radius is a non-standard tool. A concave fillet not within 0.002 in of one of these, or of a standard ball's radius, is flagged as non-standard, and a floor fillet not within 0.002 in of one of these fails the floors check. Default 0.005, 0.010, 0.030, 0.060, 0.090, 0.100 and 0.125 in."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsStandardRadii","description":"Settings a project sets for itself: rule_limits: non_standard_fillet."},"SettingsOverridesRuleLimitsTaperLimits":{"properties":{"max_lean_deg":{"anyOf":[{"type":"number","maximum":5.0,"minimum":0.01},{"type":"null"}],"title":"Max Lean Deg","description":"Largest lean off a setup's direction, in degrees, that's still cut as square. A wall leaning more gets a taper warning. Default 0.5."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsTaperLimits","description":"Settings a project sets for itself: rule_limits: taper."},"SettingsOverridesRuleLimitsThinWallLimits":{"properties":{"min_ratio":{"anyOf":[{"type":"number","maximum":20.0,"minimum":3.0},{"type":"null"}],"title":"Min Ratio","description":"Smallest ratio of a wall's depth to its thinnest thickness that's flagged. Default 8."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesRuleLimitsThinWallLimits","description":"Settings a project sets for itself: rule_limits: thin_wall."},"SettingsOverridesScorecardSettings":{"properties":{"calculate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Calculate","description":"Calculate DFM score. Off, no score or check scores are worked out or shown; the verdict stays."},"weights":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesScorecardSettingsScoreWeights"},{"type":"null"}],"description":"Each check's weight, percent. They must add up to exactly 100."},"green_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Green From","description":"The lowest score shown green. Default 85."},"yellow_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Yellow From","description":"The lowest score shown yellow, below green. Lower is red. Default 60."},"wall_corner_clearance_mm":{"anyOf":[{"type":"number","maximum":5.0,"minimum":0.0},{"type":"null"}],"title":"Wall Corner Clearance Mm","description":"How much larger than the nearest standard cutter's radius a wall corner must be, mm, so the tool sweeps through it. Default 0: only a corner at a cutter's exact radius fails."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesScorecardSettings","description":"Settings a project sets for itself: scorecard."},"SettingsOverridesScorecardSettingsScoreWeights":{"properties":{"sharp_corners":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Sharp Corners","description":"CHK-01 Sharp corners, percent. Default 10."},"length_to_diameter":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Length To Diameter","description":"CHK-02 Length to diameter, percent. Default 10."},"floors":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Floors","description":"CHK-03 Floors, percent. Default 10."},"walls":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Walls","description":"CHK-04 Walls, percent. Default 10."},"transitions":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Transitions","description":"CHK-05 Transitions, percent. Default 10."},"surface_profiling":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Surface Profiling","description":"CHK-06 Surface profiling, percent. Default 10."},"holes":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Holes","description":"CHK-07 Holes, percent. Default 10."},"thin_walls":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Thin Walls","description":"CHK-08 Thin walls, percent. Default 10."},"threads":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Threads","description":"CHK-09 Threads, percent. Default 10."},"text":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Text","description":"CHK-10 Text, percent. Default 0."},"obstructed":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Obstructed","description":"CHK-11 Obstructed surfaces, percent. Default 10."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesScorecardSettingsScoreWeights","description":"Settings a project sets for itself: scorecard: weights."},"SettingsOverridesSheetMetalSettings":{"properties":{"scorecard":{"anyOf":[{"$ref":"#/components/schemas/SettingsOverridesSheetMetalSettingsSheetMetalScorecard"},{"type":"null"}],"description":"Where the sheet metal DFM score's green and yellow start."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesSheetMetalSettings","description":"Settings a project sets for itself: sheet_metal."},"SettingsOverridesSheetMetalSettingsSheetMetalScorecard":{"properties":{"green_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Green From","description":"The lowest sheet metal DFM score shown green. Default 85."},"yellow_from":{"anyOf":[{"type":"number","maximum":100.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Yellow From","description":"The lowest sheet metal DFM score shown yellow, below green. Lower is red. Default 60."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesSheetMetalSettingsSheetMetalScorecard","description":"Settings a project sets for itself: sheet_metal: scorecard."},"SettingsOverridesStockSettings":{"properties":{"min_cleanup_mm":{"anyOf":[{"type":"number","maximum":12.7,"minimum":0.0},{"type":"null"}],"title":"Min Cleanup Mm","description":"Minimum clean-up: the least stock cut off each face, mm. Default 0.125 in."}},"additionalProperties":false,"type":"object","title":"SettingsOverridesStockSettings","description":"Settings a project sets for itself: stock."},"Setup":{"properties":{"number":{"type":"integer","title":"Number","description":"Its number, from 1, in the order they're done."},"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"The direction facing away from the table, as a unit vector x, y, z."},"kind":{"type":"string","title":"Kind","description":"main (axial), side (radial) or tilted."},"angled_fixture":{"type":"boolean","title":"Angled Fixture","description":"Whether it needs an angled fixture, as its direction isn't square to the stock.","default":false},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces cut in it.","default":[]},"holes":{"type":"integer","title":"Holes","description":"How many holes are cut in it.","default":0},"pockets":{"type":"integer","title":"Pockets","description":"How many pockets are cut in it.","default":0},"holdable":{"type":"boolean","title":"Holdable","description":"Whether two opposite flat faces of the finished part are free to hold it by, or, on a blank a lathe turned, its turned diameter. When false, uncut stock or a fixture may still hold it."},"directions":{"items":{"$ref":"#/components/schemas/ToolDirection"},"type":"array","title":"Directions","description":"Each direction the tool comes from in it.","default":[]}},"type":"object","required":["number","direction","kind","holdable"],"title":"Setup","description":"One clamping of the part."},"SetupArrow":{"properties":{"number":{"type":"integer","title":"Number","description":"The setup's number."},"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"Its direction, facing away from the table, as a unit vector."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it cuts."}},"additionalProperties":false,"type":"object","required":["number","direction","surfaces"],"title":"SetupArrow","description":"A setup's tool arrow."},"SetupCamera":{"properties":{"setup":{"type":"integer","maximum":99.0,"minimum":1.0,"title":"Setup","description":"The setup's number, from 1."}},"additionalProperties":false,"type":"object","required":["setup"],"title":"SetupCamera","description":"Looking down a setup's tool direction, as the machinist sees it."},"SetupPlan":{"properties":{"machine":{"type":"string","title":"Machine","description":"The machine planned for: the organization's machine id, or a machine type such as 3_axis."},"machine_label":{"type":"string","title":"Machine Label","description":"Its name for people."},"machine_description":{"type":"string","title":"Machine Description","description":"What that machine reaches in one clamping.","default":""},"setups":{"items":{"$ref":"#/components/schemas/Setup"},"type":"array","title":"Setups","description":"Each setup, in order."},"stock_surfaces":{"items":{"type":"string"},"type":"array","title":"Stock Surfaces","description":"Faces left as raw stock, needing no setup. Empty for analyses run since every face is machined.","default":[]},"unreachable_surfaces":{"items":{"type":"string"},"type":"array","title":"Unreachable Surfaces","description":"Faces a plain tool can't reach on this machine.","default":[]},"back_bored_surfaces":{"items":{"type":"string"},"type":"array","title":"Back Bored Surfaces","description":"The unreachable faces a back-boring tool can reach, passed through their hole from its other end.","default":[]},"sliver_surfaces":{"items":{"type":"string"},"type":"array","title":"Sliver Surfaces","description":"Faces too small to plan for.","default":[]},"cleanup_spaces":{"items":{"$ref":"#/components/schemas/CleanupSpace"},"type":"array","title":"Cleanup Spaces","description":"Each face cut in two, its bulk in one setup and the rest in another, with where the rest lies, then each obstructed face, which no tool reaches. Empty for analyses run before they were drawn.","default":[]}},"type":"object","required":["machine","machine_label","setups"],"title":"SetupPlan","description":"How the part is set up on one machine."},"SetupRef":{"properties":{"setup":{"type":"integer","maximum":99.0,"minimum":1.0,"title":"Setup","description":"The setup's number, from 1, as recognition.setup_plan numbers it."}},"additionalProperties":false,"type":"object","required":["setup"],"title":"SetupRef","description":"The faces a setup cuts."},"SetupTime":{"properties":{"number":{"type":"integer","title":"Number","description":"The setup's number, as in the setup plan."},"part_min":{"type":"number","title":"Part Min","description":"Minutes every part."},"batch_min":{"type":"number","title":"Batch Min","description":"Minutes once a batch."},"tools":{"items":{"type":"string"},"type":"array","title":"Tools","description":"The tools it uses, by size and type.","default":[]},"items":{"items":{"$ref":"#/components/schemas/TimeItem"},"type":"array","title":"Items","description":"What the minutes are made of.","default":[]}},"type":"object","required":["number","part_min","batch_min"],"title":"SetupTime","description":"One setup's time."},"ShareOut":{"properties":{"shared":{"type":"boolean","title":"Shared","description":"Whether anyone with its link can see it."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The link, app.protyus.ai/p/<token>, while it's shared. Null otherwise."},"shared_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shared By","description":"The Clerk user id of who shared it, while it's shared."},"shared_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Shared At","description":"When it was shared, while it is."},"prevented":{"type":"boolean","title":"Prevented","description":"Whether the company prevents sharing, so it can't be shared."},"can_share":{"type":"boolean","title":"Can Share","description":"Whether the caller may share it and stop sharing it: the project's owner or an admin, while the company allows sharing."},"shareable":{"type":"boolean","title":"Shareable","description":"Whether this analysis can be shared: a ready milling analysis. Other processes can't yet."}},"additionalProperties":false,"type":"object","required":["shared","url","shared_by","shared_at","prevented","can_share","shareable"],"title":"ShareOut","description":"Whether an analysis is shared, and its link while it is."},"SharedDisplay":{"properties":{"surfaces":{"additionalProperties":{"$ref":"#/components/schemas/Mesh"},"type":"object","title":"Surfaces","description":"Each face's triangles, by face.","default":{}},"edges":{"additionalProperties":{"items":{"type":"number"},"type":"array"},"type":"object","title":"Edges","description":"Each edge as a polyline, x, y, z after one another, by edge.","default":{}}},"additionalProperties":false,"type":"object","title":"SharedDisplay","description":"The part as a 3D viewer draws it, in mm."},"SharedPart":{"properties":{"process":{"type":"string","const":"milling","title":"Process","description":"The process it was analysed for: milling."},"part":{"$ref":"#/components/schemas/SharedPartRecord","description":"The part: its size, faces, edges and file warnings."},"display":{"$ref":"#/components/schemas/SharedDisplay","description":"The part's triangles and edges, for a 3D viewer."},"recognition":{"$ref":"#/components/schemas/SharedRecognition","description":"Its features, setups, findings and scorecard."}},"additionalProperties":false,"type":"object","required":["process","part","display","recognition"],"title":"SharedPart","description":"A shared part: what anyone with its link sees. Nothing about who shared it."},"SharedPartRecord":{"properties":{"units":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Units","description":"The units the file declared, such as mm or inch. Sizes here are in mm whatever it says."},"bounding_box":{"$ref":"#/components/schemas/analyses__customer__BoundingBox","description":"The part's bounding box, in mm."},"size":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Size","description":"The bounding box's size along X, Y and Z, in mm."},"volume":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Volume","description":"The part's volume, mm³."},"surface_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Surface Count","description":"How many faces it has."},"edge_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Edge Count","description":"How many edges it has."},"surfaces":{"items":{"$ref":"#/components/schemas/Surface"},"type":"array","title":"Surfaces","description":"Every face.","default":[]},"edges":{"items":{"$ref":"#/components/schemas/Edge"},"type":"array","title":"Edges","description":"Every edge.","default":[]},"warnings":{"items":{"$ref":"#/components/schemas/analyses__customer__PartWarning"},"type":"array","title":"Warnings","description":"What in the file may affect the results, one line a kind.","default":[]}},"additionalProperties":false,"type":"object","required":["bounding_box"],"title":"SharedPartRecord","description":"The part's size, faces, edges and file warnings. Lengths in mm."},"SharedPlan":{"properties":{"machine":{"type":"string","const":"plan","title":"Machine","description":"Always plan: the key of this plan's findings in recognition.dfm."},"machine_label":{"type":"string","title":"Machine Label","description":"The kind of machine, such as 3-axis."},"machine_description":{"type":"string","title":"Machine Description","description":"What that kind of machine reaches in one clamping.","default":""},"setups":{"items":{"$ref":"#/components/schemas/Setup"},"type":"array","title":"Setups","description":"Each setup, in order."},"stock_surfaces":{"items":{"type":"string"},"type":"array","title":"Stock Surfaces","description":"Faces left as raw stock, needing no setup.","default":[]},"unreachable_surfaces":{"items":{"type":"string"},"type":"array","title":"Unreachable Surfaces","description":"Faces a plain tool can't reach on this machine.","default":[]},"back_bored_surfaces":{"items":{"type":"string"},"type":"array","title":"Back Bored Surfaces","description":"The unreachable faces a back-boring tool can reach.","default":[]},"sliver_surfaces":{"items":{"type":"string"},"type":"array","title":"Sliver Surfaces","description":"Faces too small to plan for.","default":[]},"cleanup_spaces":{"items":{"$ref":"#/components/schemas/CleanupSpace"},"type":"array","title":"Cleanup Spaces","description":"Each face cut in two, and each obstructed face.","default":[]}},"additionalProperties":false,"type":"object","required":["machine","machine_label","setups"],"title":"SharedPlan","description":"How the part is set up on the machine it was analysed for."},"SharedRecognition":{"properties":{"roles":{"additionalProperties":{"type":"string"},"type":"object","title":"Roles","description":"Each face's role, by face.","default":{}},"holes":{"items":{"$ref":"#/components/schemas/Hole"},"type":"array","title":"Holes","description":"Every round hole.","default":[]},"threads":{"items":{"$ref":"#/components/schemas/Thread"},"type":"array","title":"Threads","description":"Every thread modeled into the part.","default":[]},"pockets":{"items":{"$ref":"#/components/schemas/Pocket"},"type":"array","title":"Pockets","description":"Every pocket.","default":[]},"machine":{"type":"string","const":"plan","title":"Machine","description":"Always plan, as setup_plan.machine."},"setup_plan":{"$ref":"#/components/schemas/SharedPlan","description":"The setups."},"machine_plans":{"items":{"$ref":"#/components/schemas/SharedPlan"},"type":"array","title":"Machine Plans","description":"The one plan, setup_plan, as the viewer lists plans."},"dfm":{"additionalProperties":{"$ref":"#/components/schemas/Dfm"},"propertyNames":{"const":"plan"},"type":"object","title":"Dfm","description":"The plan's findings and scorecard, under plan."},"looks_turned":{"type":"boolean","title":"Looks Turned","description":"Whether it looks like a lathe part, so the rest may be wrong.","default":false},"looks_sheet_metal":{"anyOf":[{"$ref":"#/components/schemas/SheetMetalLook"},{"type":"null"}],"description":"Its thickness and bends where it looks like sheet metal."},"thickness_rays":{"items":{"$ref":"#/components/schemas/ThicknessRay"},"type":"array","title":"Thickness Rays","description":"Lines through the metal: how thick the part is there.","default":[]}},"additionalProperties":false,"type":"object","required":["machine","setup_plan","machine_plans","dfm"],"title":"SharedRecognition","description":"What's on the part, how it's set up, and what's wrong with it."},"SheetArea":{"properties":{"mm2":{"type":"number","title":"Mm2","description":"Square millimetres."},"in2":{"type":"number","title":"In2","description":"Square inches."}},"type":"object","required":["mm2","in2"],"title":"SheetArea","description":"An area in both units."},"SheetBend":{"properties":{"id":{"type":"string","title":"Id","description":"B1, B2 ..., met walking out from the base flange."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its inside and outside faces."},"inside_radius":{"$ref":"#/components/schemas/SheetLength","description":"R, its inside radius."},"angle":{"type":"number","title":"Angle","description":"Degrees the sheet turns through it: 90 for an L."},"direction":{"anyOf":[{"type":"string","enum":["up","down"]},{"type":"null"}],"title":"Direction","description":"Up or down, seen from the base flange's reference side; null where it can't be told."},"length":{"$ref":"#/components/schemas/SheetLength","description":"Its length along its axis."},"flanges":{"items":{"type":"string"},"type":"array","title":"Flanges","description":"The flanges it joins."}},"type":"object","required":["id","surfaces","inside_radius","angle","direction","length","flanges"],"title":"SheetBend","description":"A bend: the sheet turned about one axis."},"SheetBendLine":{"properties":{"bend":{"type":"string","title":"Bend","description":"The bend, as bends lists it."},"direction":{"anyOf":[{"type":"string","enum":["up","down"]},{"type":"null"}],"title":"Direction","description":"Up or down, seen from the flat's side, the base flange's reference side."},"inside_radius":{"$ref":"#/components/schemas/SheetLength","description":"R, its inside radius."},"angle":{"type":"number","title":"Angle","description":"Degrees it bends."},"allowance":{"$ref":"#/components/schemas/SheetLength","description":"BA, its bend allowance: how wide a strip of the flat it takes."},"start":{"items":{"type":"number"},"type":"array","title":"Start","description":"One end, x and y in mm."},"end":{"items":{"type":"number"},"type":"array","title":"End","description":"The other end."}},"type":"object","required":["bend","direction","inside_radius","angle","allowance","start","end"],"title":"SheetBendLine","description":"Where a bend is on the flat: halfway across the strip it unfolds to."},"SheetBreakEven":{"properties":{"against":{"type":"string","title":"Against","description":"The cutting machine, such as SM-FL6."},"label":{"type":"string","title":"Label","description":"Its name."},"each":{"type":"number","title":"Each","description":"Its cost a part at the order quantity, US dollars."},"annual_volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Annual Volume","description":"The annual volume at which the die costs the same a part, to the nearest hundred; null where it never does."}},"type":"object","required":["against","label","each","annual_volume"],"title":"SheetBreakEven","description":"Where the die pays for itself against the cheapest cutting machine."},"SheetCommit":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"The file's Vercel Blob URL, from an upload through /upload. It must be your own upload, in uploads/{org_id}/{user_id}/; anything else is refused with NOT_YOUR_UPLOAD."},"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's original name, such as machines.xlsx or materials.csv."},"sheet":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Sheet","description":"For an XLSX, the sheet to read. Null reads the sheet whose headers match best."},"columns":{"additionalProperties":{"type":"string"},"type":"object","title":"Columns","description":"Field to column header, for any column the headers don't name well enough, such as {\"hourly_rate\": \"Rate\"}. Fields are the template's; the preview's columns show how each header was read.","default":{}},"group_actions":{"additionalProperties":{"type":"string","enum":["add","update","skip"]},"propertyNames":{"enum":["new","changed","unchanged","invalid"]},"type":"object","title":"Group Actions","description":"An action for every row of a status, such as {\"changed\": \"skip\"}.","default":{}},"actions":{"additionalProperties":{"type":"string","enum":["add","update","skip"]},"type":"object","title":"Actions","description":"An action for one row, by its row number, over its group's.","default":{}}},"additionalProperties":false,"type":"object","required":["upload_url","file_name"],"title":"SheetCommit","description":"Import a spreadsheet as one batch. Rows take their status's default action unless told otherwise."},"SheetCut":{"properties":{"id":{"type":"string","title":"Id","description":"H1 for a hole, SL1 a slot, C1 a cut-out, N1 a notch, R1 a relief."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces."},"on":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"On","description":"The flange or bend it's cut in."},"diameter":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"A hole's."},"countersunk":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Countersunk","description":"Whether a hole is countersunk."},"width":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"A slot's or cut-out's narrower side; a notch's width along the edge."},"length":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"A slot's or cut-out's longer side."},"depth":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"How far a notch runs into the sheet."},"radius":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"A round notch's radius."}},"type":"object","required":["id","surfaces","on"],"title":"SheetCut","description":"A hole, slot, cut-out, notch or relief cut through the sheet."},"SheetCutting":{"properties":{"choice":{"type":"string","title":"Choice","description":"What was asked for: auto, the cheapest machine that can make it, or a machine id."},"machine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Machine","description":"The machine: Auto's pick or the one chosen, a cutting machine or the progressive die's press, SM-PD200. Null where Auto found none that can make it."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Its name."}},"type":"object","required":["choice","machine","label"],"title":"SheetCutting","description":"The route the part is judged and costed on: a cutting machine, or the progressive die."},"SheetDie":{"properties":{"machine":{"type":"string","title":"Machine","description":"The press, SM-PD200."},"label":{"type":"string","title":"Label","description":"Its name."},"annual_volume":{"type":"integer","title":"Annual Volume","description":"The annual volume it's costed at."},"capable":{"type":"boolean","title":"Capable","description":"Whether the part can be stamped on it: the grade suits a die and the die fits."},"reasons":{"items":{"$ref":"#/components/schemas/SheetReason"},"type":"array","title":"Reasons","description":"Why it can't, where it can't: SM-A-07 or SM-M-02.","default":[]},"strip":{"$ref":"#/components/schemas/SheetDieStrip","description":"The coil strip."},"stations":{"$ref":"#/components/schemas/SheetDieStations","description":"The die's stations."},"tallest_form":{"$ref":"#/components/schemas/SheetLength","description":"The tallest flange or form standing off the strip."},"tonnage":{"$ref":"#/components/schemas/SheetDieTonnage","description":"The force it needs."},"strokes_per_minute":{"type":"integer","title":"Strokes Per Minute","description":"How fast it runs, by its tallest form."},"fit":{"items":{"$ref":"#/components/schemas/SheetDieCheck"},"type":"array","title":"Fit","description":"Each check that the die fits the press."},"die":{"anyOf":[{"$ref":"#/components/schemas/SheetDieTooling"},{"type":"null"}],"description":"The die's cost; null where it doesn't fit."},"estimate":{"anyOf":[{"$ref":"#/components/schemas/SheetEstimate"},{"$ref":"#/components/schemas/Failed"}],"title":"Estimate","description":"Its cost for the order at the annual volume, the die and a share of its die change included, or why there isn't one."},"break_even":{"anyOf":[{"$ref":"#/components/schemas/SheetBreakEven"},{"type":"null"}],"description":"Where it pays for itself; null where it doesn't fit or no cutting machine can make the part."},"volume_too_low":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Volume Too Low","description":"Whether the annual volume is too low for a dedicated die."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"What it comes to, for people."},"chosen":{"type":"boolean","title":"Chosen","description":"Whether the part is made on the die: Auto found it the cheapest route, or it was asked for. The section's findings and estimate are then the die's, and cutting names it.","default":false}},"type":"object","required":["machine","label","annual_volume","capable","strip","stations","tallest_form","tonnage","strokes_per_minute","fit","estimate"],"title":"SheetDie","description":"The part stamped from coil in a progressive die, beside the cutting machines."},"SheetDieCheck":{"properties":{"check":{"type":"string","enum":["pitch","coil_width","thickness_min","thickness_max","die_length","die_depth","dwell","tonnage"],"title":"Check","description":"Which check."},"label":{"type":"string","title":"Label","description":"Its name for people."},"needs":{"type":"number","title":"Needs","description":"What the die needs, in `unit`."},"has":{"type":"number","title":"Has","description":"What the press has: the most it takes, or the least for thickness_min."},"unit":{"type":"string","enum":["in","t"],"title":"Unit","description":"Inches, or US tons."},"passes":{"type":"boolean","title":"Passes","description":"Whether the die fits on this."}},"type":"object","required":["check","label","needs","has","unit","passes"],"title":"SheetDieCheck","description":"One of the checks that the die fits the press."},"SheetDieStation":{"properties":{"kind":{"type":"string","enum":["pierce","trim","bend","pre-bend","cutoff","idle"],"title":"Kind","description":"pierce: holes and the pilot; trim: the outline; bend and pre-bend; cutoff from the carrier; idle: empty stations for the die's strength."},"count":{"type":"integer","title":"Count","description":"How many."}},"type":"object","required":["kind","count"],"title":"SheetDieStation","description":"Stations of one kind in the die."},"SheetDieStations":{"properties":{"list":{"items":{"$ref":"#/components/schemas/SheetDieStation"},"type":"array","title":"List","description":"Each kind with its count."},"total":{"type":"integer","title":"Total","description":"Every station, idle ones included."}},"type":"object","required":["list","total"],"title":"SheetDieStations","description":"The die's stations, in its order."},"SheetDieStrip":{"properties":{"width":{"$ref":"#/components/schemas/SheetLength","description":"The strip: the part across it and a carrier each side."},"coil_width":{"$ref":"#/components/schemas/SheetLength","description":"The coil it's cut from, the next whole inch up."},"pitch":{"$ref":"#/components/schemas/SheetLength","description":"How far the strip feeds a stroke: the part along it and the web."},"carrier":{"$ref":"#/components/schemas/SheetLength","description":"Each carrier's width."},"web":{"$ref":"#/components/schemas/SheetLength","description":"The web between parts."},"parts_per_stroke":{"type":"integer","title":"Parts Per Stroke","description":"Parts made each stroke."},"turned":{"type":"boolean","title":"Turned","description":"Whether the flat's longer side runs along the strip."},"gross_weight":{"$ref":"#/components/schemas/SheetWeight","description":"The coil a part uses: pitch × coil width."},"utilisation_pct":{"type":"number","title":"Utilisation Pct","description":"The flat's area over the coil a part uses, percent."}},"type":"object","required":["width","coil_width","pitch","carrier","web","parts_per_stroke","turned","gross_weight","utilisation_pct"],"title":"SheetDieStrip","description":"The flat laid on coil for the progressive die."},"SheetDieTonnage":{"properties":{"required":{"type":"number","title":"Required","description":"US tons the die needs."},"press":{"type":"number","title":"Press","description":"US tons the press has."}},"type":"object","required":["required","press"],"title":"SheetDieTonnage","description":"The force the die needs, with its safety factor, against the press."},"SheetDieTooling":{"properties":{"cost":{"type":"number","title":"Cost","description":"US dollars."},"spread_over":{"type":"number","title":"Spread Over","description":"Parts it's spread over: its life, or three years at the annual volume."}},"type":"object","required":["cost","spread_over"],"title":"SheetDieTooling","description":"The die's own cost and how many parts it's spread over."},"SheetEstimate":{"properties":{"status":{"type":"string","title":"Status","description":"rough: a should-cost from the catalogues, not a shop's quote."},"material":{"$ref":"#/components/schemas/analyses__customer__Material","description":"The sheet grade."},"quantity":{"type":"integer","title":"Quantity","description":"How many parts."},"batch":{"type":"integer","title":"Batch","description":"Parts in a batch: the order."},"machine":{"$ref":"#/components/schemas/EstimateMachine","description":"The cutting machine."},"operations":{"items":{"$ref":"#/components/schemas/SheetOperation"},"type":"array","title":"Operations","description":"The route: the cut, deburr (not after a waterjet) and, for a bent part, the brake."},"material_cost":{"$ref":"#/components/schemas/SheetMaterialCost","description":"The material split."},"cost_lines":{"items":{"$ref":"#/components/schemas/CostLine"},"type":"array","title":"Cost Lines","description":"Every cost line, as a quote prices them."},"cost":{"$ref":"#/components/schemas/Cost","description":"The totals; each to four places, as sheet parts cost cents."},"assumptions":{"items":{"type":"string"},"type":"array","title":"Assumptions","description":"What it assumed, such as the default grade, or a feed it estimated.","default":[]},"estimated":{"type":"boolean","title":"Estimated","description":"Whether a time in it is an estimate beyond the cut speeds Protyus has for the grade.","default":false}},"type":"object","required":["status","material","quantity","batch","machine","operations","material_cost","cost_lines","cost"],"title":"SheetEstimate","description":"A rough estimate on one machine, a cutting machine at the order quantity or the progressive die at a month's run,\nin milling's cost line shape."},"SheetFinding":{"properties":{"rule":{"type":"string","title":"Rule","description":"Its rule, such as SM-V-02 or SM-B-01."},"severity":{"type":"string","title":"Severity","description":"hard_fail (fails the part), scored (costs score) or flag_only (a note, never scored)."},"level":{"anyOf":[{"type":"string","enum":["critical","major","minor","info"]},{"type":"null"}],"title":"Level","description":"How serious it is: critical fails the part, major and minor cost score, info is a note. Null for analyses run before 0.129.0."},"title":{"type":"string","title":"Title","description":"Its heading."},"explanation":{"type":"string","title":"Explanation","description":"What's wrong. Lengths in mm.","default":""},"fix":{"type":"string","title":"Fix","description":"What to change.","default":""},"fix_kind":{"type":"string","title":"Fix Kind","description":"What the fix asks of the design: easy (a radius or drill point a tool forms), model_only (the model changes, the made part doesn't), as_made (how it will be made, no design change) or none (the fix changes the part's form). Empty for analyses run before it was given.","default":""},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it's about.","default":[]},"limit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit","description":"The limit it broke, or null."},"measured":{"anyOf":[{"$ref":"#/components/schemas/SheetMeasure"},{"type":"null"}],"description":"What was measured, or null."},"threshold":{"anyOf":[{"$ref":"#/components/schemas/SheetLimit"},{"type":"null"}],"description":"What it was held to, or null."},"inch":{"anyOf":[{"$ref":"#/components/schemas/FindingInch"},{"type":"null"}],"description":"The same words with lengths in inches."}},"type":"object","required":["rule","severity","title"],"title":"SheetFinding","description":"One sheet metal finding, by its rule id."},"SheetFlange":{"properties":{"id":{"type":"string","title":"Id","description":"F1, F2 ...; F1 is the base flange."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces, both sides of the sheet."},"area_mm2":{"type":"number","title":"Area Mm2","description":"Its area on one side, mm²."},"bends":{"items":{"type":"string"},"type":"array","title":"Bends","description":"The bends on its edges."}},"type":"object","required":["id","surfaces","area_mm2","bends"],"title":"SheetFlange","description":"A flat region of the sheet."},"SheetFlat":{"properties":{"fixed_flange":{"type":"string","title":"Fixed Flange","description":"The flange it's unfolded about, which stays where it is: the base flange."},"size":{"$ref":"#/components/schemas/SheetFlatSize","description":"The smallest rectangle round it."},"area":{"$ref":"#/components/schemas/SheetArea","description":"Its area, holes and cut-outs taken out."},"cut_length":{"$ref":"#/components/schemas/SheetLength","description":"How far the cutter goes: every loop's length added up."},"pierces":{"type":"integer","title":"Pierces","description":"How many loops are cut, one pierce each: the outline and each cut inside it."},"outline":{"items":{"$ref":"#/components/schemas/SheetFlatLoop"},"type":"array","title":"Outline","description":"Its loops, the outline first."},"bend_lines":{"items":{"$ref":"#/components/schemas/SheetBendLine"},"type":"array","title":"Bend Lines","description":"Its bends, in the order bends lists them."},"overlaps":{"type":"boolean","title":"Overlaps","description":"Whether it overlaps itself, so it can't be cut from one sheet (SM-G-02 fails the part)."}},"type":"object","required":["fixed_flange","size","area","cut_length","pierces","outline","bend_lines","overlaps"],"title":"SheetFlat","description":"The part unfolded flat, as the shop cuts it before bending: GET /api/v1/analyses/{analysis_id}/flat/dxf draws it."},"SheetFlatEntity":{"properties":{"type":{"type":"string","enum":["line","arc","circle","polyline"],"title":"Type","description":"line, arc, circle or polyline (a curve on a bend)."},"points":{"anyOf":[{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Points","description":"A line's two ends or a polyline's points, each x and y in mm."},"center":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Center","description":"An arc's or circle's centre, x and y in mm."},"radius":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Radius","description":"An arc's or circle's radius, mm."},"start_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Start Angle","description":"Where an arc starts, degrees anticlockwise from +X."},"end_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End Angle","description":"Where it ends, anticlockwise from its start."}},"type":"object","required":["type"],"title":"SheetFlatEntity","description":"One piece of a loop on the flat, in mm from the flat's (0, 0) corner."},"SheetFlatLoop":{"properties":{"kind":{"type":"string","enum":["outer","inner"],"title":"Kind","description":"outer for the outline, inner for a cut inside it."},"length":{"$ref":"#/components/schemas/SheetLength","description":"How long it is."},"path":{"items":{"$ref":"#/components/schemas/SheetFlatEntity"},"type":"array","title":"Path","description":"Its pieces, end to end."},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"The part's edges it follows on the model, as part.edges lists them. Absent for analyses run before the route named what each operation makes.","default":[]}},"type":"object","required":["kind","length","path"],"title":"SheetFlatLoop","description":"A closed loop the cutter follows: the outline, or a hole, slot or cut-out inside it."},"SheetFlatSize":{"properties":{"length":{"$ref":"#/components/schemas/SheetLength","description":"Its longer side, along X."},"width":{"$ref":"#/components/schemas/SheetLength","description":"Its shorter side, along Y."}},"type":"object","required":["length","width"],"title":"SheetFlatSize","description":"The smallest rectangle round the flat."},"SheetForm":{"properties":{"id":{"type":"string","title":"Id","description":"Such as FM1."},"kind":{"type":"string","enum":["louver","dimple","emboss","extrusion"],"title":"Kind","description":"louver, dimple, emboss or extrusion."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces."},"on":{"type":"string","title":"On","description":"The flange it's pressed into."},"height":{"$ref":"#/components/schemas/SheetLength","description":"How far it stands proud of the sheet."},"direction":{"anyOf":[{"type":"string","enum":["up","down"]},{"type":"null"}],"title":"Direction","description":"up: out of the side the bends turn towards."},"length":{"$ref":"#/components/schemas/SheetLength","description":"Its footprint's longer side; a dimple's diameter."},"width":{"$ref":"#/components/schemas/SheetLength","description":"Its footprint's shorter side."},"bore":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"An extruded hole's inside diameter."}},"type":"object","required":["id","kind","surfaces","on","height","direction","length","width","bore"],"title":"SheetForm","description":"A louver, dimple, emboss or extruded hole pressed into the sheet."},"SheetGauge":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Such as 14 ga, 0.0747 in. Null where T isn't stocked."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Such as 14 ga or 0.063 in."},"value":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"The stocked thickness."},"stocked":{"type":"boolean","title":"Stocked","description":"Whether T is within 0.002 in of a stocked thickness."},"material":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Material","description":"The grade it was matched for, such as SM-07; null: any grade."}},"type":"object","required":["label","name","value","stocked","material"],"title":"SheetGauge","description":"T matched to the thicknesses its material is stocked in."},"SheetHardware":{"properties":{"id":{"type":"string","title":"Id","description":"Such as HW1."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces."},"on":{"type":"string","title":"On","description":"The flange it's pressed into."},"kind":{"anyOf":[{"type":"string","enum":["nut","standoff","stud"]},{"type":"null"}],"title":"Kind","description":"Null where it matches no catalogue part."},"part_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Part Number","description":"The PEM part it matches, such as S-440-1."},"thread":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thread","description":"Its thread, such as 4-40 or M3x0.5."},"height":{"$ref":"#/components/schemas/SheetLength","description":"How far it stands proud of the sheet."},"direction":{"anyOf":[{"type":"string","enum":["up","down"]},{"type":"null"}],"title":"Direction","description":"up: out of the side the bends turn towards."}},"type":"object","required":["id","surfaces","on","kind","part_number","thread","height","direction"],"title":"SheetHardware","description":"A self-clinching nut, standoff or stud modeled into the part."},"SheetHem":{"properties":{"bend":{"type":"string","title":"Bend","description":"The bend it is."},"kind":{"type":"string","enum":["closed","open","rolled"],"title":"Kind","description":"closed, open or rolled."},"gap":{"$ref":"#/components/schemas/SheetLength","description":"Its inside gap."},"return":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"How far the folded-back flange runs."}},"type":"object","required":["bend","kind","gap","return"],"title":"SheetHem","description":"A bend folded back 180°."},"SheetLength":{"properties":{"mm":{"type":"number","title":"Mm","description":"Millimetres."},"in":{"type":"number","title":"In","description":"Inches."}},"type":"object","required":["mm","in"],"title":"SheetLength","description":"A length in both units."},"SheetLimit":{"properties":{"value":{"$ref":"#/components/schemas/SheetLength","description":"What it's held to."},"tolerance":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"How far from it passes, where it's held within it; null where it's a least or a most."},"kind":{"type":"string","enum":["within","at_least","at_most"],"title":"Kind","description":"within: the part must be within tolerance of it; at_least or at_most: no less or no more.","default":"within"}},"type":"object","required":["value"],"title":"SheetLimit","description":"What a finding held the part to."},"SheetMaterialCost":{"properties":{"raw":{"type":"number","title":"Raw","description":"The gross weight's price, US dollars a part."},"scrap_credit":{"type":"number","title":"Scrap Credit","description":"What the scrap sells for, US dollars a part."},"net":{"type":"number","title":"Net","description":"Raw less the scrap credit: the material line."},"cost_of_scrap":{"type":"number","title":"Cost Of Scrap","description":"What the scrap costs over what it sells for, US dollars a part: shown, not added again."}},"type":"object","required":["raw","scrap_credit","net","cost_of_scrap"],"title":"SheetMaterialCost","description":"What the sheet costs a part."},"SheetMeasure":{"properties":{"min":{"$ref":"#/components/schemas/SheetLength","description":"The least measured."},"max":{"$ref":"#/components/schemas/SheetLength","description":"The most."}},"type":"object","required":["min","max"],"title":"SheetMeasure","description":"What a finding measured on the part."},"SheetMetal":{"properties":{"status":{"anyOf":[{"type":"string","enum":["not_built","ready"]},{"type":"null"}],"title":"Status","description":"not_built while Protyus doesn't analyse this process yet; ready once it has analysed the part."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The section's heading, for people, such as Sheet metal analysis isn't available yet."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"What it means, for people."},"checks":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Checks","description":"What the analysis checks for this process, in words, while it's not built."},"thickness":{"anyOf":[{"$ref":"#/components/schemas/SheetThickness"},{"type":"null"}],"description":"Its thickness; null where it isn't sheet."},"gauge":{"anyOf":[{"$ref":"#/components/schemas/SheetGauge"},{"type":"null"}],"description":"Its gauge; null where it isn't sheet."},"base_flange":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Base Flange","description":"The flange up and down are read from: the largest."},"flanges":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetFlange"},"type":"array"},{"type":"null"}],"title":"Flanges","description":"Its flat regions, the base flange first."},"bends":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetBend"},"type":"array"},{"type":"null"}],"title":"Bends","description":"Its bends."},"hems":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetHem"},"type":"array"},{"type":"null"}],"title":"Hems","description":"Bends folded back on themselves."},"holes":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetCut"},"type":"array"},{"type":"null"}],"title":"Holes","description":"Round holes."},"slots":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetCut"},"type":"array"},{"type":"null"}],"title":"Slots","description":"Slots with round ends."},"cutouts":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetCut"},"type":"array"},{"type":"null"}],"title":"Cutouts","description":"Other cuts through the sheet."},"notches":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetCut"},"type":"array"},{"type":"null"}],"title":"Notches","description":"Cuts into its edge."},"reliefs":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetCut"},"type":"array"},{"type":"null"}],"title":"Reliefs","description":"Notches cut into a bend."},"forms":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetForm"},"type":"array"},{"type":"null"}],"title":"Forms","description":"Forms pressed into it. Absent for analyses run before forms were read."},"hardware":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetHardware"},"type":"array"},{"type":"null"}],"title":"Hardware","description":"Self-clinching hardware modeled into it. Absent for analyses run before hardware was read."},"flat":{"anyOf":[{"$ref":"#/components/schemas/SheetFlat"},{"type":"null"}],"description":"The part unfolded flat, with its size, cut length, pierces, outline and bend lines; null where it can't be unfolded. Absent for analyses run before 0.127.0."},"no_flat":{"anyOf":[{"$ref":"#/components/schemas/SheetNoFlat"},{"type":"null"}],"description":"Why it can't be unfolded, where flat is null; null where it unfolds. Absent for analyses run before it was given."},"findings":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetFinding"},"type":"array"},{"type":"null"}],"title":"Findings","description":"What's wrong, by rule id, worst first."},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/ProcessScorecard"},{"type":"null"}],"description":"The verdict and the DFM score by its fourteen categories (SM-B to SM-X), in milling's shape. Absent for analyses run before 0.129.0."},"caveats":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Caveats","description":"What the rules were held to, such as a default grade, and what they couldn't check yet."},"fails":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fails","description":"Whether a finding fails the part: any hard_fail does. The score never does."},"nest":{"anyOf":[{"$ref":"#/components/schemas/SheetRouteNest"},{"type":"null"}],"description":"The flat on the cutting machine's sheet, with the material each part uses and where each part sits; null where it can't be nested. Absent for analyses run before 0.130.0."},"estimate":{"anyOf":[{"$ref":"#/components/schemas/SheetEstimate"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Estimate","description":"The cost on the cutting machine at the order quantity, or why there isn't one. Absent for analyses run before 0.130.0."},"cutting":{"anyOf":[{"$ref":"#/components/schemas/SheetCutting"},{"type":"null"}],"description":"The route its findings, nest and estimate are for: Auto's pick, the cheapest that can make it of the cutting machines and the progressive die, unless one was chosen. Absent for analyses run before the machines were compared, which were costed on the fiber laser."},"comparison":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetProcess"},"type":"array"},{"type":"null"}],"title":"Comparison","description":"All six cutting machines, always in the same order: whether each can make the part and why not, the verdict, nest, time and cost on each. Absent for analyses run before the machines were compared."},"progressive_die":{"anyOf":[{"$ref":"#/components/schemas/SheetDie"},{"type":"null"}],"description":"The part stamped from coil in a progressive die, with the annual volume at which its die breaks even with the cheapest cutting machine; null where there's no flat. Absent for analyses run before the die was costed."}},"type":"object","title":"SheetMetal","description":"A sheet metal analysis's conclusions: what the part is made of and what's wrong. Absent while the section isn't\nbuilt, and for analyses run before 0.125.0."},"SheetMetalLook":{"properties":{"thickness":{"type":"number","title":"Thickness","description":"Its material thickness, mm."},"bends":{"type":"integer","title":"Bends","description":"How many bends it has; 0 for a flat part."}},"type":"object","required":["thickness","bends"],"title":"SheetMetalLook","description":"A part with one material thickness all over, which looks like sheet metal. It's still planned as milled."},"SheetMetalScorecard":{"properties":{"green_from":{"type":"number","maximum":100.0,"exclusiveMinimum":0.0,"title":"Green From","description":"The lowest sheet metal DFM score shown green. Default 85.","default":85},"yellow_from":{"type":"number","maximum":100.0,"exclusiveMinimum":0.0,"title":"Yellow From","description":"The lowest sheet metal DFM score shown yellow, below green. Lower is red. Default 60.","default":60}},"additionalProperties":false,"type":"object","title":"SheetMetalScorecard","description":"Where the sheet metal DFM score's green and yellow start: its own, apart from milling's. By default they match\nmilling's."},"SheetMetalSettings":{"properties":{"scorecard":{"$ref":"#/components/schemas/SheetMetalScorecard","description":"Where the sheet metal DFM score's green and yellow start.","default":{"green_from":85.0,"yellow_from":60.0}}},"additionalProperties":false,"type":"object","title":"SheetMetalSettings","description":"Sheet metal's own settings: each process's settings are a section of their own, as its result is."},"SheetNest":{"properties":{"machine":{"type":"string","title":"Machine","description":"The machine it's nested for: SM-FL6 the fiber laser, SM-CO2 the CO2 laser, SM-PL the plasma, SM-WJ the waterjet, SM-TP the turret punch or SM-PLC the punch/laser."},"sheet":{"$ref":"#/components/schemas/SheetSize","description":"The sheet, 48 × 96 in unless the flat needs a larger one."},"spacing":{"$ref":"#/components/schemas/SheetLength","description":"The gap between parts."},"margin":{"$ref":"#/components/schemas/SheetLength","description":"The margin left at each edge of the sheet."},"across":{"type":"integer","title":"Across","description":"Parts along the sheet's length."},"down":{"type":"integer","title":"Down","description":"Parts across its width."},"turned":{"type":"boolean","title":"Turned","description":"Whether the flat lies across the sheet rather than along it."},"parts_per_sheet":{"type":"integer","title":"Parts Per Sheet","description":"Parts on a full sheet."},"sheets":{"type":"integer","title":"Sheets","description":"Sheets the order needs."},"on_last_sheet":{"type":"integer","title":"On Last Sheet","description":"Parts on the last sheet."},"blank_weight":{"$ref":"#/components/schemas/SheetWeight","description":"What the part itself weighs."},"gross_weight":{"$ref":"#/components/schemas/SheetWeight","description":"The sheet a part uses: the sheet's weight over parts per sheet."},"scrap_weight":{"$ref":"#/components/schemas/SheetWeight","description":"Gross less blank: the skeleton, the cut-outs and the kerf."},"utilisation_pct":{"type":"number","title":"Utilisation Pct","description":"Blank weight over gross weight, percent."}},"type":"object","required":["machine","sheet","spacing","margin","across","down","turned","parts_per_sheet","sheets","on_last_sheet","blank_weight","gross_weight","scrap_weight","utilisation_pct"],"title":"SheetNest","description":"The flat laid out on the sheet it's cut from, and the material each part uses."},"SheetNoFlat":{"properties":{"reason":{"type":"string","title":"Reason","description":"Why, in a sentence, such as that a flange isn't joined to the rest by a bend."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces that keep it from unfolding; empty where no face is to blame."}},"type":"object","required":["reason","surfaces"],"title":"SheetNoFlat","description":"Why a part can't be unfolded."},"SheetOperation":{"properties":{"operation":{"type":"string","enum":["laser","plasma","waterjet","punch","deburr","countersink","bend","stamp"],"title":"Operation","description":"laser, plasma or waterjet cuts the flat; punch punches it on the turret punch or the punch/laser (which lasers what it doesn't punch, and forms any countersinks in its cycle); deburr cleans its edges; countersink cuts the countersinks on the drill press, on a route that didn't form them; bend forms it on the press brake; stamp makes it from coil in the progressive die."},"work_centre":{"type":"string","title":"Work Centre","description":"Where: a cutting machine such as SM-FL6 the fiber laser, WC-DBR deburring, WC-DRL the drill press, WC-BRK the press brake."},"label":{"type":"string","title":"Label","description":"Its name for people."},"run_s":{"type":"number","title":"Run S","description":"Seconds a part."},"setup_min":{"type":"number","title":"Setup Min","description":"Minutes to set it up, once a batch."},"lot_min":{"type":"number","title":"Lot Min","description":"Minutes for the whole order, setup included."},"bottleneck":{"type":"boolean","title":"Bottleneck","description":"Whether it's the slowest operation over the order."},"edges":{"items":{"type":"string"},"type":"array","title":"Edges","description":"The part's edges it cuts, as part.edges lists them: every edge the cutter follows, for a cut, and the same edges for deburr. Empty for an analysis run before operations named what they make.","default":[]},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces of the features it makes: the bends on the brake, the countersunk holes on the drill press or the turret, and the whole sheet on the progressive die.","default":[]},"bends":{"items":{"type":"string"},"type":"array","title":"Bends","description":"The bends it forms, as bends lists them.","default":[]},"machine":{"type":"number","title":"Machine","description":"Machine time, US dollars a part."},"consumables":{"type":"number","title":"Consumables","description":"Gas, nozzles and the like, US dollars a part."},"labour":{"type":"number","title":"Labour","description":"Labour, US dollars a part."},"overhead":{"type":"number","title":"Overhead","description":"Overhead, US dollars a part."},"setup":{"type":"number","title":"Setup","description":"Its setup spread over the order, US dollars a part."},"total":{"type":"number","title":"Total","description":"All of it, US dollars a part."},"estimated":{"type":"boolean","title":"Estimated","description":"Whether its time is an estimate beyond the cut speeds Protyus has for the grade: the cut of a sheet thinner than they cover.","default":false}},"type":"object","required":["operation","work_centre","label","run_s","setup_min","lot_min","bottleneck","machine","consumables","labour","overhead","setup","total"],"title":"SheetOperation","description":"One operation on the route, its time and its cost a part at the order quantity."},"SheetPlacement":{"properties":{"x":{"type":"number","title":"X","description":"Its box's left edge, mm along the sheet's length from its edge."},"y":{"type":"number","title":"Y","description":"Its box's bottom edge, mm across the sheet's width from its edge."},"rotation":{"type":"integer","enum":[0,90],"title":"Rotation","description":"Degrees counterclockwise the outline is turned about its (0, 0) corner before its box is moved to x and y: 90 where the flat lies across the sheet."}},"type":"object","required":["x","y","rotation"],"title":"SheetPlacement","description":"Where one part sits on the sheet."},"SheetProcess":{"properties":{"machine":{"type":"string","title":"Machine","description":"Its id: SM-FL6, SM-CO2, SM-PL, SM-WJ, SM-TP or SM-PLC."},"label":{"type":"string","title":"Label","description":"Its name, such as Fiber laser, 6 kW."},"capable":{"type":"boolean","title":"Capable","description":"Whether it can make the part: the grade suits it, the thickness is in its range and the flat fits its sheet."},"reasons":{"items":{"$ref":"#/components/schemas/SheetReason"},"type":"array","title":"Reasons","description":"Why it can't, where it can't.","default":[]},"can_be_made":{"type":"boolean","title":"Can Be Made","description":"The part's verdict with its rules judged on this machine."},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","description":"The part's DFM score on this machine; null with scoring off."},"parts_per_sheet":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parts Per Sheet","description":"Parts on a full sheet; null where it can't be nested."},"utilisation_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Utilisation Pct","description":"Blank weight over gross weight, percent."},"run_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Run S","description":"Seconds a part over the whole route; null where it isn't costed."},"each":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Each","description":"US dollars a part at the order quantity; null where it isn't costed."},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total","description":"US dollars for the order."},"estimated":{"type":"boolean","title":"Estimated","description":"Whether its cost rests on a feed estimated beyond the cut speeds Protyus has for the grade.","default":false},"chosen":{"type":"boolean","title":"Chosen","description":"Whether the part is judged and costed on it above."},"nest":{"anyOf":[{"$ref":"#/components/schemas/SheetNest"},{"type":"null"}],"description":"Its nest; null where it can't be nested."},"estimate":{"anyOf":[{"$ref":"#/components/schemas/SheetEstimate"},{"$ref":"#/components/schemas/Failed"}],"title":"Estimate","description":"Its estimate, or why there isn't one."}},"type":"object","required":["machine","label","capable","can_be_made","chosen","estimate"],"title":"SheetProcess","description":"One cutting machine in the process comparison."},"SheetReason":{"properties":{"rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule","description":"Its rule, such as SM-A-08 (thickness outside its range) or SM-M-02 (grade not suited); null where the part couldn't be costed on it for another reason."},"title":{"type":"string","title":"Title","description":"Its heading."},"explanation":{"type":"string","title":"Explanation","description":"What's wrong, in mm."}},"type":"object","required":["rule","title","explanation"],"title":"SheetReason","description":"Why a cutting machine can't make the part."},"SheetRouteNest":{"properties":{"machine":{"type":"string","title":"Machine","description":"The machine it's nested for: SM-FL6 the fiber laser, SM-CO2 the CO2 laser, SM-PL the plasma, SM-WJ the waterjet, SM-TP the turret punch or SM-PLC the punch/laser."},"sheet":{"$ref":"#/components/schemas/SheetSize","description":"The sheet, 48 × 96 in unless the flat needs a larger one."},"spacing":{"$ref":"#/components/schemas/SheetLength","description":"The gap between parts."},"margin":{"$ref":"#/components/schemas/SheetLength","description":"The margin left at each edge of the sheet."},"across":{"type":"integer","title":"Across","description":"Parts along the sheet's length."},"down":{"type":"integer","title":"Down","description":"Parts across its width."},"turned":{"type":"boolean","title":"Turned","description":"Whether the flat lies across the sheet rather than along it."},"parts_per_sheet":{"type":"integer","title":"Parts Per Sheet","description":"Parts on a full sheet."},"sheets":{"type":"integer","title":"Sheets","description":"Sheets the order needs."},"on_last_sheet":{"type":"integer","title":"On Last Sheet","description":"Parts on the last sheet."},"blank_weight":{"$ref":"#/components/schemas/SheetWeight","description":"What the part itself weighs."},"gross_weight":{"$ref":"#/components/schemas/SheetWeight","description":"The sheet a part uses: the sheet's weight over parts per sheet."},"scrap_weight":{"$ref":"#/components/schemas/SheetWeight","description":"Gross less blank: the skeleton, the cut-outs and the kerf."},"utilisation_pct":{"type":"number","title":"Utilisation Pct","description":"Blank weight over gross weight, percent."},"outline":{"anyOf":[{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},{"type":"null"}],"title":"Outline","description":"The flat's outer boundary as a closed polyline, x and y in mm on the flat as its outline is, the first point not repeated: no holes, bend lines or other cuts inside it. Absent for analyses run before the nest was drawn."},"placements":{"anyOf":[{"items":{"$ref":"#/components/schemas/SheetPlacement"},"type":"array"},{"type":"null"}],"title":"Placements","description":"Each part on a full sheet, row by row: as many as parts_per_sheet. Absent for analyses run before the nest was drawn."}},"type":"object","required":["machine","sheet","spacing","margin","across","down","turned","parts_per_sheet","sheets","on_last_sheet","blank_weight","gross_weight","scrap_weight","utilisation_pct"],"title":"SheetRouteNest","description":"The route's nest, with what draws it: the flat's outline at each part's place on the sheet."},"SheetSize":{"properties":{"width":{"$ref":"#/components/schemas/SheetLength","description":"Its shorter side."},"length":{"$ref":"#/components/schemas/SheetLength","description":"Its longer side."}},"type":"object","required":["width","length"],"title":"SheetSize","description":"A sheet's size."},"SheetSource":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"The file's Vercel Blob URL, from an upload through /upload. It must be your own upload, in uploads/{org_id}/{user_id}/; anything else is refused with NOT_YOUR_UPLOAD."},"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's original name, such as machines.xlsx or materials.csv."},"sheet":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Sheet","description":"For an XLSX, the sheet to read. Null reads the sheet whose headers match best."},"columns":{"additionalProperties":{"type":"string"},"type":"object","title":"Columns","description":"Field to column header, for any column the headers don't name well enough, such as {\"hourly_rate\": \"Rate\"}. Fields are the template's; the preview's columns show how each header was read.","default":{}}},"additionalProperties":false,"type":"object","required":["upload_url","file_name"],"title":"SheetSource","description":"An uploaded spreadsheet and how to read it."},"SheetThickness":{"properties":{"value":{"$ref":"#/components/schemas/SheetLength","description":"T: the metal behind its largest flat face."},"constant":{"type":"boolean","title":"Constant","description":"Whether every flat face has T behind it, within 0.001 in."},"min":{"$ref":"#/components/schemas/SheetLength","description":"The thinnest metal measured behind a flat face."},"max":{"$ref":"#/components/schemas/SheetLength","description":"The thickest."},"nominal":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"The nominal wall: the sheet's most common thickness by area, in 0.005 in steps, as a moulded part's is read. Absent for analyses run before it was measured."},"departure":{"anyOf":[{"$ref":"#/components/schemas/SheetLength"},{"type":"null"}],"description":"How far from the nominal wall a spot's thickness must be to be marked: 10% of it or 0.005 in, whichever is larger. Absent for analyses run before it was measured."},"spheres":{"anyOf":[{"items":{"$ref":"#/components/schemas/WallSphere"},"type":"array"},{"type":"null"}],"title":"Spheres","description":"A sphere at each spot that departs from the nominal wall, thinner or thicker, at most 1,500, those furthest from it first; empty for a sheet of one thickness. Absent for analyses run before it was measured."}},"type":"object","required":["value","constant","min","max"],"title":"SheetThickness","description":"The sheet's thickness, T."},"SheetWeight":{"properties":{"lb":{"type":"number","title":"Lb","description":"Pounds."},"kg":{"type":"number","title":"Kg","description":"Kilograms."}},"type":"object","required":["lb","kg"],"title":"SheetWeight","description":"A weight in both units."},"SkippedItem":{"properties":{"item_id":{"type":"string","format":"uuid","title":"Item Id","description":"The item."},"reason":{"type":"string","const":"changed_since","title":"Reason","description":"changed_since: someone edited, archived or unarchived it after the batch."}},"additionalProperties":false,"type":"object","required":["item_id","reason"],"title":"SkippedItem","description":"An item an undo left alone."},"SourceCounts":{"properties":{"ui":{"type":"integer","title":"Ui","description":"Through the app, signed in with a session.","default":0},"api":{"type":"integer","title":"Api","description":"Through the API, with an API key.","default":0},"mcp":{"type":"integer","title":"Mcp","description":"Through the MCP server.","default":0},"intake":{"type":"integer","title":"Intake","description":"Started by a lead through an upload link, counted against whoever sent it.","default":0}},"additionalProperties":false,"type":"object","title":"SourceCounts","description":"How many events came through each surface."},"StandardDrills":{"properties":{"drill_sizes_mm":{"items":{"type":"number"},"type":"array","maxItems":600,"minItems":1,"title":"Drill Sizes Mm","description":"Standard drill sizes, mm. A plan drills a hole with the one nearest its size, and a hole that isn't one of these sizes (within 0.0005 in) is flagged as non-standard. Default: the drill chart up to 1 in, fractional drills 1/64 to 1 in, number drills #1 to #80, letter drills A to Z, and metric drills 1 to 14 mm in 0.1 mm steps, 14 to 16 mm in 0.25 mm steps and 16 to 25 mm in 0.5 mm steps.","default":[0.3429,0.3683,0.3969,0.4064,0.4572,0.508,0.5334,0.5715,0.6096,0.635,0.6604,0.7112,0.7417,0.7874,0.7937,0.8128,0.8382,0.889,0.9144,0.9398,0.9652,0.9906,1.0,1.016,1.0414,1.0668,1.0922,1.1,1.1811,1.1906,1.2,1.3,1.3208,1.397,1.4,1.5,1.5113,1.5875,1.6,1.6129,1.7,1.7018,1.778,1.8,1.8542,1.9,1.9304,1.9844,1.9939,2.0,2.0574,2.0828,2.1,2.1844,2.2,2.2606,2.3,2.3749,2.3812,2.4,2.4384,2.4892,2.5,2.5273,2.5781,2.6,2.6416,2.7,2.7051,2.7781,2.794,2.8,2.8194,2.8702,2.9,2.9464,3.0,3.048,3.1,3.175,3.2,3.2639,3.3,3.4,3.4544,3.5,3.5687,3.5719,3.6,3.6576,3.7,3.7338,3.7973,3.8,3.8608,3.9,3.9116,3.9688,3.9878,4.0,4.0386,4.0894,4.1,4.2,4.2164,4.3,4.3053,4.3656,4.3942,4.4,4.4958,4.5,4.572,4.6,4.6228,4.699,4.7,4.7625,4.8,4.8006,4.8514,4.9,4.9149,4.9784,5.0,5.0546,5.1,5.1054,5.1594,5.1816,5.2,5.2197,5.3,5.3086,5.4,5.4102,5.5,5.5562,5.6,5.6134,5.7,5.7912,5.8,5.9,5.9436,5.9531,6.0,6.0452,6.1,6.1468,6.2,6.2484,6.3,6.35,6.4,6.5,6.5278,6.6,6.6294,6.7,6.7469,6.7564,6.8,6.9,6.9088,7.0,7.0358,7.1,7.1374,7.1437,7.2,7.3,7.366,7.4,7.493,7.5,7.5406,7.6,7.6708,7.7,7.8,7.9,7.9375,8.0,8.0264,8.1,8.2,8.2042,8.3,8.3344,8.4,8.4328,8.5,8.6,8.6106,8.7,8.7312,8.8,8.8392,8.9,9.0,9.0932,9.1,9.1281,9.2,9.3,9.3472,9.4,9.5,9.525,9.5758,9.6,9.7,9.8,9.8044,9.9,9.9219,10.0,10.0838,10.1,10.2,10.2616,10.3,10.3187,10.4,10.4902,10.5,10.6,10.7,10.7156,10.8,10.9,11.0,11.1,11.1125,11.2,11.3,11.4,11.5,11.5094,11.6,11.7,11.8,11.9,11.9062,12.0,12.1,12.2,12.3,12.3031,12.4,12.5,12.6,12.7,12.8,12.9,13.0,13.0969,13.1,13.2,13.3,13.4,13.4937,13.5,13.6,13.7,13.8,13.8906,13.9,14.0,14.25,14.2875,14.5,14.6844,14.75,15.0,15.0812,15.25,15.4781,15.5,15.75,15.875,16.0,16.2719,16.5,16.6687,17.0,17.0656,17.4625,17.5,17.8594,18.0,18.2562,18.5,18.6531,19.0,19.05,19.4469,19.5,19.8438,20.0,20.2406,20.5,20.6375,21.0,21.0344,21.4312,21.5,21.8281,22.0,22.225,22.5,22.6219,23.0,23.0187,23.4156,23.5,23.8125,24.0,24.2094,24.5,24.6062,25.0,25.0031,25.4]}},"additionalProperties":false,"type":"object","title":"StandardDrills","description":"Which drill sizes are standard: the drills a plan may choose, and the sizes a hole is checked against."},"StandardRadii":{"properties":{"corner_radii_mm":{"items":{"type":"number"},"type":"array","maxItems":40,"minItems":1,"title":"Corner Radii Mm","description":"Standard bullnose corner radii, mm. The standard bull nose end mills carry these, and a tool with another radius is a non-standard tool. A concave fillet not within 0.002 in of one of these, or of a standard ball's radius, is flagged as non-standard, and a floor fillet not within 0.002 in of one of these fails the floors check. Default 0.005, 0.010, 0.030, 0.060, 0.090, 0.100 and 0.125 in.","default":[0.127,0.254,0.762,1.524,1.5875,2.286,2.54,3.175]}},"additionalProperties":false,"type":"object","title":"StandardRadii","description":"Which concave fillet radii count as standard: the corner radii of the standard bullnose end mills."},"StandardSizes":{"properties":{"name":{"type":"string","title":"Name","description":"Its name."},"notice":{"type":"string","title":"Notice","description":"What it is and isn't."},"tools":{"items":{"$ref":"#/components/schemas/StandardTool"},"type":"array","title":"Tools","description":"The tools matching the query, smallest diameter first."},"total":{"type":"integer","title":"Total","description":"How many match, across every page."}},"additionalProperties":false,"type":"object","required":["name","notice","tools","total"],"title":"StandardSizes","description":"The standard sizes reference library."},"StandardTool":{"properties":{"guid":{"type":"string","title":"Guid","description":"Its id in the standard sizes. Copy it with POST /api/v1/tools/standard-sizes/copy."},"tool":{"$ref":"#/components/schemas/Cutter","description":"The tool, in mm."}},"additionalProperties":false,"type":"object","required":["guid","tool"],"title":"StandardTool","description":"One standard size, as it would be copied into an organization's library."},"StartIn":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name","description":"The part's name, such as Motor mount."},"picks":{"$ref":"#/components/schemas/Picks","description":"The quick check's machine, material and quantity.","default":{}}},"additionalProperties":false,"type":"object","required":["name"],"title":"StartIn","description":"A new part, made in Design from nothing."},"StatusIn":{"properties":{"status":{"anyOf":[{"type":"string","enum":["won","lost"]},{"type":"null"}],"title":"Status","description":"won or lost; null clears it, back to what their events say."}},"additionalProperties":false,"type":"object","required":["status"],"title":"StatusIn","description":"Won, lost, or neither."},"StepArrow":{"properties":{"step":{"type":"integer","title":"Step","description":"The operation's place in its route, from 1."},"route":{"type":"string","enum":["mill","lathe","lathe_then_mill","mill_turn"],"title":"Route","description":"Its route."},"label":{"type":"string","title":"Label","description":"Its name by the arrow: Op 10 on a lathe or mill-turn, Setup 1 on a mill."},"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"Its direction, out towards the tool, as a unit vector."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it cuts."}},"additionalProperties":false,"type":"object","required":["step","route","label","direction","surfaces"],"title":"StepArrow","description":"A route operation's tool arrow."},"StepCamera":{"properties":{"step":{"type":"integer","maximum":99.0,"minimum":1.0,"title":"Step","description":"The operation's place in its route, from 1."},"route":{"anyOf":[{"type":"string","enum":["mill","lathe","lathe_then_mill","mill_turn"]},{"type":"null"}],"title":"Route","description":"The route. Leave out for the one it's made by."}},"additionalProperties":false,"type":"object","required":["step"],"title":"StepCamera","description":"How one operation of a lathe part's route sees it: down a mill setup's tool direction, or side on to the turning\naxis for a lathe or mill-turn operation, as the operator looks into the machine."},"StepOut":{"properties":{"key":{"type":"string","enum":["lines","material_markup","tools_to_buy","margin","rush","minimum"],"title":"Key","description":"lines (the cost lines but tools to buy), material_markup, tools_to_buy, margin, rush or minimum."},"label":{"type":"string","title":"Label","description":"Its name for people."},"amount":{"type":"number","title":"Amount","description":"US dollars this step adds. Zero when it doesn't apply."},"total":{"type":"number","title":"Total","description":"US dollars after this step."},"applied":{"type":"boolean","title":"Applied","description":"Whether the step changed anything."}},"type":"object","required":["key","label","amount","total","applied"],"title":"StepOut","description":"One step from cost lines to price. Each step's total is the next step's start."},"StepRef-Input":{"properties":{"step":{"type":"integer","maximum":99.0,"minimum":1.0,"title":"Step","description":"The operation's place in its route, from 1, in the order turning.routes[].operations lists them."},"route":{"anyOf":[{"type":"string","enum":["mill","lathe","lathe_then_mill","mill_turn"]},{"type":"null"}],"title":"Route","description":"The route: mill, lathe, lathe_then_mill or mill_turn. Leave out for the one it's made by, turning.route."}},"additionalProperties":false,"type":"object","required":["step"],"title":"StepRef","description":"One operation of a lathe part's route: the faces it cuts."},"Stock":{"properties":{"form":{"type":"string","title":"Form","description":"Its form, such as plate or round bar."},"size_mm":{"items":{"type":"number"},"type":"array","title":"Size Mm","description":"Its size, mm: X, Y and Z, or for a bar, diameter then length."},"weight_kg":{"type":"number","title":"Weight Kg","description":"Its weight, kg."},"buy_to_fly":{"type":"number","title":"Buy To Fly","description":"Stock weight over part weight."},"cleanup_mm":{"type":"number","title":"Cleanup Mm","description":"The least taken off each face, mm."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price","description":"Its price, US dollars. Null when it isn't priced."},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of","description":"The date of that price."},"price_per_piece":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Per Piece","description":"A fixed charge for the piece, US dollars, on results made before 2026-11-11. Null since: a piece is priced by weight alone."},"price_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Rate","description":"The material's price per price_unit, US dollars. Null when the piece isn't priced."},"price_unit":{"anyOf":[{"type":"string","enum":["lb","kg","in"]},{"type":"null"}],"title":"Price Unit","description":"What price_rate is per: lb or kg of the piece's weight (in, of a bar's length, on results made before 2026-11-11)."},"price_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price Factor","description":"The material's form factor for this stock form, which scales its price per pound: price = weight x price_rate x price_factor. Null when the piece isn't priced, and on results made before it."},"own_price":{"type":"boolean","title":"Own Price","description":"Whether the organization's own stock rows or price set it, rather than Protyus's list price.","default":false}},"type":"object","required":["form","size_mm","weight_kg","buy_to_fly","cleanup_mm"],"title":"Stock","description":"The raw stock the part is cut from."},"StockSettings":{"properties":{"min_cleanup_mm":{"type":"number","maximum":12.7,"minimum":0.0,"title":"Min Cleanup Mm","description":"Minimum clean-up: the least stock cut off each face, mm. Default 0.125 in.","default":3.175}},"additionalProperties":false,"type":"object","title":"StockSettings","description":"How much stock is left around the part. Every face is machined, so every face has some."},"SubmissionDetail":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The submission's id."},"lead_id":{"type":"string","format":"uuid","title":"Lead Id","description":"The lead who sent it."},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"The project its parts were analysed and quoted in. Null once deleted."},"submission_link_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Submission Link Id","description":"The submission link it came through. Null for an upload link the team sent."},"state":{"type":"string","enum":["analysing","held","sent","declined"],"title":"State","description":"analysing, until every part is done; held, for the team to send or decline; sent, once the quote email went (or was queued); or declined."},"quantity":{"type":"integer","title":"Quantity","description":"How many of each part the lead asked for."},"answers":{"additionalProperties":true,"type":"object","title":"Answers","description":"The lead's answers to the form, as they gave them."},"hold_reasons":{"items":{"$ref":"#/components/schemas/HoldReason"},"type":"array","title":"Hold Reasons","description":"Why it was held. Empty unless it was."},"parts":{"items":{"$ref":"#/components/schemas/SubmissionPartOut"},"type":"array","title":"Parts","description":"Its files, by file name."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the lead sent it."},"can_write":{"type":"boolean","title":"Can Write","description":"Whether the caller may send or decline it (quotes:write on its project)."}},"additionalProperties":false,"type":"object","required":["id","lead_id","project_id","submission_link_id","state","quantity","answers","hold_reasons","parts","created_at","can_write"],"title":"SubmissionDetail","description":"A lead's submission, for the shop's own people: its parts, quotes and why it's held."},"SubmissionIn":{"properties":{"answers":{"$ref":"#/components/schemas/Answers","description":"Their answers to the form's fields.","default":{}},"consent":{"type":"boolean","title":"Consent","description":"Whether they ticked the consent box. Required when the page shows a privacy policy.","default":false},"quantity":{"type":"integer","maximum":100000.0,"minimum":1.0,"title":"Quantity","description":"How many of each part, from 1 to 100,000."},"files":{"items":{"$ref":"#/components/schemas/SubmittedFile"},"type":"array","maxItems":10,"minItems":1,"title":"Files","description":"The uploaded STEP files, 1 to 10."}},"additionalProperties":false,"type":"object","required":["quantity","files"],"title":"SubmissionIn","description":"The lead's answers, files and quantity."},"SubmissionLinkChange":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Name","description":"Its new name."},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"False pauses it; true sets it taking requests again, whatever paused it."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When it stops taking requests. Leave it out to keep it; send null for never."},"config":{"anyOf":[{"$ref":"#/components/schemas/LinkConfig"},{"type":"null"}],"description":"Settings to change. Only the fields given change, at any depth; a list given replaces the old one."}},"additionalProperties":false,"type":"object","title":"SubmissionLinkChange","description":"A change to a submission link. Only what's given changes."},"SubmissionLinkIn":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name","description":"What the shop calls it, such as Website quote button. Never shown to leads."},"enabled":{"type":"boolean","title":"Enabled","description":"Whether it takes requests. Default on.","default":true},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When it stops taking requests. Leave it out for 30 days from now; send null for never."},"config":{"$ref":"#/components/schemas/LinkConfig","description":"Its settings. Anything left out takes its default.","default":{"form":{"company":"optional","due_date":"off","email":"required","first_name":"required","last_name":"required","notes":"off","phone":"off"},"auto_send":false,"hold":{"hold_below_minimum_charge":false,"hold_on_flags":false,"min_score":80},"templates":{"acknowledgement":{},"decline":{},"quote":{}},"daily_cap":25,"allowed_domains":[],"blocked_domains":[]}}},"additionalProperties":false,"type":"object","required":["name"],"title":"SubmissionLinkIn","description":"A new submission link for a project."},"SubmissionLinkOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The link's id."},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"The project its submissions land in. Null once that project is deleted."},"name":{"type":"string","title":"Name","description":"What the shop calls it."},"status":{"type":"string","enum":["active","paused","revoked"],"title":"Status","description":"active, paused (by hand or by itself; paused_reason says which) or revoked, for good."},"paused_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paused Reason","description":"Why it's paused: turned_off, daily_cap, traffic_jump or project_archived. Null unless paused."},"paused_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Paused At","description":"When it was paused, by hand or by itself. Null unless paused."},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"When it stops taking requests. Null for never."},"taking_requests":{"type":"boolean","title":"Taking Requests","description":"Whether its form takes requests now: active and not expired."},"config":{"$ref":"#/components/schemas/LinkConfig","description":"Its settings, with defaults filled in."},"created_by":{"type":"string","title":"Created By","description":"Who made it, a Clerk user id. Replies and notices go to them unless the settings say otherwise."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When it was made."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When it last changed."},"can_manage":{"type":"boolean","title":"Can Manage","description":"Whether the caller may change it (submission_links:manage on its project)."}},"additionalProperties":false,"type":"object","required":["id","project_id","name","status","paused_reason","paused_at","expires_at","taking_requests","config","created_by","created_at","updated_at","can_manage"],"title":"SubmissionLinkOut","description":"A submission link. Its token is never shown again after it's made or regenerated."},"SubmissionOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The submission's id, which a held one is sent or declined by."},"project":{"anyOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}],"description":"The project its parts were analysed in. Null once that project is deleted."},"submission_link":{"anyOf":[{"$ref":"#/components/schemas/Named"},{"type":"null"}],"description":"The submission link it came through. Null when the team sent the upload link."},"quantity":{"type":"integer","title":"Quantity","description":"How many of each part they asked for."},"state":{"type":"string","enum":["analysing","held","sent","declined"],"title":"State","description":"analysing; held for the team; sent, its quote emailed; or declined."},"hold_reasons":{"items":{"$ref":"#/components/schemas/Reason"},"type":"array","title":"Hold Reasons","description":"Why it's held, part by part. Empty unless held."},"answers":{"$ref":"#/components/schemas/Answers","description":"What they said about themselves and the request, with this submission."},"consent":{"type":"boolean","title":"Consent","description":"Whether they ticked the consent box: true when the page showed a privacy policy."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When they submitted."},"parts":{"items":{"$ref":"#/components/schemas/PartOut"},"type":"array","title":"Parts","description":"Its parts, by file name."},"can_review":{"type":"boolean","title":"Can Review","description":"Whether the caller may send, edit or decline it (quotes:write on its project)."}},"additionalProperties":false,"type":"object","required":["id","project","submission_link","quantity","state","hold_reasons","answers","consent","created_at","parts","can_review"],"title":"SubmissionOut","description":"One upload by the lead: their answers, the quantity and the parts."},"SubmissionPartOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The part's id."},"file_name":{"type":"string","title":"File Name","description":"The file's name."},"analysis_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Analysis Id","description":"Its analysis in the project, or null if it couldn't start or was deleted."},"analysis_status":{"anyOf":[{"type":"string","enum":["running","ready","failed"]},{"type":"null"}],"title":"Analysis Status","description":"That analysis's status, or null."},"quote_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Quote Id","description":"Its quote, or null if it couldn't be priced. Edit it with POST /api/v1/quotes/{quote_id}/versions."},"quote_version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quote Version","description":"The quote's latest version: the one a send uses."},"order_price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Order Price","description":"That version's price for the order at the lead's quantity, US dollars."},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score","description":"The analysis's general score, 0 to 100, or null."},"can_be_made":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Can Be Made","description":"The analysis's verdict, or null."},"clean":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Clean","description":"Whether every hold rule passed. Null until its analyses have all finished."},"reasons":{"items":{"$ref":"#/components/schemas/PartReason"},"type":"array","title":"Reasons","description":"Why it was held. Empty when it's clean."},"waiting":{"type":"boolean","title":"Waiting","description":"Whether it's waiting to be analysed until the company has room: its analyses are used up, or its plan has ended. It's analysed by itself, oldest first, once there's room; the lead is never told.","default":false}},"additionalProperties":false,"type":"object","required":["id","file_name","analysis_id","analysis_status","quote_id","quote_version","order_price","score","can_be_made","clean","reasons"],"title":"SubmissionPartOut","description":"One file of a submission: its analysis, its quote and how it was judged."},"SubmissionReceived":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Their first name, to thank them."},"email":{"type":"string","title":"Email","description":"Where the quote will go."},"part_count":{"type":"integer","title":"Part Count","description":"How many parts were received."}},"additionalProperties":false,"type":"object","required":["first_name","email","part_count"],"title":"SubmissionReceived","description":"Thanks. Nothing of an analysis: the quote comes by email."},"SubmissionSent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The submission's id."},"lead_id":{"type":"string","format":"uuid","title":"Lead Id","description":"The lead who sent it."},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"The project its parts were analysed and quoted in. Null once deleted."},"submission_link_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Submission Link Id","description":"The submission link it came through. Null for an upload link the team sent."},"state":{"type":"string","enum":["analysing","held","sent","declined"],"title":"State","description":"analysing, until every part is done; held, for the team to send or decline; sent, once the quote email went (or was queued); or declined."},"quantity":{"type":"integer","title":"Quantity","description":"How many of each part the lead asked for."},"answers":{"additionalProperties":true,"type":"object","title":"Answers","description":"The lead's answers to the form, as they gave them."},"hold_reasons":{"items":{"$ref":"#/components/schemas/HoldReason"},"type":"array","title":"Hold Reasons","description":"Why it was held. Empty unless it was."},"parts":{"items":{"$ref":"#/components/schemas/SubmissionPartOut"},"type":"array","title":"Parts","description":"Its files, by file name."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the lead sent it."},"can_write":{"type":"boolean","title":"Can Write","description":"Whether the caller may send or decline it (quotes:write on its project)."},"email_state":{"type":"string","enum":["sent","queued","failed"],"title":"Email State","description":"sent; queued, when today's email limit is reached or the provider is down, to go later; or failed, with email_error saying why."},"email_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Error","description":"Why the email is queued or failed. Null once sent."}},"additionalProperties":false,"type":"object","required":["id","lead_id","project_id","submission_link_id","state","quantity","answers","hold_reasons","parts","created_at","can_write","email_state","email_error"],"title":"SubmissionSent","description":"The submission after a send or a decline, with how its email went."},"SubmittedFile":{"properties":{"blob_url":{"type":"string","maxLength":2048,"title":"Blob Url","description":"The url put() answered with."},"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's name, as given to POST .../files."}},"additionalProperties":false,"type":"object","required":["blob_url","file_name"],"title":"SubmittedFile","description":"One uploaded file."},"SuggestedTool":{"properties":{"tool":{"type":"string","title":"Tool","description":"The tool, by size and type."},"instead_of":{"type":"string","title":"Instead Of","description":"The tool it would replace."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price","description":"Its list price, US dollars."},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of","description":"The date of that price."},"saved_min_per_part":{"type":"number","title":"Saved Min Per Part","description":"Minutes it saves a part."},"pays_back_at":{"type":"integer","title":"Pays Back At","description":"The quantity at which it has paid for itself."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it would cut.","default":[]}},"type":"object","required":["tool","instead_of","saved_min_per_part","pays_back_at"],"title":"SuggestedTool","description":"A standard size that would cut faster than the tool used, and pays for itself within the order."},"Surface":{"properties":{"id":{"type":"string","title":"Id","description":"An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."},"type":{"type":"string","title":"Type","description":"Its geometry: plane, cylinder, cone, sphere, torus or freeform."},"area":{"type":"number","title":"Area","description":"Its area, mm²."},"radius":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Radius","description":"Its radius in mm, for a round face. Null otherwise."}},"type":"object","required":["id","type","area"],"title":"Surface","description":"One face of the part."},"SurfacesRef":{"properties":{"surfaces":{"items":{"type":"string"},"type":"array","maxItems":500,"minItems":1,"title":"Surfaces","description":"Face ids, such as S0012."}},"additionalProperties":false,"type":"object","required":["surfaces"],"title":"SurfacesRef","description":"Faces by id, for anything the other references don't name."},"TaperLimits":{"properties":{"max_lean_deg":{"type":"number","maximum":5.0,"minimum":0.01,"title":"Max Lean Deg","description":"Largest lean off a setup's direction, in degrees, that's still cut as square. A wall leaning more gets a taper warning. Default 0.5.","default":0.5}},"additionalProperties":false,"type":"object","title":"TaperLimits","description":"When a wall leans enough off its setup's direction to be a taper."},"Template":{"properties":{"subject":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Subject","description":"The subject, plain text with {{fields}}. Null for the organization's."},"body":{"anyOf":[{"type":"string","maxLength":10000,"minLength":1},{"type":"null"}],"title":"Body","description":"The body, plain text with {{fields}}. Null for the organization's."}},"additionalProperties":false,"type":"object","title":"Template","description":"One email's own subject and body. Null keeps the organization's."},"Templates":{"properties":{"acknowledgement":{"$ref":"#/components/schemas/Template","description":"The email saying their parts arrived and will be reviewed.","default":{}},"quote":{"$ref":"#/components/schemas/Template","description":"The email carrying the quote PDF.","default":{}},"decline":{"$ref":"#/components/schemas/Template","description":"The email saying the shop can't quote this one.","default":{}}},"additionalProperties":false,"type":"object","title":"Templates","description":"The link's own email templates. One left null uses the organization's."},"ThicknessRay":{"properties":{"start":{"items":{"type":"number"},"type":"array","title":"Start","description":"Where it leaves the face, x, y and z, in mm, as display draws the part."},"end":{"items":{"type":"number"},"type":"array","title":"End","description":"Where it comes out of the metal, x, y and z, in mm."},"length":{"type":"number","title":"Length","description":"Its length: the wall's thickness there, mm."}},"type":"object","required":["start","end","length"],"title":"ThicknessRay","description":"A line through the metal from a face to where the metal ends: how thick the part is there.\n\nA measurement of the part itself, for the viewer to draw."},"ThinWallLimits":{"properties":{"min_ratio":{"type":"number","maximum":20.0,"minimum":3.0,"title":"Min Ratio","description":"Smallest ratio of a wall's depth to its thinnest thickness that's flagged. Default 8.","default":8}},"additionalProperties":false,"type":"object","title":"ThinWallLimits","description":"When a wall is thin for its depth."},"Thread":{"properties":{"major_diameter":{"type":"number","title":"Major Diameter","description":"Its major diameter, mm."},"minor_diameter":{"type":"number","title":"Minor Diameter","description":"Its minor diameter, mm."},"pitch":{"type":"number","title":"Pitch","description":"How far it climbs a turn, mm."},"internal":{"type":"boolean","title":"Internal","description":"Whether it's cut into a bore, rather than round a shaft or stud."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces."},"hole":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Hole","description":"The hole it lines, by its index in recognition.holes. Null for a thread round a shaft or stud."}},"type":"object","required":["major_diameter","minor_diameter","pitch","internal","surfaces"],"title":"Thread","description":"A thread modeled into the part. It's tapped or thread milled, so it's in no pocket, hole or time item."},"Time":{"properties":{"setups":{"items":{"$ref":"#/components/schemas/SetupTime"},"type":"array","title":"Setups","description":"Each setup's time.","default":[]},"job":{"items":{"$ref":"#/components/schemas/TimeItem"},"type":"array","title":"Job","description":"Time once an order, whatever the quantity, such as programming.","default":[]},"reverted":{"items":{"$ref":"#/components/schemas/RevertedTool"},"type":"array","title":"Reverted","description":"Manual tools that no longer fit their lines after this run, so those lines went back to their automatic tools.","default":[]},"part_min":{"type":"number","title":"Part Min","description":"Minutes every part."},"batch_min":{"type":"number","title":"Batch Min","description":"Minutes once a batch."},"order_min":{"type":"number","title":"Order Min","description":"Minutes once an order."}},"type":"object","required":["part_min","batch_min","order_min"],"title":"Time","description":"Machining time, every setup and the job."},"TimeItem":{"properties":{"kind":{"type":"string","title":"Kind","description":"What it is, such as roughing, drilling or tool change."},"minutes":{"type":"number","title":"Minutes","description":"How long, in minutes, each time it's paid."},"paid":{"type":"string","enum":["per_order","per_batch","per_part"],"title":"Paid","description":"When it's paid: per_order, per_batch or per_part."},"tool":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool","description":"The tool it uses, by size and type, or null."},"to_buy":{"type":"boolean","title":"To Buy","description":"Whether that tool isn't one of the organization's, so it's to buy.","default":false},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it cuts.","default":[]},"limits":{"items":{"type":"string"},"type":"array","title":"Limits","description":"How the machine held its cuts back, such as RPM-limited, HP-limited – feed 62%, HP-limited – feed 50%, depth 62% or Feed-limited. Empty when the tool runs at its own speed and feed, and on results made before it.","default":[]},"tool_notes":{"items":{"type":"string"},"type":"array","title":"Tool Notes","description":"What to know about how its tool cuts, such as Your chip load reduced for long reach, where a chip load your tool library gives this tool isn't used as typed. Empty otherwise, and on results made before it.","default":[]},"line":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Line","description":"The line's id, which GET /api/v1/analyses/{analysis_id}/lines/{line}/tools and PUT .../tool take to change its tool by hand. Null where its tool isn't changed by hand, such as drilling, a T-slot or a tool change, and on results made before it."},"manual":{"type":"boolean","title":"Manual","description":"Whether its tool was chosen by hand: a manual tool override.","default":false},"tool_detail":{"anyOf":[{"$ref":"#/components/schemas/ToolDetail"},{"type":"null"}],"description":"Its tool in full. Null where it has no tool, and on results made before it."},"required_flute_length_in":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Required Flute Length In","description":"How far its tool has to reach, inches: the flute length it needs. Null where it needs none to speak of, such as a floor or a 3D surface."},"max_diameter_in":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Diameter In","description":"The largest tool diameter its feature allows, inches. Null for no limit, and for a line with no tool rule, such as drilling."}},"type":"object","required":["kind","minutes","paid"],"title":"TimeItem","description":"One piece of machining time."},"ToleranceRow":{"properties":{"operation":{"type":"string","enum":["rough_mill","finish_mill","drill_hss","drill_carbide","ream","bore","tap"],"title":"Operation","description":"The operation: rough_mill, finish_mill, drill_hss, drill_carbide, ream, bore or tap."},"label":{"type":"string","maxLength":80,"minLength":1,"title":"Label","description":"What the screen calls it."},"plus_minus_mm":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Plus Minus Mm","description":"The ± tolerance it holds, mm. Null when it's given as limits, an IT grade or not known."},"plus_mm":{"anyOf":[{"type":"number","maximum":10.0,"minimum":0.0},{"type":"null"}],"title":"Plus Mm","description":"When it holds a one-sided tolerance: how far over size, mm, such as 0.127 for +0.005 in."},"minus_mm":{"anyOf":[{"type":"number","maximum":10.0,"minimum":0.0},{"type":"null"}],"title":"Minus Mm","description":"When it holds a one-sided tolerance: how far under size, mm, such as 0 for -0.000 in."},"it_grade":{"anyOf":[{"type":"integer","maximum":18.0,"minimum":1.0},{"type":"null"}],"title":"It Grade","description":"The ISO 286 IT grade it holds, such as 7 for H7. Null when not known."},"thread_class":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Thread Class","description":"For tapping: the thread class it holds, such as 6H."},"ra_um":{"anyOf":[{"type":"number","maximum":50.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Ra Um","description":"The surface finish it leaves, Ra in µm. Null when not known."},"leaves_mm":{"anyOf":[{"type":"number","maximum":10.0,"exclusiveMinimum":0.0},{"type":"null"}],"title":"Leaves Mm","description":"For roughing: the stock it leaves for the finish pass, mm."},"plastics_factor":{"type":"number","maximum":10.0,"minimum":1.0,"title":"Plastics Factor","description":"How much looser it holds in plastics: the tolerance times this.","default":2.0},"provisional":{"type":"boolean","title":"Provisional","description":"Whether the values are Protyus's seed, not yet confirmed by a machinist.","default":false},"from_protyus":{"type":"boolean","title":"From Protyus","description":"Whether the values are Protyus's default, not the shop's own. Defaults follow the seed until the shop edits them.","default":false}},"additionalProperties":false,"type":"object","required":["operation","label"],"title":"ToleranceRow","description":"What one operation holds and the finish it leaves."},"ToolChoice":{"properties":{"key":{"type":"string","title":"Key","description":"What PUT /api/v1/analyses/{analysis_id}/lines/{line}/tool takes to choose it."},"id":{"type":"string","title":"Id","description":"Its id as the line would show it: TL- and the start of its library item's id for the organization's tool, a generic id such as GEN-FL-1000 for a standard size."},"kind":{"type":"string","enum":["library","standard","non_standard"],"title":"Kind","description":"Whose it is: the organization's library, or a standard size."},"description":{"type":"string","title":"Description","description":"What it is, by size and type, as the library names it."},"type":{"type":"string","title":"Type","description":"flat end mill, bull nose end mill, ball end mill, slot mill, face mill or slitting saw."},"diameter_in":{"type":"number","title":"Diameter In","description":"Its diameter, inches."},"corner_radius_in":{"type":"number","title":"Corner Radius In","description":"Its corner radius, inches."},"flutes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Flutes","description":"How many flutes it has. Null where it isn't known."},"flute_length_in":{"type":"number","title":"Flute Length In","description":"Its flute length, inches."},"to_buy":{"type":"boolean","title":"To Buy","description":"Whether it isn't one of the organization's, so choosing it makes it a tool to buy."},"current":{"type":"boolean","title":"Current","description":"Whether the line uses it now."}},"additionalProperties":false,"type":"object","required":["key","id","kind","description","type","diameter_in","corner_radius_in","flute_length_in","to_buy","current"],"title":"ToolChoice","description":"A tool a line may take: valid for it by the engine's own rule."},"ToolChoiceIn":{"properties":{"tool":{"type":"string","maxLength":120,"minLength":1,"title":"Tool","description":"The tool's key, from GET /api/v1/analyses/{analysis_id}/lines/{line}/tools."}},"additionalProperties":false,"type":"object","required":["tool"],"title":"ToolChoiceIn","description":"The tool to put on a line by hand."},"ToolDetail":{"properties":{"id":{"type":"string","title":"Id","description":"Its id on the line: the organization's tool's library id, TL- and the start of its library item's id, a standard size's generic id from its type and size in thousandths of an inch such as GEN-FL-1000, or a non-standard one's such as SPL-BN-0500-R045."},"kind":{"type":"string","enum":["library","standard","non_standard"],"title":"Kind","description":"Whose it is: the organization's library, a standard size, or a non-standard tool ground to order."},"type":{"type":"string","title":"Type","description":"flat end mill, bull nose end mill, ball end mill, drill, slot mill, face mill, slitting saw or chamfer mill."},"diameter_in":{"type":"number","title":"Diameter In","description":"Its diameter, inches."},"corner_radius_in":{"type":"number","title":"Corner Radius In","description":"Its corner radius, inches: a bull nose's, half a ball's diameter, 0 for a flat.","default":0},"flutes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Flutes","description":"How many flutes it has. Null where it isn't known."},"flute_length_in":{"type":"number","title":"Flute Length In","description":"Its flute length, inches."}},"type":"object","required":["id","kind","type","diameter_in","flute_length_in"],"title":"ToolDetail","description":"A line's tool in full, as the Time tab describes it: id, type and sizes."},"ToolDirection":{"properties":{"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"The direction the tool points from, as a unit vector x, y, z."},"kind":{"type":"string","title":"Kind","description":"main (axial), side (radial) or tilted."},"machine_tilts":{"type":"boolean","title":"Machine Tilts","description":"Whether the machine tilts to this direction, so it needs no angled fixture.","default":false},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces cut from it.","default":[]},"holes":{"type":"integer","title":"Holes","description":"How many holes are cut from it.","default":0},"pockets":{"type":"integer","title":"Pockets","description":"How many pockets are cut from it.","default":0}},"type":"object","required":["direction","kind"],"title":"ToolDirection","description":"One direction a setup's tool comes from."},"ToolEdit":{"properties":{"tool":{"$ref":"#/components/schemas/Cutter","description":"Every field of the tool after the change. Lengths in mm."},"base_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Base Revision Id","description":"The revision this edit was made from. If the tool has changed since, it's refused with REVISION_CONFLICT."}},"additionalProperties":false,"type":"object","required":["tool"],"title":"ToolEdit","description":"A tool's new state. It becomes a new revision."},"ToolFacets":{"properties":{"vendors":{"items":{"type":"string"},"type":"array","title":"Vendors","description":"Every vendor named by a tool in the library."},"coatings":{"items":{"type":"string"},"type":"array","title":"Coatings","description":"Every coating named."},"tool_materials":{"items":{"type":"string"},"type":"array","title":"Tool Materials","description":"Every tool material named."}},"additionalProperties":false,"type":"object","required":["vendors","coatings","tool_materials"],"title":"ToolFacets","description":"The values the library's filters can offer."},"ToolOverride":{"properties":{"line":{"type":"string","title":"Line","description":"The line's id, as the result's time items name it."},"tool":{"type":"string","title":"Tool","description":"The tool's key, as GET /api/v1/analyses/{analysis_id}/lines/{line}/tools lists it."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"The tool, by size and type."},"setup":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Setup","description":"The setup the line is in."},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind","description":"What the line is, such as walls."}},"additionalProperties":false,"type":"object","required":["line","tool"],"title":"ToolOverride","description":"A Time tab line's tool, chosen by hand."},"ToolQuery":{"properties":{"q":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Q","description":"Text in the description, vendor or product number."},"types":{"anyOf":[{"items":{"type":"string","enum":["flat end mill","bull nose end mill","ball end mill","drill","slot mill","face mill","od turn","id boring bar","od groove","id groove","face groove","od thread","id thread","part-off"]},"type":"array"},{"type":"null"}],"title":"Types","description":"Only these types."},"diameter_min":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Diameter Min","description":"Smallest cutting diameter, mm."},"diameter_max":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Diameter Max","description":"Largest cutting diameter, mm."},"vendor":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Vendor","description":"Only this vendor, ignoring case."},"coating":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"title":"Coating","description":"Only this coating, ignoring case."},"tool_material":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"title":"Tool Material","description":"Only this tool material, ignoring case."},"collection_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Collection Id","description":"Only tools in this collection."},"archived":{"type":"string","enum":["no","yes","any"],"title":"Archived","description":"Whether to include archived tools: no, only them, or any.","default":"no"},"sort":{"type":"string","enum":["diameter","description","created","type"],"title":"Sort","description":"How to order them. Diameter compares the stored mm, so inch and metric tools sort together.","default":"diameter"},"descending":{"type":"boolean","title":"Descending","description":"Largest or latest first.","default":false}},"additionalProperties":false,"type":"object","title":"ToolQuery","description":"Which tools to list. Every condition given must hold. Lengths in mm."},"ToolShared":{"properties":{"joined":{"items":{"type":"string"},"type":"array","title":"Joined","description":"The two tools."},"kept":{"type":"string","title":"Kept","description":"The one used for both."},"seconds_lost_per_part":{"type":"number","title":"Seconds Lost Per Part","description":"Seconds a part the kept tool is slower at the other's work."},"seconds_saved_per_part":{"type":"number","title":"Seconds Saved Per Part","description":"Seconds a part saved by not changing tools."},"pays_below_batch":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pays Below Batch","description":"Sharing pays in batches below this. Null when it pays at any batch."}},"type":"object","required":["joined","kept","seconds_lost_per_part","seconds_saved_per_part"],"title":"ToolShared","description":"Two tools where one does both's work, as that costs less than a tool change."},"ToolToBuy":{"properties":{"tool":{"type":"string","title":"Tool","description":"The tool, by size and type."},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price","description":"Its list price, US dollars."},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of","description":"The date of that price."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it's needed for.","default":[]},"non_standard":{"type":"boolean","title":"Non Standard","description":"Whether it's a non-standard tool: no maker stocks it, so it's ground to order.","default":false}},"type":"object","required":["tool"],"title":"ToolToBuy","description":"A tool the plan needs that the organization doesn't have."},"TurnAttachment":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The attachment's id. It must have been read (read_design_attachment)."},"items":{"items":{"$ref":"#/components/schemas/ReadItem"},"type":"array","maxItems":60,"title":"Items","description":"The reading's items as the person confirmed them: corrected values win over the picture, and an item left out isn't built.","default":[]}},"additionalProperties":false,"type":"object","required":["id"],"title":"TurnAttachment","description":"A drawing a turn builds from, with its reading as the person confirmed it."},"TurnAxis":{"properties":{"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"The turning axis's direction, a unit vector in the part's own axes."},"point":{"items":{"type":"number"},"type":"array","title":"Point","description":"The point on the axis at the part's near end, in mm: where `at` is 0."}},"type":"object","required":["direction","point"],"title":"TurnAxis","description":"The axis the part turns about on a lathe."},"TurnBar":{"properties":{"diameter":{"$ref":"#/components/schemas/TurnLength","description":"The stocked round bar's diameter."},"length":{"$ref":"#/components/schemas/TurnLength","description":"The piece's length, saw-cut."}},"type":"object","required":["diameter","length"],"title":"TurnBar","description":"The stocked round bar a part turns from."},"TurnBarUse":{"properties":{"from":{"type":"string","enum":["bar","blank"],"title":"From","description":"bar: turned from bar and parted off; blank: chucked from a sawn blank."},"diameter":{"$ref":"#/components/schemas/TurnLength","description":"The bar's diameter."},"part":{"$ref":"#/components/schemas/TurnLength","description":"The part's length."},"blade":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"The part-off blade's width each part takes; null from a blank."},"facing":{"$ref":"#/components/schemas/TurnLength","description":"The stock faced off each end."},"saw":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A blank's length past the part, its clean-up saw-cut to the next 1/8 in; null from bar."},"remnant":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"The end of each bar left unused, shared by the parts it makes; null from a blank."},"bar_length":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A bar's length as it's bought; null from a blank."},"parts_per_bar":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parts Per Bar","description":"How many parts a bar makes; null from a blank."},"length":{"$ref":"#/components/schemas/TurnLength","description":"The bar each part takes in all: its length, the blade, the facing and its share of the remnant, or the blank."}},"type":"object","required":["from","diameter","part","facing","length"],"title":"TurnBarUse","description":"How much bar a lathe part takes, and what makes it up."},"TurnCheck":{"properties":{"id":{"type":"string","enum":["swing","turning_length","chuck","bar_capacity","tailstock"],"title":"Id","description":"What's checked."},"met":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Met","description":"Whether it fits; null where the lathe doesn't say. A bar past bar_capacity is chucked from a blank instead."},"measured":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"The part's or its bar's size."},"limit":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"The lathe's."}},"type":"object","required":["id","met"],"title":"TurnCheck","description":"One check of the lathe's envelope against the part."},"TurnCut":{"properties":{"kind":{"type":"string","enum":["face","center_drill","rough_od","drill","rough_bore","finish_od","finish_bore","od_groove","id_groove","face_groove","od_thread","id_thread","part_off"],"title":"Kind","description":"What the cut is, in the order a lathe runs them."},"features":{"items":{"type":"string"},"type":"array","title":"Features","description":"The turned features it makes, by id, such as T3."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Their faces. An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."},"tool":{"$ref":"#/components/schemas/TurnTool","description":"Its tool."},"assumed":{"type":"boolean","title":"Assumed","description":"Whether the tool is a stand-in, because the shop has none that fits."},"needs":{"$ref":"#/components/schemas/TurnNeeds","description":"What it asks of its tool."}},"type":"object","required":["kind","features","surfaces","tool","assumed","needs"],"title":"TurnCut","description":"One cut of a lathe operation."},"TurnEnvelope":{"properties":{"fits":{"type":"boolean","title":"Fits","description":"Whether its swing, turning length and chuck take the part."},"checks":{"items":{"$ref":"#/components/schemas/TurnCheck"},"type":"array","title":"Checks","description":"Each check, met or not."}},"type":"object","required":["fits","checks"],"title":"TurnEnvelope","description":"Whether the part fits the lathe it turns on."},"TurnEstimate":{"properties":{"status":{"type":"string","title":"Status","description":"rough: a should-cost from the plan, not a shop's quote."},"material":{"$ref":"#/components/schemas/analyses__customer__Material","description":"The material."},"quantity":{"type":"integer","title":"Quantity","description":"How many parts."},"batch":{"type":"integer","title":"Batch","description":"Parts in a batch."},"machine":{"$ref":"#/components/schemas/EstimateMachine","description":"The machine."},"stock":{"$ref":"#/components/schemas/Stock","description":"The stock."},"time":{"$ref":"#/components/schemas/Time","description":"The machining time."},"cost_lines":{"items":{"$ref":"#/components/schemas/CostLine"},"type":"array","title":"Cost Lines","description":"Every cost line."},"cost":{"$ref":"#/components/schemas/Cost","description":"The totals."},"tools":{"$ref":"#/components/schemas/EstimateTools","description":"Tools to buy, suggested and shared.","default":{"to_buy":[],"suggested":[],"merges":[],"none_fits":[]}},"bar":{"$ref":"#/components/schemas/TurnBarUse","description":"How much bar a part takes."}},"type":"object","required":["status","material","quantity","batch","machine","stock","time","cost_lines","cost","bar"],"title":"TurnEstimate","description":"The lathe's estimate for the part: its bar, time and cost on the lathe its operations run on."},"TurnHeld":{"properties":{"diameter":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"The smallest round bar that holds the part: its diameter."},"size":{"anyOf":[{"items":{"$ref":"#/components/schemas/TurnLength"},"type":"array"},{"type":"null"}],"title":"Size","description":"The smallest block that holds the part: its two sides across the axis and its length."},"length":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"Its length."},"utilisation_pct":{"type":"number","title":"Utilisation Pct","description":"The part's volume as a percentage of the stock's."}},"type":"object","required":["utilisation_pct"],"title":"TurnHeld","description":"The smallest round bar or block that holds the part."},"TurnHolding":{"properties":{"kind":{"type":"string","enum":["chuck","collet"],"title":"Kind","description":"A 3-jaw chuck or a collet."},"on":{"type":"string","enum":["bar","blank","diameter"],"title":"On","description":"What it grips: the bar the part's turned from, a sawn blank, or a diameter an earlier operation turned."},"feature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feature","description":"The turned diameter it grips, by id; null on the bar or a blank."},"diameter":{"$ref":"#/components/schemas/TurnLength","description":"The diameter it grips."},"grip":{"$ref":"#/components/schemas/TurnLength","description":"How much of it is in the jaws or collet."},"stickout":{"$ref":"#/components/schemas/TurnLength","description":"How far the part sticks out of them."},"slenderness":{"type":"number","title":"Slenderness","description":"Its stick-out over the part's diameter."},"bar_feeder":{"type":"boolean","title":"Bar Feeder","description":"Whether the lathe's bar feeder feeds the bar."},"tailstock":{"type":"boolean","title":"Tailstock","description":"Whether the tailstock comes up, for a slender part."},"steady_rest":{"type":"boolean","title":"Steady Rest","description":"Whether a steady rest is needed too."}},"type":"object","required":["kind","on","diameter","grip","stickout","slenderness","bar_feeder","tailstock","steady_rest"],"title":"TurnHolding","description":"How a lathe operation holds the part."},"TurnIn":{"properties":{"instruction":{"type":"string","maxLength":4000,"minLength":1,"title":"Instruction","description":"What to change, in the person's words."},"selection":{"items":{"$ref":"#/components/schemas/Face"},"type":"array","maxItems":50,"title":"Selection","description":"Faces the person picked, which the instruction may mean.","default":[]},"mode":{"type":"string","enum":["step","auto"],"title":"Mode","description":"step (step by step, the default) or auto, which needs the design_auto entitlement and design:auto.","default":"step"},"attachment":{"anyOf":[{"$ref":"#/components/schemas/TurnAttachment"},{"type":"null"}],"description":"A drawing, sketch or photo to build from, read first."}},"additionalProperties":false,"type":"object","required":["instruction"],"title":"TurnIn","description":"One instruction to Protyus AI about the working version."},"TurnLength":{"properties":{"mm":{"type":"number","title":"Mm","description":"Millimeters."},"in":{"type":"number","title":"In","description":"Inches."}},"type":"object","required":["mm","in"],"title":"TurnLength","description":"A length in both units."},"TurnMachine":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The shop's machine's id; null for a typical lathe."},"label":{"type":"string","title":"Label","description":"Its name."},"typical":{"type":"boolean","title":"Typical","description":"Whether it's a typical lathe on the Lathe class's values, because the project has none."}},"type":"object","required":["label","typical"],"title":"TurnMachine","description":"The lathe an operation runs on."},"TurnNeeds":{"properties":{"back_angle":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Back Angle","description":"How far its faces look back, away from the end it's cut from, in degrees: an insert has to reach this far."},"corner":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"Its smallest inside corner's radius, 0 where one is drawn sharp: a turning insert leaves its nose radius there."},"reach":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"How deep along the axis the tool goes, from the end it's cut from."},"bore":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"The smallest bore an inside tool passes."},"width":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A groove's width: a grooving insert no wider."},"depth":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A groove's depth, or the part-off's to the center."},"pitch":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A thread's pitch."},"threads_per_inch":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Threads Per Inch","description":"A thread's pitch as threads per inch."}},"type":"object","title":"TurnNeeds","description":"What a lathe cut asks of its tool."},"TurnOperation":{"properties":{"number":{"type":"integer","title":"Number","description":"10 or 20."},"from":{"type":"string","enum":["near","far"],"title":"From","description":"The end its tools come from: near is where the axis's `at` is 0."},"reasons":{"items":{"type":"string","enum":["back","blank"]},"type":"array","title":"Reasons","description":"Why Op 20 turns the part over: back, a feature only that end reaches; blank, it was chucked from a sawn blank. Empty for Op 10."},"machine":{"$ref":"#/components/schemas/TurnMachine","description":"The lathe it runs on."},"holding":{"$ref":"#/components/schemas/TurnHolding","description":"How it holds the part."},"cuts":{"items":{"$ref":"#/components/schemas/TurnCut"},"type":"array","title":"Cuts","description":"Its cuts in order."}},"type":"object","required":["number","from","reasons","machine","holding","cuts"],"title":"TurnOperation","description":"A lathe operation: Op 10, and Op 20 after the part is turned over."},"TurnOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The turn's id, for feedback."},"status":{"type":"string","enum":["running","done","failed"],"title":"Status","description":"done once it has built and checked the part."},"mode":{"type":"string","enum":["step","auto","edit"],"title":"Mode","description":"step or auto, or edit for a change the person made to a feature themselves, with no AI call."},"instruction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instruction","description":"What was asked; for an edit, the change in words."},"reply":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reply","description":"Protyus AI's answer: what it changed, in words."},"changed":{"type":"boolean","title":"Changed","description":"Whether the part changed.","default":false},"score_before":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score Before","description":"The score before the turn."},"score_after":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score After","description":"The score after it."},"fixed":{"items":{"$ref":"#/components/schemas/FindingOut"},"type":"array","title":"Fixed","description":"Findings the turn fixed.","default":[]},"found":{"items":{"$ref":"#/components/schemas/FindingOut"},"type":"array","title":"Found","description":"Findings the turn brought.","default":[]},"caught":{"items":{"$ref":"#/components/schemas/FindingOut"},"type":"array","title":"Caught","description":"Findings the quick check showed Protyus AI part-way through the turn, which it put right before it answered.","default":[]},"check":{"anyOf":[{"$ref":"#/components/schemas/CheckOut"},{"type":"null"}],"description":"The quick check after the turn."},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code","description":"Why it failed, if it did."},"undone":{"type":"boolean","title":"Undone","description":"Whether it was undone since.","default":false},"features_changed":{"items":{"$ref":"#/components/schemas/FeatureChanged"},"type":"array","title":"Features Changed","description":"The features it added, changed and removed.","default":[]},"features":{"items":{"$ref":"#/components/schemas/FeatureOut"},"type":"array","title":"Features","description":"The part's features after it.","default":[]},"attachment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Attachment","description":"The name of the drawing it built from, if one was attached."},"progress":{"items":{"$ref":"#/components/schemas/ProgressOut"},"type":"array","title":"Progress","description":"What it did as it ran, oldest first, in the person's words.","default":[]}},"additionalProperties":false,"type":"object","required":["id","status","mode"],"title":"TurnOut","description":"What a turn did."},"TurnOutline":{"properties":{"diameter":{"$ref":"#/components/schemas/TurnLength","description":"Across its outside."},"length":{"$ref":"#/components/schemas/TurnLength","description":"Along the axis."}},"type":"object","required":["diameter","length"],"title":"TurnOutline","description":"The part's round outline."},"TurnProfile":{"properties":{"points":{"items":{"items":{"type":"number"},"type":"array"},"type":"array","title":"Points","description":"The half-section a lathe turns, in mm: [z, r] with z along the axis from the near end and r out from it, round the outside from end to end and back along the bore, or the axis where it's solid."}},"type":"object","required":["points"],"title":"TurnProfile","description":"The half-section a lathe turns."},"TurnProgressOut":{"properties":{"turn_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Turn Id","description":"The newest turn's id; null before the version's first turn."},"status":{"anyOf":[{"type":"string","enum":["running","done","failed"]},{"type":"null"}],"title":"Status","description":"The newest turn's status."},"progress":{"items":{"$ref":"#/components/schemas/ProgressOut"},"type":"array","title":"Progress","description":"What it's done so far, oldest first.","default":[]},"preview_step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Preview Step","description":"How many features the part had at its newest preview, which GET .../preview returns; null before the turn has shown one."}},"additionalProperties":false,"type":"object","title":"TurnProgressOut","description":"The newest turn on a version and what it's done so far: polled while a turn runs, since its own request answers\nonly once it's done."},"TurnReason":{"properties":{"id":{"type":"string","enum":["round","profile","removal","round_stock"],"title":"Id","description":"round: its outside is round about one axis. profile: enough of its surface is turned about that axis. removal: turning removes enough of what comes off the bar. round_stock: round bar uses material enough better than a block."},"met":{"type":"boolean","title":"Met","description":"Whether the part meets it."},"text":{"type":"string","title":"Text","description":"Why, in words, with lengths in mm."},"inch":{"$ref":"#/components/schemas/TurnWords","description":"The same, in inches."},"measured":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Measured","description":"What the part measured, as a percentage, where the rule has a limit."},"threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Threshold","description":"The rule's limit, as a percentage."}},"type":"object","required":["id","met","text","inch"],"title":"TurnReason","description":"One of the rules a lathe part meets, and whether this part does."},"TurnStock":{"properties":{"bar":{"anyOf":[{"$ref":"#/components/schemas/TurnBar"},{"type":"null"}],"description":"The stocked round bar it turns from, with the clean-up; null where no stocked bar is big enough."},"round":{"$ref":"#/components/schemas/TurnHeld","description":"The smallest round bar that holds it, and how much of it the part uses."},"block":{"$ref":"#/components/schemas/TurnHeld","description":"The smallest block that holds it, and how much of it the part uses."},"round_better_pct":{"type":"number","title":"Round Better Pct","description":"How much better round bar's utilization is than the block's, as a percentage."}},"type":"object","required":["bar","round","block","round_better_pct"],"title":"TurnStock","description":"Round bar against a block for the part."},"TurnTool":{"properties":{"type":{"type":"string","enum":["od turn","id boring bar","od groove","id groove","face groove","od thread","id thread","part-off","drill","center drill"],"title":"Type","description":"Its tool type, as the tool library names it."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The shop's tool's revision id, as the tool library gives it; null for a stand-in."},"description":{"type":"string","title":"Description","description":"What it is: the shop's own description, or the stand-in's."},"shape":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shape","description":"Its insert's shape: the ISO letter, such as C for an 80 degree diamond, or a thread form."},"hand":{"anyOf":[{"type":"string","enum":["R","L","N"]},{"type":"null"}],"title":"Hand","description":"Its holder's hand: R, L or N for neutral."},"nose_radius":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"Its insert's nose radius."},"width":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A grooving insert's or part-off blade's width."},"diameter":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A drill's or boring bar's diameter."},"min_bore":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"The smallest bore an inside tool fits."},"reach":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"How deep an inside tool reaches."}},"type":"object","required":["type","description"],"title":"TurnTool","description":"A lathe cut's tool: the shop's own, or a stand-in."},"TurnWords":{"properties":{"text":{"type":"string","title":"Text","description":"The same words, with lengths in inches."}},"type":"object","required":["text"],"title":"TurnWords","description":"A reason's words with lengths in inches."},"TurnedFeature":{"properties":{"id":{"type":"string","title":"Id","description":"Its id in this analysis, such as T3."},"kind":{"type":"string","enum":["face","diameter","step","taper","chamfer","radius","groove","bore","thread"],"title":"Kind","description":"What it is."},"side":{"anyOf":[{"type":"string","enum":["od","id","face"]},{"type":"null"}],"title":"Side","description":"od on the outside, id in a bore, face for a groove cut into a face; null for an end face."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"Its faces. An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."},"diameter":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"Its diameter: a groove's at its floor, a taper's, chamfer's or step's where it starts, a thread's major diameter."},"to_diameter":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"Where a taper, chamfer, step or face ends: its other diameter."},"length":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"Along the axis."},"at":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"Where it starts along the axis, from the part's near end."},"angle":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Angle","description":"A taper's or chamfer's angle to the axis, in degrees."},"radius":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A radius's."},"corner":{"anyOf":[{"type":"string","enum":["inside","outside"]},{"type":"null"}],"title":"Corner","description":"A radius in an inside corner (a fillet) or on an outside one (a round)."},"width":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A groove's width."},"depth":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A groove's depth."},"pitch":{"anyOf":[{"$ref":"#/components/schemas/TurnLength"},{"type":"null"}],"description":"A thread's pitch."},"threads_per_inch":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Threads Per Inch","description":"A thread's pitch as threads per inch, as an inch part gives it."},"thread":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thread","description":"The standard thread it's taken for, such as 1/2-20 UNF."}},"type":"object","required":["id","kind","side","surfaces"],"title":"TurnedFeature","description":"A feature a lathe turns."},"TurnedRef":{"properties":{"turned":{"type":"string","maxLength":20,"minLength":1,"title":"Turned","description":"The feature's id, as turning.features names one a lathe turns, such as T3, or turning.milled_features one left for milling, such as M1."}},"additionalProperties":false,"type":"object","required":["turned"],"title":"TurnedRef","description":"A feature of a lathe part: one a lathe turns, or one left for milling."},"Turning":{"properties":{"status":{"anyOf":[{"type":"string","enum":["ready","failed"]},{"type":"null"}],"title":"Status","description":"ready, or failed where it couldn't be worked out."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Why it failed: TURNING_FAILED."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"What failed, for people."},"on_lathe":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"On Lathe","description":"Whether it belongs on a lathe: it meets every reason."},"reasons":{"anyOf":[{"items":{"$ref":"#/components/schemas/TurnReason"},"type":"array"},{"type":"null"}],"title":"Reasons","description":"The rules a lathe part meets, and whether it does. A part whose outside isn't round has that reason alone."},"axis":{"anyOf":[{"$ref":"#/components/schemas/TurnAxis"},{"type":"null"}],"description":"The turning axis; null where the outside isn't round."},"revolved_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Revolved Pct","description":"The share of its surface turned about the axis, as a percentage."},"outline":{"anyOf":[{"$ref":"#/components/schemas/TurnOutline"},{"type":"null"}],"description":"Its round outline; null where the outside isn't round."},"stock":{"anyOf":[{"$ref":"#/components/schemas/TurnStock"},{"type":"null"}],"description":"Round bar against a block; null where the outside isn't round."},"profile":{"anyOf":[{"$ref":"#/components/schemas/TurnProfile"},{"type":"null"}],"description":"The half-section a lathe turns; null where it isn't a lathe part."},"features":{"anyOf":[{"items":{"$ref":"#/components/schemas/TurnedFeature"},"type":"array"},{"type":"null"}],"title":"Features","description":"What a lathe turns: diameters, steps, faces, tapers, chamfers, radii, bores, grooves and threads."},"milled_features":{"anyOf":[{"items":{"$ref":"#/components/schemas/MilledFeature"},"type":"array"},{"type":"null"}],"title":"Milled Features","description":"What a lathe can't make, left for milling: flats, keyways, cross holes and holes off the axis."},"operations":{"anyOf":[{"items":{"$ref":"#/components/schemas/TurnOperation"},"type":"array"},{"type":"null"}],"title":"Operations","description":"The lathe operations, in order: each one's lathe, holding and cuts. Empty where it isn't a lathe part."},"envelope":{"anyOf":[{"$ref":"#/components/schemas/TurnEnvelope"},{"type":"null"}],"description":"Whether the part fits the lathe it turns on; null where it isn't a lathe part."},"findings":{"anyOf":[{"items":{"$ref":"#/components/schemas/Finding"},"type":"array"},{"type":"null"}],"title":"Findings","description":"What's hard to turn, worst first, each with its faces and fix, as milling's findings are. Empty where it isn't a lathe part. Absent for analyses run before lathe findings."},"scorecard":{"anyOf":[{"$ref":"#/components/schemas/ProcessScorecard"},{"type":"null"}],"description":"Whether it can be turned as modeled, and the DFM score over the lathe findings, on milling's bands. Null where it isn't a lathe part. Absent for analyses run before lathe findings."},"estimate":{"anyOf":[{"$ref":"#/components/schemas/TurnEstimate"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Estimate","description":"Its time and cost on that lathe, in the estimate's shape, each operation a setup numbered 10 or 20, or why there isn't one; null where it isn't a lathe part."},"mill_turn":{"anyOf":[{"$ref":"#/components/schemas/MillTurn"},{"$ref":"#/components/schemas/Failed"},{"type":"null"}],"title":"Mill Turn","description":"The part turned and milled in one holding on a mill-turn, or why that couldn't be worked out; null where nothing is left to mill or the outside isn't round. Absent for analyses run before mill-turns."},"routes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Route"},"type":"array"},{"type":"null"}],"title":"Routes","description":"The ways to make it, each costed: mill only, then lathe only, or lathe then mill for a part with features a lathe can't make. Empty where it isn't a lathe part. Absent for analyses run before routes."},"route":{"anyOf":[{"$ref":"#/components/schemas/ChosenRoute"},{"type":"null"}],"description":"The route it's made by, which Price this prices; null without routes."}},"type":"object","title":"Turning","description":"Whether the part turns on a lathe, and what a lathe turns. A milling analysis has it where turning is on for\nthe person who started it."},"TurningAxis":{"properties":{"point":{"items":{"type":"number"},"type":"array","title":"Point","description":"Where it meets the part's near end, x, y, z in mm."},"direction":{"items":{"type":"number"},"type":"array","title":"Direction","description":"Its direction, a unit vector, from the near end to the far end."},"length":{"type":"number","title":"Length","description":"The part's length along it, mm. Draw it a little past each end."}},"additionalProperties":false,"type":"object","required":["point","direction","length"],"title":"TurningAxis","description":"A lathe part's turning axis, to draw as a line through it."},"UndoOut":{"properties":{"batch":{"$ref":"#/components/schemas/BatchOut","description":"The batch, now undone."},"archived":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Archived","description":"Items the batch added, now archived."},"restored":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Restored","description":"Items the batch updated, now back at the revision they had before it."},"unarchived":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Unarchived","description":"Items the batch archived, now back in the library."},"skipped":{"items":{"$ref":"#/components/schemas/SkippedItem"},"type":"array","title":"Skipped","description":"Items left alone, with the reason."}},"additionalProperties":false,"type":"object","required":["batch","archived","restored","unarchived","skipped"],"title":"UndoOut","description":"What undoing a batch put back, and what it left alone."},"UnpricedLineOut":{"properties":{"key":{"type":"string","title":"Key","description":"Which line."},"label":{"type":"string","title":"Label","description":"Its name for people."}},"type":"object","required":["key","label"],"title":"UnpricedLineOut","description":"A cost line that counts something but has no rate, so the price leaves it out."},"UploadIn":{"properties":{"file_name":{"type":"string","maxLength":255,"minLength":1,"title":"File Name","description":"The file's name, such as bracket.step: .step or .stp to analyse, .csv or .xlsx to import machines or materials, .tools, .json or .csv to import tools, and .png or .svg for your organization's logo."}},"additionalProperties":false,"type":"object","required":["file_name"],"title":"UploadIn","description":"The file you're about to send: a STEP file to analyse, a file to import, or a logo."},"UploadLinkIn":{"properties":{"email":{"type":"string","maxLength":254,"pattern":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$","title":"Email","description":"Where to send it: the person's email address. Lowercased; one lead per address in the organization."},"project_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Project Id","description":"The project their parts are analysed and quoted in. Give this or submission_link_id, not both."},"submission_link_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Submission Link Id","description":"A submission link whose project, form fields, sender name, reply-to and logo to use. Give this or project_id."},"prefill":{"$ref":"#/components/schemas/Answers","description":"What you know of the person, shown filled in on their upload page, and saved on the lead where it has none.","default":{}}},"additionalProperties":false,"type":"object","required":["email"],"title":"UploadLinkIn","description":"An upload link to email to someone: for a project, or through one of its submission links."},"UploadLinkSent":{"properties":{"upload_link_id":{"type":"string","format":"uuid","title":"Upload Link Id","description":"The upload link's id."},"lead_id":{"type":"string","format":"uuid","title":"Lead Id","description":"The lead it went to, found or made by email address."},"email":{"type":"string","title":"Email","description":"Where it went."},"project_id":{"type":"string","format":"uuid","title":"Project Id","description":"The project their parts go to."},"submission_link_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Submission Link Id","description":"The submission link it came through. Null when sent for a project."},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"When it stops working: 72 hours from now."},"replaced":{"type":"integer","title":"Replaced","description":"How many unused upload links to the same person for the same project this one replaced. They stop working."},"email_state":{"type":"string","enum":["sent","queued","failed"],"title":"Email State","description":"sent; queued, when today's email limit is reached or the provider is down, to go later; or failed, with email_error saying why."},"email_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Error","description":"Why the email is queued or failed. Null once sent."}},"additionalProperties":false,"type":"object","required":["upload_link_id","lead_id","email","project_id","submission_link_id","expires_at","replaced","email_state","email_error"],"title":"UploadLinkSent","description":"An upload link, emailed. Its token is only in the email: Protyus keeps its hash, and whoever sent it never sees it."},"UploadOut":{"properties":{"pathname":{"type":"string","title":"Pathname","description":"Where the file goes in the file store, in your own upload folder. Pass it as the pathname to put() from @vercel/blob/client, with client_token."},"client_token":{"type":"string","title":"Client Token","description":"Sends the file straight to the file store, up to max_bytes: put(pathname, file, {access: 'private', token: client_token, contentType: content_type}) from @vercel/blob/client. Pass the url it answers with as upload_url. It allows this pathname only, as content_type only, until expires_at."},"content_type":{"type":"string","title":"Content Type","description":"The content type to send the file as. The file store refuses any other."},"max_bytes":{"type":"integer","title":"Max Bytes","description":"The largest file Protyus takes, in bytes: the most the engine reads."},"put_url":{"type":"string","title":"Put Url","description":"Or send the file's raw bytes here with HTTP PUT, no other headers needed, up to put_url_max_bytes. It works once you have it, until expires_at, for this file name only."},"put_url_max_bytes":{"type":"integer","title":"Put Url Max Bytes","description":"The largest file put_url takes, in bytes: the most one request to Protyus carries. Send a bigger file with client_token."},"method":{"type":"string","title":"Method","description":"put_url's method: always PUT.","default":"PUT"},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"When client_token and put_url stop working."},"curl":{"type":"string","title":"Curl","description":"A command that sends the file to put_url, run from the folder holding it. It prints JSON with the upload_url to start an analysis with."}},"additionalProperties":false,"type":"object","required":["pathname","client_token","content_type","max_bytes","put_url","put_url_max_bytes","expires_at","curl"],"title":"UploadOut","description":"Where to send the file's bytes, and how: straight to the file store, or through Protyus."},"UploadPageOut":{"properties":{"sender_name":{"type":"string","title":"Sender Name","description":"Who the lead is sending their parts to."},"logo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo","description":"The shop's logo as a data: URI, or null. Never the stored URL, which is private."},"email":{"type":"string","title":"Email","description":"The lead's email address, where the quote will go."},"form":{"$ref":"#/components/schemas/FormFields","description":"Which answers to ask for: each off, optional or required."},"answers":{"$ref":"#/components/schemas/Answers","description":"The answers already known, to show filled in."},"privacy_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Privacy Url","description":"The shop's privacy policy. When there is one, the lead must tick the consent box, which links to it."},"consent_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consent Text","description":"The consent box's words, when there's a privacy policy."},"quantity":{"$ref":"#/components/schemas/QuantityRange","description":"The quantity to ask for."},"limits":{"$ref":"#/components/schemas/FileLimits","description":"Which files it takes."},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"When the link stops working."}},"additionalProperties":false,"type":"object","required":["sender_name","logo","email","form","answers","privacy_url","consent_text","quantity","limits","expires_at"],"title":"UploadPageOut","description":"What the upload page shows. Only what the shop chose to show: never an analysis, a file or an id."},"UploadedOut":{"properties":{"upload_url":{"type":"string","title":"Upload Url","description":"Pass this as upload_url to start an analysis, POST /api/v1/projects/{project_id}/analyses, or to an import's preview and commit, such as POST /api/v1/organization/machines/imports/preview. It's in your own upload folder, uploads/{org_id}/{user_id}/, so only you can use it. It's deleted once analysed."},"file_name":{"type":"string","title":"File Name","description":"The file's name, to pass as file_name."},"size_bytes":{"type":"integer","title":"Size Bytes","description":"How many bytes were stored."}},"additionalProperties":false,"type":"object","required":["upload_url","file_name","size_bytes"],"title":"UploadedOut","description":"A file, stored and ready to analyse or import."},"UsageTotals":{"properties":{"runs":{"type":"integer","title":"Runs","description":"How many billable actions: analyses run and files extracted, whatever their outcome.","default":0},"succeeded":{"type":"integer","title":"Succeeded","description":"How many of them succeeded.","default":0},"failed":{"type":"integer","title":"Failed","description":"How many failed. Runs still running, or deleted while running, are neither.","default":0},"by_source":{"$ref":"#/components/schemas/SourceCounts","description":"The runs, split by the surface they came through.","default":{"ui":0,"api":0,"mcp":0,"intake":0}},"compute_seconds":{"type":"number","title":"Compute Seconds","description":"The engine's time on them, in seconds: download, analysis and saving.","default":0},"storage_bytes_added":{"type":"integer","title":"Storage Bytes Added","description":"What they added to file storage, in bytes, whether or not it's been deleted since.","default":0}},"additionalProperties":false,"type":"object","title":"UsageTotals","description":"Usage added up over some events."},"Verdict":{"properties":{"can_be_made":{"type":"boolean","title":"Can Be Made","description":"False when a required check fails."},"title":{"type":"string","title":"Title","description":"The verdict, for people."}},"type":"object","required":["can_be_made","title"],"title":"Verdict","description":"Whether the part can be made as drawn."},"VersionIn":{"properties":{"rush":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rush","description":"Whether it's a rush order. Leave out or null to keep the last version's."},"repeat_job":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Repeat Job","description":"Whether it's a repeat job: a part the shop has made before, so its program and first article already exist. True leaves programming and the first article out of the price; false prices them in, as a first run. Leave out or null to keep the last version's."},"include_tools_to_buy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Tools To Buy","description":"Whether to price in the tools to buy. Leave out to keep the last version's; send null to follow the settings."},"reprice":{"type":"boolean","title":"Reprice","description":"True prices at today's quote settings (margin, markup, minimum, rush); false keeps the last version's.","default":false},"analysis_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Analysis Id","description":"Price this analysis instead: a newer iteration of the same part (list_iterations lists them), ready and estimated. Leave out to price the analysis the last version priced."}},"additionalProperties":false,"type":"object","title":"VersionIn","description":"A new version of a quote. Only what's given changes from the last version."},"VersionTerms":{"properties":{"lead_time_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Time Text","description":"The lead time the quote states, as the shop words it. Null: the quote leaves it out."},"valid_days":{"type":"integer","title":"Valid Days","description":"How many days the quote holds, from the moment the version was saved.","default":30},"terms_text":{"type":"string","title":"Terms Text","description":"The terms at the foot of the quote."},"valid_until":{"type":"string","format":"date-time","title":"Valid Until","description":"When the quote stops holding: valid_days after the version was saved."}},"additionalProperties":false,"type":"object","required":["terms_text","valid_until"],"title":"VersionTerms","description":"What the customer's quote says around the price: lead time, validity and terms, as the version kept them."},"ViewIn":{"properties":{"version":{"type":"integer","const":1,"title":"Version","description":"The view's version, 1.","default":1},"title":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Title","description":"A heading for the card."},"preset":{"anyOf":[{"type":"string","enum":["problems","setups","score","route"]},{"type":"null"}],"title":"Preset","description":"problems: what's wrong, every finding then one frame each. setups: a frame per setup, down its tool direction. score: a frame per failing score check, worst first. route: how a lathe part is made, what the lathe turns about its axis, then a frame per operation of its route with its arrow; on a part that isn't turned, why not."},"frames":{"anyOf":[{"items":{"$ref":"#/components/schemas/FrameIn"},"type":"array","maxItems":8,"minItems":1},{"type":"null"}],"title":"Frames","description":"The frames, 1 to 8, when there's no preset."}},"additionalProperties":false,"type":"object","title":"ViewIn","description":"A part view: a preset, or frames. Not both."},"ViewOut":{"properties":{"version":{"type":"integer","title":"Version","description":"The view's version, 1."},"analysis_id":{"type":"string","format":"uuid","title":"Analysis Id","description":"The analysis."},"file_name":{"type":"string","title":"File Name","description":"The STEP file's name."},"machine":{"type":"string","title":"Machine","description":"The machine its findings and setups are for."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The heading: the given title, else the preset's, else null."},"frames":{"items":{"$ref":"#/components/schemas/FrameOut"},"type":"array","title":"Frames","description":"Each frame, in order."},"dropped":{"items":{"$ref":"#/components/schemas/Dropped"},"type":"array","title":"Dropped","description":"References left out, each with why. Empty when everything resolved."}},"additionalProperties":false,"type":"object","required":["version","analysis_id","file_name","machine","title","frames","dropped"],"title":"ViewOut","description":"A part view, resolved: faces, cameras and callouts worked out. It carries no mesh: draw the part from\nGET /api/v1/analyses/{analysis_id} with sections=display."},"ViewSettings":{"properties":{"data_panel":{"type":"string","enum":["open","collapsed"],"title":"Data Panel","description":"Whether an analysis's data panel starts open or collapsed.","default":"open"},"first_tab":{"type":"string","enum":["findings","setups","holes","surfaces","edges","warnings","raw"],"title":"First Tab","description":"The report tab an analysis opens on.","default":"findings"},"reopen_tabs":{"type":"boolean","title":"Reopen Tabs","description":"Whether a project reopens the analysis tabs left open last time.","default":true},"theme":{"type":"string","enum":["system","light","dark"],"title":"Theme","description":"Light, dark, or follow the device.","default":"system"},"project_runs":{"type":"string","enum":["cards","list"],"title":"Project Runs","description":"Whether a project shows its analysis runs as cards or a list.","default":"cards"},"viewer_edges":{"type":"boolean","title":"Viewer Edges","description":"Whether the 3D viewer shows edges.","default":true},"viewer_roles":{"type":"boolean","title":"Viewer Roles","description":"Whether the 3D viewer colours faces by role.","default":true},"viewer_surface_ids":{"type":"boolean","title":"Viewer Surface Ids","description":"Whether the 3D viewer writes surface IDs, such as S0013, on the selected faces.","default":false},"length_units":{"type":"string","enum":["organization","mm","inch"],"title":"Length Units","description":"Lengths on the analysis screen: mm, inch, or the organization's display units.","default":"organization"},"viewer_xray":{"type":"boolean","title":"Viewer Xray","description":"Whether the 3D viewer shows faces see-through.","default":false},"viewer_projection":{"type":"string","enum":["perspective","orthographic"],"title":"Viewer Projection","description":"The 3D viewer's camera.","default":"perspective"},"hidden_menu_items":{"items":{"type":"string","enum":["ai","parts","dashboard","analyses","recent","designs","new-part","quotes","leads","submission-links","quotes-pricing","branding-emails","machines","tools","materials","tolerances","organization-general","organization-members","organization-billing","organization-credits","organization-api-keys"]},"type":"array","title":"Hidden Menu Items","description":"The items this person hides from the left-hand menu, in every app, in the menu's order. Their pages still open. Projects and Settings always show."}},"additionalProperties":false,"type":"object","title":"ViewSettings","description":"How the app opens for this person."},"ViewSettingsIn":{"properties":{"data_panel":{"anyOf":[{"type":"string","enum":["open","collapsed"]},{"type":"null"}],"title":"Data Panel","description":"Whether an analysis's data panel starts open or collapsed."},"first_tab":{"anyOf":[{"type":"string","enum":["findings","setups","holes","surfaces","edges","warnings","raw"]},{"type":"null"}],"title":"First Tab","description":"The report tab an analysis opens on."},"reopen_tabs":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reopen Tabs","description":"Whether a project reopens the analysis tabs left open last time."},"theme":{"anyOf":[{"type":"string","enum":["system","light","dark"]},{"type":"null"}],"title":"Theme","description":"Light, dark, or follow the device."},"project_runs":{"anyOf":[{"type":"string","enum":["cards","list"]},{"type":"null"}],"title":"Project Runs","description":"Whether a project shows its analysis runs as cards or a list."},"viewer_edges":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Viewer Edges","description":"Whether the 3D viewer shows edges."},"viewer_roles":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Viewer Roles","description":"Whether the 3D viewer colours faces by role."},"viewer_surface_ids":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Viewer Surface Ids","description":"Whether the 3D viewer writes surface IDs on the selected faces."},"length_units":{"anyOf":[{"type":"string","enum":["organization","mm","inch"]},{"type":"null"}],"title":"Length Units","description":"Lengths on the analysis screen: mm, inch, or organization."},"viewer_xray":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Viewer Xray","description":"Whether the 3D viewer shows faces see-through."},"viewer_projection":{"anyOf":[{"type":"string","enum":["perspective","orthographic"]},{"type":"null"}],"title":"Viewer Projection","description":"The 3D viewer's camera."},"hidden_menu_items":{"anyOf":[{"items":{"type":"string","enum":["ai","parts","projects","dashboard","analyses","recent","designs","new-part","quotes","leads","submission-links","quotes-pricing","branding-emails","machines","tools","materials","tolerances","settings","organization-general","organization-members","organization-billing","organization-credits","organization-api-keys"]},"type":"array","maxItems":64},{"type":"null"}],"title":"Hidden Menu Items","description":"The left-hand menu items to hide, in every app. This list replaces the one kept; an empty list shows every item again. Their pages still open. Projects and Settings always show, and asking to hide either is refused with MENU_ITEM_ALWAYS_SHOWN."}},"additionalProperties":false,"type":"object","title":"ViewSettingsIn","description":"View settings to change. Leave out or send null for any that stay as they are."},"WallRecord":{"properties":{"surface":{"type":"string","title":"Surface","description":"An opaque reference to a face, as display, roles and every list of surfaces name it, such as S0012."},"floor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Floor","description":"The floor of the pocket it stands on. Null for an open wall."},"setup":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Setup","description":"The setup that cuts it, by number. Null where no setup reaches it."},"lean":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lean","description":"Degrees it leans off square to the direction it's cut from. Null for a freeform face."},"foot_fillet":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Foot Fillet","description":"The fillet radius at its foot, mm, which its tool's corner forms. Null for none."},"tightest_corner":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Tightest Corner","description":"The tightest corner radius its tool has to fit, mm: its pocket's, or its own curve. Null for none."},"height":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Height","description":"Its height along the direction it's cut from, mm."},"cut":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cut","description":"How it's finished, as the estimate's time item names it, such as walls, corner or profiling."},"tool":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool","description":"The tool that finishes it, by size and type. Null where none does."},"to_buy":{"type":"boolean","title":"To Buy","description":"Whether that tool isn't one of the organization's, so it's to buy.","default":false}},"type":"object","required":["surface"],"title":"WallRecord","description":"A wall, with what sizes the tool that finishes it, and that tool."},"WallSphere":{"properties":{"center":{"items":{"type":"number"},"type":"array","title":"Center","description":"Its center, x, y and z, in mm, as display draws the part."},"diameter":{"type":"number","title":"Diameter","description":"Its diameter: the wall's thickness there, mm."}},"type":"object","required":["center","diameter"],"title":"WallSphere","description":"A sphere inside the part that shows how thick a wall is there: centered midway between the wall's two sides, as\nwide as the wall is thick, so it touches both. No two overlap.\n\nA measurement of the part itself, for the viewer to draw."},"WorkingOut":{"properties":{"version_id":{"type":"string","format":"uuid","title":"Version Id","description":"The working version's id: open it in Design with get_design."},"held_by":{"type":"string","title":"Held By","description":"The name of whoever holds it, or their email when they have no name."},"mine":{"type":"boolean","title":"Mine","description":"Whether the caller holds it."}},"additionalProperties":false,"type":"object","required":["version_id","held_by","mine"],"title":"WorkingOut","description":"The part's working version, and who holds it."},"analyses__customer__BoundingBox":{"properties":{"min":{"items":{"type":"number"},"type":"array","title":"Min","description":"The lowest corner, x, y and z, in mm."},"max":{"items":{"type":"number"},"type":"array","title":"Max","description":"The highest corner, x, y and z, in mm."}},"type":"object","required":["min","max"],"title":"BoundingBox","description":"A box aligned with the axes, in mm."},"analyses__customer__Material":{"properties":{"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key","description":"The reference grade's key, such as 6061."},"name":{"type":"string","title":"Name","description":"Its name, such as 6061-T6 aluminium."},"family":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family","description":"metal or plastic."}},"type":"object","required":["name"],"title":"Material","description":"The material estimated in."},"analyses__customer__PartWarning":{"properties":{"text":{"type":"string","title":"Text","description":"What it is, in a sentence a person can read."},"surfaces":{"items":{"type":"string"},"type":"array","title":"Surfaces","description":"The faces it's about. Empty when it's about the whole file.","default":[]}},"type":"object","required":["text"],"title":"PartWarning","description":"Something in the file that may affect the results."},"analyses__views__StepRef":{"properties":{"step":{"type":"integer","maximum":99.0,"minimum":1.0,"title":"Step","description":"The operation's place in its route, from 1, in the order turning.routes[].operations lists them."},"route":{"anyOf":[{"type":"string","enum":["mill","lathe","lathe_then_mill","mill_turn"]},{"type":"null"}],"title":"Route","description":"The route: mill, lathe, lathe_then_mill or mill_turn. Leave out for the one it's made by, turning.route."}},"additionalProperties":false,"type":"object","required":["step"],"title":"StepRef","description":"One operation of a lathe part's route: the faces it cuts."},"library__materials__Material":{"properties":{"reference":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Reference","description":"The reference grade it offers, such as 6061. Null for a custom grade."},"name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Name","description":"A custom grade's name. Ignored for a reference grade, which keeps its own."},"cutting_group":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Cutting Group","description":"A custom grade's cutting group: one a reference grade uses, such as N1.2.Z.AG. Required for a custom grade."},"family":{"anyOf":[{"type":"string","enum":["metal","plastic"]},{"type":"null"}],"title":"Family","description":"A custom grade's family. A reference grade keeps its own."},"stock_price":{"anyOf":[{"type":"number","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Stock Price","description":"The shop's raw stock price, US dollars per kg, whatever the form. Needs price_as_of. Null uses Protyus's list price."},"price_as_of":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Price As Of","description":"When the stock price was set."},"form_factors":{"$ref":"#/components/schemas/FormFactors","description":"What scales the stock price for each stock form: a piece costs its weight x the price x its form's factor. Each 1.0 unless set."}},"additionalProperties":false,"type":"object","title":"Material","description":"A grade the organization offers: a reference grade, or a custom one that names the cutting group it machines like."},"plans__credits__CreditPackOut":{"properties":{"analyses":{"type":"integer","title":"Analyses","description":"Analyses in a pack."},"price_usd":{"type":"number","title":"Price Usd","description":"Its price, in US dollars."},"months":{"type":"integer","title":"Months","description":"How many months a pack lasts from the day it's bought."}},"additionalProperties":false,"type":"object","required":["analyses","price_usd","months"],"title":"CreditPackOut","description":"What one pack of credits is now."}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"A Clerk session token, or an API key (ak_...) that acts as the person who made it."}}},"security":[{"bearer":[]}],"tags":[{"name":"Analyses","description":"Upload a STEP file, start an analysis of it, wait for it, and read its result: features, setups, tool access and DFM findings."},{"name":"Design","description":"List the organization's parts, and make and change a milled part with Protyus AI: start a part or optimise a final version, run turns, quick-check, keep checkpoints, analyse, finalise and download its STEP file. Only where the design flag is on."},{"name":"Quotes","description":"Price an analysis's cost lines at the organization's margin and terms, at three quantities, and keep quotes with versions that never change."},{"name":"Submission links","description":"Links a shop shares to collect leads and STEP files from people outside Protyus, each for one project. Make, edit, regenerate and revoke them; each link's token is shown once. Email someone an upload link, and the public routes its upload page uses."},{"name":"Leads","description":"The people outside Protyus who were sent an upload link or filled in a submission link's form, each with their submissions, quotes and a timeline of what happened. Mark them won or lost, export them as CSV, or delete one for a privacy request. Read one of their submissions, and send or decline its held quotes."},{"name":"Dashboards","description":"The organization's named dashboards. Each card is a saved read-only call that runs as whoever views it, so it shows only what they may see."},{"name":"Projects","description":"Projects hold analyses. Each has an owner and members from the organization."},{"name":"Account","description":"The caller: who they are, their organization and its name, and what they may do; and leaving: exporting the company's data, and deleting it."},{"name":"API keys","description":"Personal API keys for agents and scripts: each acts as the person who made it. Create, list and revoke your own; admins revoke anyone's in the organization."},{"name":"Members and roles","description":"The organization's people, invitations, and the roles that grant permissions across it or on one project."},{"name":"Settings","description":"Settings at three levels: the caller's own, the organization's, and what one project overrides."},{"name":"Machines","description":"The shop's machines, each built on a machine class that fills in its values, added one at a time, from the reference list or from a spreadsheet."},{"name":"Tools","description":"The organization's cutting tools: search, add, edit, import from Fusion or CSV, and export."},{"name":"Materials","description":"Protyus's reference grades, and the grades the organization offers, with their stock prices, added one at a time or from a spreadsheet."},{"name":"Tolerances","description":"What the shop can hold: a general tolerance and a capability table, with project overrides."},{"name":"Library","description":"Every kind of library item: revisions, archiving, collections, and batches that can be undone."},{"name":"Metrics","description":"Counts and values across the organization, for dashboards and agents: analyses, findings, scores, quotes and usage, by time and category, scoped to what the caller can see."},{"name":"Usage","description":"The organization's billable actions: analyses run and files extracted, from the app, the API or MCP, with their compute and storage, Protyus AI messages with their tokens, and the organization's credits."},{"name":"Plans","description":"What each plan includes and costs, the free trial and credits: public, with no sign-in."},{"name":"Protyus AI","description":"How Protyus AI's own server meters each chat message: checked against the organization's trial, its plan and the person's AI switch, then counted with its tokens."},{"name":"Service","description":"Whether the deployment is up."}]}