{"openapi":"3.0.1","info":{"title":"","version":""},"paths":{"/AttributeValues":{"get":{"tags":["AttributeValues"],"summary":"Get a list of unique values and number of occurrences of an attribute (user access token required)","parameters":[{"name":"attribute","in":"query","description":"Type: string (required). Atrribute name.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttributeCount"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttributeCount"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttributeCount"}}}}}}}},"/CompanyLogo":{"put":{"tags":["CompanyLogo"],"summary":"Sets the logo for a company (user access token required)","requestBody":{"description":"Type: string, JSON serialized base64-encoded file bytes (required)","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}},"delete":{"tags":["CompanyLogo"],"summary":"Removes a company logo (user access token required)","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}},"/CompanyProfile":{"get":{"tags":["CompanyProfile"],"summary":"Gets a company's profile (user access token required)","parameters":[{"name":"companyID","in":"query","description":"Type: string (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CompanyProfile"}},"application/json":{"schema":{"$ref":"#/components/schemas/CompanyProfile"}},"text/json":{"schema":{"$ref":"#/components/schemas/CompanyProfile"}}}}}},"put":{"tags":["CompanyProfile"],"summary":"Create a new account (user access token and special access required)","parameters":[{"name":"accountName","in":"query","description":"Type: string, 100 character limit (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/ConvertFiles":{"put":{"tags":["ConvertFiles"],"summary":"Converts 3D model files into either .stl or .step files (user access token required)","parameters":[{"name":"fileNames","in":"query","description":"Type: string (required). Comma-separated list of the fileNames to be converted.\r\n Must be in the same order as the byte arrays.","schema":{"type":"string"}},{"name":"conversionExtension","in":"query","description":"Type: string (required). Allowed values: 'stl' or 'step'","schema":{"type":"string"}},{"name":"useCompanyFolder","in":"query","description":"Type: bool. Internal use only","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"Type: string (required). The byte arrays of the files (JSON serialized string[] of base64-encoded byte arrays)","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/CustomProductCategory":{"get":{"tags":["CustomProductCategory"],"summary":"Creates a new product category (user access token required)","parameters":[{"name":"name","in":"query","description":"Type: URL-encoded string(required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProductCategory"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProductCategory"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProductCategory"}}}}}}},"/ExtractedAttributeFeedback":{"put":{"tags":["ExtractedAttributeFeedback"],"summary":"Send feedback for a file, based on the attributes that were extracted. (user access token required)","parameters":[{"name":"fileUID","in":"query","description":"Type: string. The 'UID' of the VizSeek file.","schema":{"type":"string"}},{"name":"feedback","in":"query","description":"Type: string, URL-encoded. What should have VizSeek extracted differently? (Max 300 characters)","schema":{"type":"string"}},{"name":"user","in":"query","description":"Type: string, URL-encoded. (optional) Any user information you want to associate with the feedback. Max 100 characters.","schema":{"type":"string"}},{"name":"feedbackId","in":"query","description":"Type: string. (optional) A Guid to use as an identifier. If none is passed, we will generate one.","schema":{"type":"string"}}],"requestBody":{"description":"Type: string. Extracted File Attributes (Passed in the body). \r\n A comma-separated list of the relevant attributes that VizSeek originally extracted, formatted like: \r\n [attribute 1 name]=[attribute 1 value],etc. Example: \"Color=Red,Category=Castors\"","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/File":{"get":{"tags":["File"],"summary":"Returns an existing file, using either the fileUID or fileName (user access token required)","parameters":[{"name":"fileUID","in":"query","description":"Type: string","schema":{"type":"string"}},{"name":"fileName","in":"query","description":"Type: string. Full file path","schema":{"type":"string"}},{"name":"includeShapelets","in":"query","description":"Type: boolean (default false)
Whether to include shape locations and thumbnail images.
For 2d, the shape location is the bounding box of the shape: x, y, width and height.
For 3d, the shape location is scale, x, y, and z of the camera position.","schema":{"type":"boolean","default":false}},{"name":"lgFileNumber","in":"query","description":"Type: string (optional). The page number to use for a multi-page file.","schema":{"type":"string","default":""}},{"name":"includeShapes","in":"query","description":"Type: boolean (default false) Whether to include advanced shapes (Internal use)","schema":{"type":"boolean","default":false}},{"name":"accountName","in":"query","description":"Type: string, Only use if directed","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/FileMap"}},"application/json":{"schema":{"$ref":"#/components/schemas/FileMap"}},"text/json":{"schema":{"$ref":"#/components/schemas/FileMap"}}}}}},"put":{"tags":["File"],"summary":"Saves a new file for search input or to the company database. The difference is that a file only used for \r\n search will not be available later in the company database. You will be returned the fileUID to use for the search method.\r\n (user access token required)","parameters":[{"name":"file","in":"query","description":"Type: URL-encoded string (required).
\r\n If adding for search, only pass the extension (Ex. '.png')
\r\n If adding to company, pass the full file path (Ex. 'Design/chair.png')","schema":{"type":"string"}},{"name":"isGZipCompressed","in":"query","description":"Type: boolean (default = false). (Depricated) Only send true if the file is compressed using GZip.","schema":{"type":"boolean","default":false}},{"name":"isSearchInput","in":"query","description":"Type: boolean (default = true). Use false if the file should be added to your file database","schema":{"type":"boolean","default":true}},{"name":"attributes","in":"query","description":"Type: URL-encoded string (optional). The file attributes in a query string format \r\n (\"attributeName=attributeValue\" pairs separated by &). Ex. before encoding: \"Width=10.5&Color=Blue\", after encoding: \"Width%3D10.5%26Color%3DBlue\"","schema":{"type":"string"}},{"name":"QRCodeId","in":"query","description":"Type: string (Internal use only)","schema":{"type":"string"}},{"name":"categoryId","in":"query","description":"Type: int (Required only for companies that use file categories)","schema":{"type":"integer","format":"int32","default":-1}},{"name":"textOnly","in":"query","description":"Type: bool (default = false) True skips shape indexing","schema":{"type":"boolean","default":false}},{"name":"attrTemplate","in":"query","description":"Type: string (DO NOT USE unless instructed by VizSeek)","schema":{"type":"string"}},{"name":"uid","in":"query","description":"Type: string. To use a specific uid for the file (MUST BE a GUID). Otherwise a random guid will be generated.\r\n If another file already exists with this uid, it will be overwritten.","schema":{"type":"string"}},{"name":"rmIfDup","in":"query","description":"Type: boolean (default = false). If set to true, any duplicate files added after this one will be removed.","schema":{"type":"boolean","default":false}},{"name":"isPriority","in":"query","description":"Type: boolean (default = false).","schema":{"type":"boolean","default":false}},{"name":"overwriteFile","in":"query","description":"Type: nullable boolean (Optional. default = null).
\r\n This applies when uploading a file that already has a file name match in your database.
\r\n If true, the existing file will be replaced with the new one. If false, the new file will have a number appended to the name, like \"Gear(2).jpg.\"
\r\n If this value is not passed, your company's default setting will be used. (This can be changed in the VizSeek company profile page.)","schema":{"type":"boolean"}},{"name":"indexAssemblyComponents","in":"query","description":"Type: boolean (default = false).","schema":{"type":"boolean","default":false}},{"name":"callbackParam","in":"query","description":"Type: string (Optional. default = null). If not null, and Callback Url settings are set in the UI\r\n company settings page, this parameter will be added to the callback respose. Ex: \"callbackParam=productId:123456-ABC\". The\r\n callback response will be the same as our File GET API JSON, plus \"\\\"productId\\\": \\\"123456-ABC\\\".\"","schema":{"type":"string"}},{"name":"accountName","in":"query","description":"Type: string, Only use if directed","schema":{"type":"string"}}],"requestBody":{"description":"Type: string, JSON serialized base64-encoded file bytes (required)","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}},"delete":{"tags":["File"],"summary":"Deletes an existing file (user access token required)","parameters":[{"name":"fileUID","in":"query","description":"Type: string (required)","schema":{"type":"string"}},{"name":"accountName","in":"query","description":"Type: string, Only use if directed","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}},"/FileAttributes":{"get":{"tags":["FileAttributes"],"summary":"Gets a list of attributes for the current user's company (user access token required)","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileAttribute"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileAttribute"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileAttribute"}}}}}}},"put":{"tags":["FileAttributes"],"summary":"Adds attributes to a file. Either fileUID or fileName is required (user access token required)","parameters":[{"name":"fileUID","in":"query","description":"Type: string","schema":{"type":"string"}},{"name":"fileName","in":"query","description":"Type: string. Full file path","schema":{"type":"string"}},{"name":"deleteExisting","in":"query","description":"Type: boolean (optional). Default is true (will remove all current attributes before adding new ones).","schema":{"type":"boolean","default":true}}],"requestBody":{"description":"Type: string (JSON-serialized string[] of name=value pairs, or name(unit)=value if there is a unit) (required)","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}},"delete":{"tags":["FileAttributes"],"summary":"Removes all attributes from a file (user access token required)","parameters":[{"name":"fileUID","in":"query","description":"Type: string (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}},"/FileBinary":{"put":{"tags":["FileBinary"],"summary":"(Same functionality as File PUT, except here, the file content is sent in binary format instead of a base64 string) \r\n Saves a new file for search input or to your file database.\r\n (user access token required)","parameters":[{"name":"file","in":"query","description":"Type: URL-encoded string (required).
\r\n If adding for search, only pass the extension (Ex. '.png')
\r\n If adding to company, pass the full file path (Ex. 'Design/chair.png')","schema":{"type":"string"}},{"name":"isGZipCompressed","in":"query","description":"Type: boolean (default = false). (Depricated) Only send true if the file is compressed using GZip.","schema":{"type":"boolean","default":false}},{"name":"isSearchInput","in":"query","description":"Type: boolean (default = true). Use false if the file should be added to your file database","schema":{"type":"boolean","default":true}},{"name":"attributes","in":"query","description":"Type: URL-encoded string (optional). The file attributes in a query string format \r\n (\"attributeName=attributeValue\" pairs separated by &). Ex. before encoding: \"Width=10.5&Color=Blue\", after encoding: \"Width%3D10.5%26Color%3DBlue\"","schema":{"type":"string"}},{"name":"QRCodeId","in":"query","description":"Type: string (Internal use only)","schema":{"type":"string"}},{"name":"categoryId","in":"query","description":"Type: int (Required only for companies that use file categories)","schema":{"type":"integer","format":"int32","default":-1}},{"name":"textOnly","in":"query","description":"Type: bool (default = false) True skips shape indexing","schema":{"type":"boolean","default":false}},{"name":"attrTemplate","in":"query","description":"Type: string (DO NOT USE unless instructed by VizSeek)","schema":{"type":"string"}},{"name":"uid","in":"query","description":"Type: string. To use a specific uid for the file (MUST BE a GUID). Otherwise a random guid will be generated.\r\n If another file already exists with this uid, it will be overwritten.","schema":{"type":"string"}},{"name":"rmIfDup","in":"query","description":"Type: boolean (default = false). If set to true, any duplicate files added after this one will be removed.","schema":{"type":"boolean","default":false}},{"name":"isPriority","in":"query","description":"Type: boolean (default = false).","schema":{"type":"boolean","default":false}},{"name":"overwriteFile","in":"query","description":"Type: nullable boolean (Optional. default = null).
\r\n This applies when uploading a file that already has a file name match in your database.
\r\n If true, the existing file will be replaced with the new one. If false, the new file will have a number appended to the name, like \"Gear(2).jpg.\"
\r\n If this value is not passed, your company's default setting will be used. (This can be changed in the VizSeek company profile page.)","schema":{"type":"boolean"}},{"name":"indexAssemblyComponents","in":"query","description":"Type: boolean (default = false).","schema":{"type":"boolean","default":false}},{"name":"callbackParam","in":"query","description":"Type: string (Optional. default = null). If not null, and Callback Url settings are set in the UI\r\n company settings page, this parameter will be added to the callback respose. Ex: \"callbackParam=productId:123456-ABC\". The\r\n callback response will be the same as our File GET API JSON, plus \"\\\"productId\\\": \\\"123456-ABC\\\".\"","schema":{"type":"string"}},{"name":"accountName","in":"query","description":"Type: string, Only use if directed","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/FileBinaryDirect":{"put":{"tags":["FileBinaryDirect"],"summary":"(Synchronous form of the FileBinary API that waits for indexing to complete, then returns the File object) \r\n Saves a new file for search input or to your file database.\r\n (user access token required)","parameters":[{"name":"file","in":"query","description":"Type: URL-encoded string (required).
\r\n If adding for search, only pass the extension (Ex. '.png')
\r\n If adding to company, pass the full file path (Ex. 'Design/chair.png')","schema":{"type":"string"}},{"name":"isGZipCompressed","in":"query","description":"Type: boolean (default = false). (Depricated) Only send true if the file is compressed using GZip.","schema":{"type":"boolean","default":false}},{"name":"isSearchInput","in":"query","description":"Type: boolean (default = true). Use false if the file should be added to your file database.","schema":{"type":"boolean","default":true}},{"name":"attributes","in":"query","description":"Type: URL-encoded string (optional). The file attributes in a query string format \r\n (\"attributeName=attributeValue\" pairs separated by &). Ex. before encoding: \"Width=10.5&Color=Blue\", after encoding: \"Width%3D10.5%26Color%3DBlue\"","schema":{"type":"string"}},{"name":"QRCodeId","in":"query","description":"Type: string (Internal use only)","schema":{"type":"string"}},{"name":"categoryId","in":"query","description":"Type: int (Required only for companies that use file categories)","schema":{"type":"integer","format":"int32","default":-1}},{"name":"textOnly","in":"query","description":"Type: bool (default = false) True skips shape indexing","schema":{"type":"boolean","default":false}},{"name":"attrTemplate","in":"query","description":"Type: string (DO NOT USE unless instructed by VizSeek)","schema":{"type":"string"}},{"name":"uid","in":"query","description":"Type: string. To use a specific uid for the file (MUST BE a GUID). Otherwise a random guid will be generated.\r\n If another file already exists with this uid, it will be overwritten.","schema":{"type":"string"}},{"name":"rmIfDup","in":"query","description":"Type: boolean (default = false). If set to true, any duplicate files added after this one will be removed.","schema":{"type":"boolean","default":false}},{"name":"isPriority","in":"query","description":"Type: boolean (default = false).","schema":{"type":"boolean","default":false}},{"name":"overwriteFile","in":"query","description":"Type: nullable boolean (Optional. default = null).
\r\n This applies when uploading a file that already has a file name match in your database.
\r\n If true, the existing file will be replaced with the new one. If false, the new file will have a number appended to the name, like \"Gear(2).jpg.\"
\r\n If this value is not passed, your company's default setting will be used. (This can be changed in the VizSeek company profile page.)","schema":{"type":"boolean"}},{"name":"indexAssemblyComponents","in":"query","description":"Type: boolean (default = false).","schema":{"type":"boolean","default":false}},{"name":"callbackParam","in":"query","description":"Type: string (Optional. default = null). If not null, and Callback Url settings are set in the UI\r\n company settings page, this parameter will be added to the callback respose. Ex: \"callbackParam=productId:123456-ABC\". The\r\n callback response will be the same as our File GET API JSON, plus \"\\\"productId\\\": \\\"123456-ABC\\\".\"","schema":{"type":"string"}},{"name":"includeShapelets","in":"query","description":"Type: boolean (default false) Whether to include additional shapes","schema":{"type":"boolean","default":false}},{"name":"lgFileNumber","in":"query","description":"Type: string (optional). The page number to use for a multi-page file.","schema":{"type":"string","default":""}},{"name":"includeShapes","in":"query","description":"Type: boolean (default false) Whether to include advanced shapes (Internal use only)","schema":{"type":"boolean","default":false}},{"name":"accountName","in":"query","description":"Type: string, Only use if directed","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/FileMap"}},"application/json":{"schema":{"$ref":"#/components/schemas/FileMap"}},"text/json":{"schema":{"$ref":"#/components/schemas/FileMap"}}}}}}},"/FileStatus":{"get":{"tags":["FileStatus"],"summary":"Returns null if the file has not been indexed; returns the timestamp if it has been indexed; \r\n or returns a list of dulpicate fileUIDs and a list of similar fileUIDs and their corresponding match scores \r\n if the file has been indexed and there are dulpicates. \r\n If the file was added with rmIfDup(remove if duplicate) set to true, the file will be removed. (user access token required)","parameters":[{"name":"fileUID","in":"query","description":"Type: string (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/Image":{"get":{"tags":["Image"],"summary":"Returns the base64 string of the thumbnail image of a file (user access token required)","parameters":[{"name":"fid","in":"query","description":"Type: string (required). Id of the file","schema":{"type":"string"}},{"name":"token","in":"query","description":"Type: string (required).","schema":{"type":"string"}},{"name":"type","in":"query","description":"Type: int. The type of image to return: 0 = small thumbnail, 1 = large thumbnail,\r\n 2 = specific extracted shape","schema":{"type":"integer","format":"int32","default":0}},{"name":"shapeIndex","in":"query","description":"Type: int. The index of the extracted shape to return","schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string","format":"byte"}},"application/json":{"schema":{"type":"string","format":"byte"}},"text/json":{"schema":{"type":"string","format":"byte"}}}}}}},"/IsEmployee":{"get":{"tags":["IsEmployee"],"summary":"Checks if the current user is a member of a given company (user access token required)","parameters":[{"name":"companyID","in":"query","description":"Type: string (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}},"/MonthlyUsage":{"get":{"tags":["MonthlyUsage"],"summary":"Gets monthly file count and token usage summary (user access token required)","parameters":[{"name":"year","in":"query","description":"Type: int (optional)","schema":{"type":"integer","format":"int32"}},{"name":"month","in":"query","description":"Type: int (optional)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonthlyUsageResponse"},"example":{"BillingPeriod":"08/01/2025 - 08/31/2025","FilePlanLimit":25000,"RemainingFiles":18345,"FileCount":{"CountDoc":6,"Count2D":555,"Count3D":1212,"CountPhoto":188,"Total":6655},"TokenPlanLimit":6000,"RemainingTokens":5849.6,"TokenUsage":{"TokenFileIndex":5,"TokenTableIndex":0,"TokenStorage":133.1,"TokenVSearch":8,"TokenTSearch":0.5,"TokenRAG":1,"TokenCompare":2.5,"Token2DPMI":0.3,"Token3DConvert":0,"Total":150.4}}}}}}}},"/PMIData":{"get":{"tags":["PMIData"],"summary":"Gets the PMI data extracted from a file (user access token required)","parameters":[{"name":"fileUID","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success.

PMI data structure:

At the top level of a PMI json object, there is a \"BEVersion\" (the vizseek backend version used when this PMI data was extracted) and an array of PMI data per page. For each page level PMI data, there is a \"page\" id and an \"ImageSize\" (the width and the height of the image from a pdf or dwg/dxf file), and an array of PMI data objects. At a PMI data object level, there is \"type_id\" (see the table below for a list of types), a \"_id\" (for internal usage), a bounding box (x, y, width and height, where the origin is the upper left corner of the image), and one or more fields for the text portion of the PMI data. If a PMI data object contains only one text, the text field is named \"text\" with a \"tol\" array for tolerance (if available). Some PMI data could contain multiple text fields. We use a json string array for multiple text fields without a tolerance. However, if one of the text fields includes a tolerance, a json array of json objects, named \"mtext\", will be used. The following is a list of examples.

simple text:
{\"box\":[1274,356,29,125],\"type_id\":0,\"_id\":6,\"text\":\"11\"}
single text with tolerance:
{\"box\":[155,824,35,449],\"type_id\":0,\"_id\":27,\"text\":\"8\",\"tol\":[\"±0,15\"]}, or
{\"box\":[1463,499,174,36],\"type_id\":3,\"_id\":29,\"text\":\"Ø5,2\",\"tol\":[\"+0,1\",\"-0,05\"]}
array of simple text:
{\"box\":[1947,1056,458,222],\"type_id\": 3,\"_id\": 74,\"text\": [\"30°\",\"48,41°\"]}
mix of simple text and text with tolerance:
{\"box\":[1641,819,240,135],\"type_id\": 0,\"_id\": 66,\"mtext\":[{\"text\": \"für 4x 8H7\"},{\"text\": \"⌀310\",\"tol\":[\"+0,02\",\"-0,02\"]}]}

We also group different \"type_id\"s into \"Measurement\", \"Datum\", \"GD&T\", \"SurfaceFinish\" and \"GeneralTolerance\" sub groups.


List of PMI data types:
IDDescription
02 dimensional arrows inside - value inside
1First angle projection
2Third angle projection
3Diameter
4View/Shape
5GD&T (geometric dimensioning and tolerancing)
62 dimensional arrows (others)
7Dimension arrow inside - value outside
8Dimension arrow outside - value outside
9Dimension gap - value outside
10Dimension gap - value inside
11Reserved
12Reserved
13Reserved
14Reserved
15Reserved
16Surface finish (any)
17Surface finish (machining)
18Diameter symbol
19Ascending dimension lines
20Parallel symbol
21Flat symbol
22Perpendicular symbol
23Straightness symbol
24Profile of a line symbol
25Profile of a surface symbol
26Angular symbol
27Cylindricity symbol
28Circularity symbol
29Circular runout symbol
30Symmetry symbol
31Concentricity symbol
32Total runout symbol
33True position symbol
34Datum
35Radius dimension
36Outer edge general tolerance
37Inner edge general tolerance
38Surface finish prohibited
39Plus/minus symbol
40Leader (dimension line without arrow)
41Depth
423D view/shape
43Reserved
44Surface texture (any process)
45Surface texture (material removal prohibited)
46Surface texture (material removal required)
47Table
48Counterbore
49Reserved
","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PMIData"}},"application/json":{"schema":{"$ref":"#/components/schemas/PMIData"}},"text/json":{"schema":{"$ref":"#/components/schemas/PMIData"}}}}}}},"/RFQ":{"put":{"tags":["RFQ"],"summary":"Input a file to create an RFQ. The file content must be sent in the body as a byte[]. (user access token required)","parameters":[{"name":"fileName","in":"query","description":"Type: URL-encoded string (required)","schema":{"type":"string"}},{"name":"customQuoteId","in":"query","description":"Type: string (optional)","schema":{"type":"string"}},{"name":"rfqId","in":"query","description":"Type: string (optional)","schema":{"type":"string"}},{"name":"chunkNum","in":"query","description":"Type: int (optional, if sending file in chunks)","schema":{"type":"integer","format":"int32"}},{"name":"totalChunks","in":"query","description":"Type: int (optional, if sending file in chunks)","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Type: string, JSON serialized base64-encoded file bytes (required)","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}},"get":{"tags":["RFQ"],"summary":"Gets an RFQ (user access token required)","parameters":[{"name":"rfqId","in":"query","description":"Type: string","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/RFQ"}},"application/json":{"schema":{"$ref":"#/components/schemas/RFQ"}},"text/json":{"schema":{"$ref":"#/components/schemas/RFQ"}}}}}},"delete":{"tags":["RFQ"],"summary":"Deletes an RFQ (user access token required)","parameters":[{"name":"rfqId","in":"query","description":"Type: string","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}},"/SavedSearches":{"put":{"tags":["SavedSearches"],"summary":"Saves a search (user access token required)","parameters":[{"name":"name","in":"query","description":"Type: URL-encoded string (required)","schema":{"type":"string"}},{"name":"queryStr","in":"query","description":"Type: URL-encoded string (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SavedSearch"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SavedSearch"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SavedSearch"}}}}}}},"get":{"tags":["SavedSearches"],"summary":"Gets the list of the user's saved searches (user access token required)","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}},"delete":{"tags":["SavedSearches"],"summary":"Deletes a saved search (user access token required)","parameters":[{"name":"id","in":"query","description":"Type: string (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"boolean"}},"application/json":{"schema":{"type":"boolean"}},"text/json":{"schema":{"type":"boolean"}}}}}}},"/Search":{"put":{"tags":["Search"],"summary":"Performs a search (user access token required)","parameters":[{"name":"fileExtension","in":"query","description":"Type: URL-encoded string. The extension of the search input files (Ex. '.png')","schema":{"type":"string"}},{"name":"filterStr","in":"query","description":"Type: URL-encoded string (optional). The filter string in a query string format \r\n (\"field=value\" pairs separated by &). Possible filter \"field\" options are:
\r\n 1) resultFileType – type of files to return (\"Image\", \"ThreeD\", \"TwoD\", or \"Text\")
\r\n 2) FT – free text search (FT value should be URL-encoded)
Ex. 1: \"FT=pump\"
\r\n Ex. 2 (attribute search): To search for \"Width=10.5&Color=Blue\", \r\n after the first encoding for the 'FT' value: \"FT=Width%3D10.5%26Color%3DBlue\", \r\n then after 'filterStr' gets encoded: \"filterStr=FT%3DWidth%253D10.5%2526Color%253DBlue\".\r\n
Because 'filterStr' as a whole is also URL-encoded, this means special characters within the text search string will end up being \r\n double URL-encoded.
\r\n 4) v – volume tolerance
\r\n 5) bbv – bounding box volume tolerance
\r\n 6) sa – surface area tolerance
\r\n Note 1: v, bbv and sa (4, 5 and 6) are used for 3D to 3D search only.
\r\n Note 2: Tolerance format is a decimal percentage. Ex: \".1\" (equivalent to +/-.1) represents 10%. Other examples: \"+0.3/-0.4\", \"+.2\", or \"-.5\"
","schema":{"type":"string"}},{"name":"isGZipCompressed","in":"query","description":"Type: boolean (optional) (default = false). Indicates if the search input files are GZipCompressed","schema":{"type":"boolean","default":false}},{"name":"cropX","in":"query","description":"(Depricated) Type: int (optional) X-coordinate of the crop area. \r\n (The distance from the left edge of the image to the left edge of the crop area)","schema":{"type":"integer","format":"int32","default":-1}},{"name":"cropY","in":"query","description":"(Depricated) Type: int (optional) Y-coordinate of the crop area. \r\n (The distance from the top edge of the image to the top edge of the crop area)","schema":{"type":"integer","format":"int32","default":-1}},{"name":"cropW","in":"query","description":"(Depricated) Type: int (optional) Width of the crop area","schema":{"type":"integer","format":"int32","default":-1}},{"name":"cropH","in":"query","description":"(Depricated) Type: int (optional) Height of the crop area","schema":{"type":"integer","format":"int32","default":-1}},{"name":"includeShapelets","in":"query","description":"Type: boolean (optional) If the extracted file shapelets should be included","schema":{"type":"boolean","default":false}},{"name":"customAPI","in":"query","description":"(Depricated) Type: int","schema":{"type":"integer","format":"int32","default":-1}},{"name":"crawl_parameter","in":"query","description":"(Depricated) Type: string","schema":{"type":"string"}},{"name":"accountName","in":"query","description":"Type: string (optional), Only use if directed","schema":{"type":"string"}},{"name":"targetFids","in":"query","description":"Type: string (optional), Comma-delimited string with a list of target Fids for search. e.g. targetFids=3247d83f-bc5a-4d8f-a24c-0cc88aff7b9b,3985fd80-cf31-42d0-a227-ff8cfb5c5516","schema":{"type":"string"}}],"requestBody":{"description":"Type: string (optional). The search input file(s), formatted in a JSON serialized array of base64-encoded file byte arrays","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success.

Score: Lower scores indicates more similarity between the search input and the result. A score of 0.0 means the result is an exact match.

MatchPosition: For 2d only, MatchPosition is x and y offset, rotation angle, and scaling factor.
See the c++ sample code for how to use the MatchPosition to construct a rotation matrix to overlay an input shape to a matching shape.","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/SearchResultSummary"},"example":{"ResultsList":[{"ShapeResult":{"UID":"00000000-0000-0000-0000-000000000000","Score":3.22989,"Volume":0,"SurfaceArea":0,"ViewerUrl":"https://hoops.vizseek.com/view/viewer.html?...","DetailsUrl":"https://www.vizseek.com/ViewFile?...","LargeFileUrl":"https://viewfiles.vizseek.com/vizseek/.../.../lg.png?ver=3","FileHash":null,"Attributes":["color=red","size=5"],"FileHasThumbnail":true,"Shapelets":null,"FirstShapeMatchIndex":"1","FirstShapeMatchPageNum":"0","MatchPosition":"0,0,0.785398,0.472566","Name":"test.pdf"},"CompanyName":"YourCompany","PublicURL":null,"CompanyVizSpaceID":null,"UserVizSpaceID":null,"LocationID":null,"FullText":null,"FileType":0,"ThumbnailURL":null,"ComponentFID":null,"ComponentName":null,"TextHighlights":null,"TextHighlightLocations":null,"FileName":"test.pdf","FileUID":"00000000-0000-0000-0000-000000000000","DateAdded":null,"ViewURL":"https://poc.vizseek.com/ViewFile?fileUID=00000000-0000-0000-0000-000000000000","Attributes":null,"CategoryID":null,"Name":null}],"RFQLines":null,"TotalResults":2,"CurrentCategory":null,"AdditionalCategories":null,"SearchTime":"00:00:00","InputFileUID":"example-uid","InputVolume":0,"InputBBVolume":0,"InputSurfaceArea":0,"InputShapeSizes":null,"InputUnits":null,"InputThumbnail":null,"CustomReply":null,"Categories":null,"SearchFilters":null,"Message":null}},"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultSummary"},"example":{"ResultsList":[{"ShapeResult":{"UID":"00000000-0000-0000-0000-000000000000","Score":3.22989,"Volume":0,"SurfaceArea":0,"ViewerUrl":"https://hoops.vizseek.com/view/viewer.html?...","DetailsUrl":"https://www.vizseek.com/ViewFile?...","LargeFileUrl":"https://viewfiles.vizseek.com/vizseek/.../.../lg.png?ver=3","FileHash":null,"Attributes":["color=red","size=5"],"FileHasThumbnail":true,"Shapelets":null,"FirstShapeMatchIndex":"1","FirstShapeMatchPageNum":"0","MatchPosition":"0,0,0.785398,0.472566","Name":"test.pdf"},"CompanyName":"YourCompany","PublicURL":null,"CompanyVizSpaceID":null,"UserVizSpaceID":null,"LocationID":null,"FullText":null,"FileType":0,"ThumbnailURL":null,"ComponentFID":null,"ComponentName":null,"TextHighlights":null,"TextHighlightLocations":null,"FileName":"test.pdf","FileUID":"00000000-0000-0000-0000-000000000000","DateAdded":null,"ViewURL":"https://poc.vizseek.com/ViewFile?fileUID=00000000-0000-0000-0000-000000000000","Attributes":null,"CategoryID":null,"Name":null}],"RFQLines":null,"TotalResults":2,"CurrentCategory":null,"AdditionalCategories":null,"SearchTime":"00:00:00","InputFileUID":"example-uid","InputVolume":0,"InputBBVolume":0,"InputSurfaceArea":0,"InputShapeSizes":null,"InputUnits":null,"InputThumbnail":null,"CustomReply":null,"Categories":null,"SearchFilters":null,"Message":null}},"text/json":{"schema":{"$ref":"#/components/schemas/SearchResultSummary"},"example":{"ResultsList":[{"ShapeResult":{"UID":"00000000-0000-0000-0000-000000000000","Score":3.22989,"Volume":0,"SurfaceArea":0,"ViewerUrl":"https://hoops.vizseek.com/view/viewer.html?...","DetailsUrl":"https://www.vizseek.com/ViewFile?...","LargeFileUrl":"https://viewfiles.vizseek.com/vizseek/.../.../lg.png?ver=3","FileHash":null,"Attributes":["color=red","size=5"],"FileHasThumbnail":true,"Shapelets":null,"FirstShapeMatchIndex":"1","FirstShapeMatchPageNum":"0","MatchPosition":"0,0,0.785398,0.472566","Name":"test.pdf"},"CompanyName":"YourCompany","PublicURL":null,"CompanyVizSpaceID":null,"UserVizSpaceID":null,"LocationID":null,"FullText":null,"FileType":0,"ThumbnailURL":null,"ComponentFID":null,"ComponentName":null,"TextHighlights":null,"TextHighlightLocations":null,"FileName":"test.pdf","FileUID":"00000000-0000-0000-0000-000000000000","DateAdded":null,"ViewURL":"https://poc.vizseek.com/ViewFile?fileUID=00000000-0000-0000-0000-000000000000","Attributes":null,"CategoryID":null,"Name":null}],"RFQLines":null,"TotalResults":2,"CurrentCategory":null,"AdditionalCategories":null,"SearchTime":"00:00:00","InputFileUID":"example-uid","InputVolume":0,"InputBBVolume":0,"InputSurfaceArea":0,"InputShapeSizes":null,"InputUnits":null,"InputThumbnail":null,"CustomReply":null,"Categories":null,"SearchFilters":null,"Message":null}}}}}},"get":{"tags":["Search"],"summary":"Performs a search (user access token required)","parameters":[{"name":"filterStr","in":"query","description":"Type: URL-encoded string(required). The filter string in a query string format \r\n (\"field=value\" pairs separated by &). Possible filter \"field\" options are:
\r\n 1) fileUID – fileUID of the search input file uploaded using the Put File call
\r\n 2) resultFileType – type of files to return (\"Image\", \"ThreeD\", \"TwoD\", or \"Text\")
\r\n 3) FT – free text search (FT value should be URL-encoded)
Ex. 1: \"FT=pump\"
\r\n Ex. 2 (attribute search): To search for \"Width=10.5&Color=Blue\", \r\n after the first encoding for the 'FT' value: \"FT=Width%3D10.5%26Color%3DBlue\", \r\n then after 'filterStr' gets encoded: \"filterStr=FT%3DWidth%253D10.5%2526Color%253DBlue\".\r\n
Because 'filterStr' as a whole is also URL-encoded, this means special characters within the text search string will end up being \r\n double URL-encoded.
\r\n 4) v – volume tolerance
\r\n 5) bbv – bounding box volume tolerance
\r\n 6) sa – surface area tolerance
\r\n Note 1: v, bbv and sa (4, 5 and 6) are used for 3D to 3D search only.
\r\n Note 2: Tolerance format is a decimal percentage. Ex: \".1\" (equivalent to +/-.1) represents 10%. Other examples: \"+0.3/-0.4\", \"+.2\", or \"-.5\"
","schema":{"type":"string"}},{"name":"includeShapelets","in":"query","description":"Type: boolean (optional) If the extracted file shapelets (thumbnail images for multiple views) should be included","schema":{"type":"boolean","default":false}},{"name":"customAPI","in":"query","description":"(Depricated) Type: int","schema":{"type":"integer","format":"int32","default":-1}},{"name":"searchAssemblyComponents","in":"query","description":"Type: boolean (optional - default false) For assembly file input, pass True to return results for\r\n every component, otherwise only files matching the entire assembly will be returned. Component results will include properties \"ComponentFID\"\r\n and \"ComponentName\" corresponding to which component they match. The property TotalResults will be set to -1 if the assembly has not finished indexing yet.","schema":{"type":"boolean","default":false}},{"name":"accountName","in":"query","description":"Type: string, Only use if directed","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/SearchResultSummary"},"example":{"ResultsList":[{"ShapeResult":{"UID":"00000000-0000-0000-0000-000000000000","Score":3.22989,"Volume":0,"SurfaceArea":0,"ViewerUrl":"https://hoops.vizseek.com/view/viewer.html?...","DetailsUrl":"https://www.vizseek.com/ViewFile?...","LargeFileUrl":"https://viewfiles.vizseek.com/vizseek/.../.../lg.png?ver=3","FileHash":null,"Attributes":["color=red","size=5"],"FileHasThumbnail":true,"Shapelets":null,"FirstShapeMatchIndex":"1","FirstShapeMatchPageNum":"0","MatchPosition":"0,0,0.785398,0.472566","Name":"test.pdf"},"CompanyName":"YourCompany","PublicURL":null,"CompanyVizSpaceID":null,"UserVizSpaceID":null,"LocationID":null,"FullText":null,"FileType":0,"ThumbnailURL":null,"ComponentFID":null,"ComponentName":null,"TextHighlights":null,"TextHighlightLocations":null,"FileName":"test.pdf","FileUID":"00000000-0000-0000-0000-000000000000","DateAdded":null,"ViewURL":"https://poc.vizseek.com/ViewFile?fileUID=00000000-0000-0000-0000-000000000000","Attributes":null,"CategoryID":null,"Name":null}],"RFQLines":null,"TotalResults":2,"CurrentCategory":null,"AdditionalCategories":null,"SearchTime":"00:00:00","InputFileUID":"example-uid","InputVolume":0,"InputBBVolume":0,"InputSurfaceArea":0,"InputShapeSizes":null,"InputUnits":null,"InputThumbnail":null,"CustomReply":null,"Categories":null,"SearchFilters":null,"Message":null}},"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultSummary"},"example":{"ResultsList":[{"ShapeResult":{"UID":"00000000-0000-0000-0000-000000000000","Score":3.22989,"Volume":0,"SurfaceArea":0,"ViewerUrl":"https://hoops.vizseek.com/view/viewer.html?...","DetailsUrl":"https://www.vizseek.com/ViewFile?...","LargeFileUrl":"https://viewfiles.vizseek.com/vizseek/.../.../lg.png?ver=3","FileHash":null,"Attributes":["color=red","size=5"],"FileHasThumbnail":true,"Shapelets":null,"FirstShapeMatchIndex":"1","FirstShapeMatchPageNum":"0","MatchPosition":"0,0,0.785398,0.472566","Name":"test.pdf"},"CompanyName":"YourCompany","PublicURL":null,"CompanyVizSpaceID":null,"UserVizSpaceID":null,"LocationID":null,"FullText":null,"FileType":0,"ThumbnailURL":null,"ComponentFID":null,"ComponentName":null,"TextHighlights":null,"TextHighlightLocations":null,"FileName":"test.pdf","FileUID":"00000000-0000-0000-0000-000000000000","DateAdded":null,"ViewURL":"https://poc.vizseek.com/ViewFile?fileUID=00000000-0000-0000-0000-000000000000","Attributes":null,"CategoryID":null,"Name":null}],"RFQLines":null,"TotalResults":2,"CurrentCategory":null,"AdditionalCategories":null,"SearchTime":"00:00:00","InputFileUID":"example-uid","InputVolume":0,"InputBBVolume":0,"InputSurfaceArea":0,"InputShapeSizes":null,"InputUnits":null,"InputThumbnail":null,"CustomReply":null,"Categories":null,"SearchFilters":null,"Message":null}},"text/json":{"schema":{"$ref":"#/components/schemas/SearchResultSummary"},"example":{"ResultsList":[{"ShapeResult":{"UID":"00000000-0000-0000-0000-000000000000","Score":3.22989,"Volume":0,"SurfaceArea":0,"ViewerUrl":"https://hoops.vizseek.com/view/viewer.html?...","DetailsUrl":"https://www.vizseek.com/ViewFile?...","LargeFileUrl":"https://viewfiles.vizseek.com/vizseek/.../.../lg.png?ver=3","FileHash":null,"Attributes":["color=red","size=5"],"FileHasThumbnail":true,"Shapelets":null,"FirstShapeMatchIndex":"1","FirstShapeMatchPageNum":"0","MatchPosition":"0,0,0.785398,0.472566","Name":"test.pdf"},"CompanyName":"YourCompany","PublicURL":null,"CompanyVizSpaceID":null,"UserVizSpaceID":null,"LocationID":null,"FullText":null,"FileType":0,"ThumbnailURL":null,"ComponentFID":null,"ComponentName":null,"TextHighlights":null,"TextHighlightLocations":null,"FileName":"test.pdf","FileUID":"00000000-0000-0000-0000-000000000000","DateAdded":null,"ViewURL":"https://poc.vizseek.com/ViewFile?fileUID=00000000-0000-0000-0000-000000000000","Attributes":null,"CategoryID":null,"Name":null}],"RFQLines":null,"TotalResults":2,"CurrentCategory":null,"AdditionalCategories":null,"SearchTime":"00:00:00","InputFileUID":"example-uid","InputVolume":0,"InputBBVolume":0,"InputSurfaceArea":0,"InputShapeSizes":null,"InputUnits":null,"InputThumbnail":null,"CustomReply":null,"Categories":null,"SearchFilters":null,"Message":null}}}}}}},"/SearchFeedback":{"put":{"tags":["SearchFeedback"],"summary":"Send user feedback for a search. (user access token required)","parameters":[{"name":"found","in":"query","description":"Type: bool? (optional) Was the expected result found?","schema":{"type":"boolean"}},{"name":"rank","in":"query","description":"Type: int? (optional) If found, the rank (by score) of the matching result","schema":{"type":"integer","format":"int32"}},{"name":"expectation","in":"query","description":"Type: string, URL-encoded. (optional) What you expected to find, if the expected result was not found. Max 100 characters.","schema":{"type":"string"}},{"name":"helpfulness","in":"query","description":"Type: int? (optional) On a scale of 1 to 5, how helpful were the results?","schema":{"type":"integer","format":"int32"}},{"name":"user","in":"query","description":"Type: string, URL-encoded. (optional) Any user information you want to associate with the feedback. Max 100 characters.","schema":{"type":"string"}},{"name":"inputFileUID","in":"query","description":"Type: string. (optional) The 'InputFileUID' returned from the Search API, if a file was used as input.","schema":{"type":"string"}},{"name":"inputFileName","in":"query","description":"Type: string, URL-encoded. (optional) The name of the file, if any, that was used as input.","schema":{"type":"string"}},{"name":"otherInput","in":"query","description":"Type: string, URL-encoded. (optional) Any other search input that was used, other than/in addition to a file.","schema":{"type":"string"}},{"name":"feedbackId","in":"query","description":"Type: string. (optional) A Guid to use as an identifier. If none is passed, we will generate one.","schema":{"type":"string"}}],"requestBody":{"description":"Type: string. Passed in the body. A comma-separated list of results, formatted like\r\n [result file UID]_[result score], Example: \"17bc1ed1-1939-425f-bdfe-e59cbffaea16_1.05,10a5ba67-abfe-4b15-a085-e9f9a9952104_1.89\"","content":{"application/json-patch+json":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}},"application/*+json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/Token":{"post":{"tags":["Token"],"summary":"Gets an authentication token.","parameters":[{"name":"grant_type","in":"query","schema":{"type":"string"}},{"name":"client_id","in":"query","schema":{"type":"string"}},{"name":"username","in":"query","schema":{"type":"string"}},{"name":"password","in":"query","schema":{"type":"string"}},{"name":"refresh_token","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}}}},"/User":{"get":{"tags":["User"],"summary":"Authenticates the given credentials (a null response is most likely due to invalid credentials)","parameters":[{"name":"emailID","in":"query","description":"Type: string (required)","schema":{"type":"string"}},{"name":"password","in":"query","description":"SHA1 hash (base64-encoded string) of the password (required)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UserProfile"}},"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}},"text/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}}}},"put":{"tags":["User"],"summary":"Creates a new user.\r\nIf companyId is not specified, and there's an email domain to companyId mapping saved, the user will be associated with that company.","parameters":[{"name":"emailID","in":"query","description":"Type: string (required)","schema":{"type":"string"}},{"name":"firstName","in":"query","description":"Type: URL-encoded string (required)","schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Type: URL-encoded string (required)","schema":{"type":"string"}},{"name":"password","in":"query","description":"SHA1 hash (base64-encoded string) of the password (required)","schema":{"type":"string"}},{"name":"companyId","in":"query","description":"Type: string. The Id of the company with which to associate the new user. (optional)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/UserProfile"}},"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}},"text/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}}}}},"/ValidUploadFileTypes":{"get":{"tags":["ValidUploadFileTypes"],"summary":"Gets a list of allowed file types","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"array","items":{"type":"string"}}},"application/json":{"schema":{"type":"array","items":{"type":"string"}}},"text/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/Version":{"get":{"tags":["Version"],"summary":"Use this method as an easy way to check connectivity. This will always return \"1\".","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}},"text/json":{"schema":{"type":"string"}}}}}}},"/VizSeekFileCount":{"get":{"tags":["VizSeekFileCount"],"summary":"Gives the current number of database files for the company (user access token required)","responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"type":"integer","format":"int32"}},"application/json":{"schema":{"type":"integer","format":"int32"}},"text/json":{"schema":{"type":"integer","format":"int32"}}}}}}}},"components":{"schemas":{"AssemblyItem":{"type":"object","properties":{"uid":{"type":"string","nullable":true},"fileName":{"type":"string","nullable":true},"thumbnailURL":{"type":"string","nullable":true},"viewerURL":{"type":"string","nullable":true}},"additionalProperties":false},"AttributeCount":{"type":"object","properties":{"name":{"type":"string","nullable":true},"count":{"type":"integer","format":"int32"}},"additionalProperties":false},"CategorySearchResult":{"type":"object","properties":{"name":{"type":"string","nullable":true},"imageURL":{"type":"string","nullable":true},"count":{"type":"integer","format":"int32"},"searchURL":{"type":"string","nullable":true},"searchFilterValue":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"CompanyProfile":{"type":"object","properties":{"publicURL":{"type":"string","nullable":true},"companyURL":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"registrationDate":{"type":"string","format":"date-time"},"iCode":{"type":"string","nullable":true},"logo":{"type":"string","nullable":true},"folderURL":{"type":"string","nullable":true},"tagLogo":{"type":"string","nullable":true},"logoHTML":{"type":"string","nullable":true},"webSearchType":{"type":"integer","format":"int32"},"rasterSearchMethod":{"type":"integer","format":"int32"},"vectorSearchMethod":{"type":"integer","format":"int32"},"publiclyAccessible":{"type":"boolean"},"hasFileCategories":{"type":"boolean"},"usesDeepLearning":{"type":"boolean"},"usesAutoClassify":{"type":"boolean"},"usesPngThumbnails":{"type":"boolean"},"maxVisualSearchResults":{"type":"integer","format":"int32"},"maxRFQSearchResults":{"type":"integer","format":"int32"},"scoreThreshold":{"type":"number","format":"double","nullable":true},"viewScoreThreshold44":{"type":"number","format":"double"},"viewScoreThreshold43":{"type":"number","format":"double"},"viewScoreThreshold22":{"type":"number","format":"double"},"viewScoreThreshold23":{"type":"number","format":"double"},"viewScoreThreshold2b2b":{"type":"number","format":"double"},"viewScoreThreshold2b3":{"type":"number","format":"double"},"viewScoreThreshold34":{"type":"number","format":"double"},"viewScoreThreshold32":{"type":"number","format":"double"},"viewScoreThreshold33":{"type":"number","format":"double"},"viewScoreThreshold6":{"type":"number","format":"double"},"threeDImageIndex":{"type":"integer","format":"int32"},"threeDDrawingIndex":{"type":"integer","format":"int32"},"hideFileExtNum":{"type":"boolean"},"isPayingForDuplicates":{"type":"boolean"},"usesFileTextForSearch":{"type":"boolean"},"textOnly":{"type":"boolean"},"hideVizSeekBranding":{"type":"boolean"},"currency":{"$ref":"#/components/schemas/Currency"},"filePriority":{"type":"integer","format":"int32"},"isRFQThreeD":{"type":"boolean"},"beSetting":{"type":"string","nullable":true},"volTolerance":{"type":"string","nullable":true},"bbVolTolerance":{"type":"string","nullable":true},"exactScoreTolerance":{"type":"number","format":"double","nullable":true},"exactVolTolerance":{"type":"number","format":"double","nullable":true},"exactBBVolTolerance":{"type":"number","format":"double","nullable":true},"overwriteFiles":{"type":"boolean"},"useNumericTextSearch":{"type":"boolean"},"overallDeficitThreshold":{"type":"integer","format":"int32","nullable":true},"perViewDeficitThreshold":{"type":"integer","format":"int32","nullable":true},"combineVariations":{"type":"boolean"},"kuaguOrderEmail":{"type":"string","nullable":true},"useSketchInput":{"type":"boolean"},"priorityAttrs":{"type":"string","nullable":true},"listAttrs":{"type":"string","nullable":true},"dependentDdlAttrs":{"type":"string","nullable":true},"shapeOnlyDups":{"type":"boolean"},"attrsOnlyDups":{"type":"boolean"},"shapePlusAttrsDups":{"type":"boolean"},"trialStartDate":{"type":"string","format":"date-time","nullable":true},"addCompareFilesToDB":{"type":"boolean"},"overlayCompareOn":{"type":"boolean"},"preferredUnits":{"type":"string","nullable":true},"decimalPlaces":{"type":"integer","format":"int32"},"useTextHighlighting":{"type":"boolean"},"useOldESTextQuery":{"type":"boolean"},"showMatchingShapes":{"type":"boolean"},"feedbackExpectationMappedAttribute":{"type":"string","nullable":true},"useInputSummary":{"type":"boolean"},"customFeature1":{"type":"boolean"},"useRAG":{"type":"boolean"},"usePublicURL":{"type":"boolean"},"isPublished":{"type":"boolean","readOnly":true},"logoURL":{"type":"string","nullable":true},"isValidStatus":{"type":"integer","format":"int32"},"isFiles":{"type":"boolean","readOnly":true},"isAMAS":{"type":"boolean","readOnly":true},"isRFQ":{"type":"boolean","readOnly":true},"isRFQQuoting":{"type":"boolean","readOnly":true},"isFilesPlusRFQQuoting":{"type":"boolean","readOnly":true},"isPrivateKuaguCompany":{"type":"boolean","readOnly":true},"isKuaguBuyer":{"type":"boolean","readOnly":true},"isKuaguVendor":{"type":"boolean","readOnly":true},"isExtrusion":{"type":"boolean","readOnly":true},"isInvalid":{"type":"boolean","readOnly":true},"hasValidatedAdmin":{"type":"boolean","readOnly":true},"isValidStatusStr":{"type":"string","nullable":true,"readOnly":true},"hasBeenValidated":{"type":"boolean","readOnly":true},"hasBeenInValidated":{"type":"boolean","readOnly":true},"type":{"type":"integer","format":"int32"}},"additionalProperties":false},"Currency":{"enum":[0,1,2,3],"type":"integer","format":"int32"},"FileAttribute":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"unit":{"type":"string","nullable":true},"isCustom":{"type":"boolean"},"value":{"type":"string","nullable":true},"timestamp":{"type":"string","format":"date-time","nullable":true},"namePlusUnit":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"FileCountDto":{"type":"object","properties":{"Doc":{"type":"integer","format":"int32"},"2D":{"type":"integer","format":"int32"},"3D":{"type":"integer","format":"int32"},"Photo":{"type":"integer","format":"int32"},"Total":{"type":"integer","format":"int32"}},"additionalProperties":false},"FileMap":{"type":"object","properties":{"uid":{"type":"string","nullable":true},"isInputFile":{"type":"boolean","readOnly":true},"extension":{"type":"string","nullable":true,"readOnly":true},"viewerFile":{"type":"string","nullable":true,"readOnly":true},"vizSpaceID":{"type":"string","nullable":true},"pureRelativeFileName":{"type":"string","nullable":true},"fileName":{"type":"string","nullable":true,"readOnly":true},"displayName":{"type":"string","nullable":true,"readOnly":true},"link":{"type":"string","nullable":true,"readOnly":true},"thumbNailURL":{"type":"string","nullable":true,"readOnly":true},"publicURL":{"type":"string","nullable":true,"readOnly":true},"detailsURL":{"type":"string","nullable":true,"readOnly":true},"pdfUrl":{"type":"string","nullable":true},"unstructuredText":{"type":"string","nullable":true},"attributes":{"type":"array","items":{"type":"string"},"nullable":true},"extractedAttributes":{"type":"array","items":{"type":"string"},"nullable":true},"relativeFileName":{"type":"string","nullable":true,"readOnly":true},"absFileName":{"type":"string","nullable":true,"readOnly":true},"thumbNailURLFromID":{"type":"string","nullable":true,"readOnly":true},"hasThumbnail":{"type":"boolean","readOnly":true},"indexingFinished":{"type":"boolean","readOnly":true},"indexingFailed":{"type":"boolean","readOnly":true},"pngurlFromID":{"type":"string","nullable":true,"readOnly":true},"lgFiles":{"type":"array","items":{"$ref":"#/components/schemas/StringStringTuple"},"nullable":true},"smFiles":{"type":"array","items":{"$ref":"#/components/schemas/StringStringTuple"},"nullable":true},"userInputThumbnails":{"type":"array","items":{"type":"string"},"nullable":true},"pngHTML":{"type":"string","nullable":true,"readOnly":true},"fileType":{"type":"integer","format":"int32"},"categoryID":{"type":"integer","format":"int32"},"fileTypeName":{"type":"string","nullable":true,"readOnly":true},"userVizSpaceHTML":{"type":"string","nullable":true,"readOnly":true},"is3D":{"type":"boolean","readOnly":true},"is2D":{"type":"boolean","readOnly":true},"isImage":{"type":"boolean","readOnly":true},"isLocallyIndexed":{"type":"boolean","readOnly":true},"canEdit":{"type":"boolean","readOnly":true},"rmIfDup":{"type":"boolean"},"locationId":{"type":"integer","format":"int32","nullable":true},"priorityLevel":{"type":"integer","format":"int32"},"mD5Hash":{"type":"string","nullable":true},"syncResourceId":{"type":"string","nullable":true},"syncResourcePath":{"type":"string","nullable":true},"currentShapelet":{"type":"string","nullable":true},"originalPath":{"type":"string","nullable":true},"item2":{"type":"integer","format":"int32"},"entityId":{"type":"string","nullable":true},"viewerURL":{"type":"string","nullable":true,"readOnly":true},"assemblyParents":{"type":"array","items":{"$ref":"#/components/schemas/AssemblyItem"},"nullable":true},"assemblyChildren":{"type":"array","items":{"$ref":"#/components/schemas/AssemblyItem"},"nullable":true},"dateAdded":{"type":"string","format":"date-time"},"userVizSpaceID":{"type":"string","nullable":true},"shapelets":{"type":"array","items":{"$ref":"#/components/schemas/Shapelet"},"nullable":true},"traceFileContent":{"type":"string","nullable":true},"pngFileWidth":{"type":"string","nullable":true},"pngFileHeight":{"type":"string","nullable":true},"rawContent":{"type":"string","format":"byte","nullable":true}},"additionalProperties":false},"Filter":{"type":"object","properties":{"filterType":{"$ref":"#/components/schemas/ResultFilterTypes"},"queryString":{"type":"string","nullable":true},"value":{"nullable":true},"label":{"type":"string","nullable":true},"labelWithoutColon":{"type":"string","nullable":true,"readOnly":true},"helpText":{"type":"string","nullable":true},"filterValues":{"type":"array","items":{"$ref":"#/components/schemas/ResultFilter"},"nullable":true}},"additionalProperties":false},"MonthlyUsageResponse":{"type":"object","properties":{"billingPeriod":{"type":"string","nullable":true},"filePlanLimit":{"type":"integer","format":"int32"},"remainingFiles":{"type":"integer","format":"int32"},"fileCount":{"$ref":"#/components/schemas/FileCountDto"},"tokenPlanLimit":{"type":"integer","format":"int32"},"remainingTokens":{"type":"number","format":"double"},"tokenUsage":{"$ref":"#/components/schemas/TokenUsageDto"}},"additionalProperties":false},"PMIData":{"type":"object","properties":{"pmi":{"type":"string","nullable":true},"unstructuredText":{"type":"string","nullable":true},"extractedAttributes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"ProductCategory":{"type":"object","properties":{"name":{"type":"string","nullable":true},"nameZH":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"rasterSearchMethod":{"type":"integer","format":"int32"},"vectorSearchMethod":{"type":"integer","format":"int32"},"imageAsDrawing":{"type":"integer","format":"int32"},"parent":{"$ref":"#/components/schemas/ProductCategory"},"usageCount":{"type":"integer","format":"int32"},"fullName":{"type":"string","nullable":true,"readOnly":true},"fullNameZH":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"RFQ":{"type":"object","properties":{"id":{"type":"string","nullable":true},"userId":{"type":"string","nullable":true},"companyId":{"type":"string","nullable":true},"searchFileId":{"type":"string","nullable":true},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/RFQStatus"},"statusName":{"type":"string","nullable":true},"totalPrice":{"type":"number","format":"double"},"emailSubject":{"type":"string","nullable":true},"senderName":{"type":"string","nullable":true},"senderEmail":{"type":"string","nullable":true},"fromEmail":{"type":"string","nullable":true},"recipients":{"type":"string","nullable":true},"otherEmails":{"type":"string","nullable":true},"ab":{"type":"string","nullable":true},"shippingInstructions":{"type":"string","nullable":true},"specialInstructions":{"type":"string","nullable":true},"codeBlue":{"type":"boolean"},"baseFileName":{"type":"string","nullable":true},"unmatchedFiles":{"type":"string","nullable":true},"unmatchedAttachments":{"type":"array","items":{"$ref":"#/components/schemas/RFQAttachment"},"nullable":true},"otherBaseAttachments":{"type":"array","items":{"$ref":"#/components/schemas/RFQAttachment"},"nullable":true},"otherBaseFiles":{"type":"string","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/RFQLine"},"nullable":true},"sentOn":{"type":"string","nullable":true},"header":{"type":"string","nullable":true},"customQuoteId":{"type":"string","nullable":true},"numComponents":{"type":"integer","format":"int32","nullable":true},"numFilesRemaining":{"type":"integer","format":"int32"},"usesVisualSearch":{"type":"boolean"},"userName":{"type":"string","nullable":true},"baseFileUrl":{"type":"string","nullable":true},"baseFileThumbnailUrl":{"type":"string","nullable":true},"baseFileViewerUrl":{"type":"string","nullable":true},"customReply":{"type":"string","nullable":true},"serviceSkip":{"type":"boolean"},"contextVID":{"type":"string","nullable":true},"autoId":{"type":"integer","format":"int32","nullable":true},"failedComponents":{"type":"string","nullable":true},"indexingError":{"type":"string","nullable":true},"importance":{"type":"string","nullable":true},"priority":{"type":"string","nullable":true},"qt":{"type":"string","nullable":true},"so":{"type":"string","nullable":true},"distributor":{"type":"string","nullable":true},"distributorContact":{"type":"string","nullable":true},"distributorPhone":{"type":"string","nullable":true},"distributorEmail":{"type":"string","nullable":true},"engContact":{"type":"string","nullable":true},"customerPhone":{"type":"string","nullable":true},"unstructuredContent":{"type":"string","nullable":true},"referenceRFQ":{"type":"string","nullable":true}},"additionalProperties":false},"RFQAttachment":{"type":"object","properties":{"fid":{"type":"string","nullable":true},"fileName":{"type":"string","nullable":true},"fileType":{"type":"integer","format":"int32"},"thumbNailURL":{"type":"string","nullable":true},"publicURL":{"type":"string","nullable":true},"viewerURL":{"type":"string","nullable":true},"otherBaseViewerURL":{"type":"string","nullable":true}},"additionalProperties":false},"RFQLine":{"type":"object","properties":{"lineNumber":{"type":"string","nullable":true},"rfqId":{"type":"string","nullable":true},"selectedFID":{"type":"string","nullable":true},"inputText":{"type":"string","nullable":true},"inputVolume":{"type":"number","format":"double","nullable":true},"inputArea":{"type":"number","format":"double","nullable":true},"inputBBVolume":{"type":"number","format":"double","nullable":true},"inputUnits":{"type":"string","nullable":true},"inputSmallDim":{"type":"number","format":"double","nullable":true},"inputMediumDim":{"type":"number","format":"double","nullable":true},"inputLargeDim":{"type":"number","format":"double","nullable":true},"quantity":{"type":"integer","format":"int32"},"manualPrice":{"type":"string","nullable":true},"manualSku":{"type":"string","nullable":true},"sq":{"type":"string","nullable":true},"initialCategories":{"type":"array","items":{"type":"string"},"nullable":true},"category":{"type":"string","nullable":true},"line":{"type":"string","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/RFQSearchResult"},"nullable":true},"crawlResults":{"type":"array","items":{"$ref":"#/components/schemas/RFQSearchResult"},"nullable":true},"inputFID":{"type":"string","nullable":true},"fields":{"type":"string","nullable":true},"originalLine":{"type":"string","nullable":true},"selection":{"type":"integer","format":"int32","nullable":true},"anyBBVolDiffZero":{"type":"boolean"},"exactMatchFID":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"inputFilename":{"type":"string","nullable":true},"findSimilarFID":{"type":"string","nullable":true},"inputThumbnailUrl":{"type":"string","nullable":true},"inputViewerUrl":{"type":"string","nullable":true},"componentUrl":{"type":"string","nullable":true},"selectedVariationFID":{"type":"string","nullable":true},"selectedShapelets":{"type":"string","nullable":true},"selectedAssyFIDs":{"type":"string","nullable":true},"inputFIDs":{"type":"array","items":{"type":"string"},"nullable":true},"previousReferenceItemNumber":{"type":"string","nullable":true},"qt":{"type":"string","nullable":true},"so":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/RFQAttachment"},"nullable":true},"tempFiles":{"type":"array","items":{"type":"string"},"nullable":true},"fileHash":{"type":"string","nullable":true},"fieldsText":{"type":"string","nullable":true},"formattedFields":{"type":"array","items":{"$ref":"#/components/schemas/StringStringStringTuple"},"nullable":true}},"additionalProperties":false},"RFQSearchResult":{"type":"object","properties":{"fid":{"type":"string","nullable":true},"score":{"type":"string","nullable":true},"deficit":{"type":"number","format":"double","nullable":true},"category":{"type":"string","nullable":true},"fileName":{"type":"string","nullable":true},"fileType":{"type":"string","nullable":true},"price":{"type":"number","format":"double","nullable":true},"lineQty":{"type":"integer","format":"int32","nullable":true},"url":{"type":"string","nullable":true},"attributes":{"type":"array","items":{"type":"string"},"nullable":true},"index":{"type":"integer","format":"int32"},"thumbnailUrl":{"type":"string","nullable":true},"viewerUrl":{"type":"string","nullable":true},"overlayUrl":{"type":"string","nullable":true},"nVars":{"type":"integer","format":"int32","nullable":true},"nComponents":{"type":"integer","format":"int32","nullable":true},"primaryVarFid":{"type":"string","nullable":true},"partNumber":{"type":"string","nullable":true},"partName":{"type":"string","nullable":true},"material":{"type":"string","nullable":true},"_isBBoxMatch":{"type":"boolean"}},"additionalProperties":false},"RFQStatus":{"enum":[0,1,2,3,4,5,6,7,8,9,10,11,-5,-4,-3,-2,-1],"type":"integer","format":"int32"},"ResultFilter":{"type":"object","properties":{"value":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"count":{"type":"integer","format":"int32"},"index":{"type":"integer","format":"int32"},"arg":{"nullable":true}},"additionalProperties":false},"ResultFilterTypes":{"enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52],"type":"integer","format":"int32"},"SavedSearch":{"type":"object","properties":{"id":{"type":"string","nullable":true},"userID":{"type":"string","nullable":true},"searchVID":{"type":"string","nullable":true},"queryStr":{"type":"string","nullable":true},"timeStamp":{"type":"string","format":"date-time"},"name":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/SearchType"},"url":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false},"SearchResult":{"type":"object","properties":{"resultID":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"fid":{"type":"string","nullable":true},"objectType":{"type":"string","nullable":true}},"additionalProperties":false},"SearchResultSummary":{"type":"object","properties":{"resultsList":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"},"nullable":true},"rfqLines":{"type":"array","items":{"$ref":"#/components/schemas/RFQLine"},"nullable":true},"totalResults":{"type":"integer","format":"int32"},"currentCategory":{"$ref":"#/components/schemas/ProductCategory"},"additionalCategories":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategory"},"nullable":true},"totalPages":{"type":"integer","format":"int32","readOnly":true},"timeSpan":{"type":"integer","format":"int32"},"searchTime":{"$ref":"#/components/schemas/TimeSpan"},"inputFileUID":{"type":"string","nullable":true},"inputVolume":{"type":"number","format":"double"},"inputBBVolume":{"type":"number","format":"double"},"inputSurfaceArea":{"type":"number","format":"double"},"inputShapeSizes":{"type":"array","items":{"$ref":"#/components/schemas/ShapeSizeMatch"},"nullable":true},"inputUnits":{"type":"string","nullable":true},"inputThumbnail":{"type":"string","nullable":true},"contourPoints":{"type":"string","nullable":true},"customReply":{"type":"string","nullable":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategorySearchResult"},"nullable":true},"searchFilters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"},"nullable":true},"returnedFields":{"$ref":"#/components/schemas/SearchReturnedFields"},"message":{"type":"string","nullable":true},"returnedObjects":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"SearchReturnedFields":{"enum":[0,1,2,4,8,16,32,64,128,256,512,1024,2048,4096,8192],"type":"integer","format":"int32"},"SearchType":{"enum":[0,1,2,4,6,11],"type":"integer","format":"int32"},"ShapeSizeMatch":{"type":"object","properties":{"matchView":{"type":"string","nullable":true},"size":{"type":"number","format":"double"}},"additionalProperties":false},"Shapelet":{"type":"object","properties":{"src":{"type":"string","nullable":true},"index":{"type":"string","nullable":true},"loc":{"type":"string","nullable":true}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"StringStringStringTuple":{"type":"object","properties":{"item1":{"type":"string","nullable":true},"item2":{"type":"string","nullable":true},"item3":{"type":"string","nullable":true}},"additionalProperties":false},"StringStringTuple":{"type":"object","properties":{"item1":{"type":"string","nullable":true},"item2":{"type":"string","nullable":true}},"additionalProperties":false},"TimeSpan":{"type":"object","properties":{"ticks":{"type":"integer","format":"int64"},"days":{"type":"integer","format":"int32","readOnly":true},"hours":{"type":"integer","format":"int32","readOnly":true},"milliseconds":{"type":"integer","format":"int32","readOnly":true},"minutes":{"type":"integer","format":"int32","readOnly":true},"seconds":{"type":"integer","format":"int32","readOnly":true},"totalDays":{"type":"number","format":"double","readOnly":true},"totalHours":{"type":"number","format":"double","readOnly":true},"totalMilliseconds":{"type":"number","format":"double","readOnly":true},"totalMinutes":{"type":"number","format":"double","readOnly":true},"totalSeconds":{"type":"number","format":"double","readOnly":true}},"additionalProperties":false},"TokenUsageDto":{"type":"object","properties":{"tokenFileIndex":{"type":"number","format":"double"},"tokenTableIndex":{"type":"number","format":"double"},"tokenStorage":{"type":"number","format":"double"},"tokenVSearch":{"type":"number","format":"double"},"tokenTSearch":{"type":"number","format":"double"},"tokenRAG":{"type":"number","format":"double"},"tokenCompare":{"type":"number","format":"double"},"token2DPMI":{"type":"number","format":"double"},"token3DConvert":{"type":"number","format":"double"},"total":{"type":"number","format":"double"}},"additionalProperties":false},"UserProfile":{"type":"object","properties":{"companyURL":{"type":"string","nullable":true},"companyVizSpaceID":{"type":"string","nullable":true},"usesAutoClassify":{"type":"boolean"},"usesDeepLearning":{"type":"boolean"},"companyContentType":{"type":"integer","format":"int32"},"vizSpaceID":{"type":"string","nullable":true},"companyName":{"type":"string","nullable":true},"emailID":{"type":"string","nullable":true},"password":{"type":"string","nullable":true},"openIDUrl":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"continueURL":{"type":"string","nullable":true},"registrationStatus":{"type":"integer","format":"int32"},"loginStatus":{"type":"integer","format":"int32"},"validationCode":{"type":"integer","format":"int32"},"iCode":{"type":"string","nullable":true},"registrationStartDate":{"type":"string","format":"date-time"},"isValid":{"type":"boolean"},"registrationCompleteDate":{"type":"string","format":"date-time"},"logo":{"type":"string","nullable":true},"companyLogoURL":{"type":"string","nullable":true},"optedOutOfImageCrop":{"type":"boolean"},"locationId":{"type":"integer","format":"int32"},"serverURL":{"type":"string","nullable":true}},"additionalProperties":false}}}}