import { useState, useEffect } from 'react'; export const TRYIT_CONFIGS = {"transform-your-first-vehicle-1":{"title":"Transform a vehicle","method":"POST","url":"https://api.spyne.ai/api/pv1/merchandise/process","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"],["Rate limit","200 requests / min"],["Processing","Asynchronous"]],"fields":[{"path":"vin","required":false,"desc":"VIN is the unique 17-character alphanumeric identifier of a vehicle. If the VIN is not available, you can use the Stock Number or Registration Number as alternate identifiers.…","kind":"string","value":"1HGCM82633A004352"},{"path":"stockNumber","required":false,"desc":"A dealer's internal identifier for inventory tracking","kind":"string","value":""},{"path":"registrationNumber","required":false,"desc":"The vehicle's official registration number used for identification","kind":"string","value":""},{"path":"dealerId","required":false,"desc":"Deprecated and ignored. This field is accepted for backward compatibility but has no effect on processing. The team the vehicle is processed under is always taken from the…","kind":"string","value":""},{"path":"media","required":true,"desc":"The media parameter specifies the types of media to be processed. Each parameter is a boolean (true or false), indicating whether the corresponding media type should be…","kind":"group"},{"path":"media.image","required":false,"desc":"Set to true to process the vehicle images into a studio-ready format","kind":"boolean","value":"true"},{"path":"media.spin","required":false,"desc":"Set to true to create a 360° spin for the vehicle","kind":"boolean","value":"true"},{"path":"media.featureVideo","required":false,"desc":"Set to true to generate a feature video highlighting key vehicle details","kind":"boolean","value":""},{"path":"media.mediaKit","required":false,"desc":"Set to true to generate media kit assets for the vehicle","kind":"boolean","value":""},{"path":"mediaInput","required":true,"desc":"The mediaInput parameter contains an array of URLs for either images, videos, or both, which are to be processed.","kind":"group"},{"path":"mediaInput.imageData","required":false,"desc":"An array of URLs pointing to the images to be processed for studio-ready outputs.","kind":"items","sub":[{"key":"url","kind":"string","enum":null,"desc":"URL of the Images or Videos"},{"key":"clientMetaData","kind":"json","enum":null,"desc":"Opaque per-image metadata. Stored against the asset and echoed back unchanged on Retrieve Media. Spyne does not interpret these keys."}],"rows":[{"url":"https://cdn.example.com/veh/front.jpg","clientMetaData":"{\"position\": \"front\"}"},{"url":"https://cdn.example.com/veh/rear.jpg"}]},{"path":"mediaInput.videoData","required":false,"desc":"An array of URLs pointing to videos, primarily used for generating 360° spins or feature videos. Only url is read; any other keys are ignored.","kind":"items","sub":[{"key":"url","kind":"string","enum":null,"desc":"Publicly reachable source video URL."}],"rows":[{}]},{"path":"processingDetails","required":true,"desc":"The processingDetails parameter specifies additional configurations and customizations for processing the media. This includes details like logos, templates, and…","kind":"group"},{"path":"processingDetails.numberPlateLogo","required":false,"desc":"It specifies the treatment for the vehicle’s number plate. You can also Pass 0 for no number plate masking, 1 for a plain white masking, or a URL to use a custom number plate…","kind":"string","value":"1"},{"path":"processingDetails.backgroundId","required":false,"desc":"Identifier for the background to composite behind the vehicle. This ID is created by the Spyne team. Note: this is not optional in practice — a request submitted without it is…","kind":"string","hint":"75282","value":"75282"},{"path":"processingDetails.image","required":false,"desc":"Configurations to generate a catalog-ready images of the vehicle.","kind":"group"},{"path":"processingDetails.image.catalogCount","required":false,"desc":"The number of catalog images to generate. Defaults to 8 when omitted. Note: this is only needed when a video input is provided; for image input it can be left blank.","kind":"integer","hint":"8","value":"12"},{"path":"processingDetails.spin","required":false,"desc":"Configurations to generate a 360-spin of the vehicle","kind":"group"},{"path":"processingDetails.spin.hotspot","required":false,"desc":"Set to true to detect and include interactive hotspots on the spin. Defaults to false when omitted.","kind":"boolean","hint":"false","value":"true"},{"path":"processingDetails.spin.spinFrameCount","required":false,"desc":"Number of frames to be used in the 360° spin generation. The accepted values are 36 or 72.","kind":"enum","hint":"36","enum":["36","72"],"value":"36"},{"path":"processingDetails.featureVideo","required":false,"desc":"Configurations to generate a feature Video.","kind":"group"},{"path":"processingDetails.featureVideo.templateId","required":false,"desc":"Identifier for the video template used to generate the feature video. This ID is provided by the Spyne team; there is no default.","kind":"string","value":""},{"path":"processingDetails.featureVideo.musicId","required":false,"desc":"Identifier for the background music to include in the video. This ID is provided by the Spyne team; there is no default.","kind":"string","value":""},{"path":"processingDetails.featureVideo.voiceId","required":false,"desc":"Identifier for the voice-over added to the video. This ID is provided by the Spyne team; there is no default.","kind":"string","value":""},{"path":"processingDetails.featureVideo.language","required":false,"desc":"Language used for the generated voice-over script. Defaults to english when omitted.","kind":"string","hint":"english","value":""},{"path":"processingDetails.featureVideo.targetLanguage","required":false,"desc":"Output language code for the voice-over. Defaults to en when omitted.","kind":"string","hint":"en","value":""},{"path":"processingDetails.featureVideo.font","required":false,"desc":"Font used for on-screen text, with text and key properties. Defaults to Montserrat for both when omitted.","kind":"group"},{"path":"processingDetails.featureVideo.font.text","required":false,"desc":"","kind":"string","hint":"Montserrat","value":""},{"path":"processingDetails.featureVideo.font.key","required":false,"desc":"","kind":"string","hint":"Montserrat","value":""},{"path":"processingDetails.featureVideo.themeColors","required":false,"desc":"Theme colours applied to the video, with a primaryColor property. Defaults to #ffca13 when omitted.","kind":"group"},{"path":"processingDetails.featureVideo.themeColors.primaryColor","required":false,"desc":"","kind":"string","hint":"#ffca13","value":""},{"path":"vinMetaData","required":false,"desc":"Free-form vehicle attributes such as make, model, year, engine, interior and exterior details. Stored against the vehicle record and not interpreted by processing.","kind":"json","value":"{\n \"make\": \"Honda\",\n \"model\": \"Accord\",\n \"year\": \"2020\"\n}"},{"path":"clientMetaData","required":false,"desc":"Opaque request-level metadata. Stored against the record and echoed back on Retrieve Media. Spyne does not interpret these keys.","kind":"json","value":"{\n \"dmsRef\": \"RO-88213\"\n}"},{"path":"mediaKitConfig","required":false,"desc":"Media kit overrides. Note: supplying banner or billboard is rejected with 400 if the enterprise and team have a smart campaign in ACTIVE, PAUSED or SCHEDULED state, because a…","kind":"group"},{"path":"mediaKitConfig.banner","required":false,"desc":"","kind":"json","value":""},{"path":"mediaKitConfig.billboard","required":false,"desc":"","kind":"json","value":""}]},"retrive-transformed-vehicle":{"title":"Retrieve a vehicle","method":"GET","url":"https://api.spyne.ai/api/pv1/merchandise","params":[{"name":"dealerVinId","in":"query","required":false,"value":"","desc":"Spyne's record identifier, returned by the processing request. When supplied, the other identifiers are ignored."},{"name":"vin","in":"query","required":false,"value":"","desc":"The vehicle's 17-character alphanumeric VIN."},{"name":"stockNumber","in":"query","required":false,"value":"","desc":"The dealer's internal inventory identifier."},{"name":"registrationNumber","in":"query","required":false,"value":"","desc":"The vehicle's official registration number."},{"name":"teamId","in":"query","required":false,"value":"","desc":"Team the lookup is scoped to. If omitted, the team from the authenticated API credential is used. Note: a supplied teamId takes precedence over the credential's team."}],"contentType":null,"meta":[["Auth","Bearer token"],["Same shape as","Webhook payload"]]},"retrieve-rooftops":{"title":"Retrieve Rooftops","method":"GET","url":"https://api.spyne.ai/api/pv1/enterprise/get-teams","params":[{"name":"enterprise_id","in":"query","required":true,"value":"","desc":"The enterprise whose teams should be listed. Note: this value is not checked against the authenticated credential's enterprise."}],"contentType":null,"meta":[["Auth","Bearer token"]]},"retrieve-inventory":{"title":"Retrieve Inventory","method":"GET","url":"https://api.spyne.ai/api/pv1/enterprise/v2","params":[{"name":"enterprise_id","in":"query","required":true,"value":"","desc":"The enterprise to list inventory for."},{"name":"team_id","in":"query","required":true,"value":"","desc":"The team (rooftop) to list inventory for. Must belong to the enterprise, or the request is rejected with 400."},{"name":"page","in":"query","required":true,"value":"1","desc":"1-based page number."},{"name":"per_page","in":"query","required":true,"value":"20","desc":"Number of records per page."},{"name":"sort_by","in":"query","required":false,"value":"{\"creation_epoch\":\"desc\"}","desc":"Sort order, as {creation_epoch: asc} or {creation_epoch: desc}. Note: creation_epoch is the only supported sort key."},{"name":"created_at","in":"query","required":false,"value":"{\"from\":\"2026-01-01\",\"to\":\"2026-03-01\"}","desc":"Creation-date window, as {from: YYYY-MM-DD, to: YYYY-MM-DD}. Both keys are required when this parameter is used. Note: there is a known issue where the two bounds are applied…"},{"name":"updated_at","in":"query","required":false,"value":"{\"from\":\"2026-01-01\",\"to\":\"2026-03-01\"}","desc":"Update-date window, as {from: YYYY-MM-DD, to: YYYY-MM-DD}. Both keys are required when supplied. Note: there is a known issue where the two bounds are applied in reverse, so a…"},{"name":"is_sold","in":"query","required":false,"value":"","desc":"Restrict the list to sold (true) or unsold (false) vehicles. Omit to include both."}],"contentType":null,"meta":[["Auth","Bearer token"]]},"v1-classify-images":{"title":"Classify Images","method":"POST","url":"https://api.spyne.ai/auto/classify/v1/image","params":[],"contentType":"multipart/form-data","meta":[["Auth","Bearer token"]],"fields":[{"path":"image_file","required":false,"desc":"Upload an image to classify and validate","kind":"string","value":""},{"path":"image_url","required":false,"desc":"URL of an image to classify and validate","kind":"string","hint":"https://spyne-prod-tech.s3.amazonaws.com/fGD1VC1So/TJgk9lIE/02d374d9674c4d5abb730485cb6d8380/75a6d8bf7a77457c/images/input/hres_I2IXTXOCWE_75a6d8bf7a77457c_Exterior_1.jpg","value":"https://spyne-prod-tech.s3.amazonaws.com/fGD1VC1So/TJgk9lIE/02d374d9674c4d5abb730485cb6d8380/75a6d8bf7a77457c/images/input/hres_I2IXTXOCWE_75a6d8bf7a77457c_Exterior_1.jpg"},{"path":"car_classifier","required":false,"desc":"Identifies if a car is present in the image Expected response: true / false","kind":"boolean","hint":"true","value":"true"},{"path":"car_type_classifier","required":false,"desc":"Identifies the type of car present in the image Expected response: SUV / Sedane / Hatchback / Pickup / Sports","kind":"boolean","hint":"true","value":"true"},{"path":"car_shoot_category","required":false,"desc":"Identifies the shoot category of car Expected response: Exterior/ Interior/ Miscellaneous -- Exterior refers to the detection of the outside of the car -- Interior refers to…","kind":"boolean","hint":"true","value":"true"},{"path":"car_interior_category","required":false,"desc":"Identifies the interior car component captured in the image Expected response: Dashboard / Odometer / Gearbox","kind":"boolean","hint":"true","value":"true"},{"path":"angle_detection","required":false,"desc":"Measures the angle of the car in the image relative to its front view (0°) Minimum value: 0° Maximum value: 359°","kind":"boolean","hint":"true","value":"true"},{"path":"crop_detection","required":false,"desc":"Determines if the car in the image has been cropped Expected response: true / false","kind":"boolean","hint":"true","value":"true"},{"path":"distance_detection","required":false,"desc":"Determines if the car was captured from far away Expected response: good / bad","kind":"boolean","hint":"true","value":"true"},{"path":"exposure_detection","required":false,"desc":"Determines if the car was captured in poor lighting conditions Expected reponse: low / med / high -- low refers to when the car is in a dimly lit environment -- high refers to…","kind":"boolean","hint":"true","value":"true"},{"path":"reflection_detection","required":false,"desc":"Recognizes the presence of reflections on the car body Expected reponse: true / false","kind":"boolean","hint":"true","value":"true"},{"path":"tilt_detection","required":false,"desc":"Identifies the tilt of the car in the image relative to the ground Minimum value: 0° Maximum value: 45°","kind":"boolean","hint":"true","value":"true"},{"path":"window_tint_detection","required":false,"desc":"Recognizes the presence of tinted windows on the car in the image Expected reponse: true / false","kind":"boolean","hint":"true","value":"true"},{"path":"tyre_mud_detection","required":false,"desc":"Recognizes if mud is present on the tires of the car in the image Expected reponse: clean / dirty && dirty tyre: {count}, clean tyre: {count}","kind":"boolean","hint":"true","value":"true"},{"path":"number_plate_detection","required":false,"desc":"Determines the presence of license plate on the car in the image Expected reponse: true / false","kind":"boolean","hint":"true","value":"true"}]},"v1-transform-images":{"title":"Transform Images","method":"POST","url":"https://api.spyne.ai/api/pv1/image/replace-bg","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"]],"fields":[{"path":"auth_key","required":true,"desc":"The authentication key of the user","kind":"string","value":""},{"path":"sku_name","required":true,"desc":"The name of sku you are processing","kind":"string","value":""},{"path":"category_id","required":true,"desc":"The type of images to be processed, can be one of the following, “Automobile”, “Food”, E-commerce","kind":"string","hint":"Automobile","value":"Automobile"},{"path":"image_data","required":true,"desc":"An array object containing batches of images to process","kind":"items","sub":[{"key":"category","kind":"string","enum":null,"desc":"Our AI Models will automatically detect the image as Exterior, Interior, Miscellaneous"},{"key":"image_urls","kind":"json","enum":null,"desc":"Provide the URL of the image to be processed. You can add multiple images by clicking on the + sign"},{"key":"image_meta_data","kind":"json","enum":null,"desc":"Optional information at an individual images level that will be returned in the response"}],"rows":[{"category":"Unclassified","image_urls":"[]","image_meta_data":"{}"}]},{"path":"background_type","required":true,"desc":"This attribute is deprecated, please use legacy at all times","kind":"string","hint":"legacy","value":"legacy"},{"path":"background","required":true,"desc":"The ID of the new background which would be placed into the image, you can get these from your Spyne POC or from Darkroom","kind":"string","hint":"923","value":"923"},{"path":"number_plate_logo","required":false,"desc":"Put 0 for no number plate masking, 1 for white number plate masking or a URL in 5:1 aspect ratio to mask the number plate with specific image","kind":"string","value":""},{"path":"sku_meta_data","required":false,"desc":"Optional JSON data which will be sent back in the response","kind":"json","value":""}]},"v1-get-images":{"title":"GET Images","method":"GET","url":"https://api.spyne.ai/api/pv1/sku/get-ready-images/v2/","params":[{"name":"auth_key","in":"query","required":false,"value":"","desc":"The authentication key of the user"},{"name":"sku_id","in":"query","required":false,"value":"b5479027","desc":"The ID of the sku to be fetched"}],"contentType":null,"meta":[["Auth","Bearer token"]]},"v1-video-validation":{"title":"Video Validation","method":"POST","url":"https://api.spyne.ai/360/v1/validate-video","params":[],"contentType":"application/x-www-form-urlencoded","meta":[["Auth","Bearer token"]],"fields":[{"path":"video_url","required":false,"desc":"The URL of the video to be validated.","kind":"string","hint":"https://spyne.s3.amazonaws.com/3a7c183f5/1c1997c1/3f667484f53f42feb42f98b9ecdc2315/4e0a1300add14ca094e01da1d72a4702/video/8AE09B55-FAF8-4211-95C3-CD5F472CB15C.mp4","value":"https://spyne.s3.amazonaws.com/3a7c183f5/1c1997c1/3f667484f53f42feb42f98b9ecdc2315/4e0a1300add14ca094e01da1d72a4702/video/8AE09B55-FAF8-4211-95C3-CD5F472CB15C.mp4"}]},"v1-3d-360-spin":{"title":"3D 360-Spin","method":"POST","url":"https://api.spyne.ai/360/v1/3d","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"]],"fields":[{"path":"videoUrl","required":false,"desc":"The URL of the video to be processed.","kind":"string","hint":"https://spyne.s3.amazonaws.com/multipartUpload/d4b845bb5/Maya/de47221eea1c4e5a8444824cf8da4d01/4f2bb68016684225b0cfe3783b0794f7/video/9D6B40EE-B6D0-43B7-BDE2-351DC881C8DE.mp4","value":"https://spyne.s3.amazonaws.com/multipartUpload/d4b845bb5/Maya/de47221eea1c4e5a8444824cf8da4d01/4f2bb68016684225b0cfe3783b0794f7/video/9D6B40EE-B6D0-43B7-BDE2-351DC881C8DE.mp4"},{"path":"vin_name","required":false,"desc":"VIN name associated with the video.","kind":"string","hint":"5NPE34AB6FH087111","value":"5NPE34AB6FH087111"},{"path":"backgroundId","required":false,"desc":"Spyne Studio-type Background ID.","kind":"string","hint":"36242","value":"36242"},{"path":"generatePhotos","required":false,"desc":"Generate 8-12 Exterior Photos from Video in Studio-type Backgrounds.","kind":"group"},{"path":"generatePhotos.catalogCount","required":false,"desc":"This property only accepts 8 OR 12 as an input value.","kind":"integer","hint":"8","value":"8"},{"path":"exteriorFrameCount","required":false,"desc":"Number of frames in the exterior spin.","kind":"integer","hint":"36","value":"36"},{"path":"interior360Image","required":false,"desc":"URL to the 360 interior image.","kind":"string","hint":"https://spyne-prod-tech.s3.amazonaws.com/b7982f335/ca62c156/1a3a21e8e8e14c27a7d880f47cec1989/ec18a6194b0e4cf8a984488e7a91fa54/images/input/hres__ec18a6194b0e4cf8a984488e7a91fa54_360int_2.jpeg","value":"https://spyne-prod-tech.s3.amazonaws.com/b7982f335/ca62c156/1a3a21e8e8e14c27a7d880f47cec1989/ec18a6194b0e4cf8a984488e7a91fa54/images/input/hres__ec18a6194b0e4cf8a984488e7a91fa54_360int_2.jpeg"},{"path":"licensePlateUrl","required":false,"desc":"URL to the license plate image.","kind":"string","hint":"https://spyne-test.s3.amazonaws.com/alm%20leasing%20%26%20rentals_18e2d9d0_2024-03-20_17-48-58%20copy.png","value":"https://spyne-test.s3.amazonaws.com/alm%20leasing%20%26%20rentals_18e2d9d0_2024-03-20_17-48-58%20copy.png"},{"path":"meta_data","required":false,"desc":"Additional metadata associated with the request. Must be a JSON object, and users can freely add key-value strings.","kind":"json","value":"{\n \"userDefinedKey1\": \"userDefinedValue1\",\n \"userDefinedKey2\": \"userDefinedValue2\"\n}"}]},"v1-response-360-spin":{"title":"Response 360-Spin","method":"GET","url":"https://api.spyne.ai/360/v1/response","params":[{"name":"sku_name","in":"query","required":false,"value":"3GNAXHEG0SL141295","desc":"SKU name of the vehicle."},{"name":"sku_id","in":"query","required":false,"value":"1728d62489e749fe8a8c6bf1c3bd5236","desc":"SKU ID of the vehicle. Only one of sku_id or sku_name should be present in a request."}],"contentType":null,"meta":[["Auth","Bearer token"]]},"v1-video-generation":{"title":"Video Generation","method":"POST","url":"https://api.spyne.ai/api/pv1/video/process-video","params":[{"name":"template","in":"query","required":false,"value":"","desc":""},{"name":"voice","in":"query","required":false,"value":"","desc":""},{"name":"background_music","in":"query","required":false,"value":"","desc":""},{"name":"vehicle_data","in":"query","required":false,"value":"","desc":""}],"contentType":null,"meta":[["Auth","Bearer token"]]},"v1-response-videos":{"title":"Response Videos","method":"GET","url":"https://api.spyne.ai/api/pv1/video/get-video-sku","params":[{"name":"video_sku_id","in":"query","required":true,"value":"","desc":""}],"contentType":null,"meta":[["Auth","Bearer token"]]},"promote-list-images":{"title":"List images","method":"GET","url":"https://api.spyne.ai/api/pv1/branding-assets","params":[{"name":"type","in":"query","required":false,"value":"banner","desc":"banner or billboard."},{"name":"page","in":"query","required":false,"value":"","desc":"Page number from 1. Default 1."},{"name":"perPage","in":"query","required":false,"value":"","desc":"1 to 200. Default 50."}],"contentType":null,"meta":[["Auth","Bearer token"],["Rate limit","120 reads / min per rooftop"]],"fields":[]},"promote-add-image":{"title":"Add an image","method":"POST","url":"https://api.spyne.ai/api/pv1/branding-assets","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"],["Rate limit","30 changes / min per rooftop"]],"fields":[{"path":"type","required":true,"desc":"banner or billboard.","kind":"enum","enum":["banner","billboard"],"value":"banner"},{"path":"url","required":true,"desc":"Public link to a PNG or JPG.","kind":"string","value":"https://example.com/fall-offer.png"}]},"promote-dry-run":{"title":"Check a promotion (dry run)","method":"POST","url":"https://api.spyne.ai/api/pv1/promotions","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"],["Rate limit","30 changes / min per rooftop"],["Creates","Nothing"]],"fields":[{"path":"name","required":true,"desc":"1 to 255 characters.","kind":"string","value":"Fall Clearance"},{"path":"vehicles","required":false,"desc":"Hand-picked: one VIN, stock number or registration number per line. Send this or criteria, not both.","kind":"list","itemType":"string","value":"1HGCM82633A004352\nSTK-10492"},{"path":"criteria","required":false,"desc":"Filter-based: for example {\"makes\": [\"Toyota\"], \"minPrice\": 20000}. Send this or vehicles, not both.","kind":"json","value":""},{"path":"excludeVins","required":false,"desc":"Filter-based only: one VIN per line to leave out.","kind":"list","itemType":"string","value":""},{"path":"assets","required":true,"desc":"1 to 10 images. Each entry has an assetId, or a url with its type.","kind":"items","sub":[{"key":"assetId","kind":"string","enum":null,"desc":"A saved image id."},{"key":"url","kind":"string","enum":null,"desc":"A public image link."},{"key":"type","kind":"enum","enum":["banner","billboard"],"desc":"Required with url."},{"key":"position","kind":"enum","enum":["all_images","first_image","last_image","after_last_image","all_exterior","all_interior","custom"],"desc":"Which photos get it."}],"rows":[{"url":"https://example.com/fall-offer.png","type":"banner"}]},{"path":"dryRun","required":true,"desc":"true: only check the request.","kind":"boolean","value":"true"}]},"promote-create":{"title":"Create a promotion","method":"POST","url":"https://api.spyne.ai/api/pv1/promotions","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"],["Rate limit","30 changes / min per rooftop"]],"fields":[{"path":"name","required":true,"desc":"1 to 255 characters.","kind":"string","value":"Fall Clearance"},{"path":"vehicles","required":false,"desc":"Hand-picked: one VIN, stock number or registration number per line. Send this or criteria, not both.","kind":"list","itemType":"string","value":"1HGCM82633A004352\nSTK-10492"},{"path":"criteria","required":false,"desc":"Filter-based: for example {\"makes\": [\"Toyota\"], \"minPrice\": 20000}. Send this or vehicles, not both.","kind":"json","value":""},{"path":"excludeVins","required":false,"desc":"Filter-based only: one VIN per line to leave out.","kind":"list","itemType":"string","value":""},{"path":"assets","required":true,"desc":"1 to 10 images. Each entry has an assetId, or a url with its type.","kind":"items","sub":[{"key":"assetId","kind":"string","enum":null,"desc":"A saved image id."},{"key":"url","kind":"string","enum":null,"desc":"A public image link."},{"key":"type","kind":"enum","enum":["banner","billboard"],"desc":"Required with url."},{"key":"position","kind":"enum","enum":["all_images","first_image","last_image","after_last_image","all_exterior","all_interior","custom"],"desc":"Which photos get it."}],"rows":[{"url":"https://example.com/fall-offer.png","type":"banner"}]},{"path":"description","required":false,"desc":"Up to 1000 characters.","kind":"string","value":""},{"path":"schedule","required":false,"desc":"Leave out to start now and never end.","kind":"group"},{"path":"schedule.startDate","required":false,"desc":"2026-10-15 or 2026-10-15T09:00:00-04:00.","kind":"string","value":""},{"path":"schedule.endDate","required":false,"desc":"Same format, in the future.","kind":"string","value":""},{"path":"schedule.timezone","required":false,"desc":"Stored for reference.","kind":"string","value":""},{"path":"draft","required":false,"desc":"true saves it without going live.","kind":"boolean","value":""},{"path":"priority","required":false,"desc":"0 = automatic. Filter-based 1 to 999; hand-picked 1000 to 9999.","kind":"integer","value":""}]},"promote-list":{"title":"List promotions","method":"GET","url":"https://api.spyne.ai/api/pv1/promotions","params":[{"name":"status","in":"query","required":false,"value":"active","desc":"draft, scheduled, active, paused or completed."},{"name":"promotionType","in":"query","required":false,"value":"","desc":"custom or dynamic."},{"name":"search","in":"query","required":false,"value":"","desc":"Part of the name."},{"name":"page","in":"query","required":false,"value":"","desc":"Default 1."},{"name":"perPage","in":"query","required":false,"value":"","desc":"1 to 100. Default 20."}],"contentType":null,"meta":[["Auth","Bearer token"],["Rate limit","120 reads / min per rooftop"]],"fields":[]},"promote-retrieve":{"title":"Retrieve a promotion","method":"GET","url":"https://api.spyne.ai/api/pv1/promotions/{id}","params":[{"name":"id","in":"path","required":true,"value":"351","desc":"The promotion id."}],"contentType":null,"meta":[["Auth","Bearer token"],["Rate limit","120 reads / min per rooftop"]],"fields":[]},"promote-change-status":{"title":"Change status","method":"POST","url":"https://api.spyne.ai/api/pv1/promotions/{id}/status","params":[{"name":"id","in":"path","required":true,"value":"351","desc":"The promotion id."}],"contentType":"application/json","meta":[["Auth","Bearer token"],["Rate limit","30 changes / min per rooftop"]],"fields":[{"path":"action","required":true,"desc":"activate, pause or complete.","kind":"enum","enum":["activate","pause","complete"],"value":"pause"}]},"promote-delete":{"title":"Delete a promotion","method":"DELETE","url":"https://api.spyne.ai/api/pv1/promotions/{id}","params":[{"name":"id","in":"path","required":true,"value":"351","desc":"The promotion id."}],"contentType":null,"meta":[["Auth","Bearer token"],["Rate limit","30 changes / min per rooftop"],["Allowed","Not while active"]],"fields":[]},"onb-contract-get-config":{"title":"Get contract config","method":"GET","url":"https://api.spyne.ai/credit/v6/contracting/get-contract-config","params":[{"name":"currency","in":"query","required":false,"value":"USD","desc":"Currency code for price conversion, e.g. USD or INR. Default USD."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; built from database reads in the same request."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-contract-prefill":{"title":"Reload a saved contract","method":"GET","url":"https://api.spyne.ai/credit/v6/contracting/prefill-contract-data","params":[{"name":"contractId","in":"query","required":true,"value":"CONTRACT_ID","desc":"ID of the contract to load."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the contract read and the pricing and rooftop name refresh."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-contract-create":{"title":"Save or submit a contract","method":"POST","url":"https://api.spyne.ai/credit/v6/contracting/create-contract-v2","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for validation and the contract write."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"isDraft","required":true,"desc":"true saves a draft; false submits the contract.","kind":"boolean","value":"false"},{"path":"contractId","required":false,"desc":"ID of an existing Draft contract to update. Leave empty to create a new one.","kind":"string","value":"CONTRACT_ID"},{"path":"isAmendment","required":false,"desc":"true routes to the amendment flow (not covered on this page).","kind":"boolean","value":"false"},{"path":"contractDetails","required":true,"desc":"Deal-level details.","kind":"group"},{"path":"contractDetails.enterpriseId","required":true,"desc":"Dealer group ID. Required for drafts too.","kind":"string","value":"ENTERPRISE_ID"},{"path":"contractDetails.currency","required":true,"desc":"Currency code; must be INR when the customer country is India.","kind":"string","value":"USD"},{"path":"contractDetails.dealType","required":true,"desc":"One of data.basicDetails.dealTypes; currently only New Deal.","kind":"enum","enum":["New Deal"],"value":"New Deal"},{"path":"contractDetails.customerType","required":true,"desc":"Dealer type of the customer.","kind":"enum","enum":["Individual Dealer","Group Dealer","Reseller"],"value":"Individual Dealer"},{"path":"contractDetails.managerName","required":false,"desc":"Account manager; if set, one of data.basicDetails.managerNames.","kind":"string","value":""},{"path":"customerDetails","required":false,"desc":"Required when submitting. Legal entity and address of the dealer group.","kind":"group"},{"path":"customerDetails.legalName","required":true,"desc":"Legal name of the dealer group.","kind":"string","value":"Example Motors LLC"},{"path":"customerDetails.brandName","required":true,"desc":"Trading name.","kind":"string","value":"Example Motors"},{"path":"customerDetails.region","required":true,"desc":"Region of the dealer group.","kind":"enum","enum":["AMER","APAC","EMEA","OTHERS"],"value":"AMER"},{"path":"customerDetails.streetAddress","required":true,"desc":"Street address.","kind":"string","value":"100 Example Street"},{"path":"customerDetails.country","required":true,"desc":"Country.","kind":"string","value":"United States"},{"path":"customerDetails.pincode","required":true,"desc":"Postal (ZIP) code, sent as a string.","kind":"string","value":"00000"},{"path":"customerDetails.state","required":true,"desc":"State.","kind":"string","value":"Example State"},{"path":"customerDetails.city","required":true,"desc":"City.","kind":"string","value":"Example City"},{"path":"customerDetails.stateCode","required":false,"desc":"Sent only when the country is India.","kind":"string","value":""},{"path":"customerDetails.contractedRooftops","required":false,"desc":"Required for Group Dealer. Number of contracted rooftops, above 0.","kind":"integer","value":""},{"path":"customerDetails.billingTo","required":false,"desc":"Required for Group Dealer. Currently only Group Dealer (Combined).","kind":"string","value":""},{"path":"pricing","required":false,"desc":"Required when submitting. data.pricing from Get contract config, unchanged; needs an entry per product line used.","kind":"json","value":"{\n \"conversationalAi\": {\n \"type\": \"\",\n \"allowedProducts\": {},\n \"items\": {}\n }\n}"},{"path":"rooftops","required":false,"desc":"Required when submitting. At least one rooftop.","kind":"items","sub":[{"key":"rooftopName","kind":"string","enum":null,"desc":"Rooftop name, unique within the contract."},{"key":"subType","kind":"enum","enum":["Independent Dealer","Franchise Dealer","Mixed"],"desc":"Rooftop type."},{"key":"region","kind":"enum","enum":["AMER","APAC","EMEA","OTHERS"],"desc":"Copied from customerDetails by the console."},{"key":"streetAddress","kind":"string","enum":null,"desc":"Rooftop street address."},{"key":"country","kind":"string","enum":null,"desc":"Rooftop country."},{"key":"pincode","kind":"string","enum":null,"desc":"Rooftop postal (ZIP) code."},{"key":"state","kind":"string","enum":null,"desc":"Rooftop state."},{"key":"city","kind":"string","enum":null,"desc":"Rooftop city."},{"key":"bundle","kind":"string","enum":null,"desc":"Key of the bundle in line_items.value, e.g. bundle-1."},{"key":"teamId","kind":"string","enum":null,"desc":"Existing rooftop ID; sent only for amendments."},{"key":"existingInventory","kind":"number","enum":null,"desc":"Optional; must be a number when sent."},{"key":"productsLines","kind":"json","enum":null,"desc":"Array of product lines (productLineName, plan, products, oneTimePurchases, addOns)."}],"rows":[{"rooftopName":"Example Motors","subType":"Franchise Dealer","region":"AMER","streetAddress":"100 Example Street","country":"United States","pincode":"00000","city":"Example City","state":"Example State","bundle":"bundle-1","productsLines":"[\n {\n \"productLineName\": \"conversationalAi\",\n \"plan\": \"\",\n \"oneTimePurchases\": [],\n \"products\": [\n {\n \"product\": \"salesInbound\",\n \"units\": \"100\",\n \"unitType\": \"vinsPerMonth\",\n \"cost\": 0\n },\n {\n \"product\": \"serviceInbound\",\n \"units\": \"100\",\n \"unitType\": \"roPerMonth\",\n \"cost\": 0\n }\n ]\n }\n]"}]},{"path":"signatoryDetails","required":false,"desc":"Required when submitting. The dealer-side person who signs.","kind":"group"},{"path":"signatoryDetails.name","required":true,"desc":"Signer name.","kind":"string","value":"Jane Doe"},{"path":"signatoryDetails.email","required":true,"desc":"Signer email; DocuSign sends the envelope here.","kind":"string","value":"jane.doe@example.com"},{"path":"signatoryDetails.designation","required":true,"desc":"Signer job title.","kind":"string","value":"General Manager"},{"path":"signatoryDetails.contactNumber","required":true,"desc":"Object with isdCode and number, both strings.","kind":"json","value":"{\n \"isdCode\": \"+1\",\n \"number\": \"5550100000\"\n}"},{"path":"signatoryDetails.clientPOCs","required":false,"desc":"Extra dealer emails to copy on the envelope, one per line.","kind":"list","itemType":"string","value":""},{"path":"billingDetails","required":false,"desc":"Required when submitting. Billing frequency and finance contact.","kind":"group"},{"path":"billingDetails.billingFrequency","required":true,"desc":"Billing frequency in months: 1, 3, 6 or 12.","kind":"integer","value":"12"},{"path":"billingDetails.financePOCName","required":true,"desc":"Finance contact name.","kind":"string","value":"John Doe"},{"path":"billingDetails.financePOCEmail","required":true,"desc":"Finance contact email.","kind":"string","value":"john.doe@example.com"},{"path":"billingDetails.financePOCNumber","required":true,"desc":"Object with isdCode and number, both strings.","kind":"json","value":"{\n \"isdCode\": \"+1\",\n \"number\": \"5550100000\"\n}"},{"path":"billingDetails.billingTo","required":false,"desc":"Copied from customerDetails.billingTo when set.","kind":"string","value":""},{"path":"billingDetails.billingEntity","required":false,"desc":"Billing entity from data.billingEntities (key vs label not confirmed).","kind":"string","value":""},{"path":"billingDetails.taxId","required":false,"desc":"Tax ID; sent only when not empty.","kind":"string","value":""},{"path":"terms","required":false,"desc":"Required when submitting. Contract terms.","kind":"group"},{"path":"terms.t&cTemplatePath","required":true,"desc":"Terms template path, normally data.defaultTcTemplatePathPdf.","kind":"string","value":"contracts/default-terms-and-conditions-template.pdf"},{"path":"terms.editT&C","required":true,"desc":"true if custom terms were uploaded.","kind":"boolean","value":"false"},{"path":"terms.exception","required":true,"desc":"true if the deal is raised as an exception.","kind":"boolean","value":"false"},{"path":"terms.contractTerm","required":true,"desc":"Contract term; unit not documented.","kind":"integer","value":"12"},{"path":"terms.lockInPeriod","required":true,"desc":"Lock-in period; unit not documented.","kind":"integer","value":"12"},{"path":"terms.noticePeriodForAutoRenewal","required":true,"desc":"Notice period for auto renewal; unit not documented.","kind":"integer","value":"30"},{"path":"terms.terminationDays","required":false,"desc":"Value from data.terminationDays (30 or 60).","kind":"integer","value":"30"},{"path":"terms.freeDays","required":false,"desc":"Must be a number when sent.","kind":"integer","value":""},{"path":"line_items","required":false,"desc":"Required when submitting. Priced line items grouped by bundle.","kind":"group"},{"path":"line_items.type","required":true,"desc":"Must be bundle.","kind":"enum","enum":["bundle"],"value":"bundle"},{"path":"line_items.value","required":true,"desc":"One entry per bundle key (e.g. bundle-1) with studioAi / conversationalAi sections of line items.","kind":"json","value":"{\n \"bundle-1\": {\n \"existingInventoryPerRooftop\": 0,\n \"rooftopsCount\": 1,\n \"studioAi\": {\n \"studio\": [],\n \"addOns\": []\n },\n \"conversationalAi\": {\n \"salesAgent\": [\n {\n \"type\": \"Inbound\",\n \"frequency\": \"Monthly\",\n \"basePrice\": 0,\n \"discountAmount\": 0,\n \"discountPercent\": 0,\n \"finalPrice\": 0,\n \"units\": 100\n }\n ],\n \"serviceAgent\": [\n {\n \"type\": \"Inbound\",\n \"frequency\": \"Monthly\",\n \"basePrice\": 0,\n \"discountAmount\": 0,\n \"discountPercent\": 0,\n \"finalPrice\": 0,\n \"units\": 100\n }\n ],\n \"receptionAgent\": [],\n \"acquisitionAgent\": [],\n \"addOns\": []\n }\n }\n}"},{"path":"summary","required":false,"desc":"Required when submitting. Fee totals.","kind":"group"},{"path":"summary.totalOneTimeFee","required":true,"desc":"Total one-time fees, at most 2 decimals.","kind":"number","value":"0"},{"path":"summary.totalMonthlyRecurringFee","required":true,"desc":"Total monthly recurring fees, at most 2 decimals.","kind":"number","value":"0"},{"path":"summary.totalAnnuallyRecurringFee","required":true,"desc":"Total annual recurring fees, at most 2 decimals.","kind":"number","value":"0"}]},"onb-contract-send-for-signature":{"title":"Send for signature","method":"POST","url":"https://api.spyne.ai/credit/v6/contracting/send-for-signature","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for DocuSign to create the envelope and for the stage update."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID; must match the contract.","kind":"string","value":"ENTERPRISE_ID"},{"path":"contractId","required":true,"desc":"Contract ID from Save or submit a contract.","kind":"string","value":"CONTRACT_ID"}]},"onb-contract-docusign-webhook":{"title":"Receive DocuSign events","method":"POST","url":"https://api.spyne.ai/credit/v6/contracting/docusign-webhook","params":[],"contentType":"application/json","meta":[["Auth","No user token. Requires X-DocuSign-Signature-1 (or -2): HMAC-SHA256, base64, of the raw body"],["Caller","DocuSign Connect, not a console user"],["Rate limit","Not documented"],["Processing","Synchronous; on envelope-completed waits for the signed PDF copy, child records and stage update."]],"authHint":"No bearer token: DocuSign calls this endpoint. Without a valid X-DocuSign-Signature-1 HMAC header the request is rejected.","fields":[{"path":"event","required":true,"desc":"DocuSign event name; also read from data.event.","kind":"enum","enum":["envelope-sent","envelope-delivered","recipient-viewed","envelope-viewed","recipient-authentication-failed","envelope-voided","voided","declined","recipient-completed","envelope-completed"],"value":"envelope-completed"},{"path":"data","required":false,"desc":"DocuSign payload wrapper.","kind":"group"},{"path":"data.envelopeId","required":false,"desc":"Required if the event is processed. Envelope ID; also read from top-level envelopeId.","kind":"string","value":"ENVELOPE_ID"},{"path":"data.envelopeSummary.customFields.textCustomFields","required":false,"desc":"contractId and enterpriseId entries used to find the contract.","kind":"items","sub":[{"key":"name","kind":"string","enum":null,"desc":"contractId or enterpriseId."},{"key":"value","kind":"string","enum":null,"desc":"The matching ID."}],"rows":[{"name":"contractId","value":"CONTRACT_ID"},{"name":"enterpriseId","value":"ENTERPRISE_ID"}]},{"path":"data.signerEmail","required":false,"desc":"Dealer signer email for recipient-completed; falls back to the stored email.","kind":"string","value":""},{"path":"data.spyneSignerEmail","required":false,"desc":"Spyne signer email for envelope-completed.","kind":"string","value":""}]},"onb-contract-handover-details":{"title":"Save handover details","method":"POST","url":"https://api.spyne.ai/console/v1/contracting/onboarding/update-handover-details-v2","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; one read and one update of the product line record."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"product_line_details_id","required":true,"desc":"Product line ID.","kind":"string","value":"PRODUCT_LINE_ID"},{"path":"input_medium","required":false,"desc":"Systems the rooftop's data comes from; must contain ims_dms and website_provider.","kind":"json","value":"{\n \"ims_dms\": \"IMS_DMS\",\n \"website_provider\": \"WEBSITE_PROVIDER\"\n}"},{"path":"output_medium","required":false,"desc":"Systems the output goes to; must contain ims_dms and website_provider.","kind":"json","value":"{\n \"ims_dms\": \"IMS_DMS\",\n \"website_provider\": \"WEBSITE_PROVIDER\"\n}"},{"path":"platforms","required":false,"desc":"Platform list, one per line; allowed values not documented.","kind":"list","itemType":"string","value":"PLATFORM"},{"path":"website_url","required":false,"desc":"Dealer website URL.","kind":"string","value":"https://www.example.com"},{"path":"spyne_rooftops","required":false,"desc":"Number of rooftops on Spyne.","kind":"number","value":"1"},{"path":"potential_rooftops","required":false,"desc":"Number of potential rooftops.","kind":"number","value":"1"},{"path":"markets_serving","required":false,"desc":"Markets the dealer serves.","kind":"string","value":"Example City"},{"path":"languages_spoken","required":false,"desc":"Languages spoken, one per line.","kind":"list","itemType":"string","value":"English"},{"path":"notes","required":false,"desc":"Handover notes.","kind":"string","value":"Example handover notes"}]},"onb-contract-schedule-meeting":{"title":"Schedule an onboarding meeting","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/schedule-onboarding-meeting","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for Google Calendar to create the event."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"startTime","required":true,"desc":"Start time, ISO 8601.","kind":"string","value":"2026-01-01T15:00:00.000Z"},{"path":"endTime","required":true,"desc":"End time, ISO 8601; must be after startTime.","kind":"string","value":"2026-01-01T15:15:00.000Z"},{"path":"timeZone","required":true,"desc":"IANA time zone, e.g. America/New_York.","kind":"string","value":"America/New_York"},{"path":"attendees","required":true,"desc":"Attendee emails, one per line; must not be empty.","kind":"list","itemType":"string","value":"jane.doe@example.com"},{"path":"summary","required":true,"desc":"Event title.","kind":"string","value":"Example Motors onboarding"}]},"onb-contract-update-sub-stage":{"title":"Update handover sub-stage","method":"POST","url":"https://api.spyne.ai/user-management/v1/product-line/update-stage","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; on Meet Done also calls the checklist creation (its failure does not fail the request)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"entityType","required":true,"desc":"product_line for this use; product, team and addon are not covered here.","kind":"enum","enum":["product_line","product","team","addon"],"value":"product_line"},{"path":"entityId","required":true,"desc":"Product line ID when entityType is product_line.","kind":"string","value":"PRODUCT_LINE_ID"},{"path":"sub_stage","required":false,"desc":"New sub-stage, e.g. Meet Scheduled or Meet Done. Send this or stage, not both.","kind":"string","value":"Meet Done"},{"path":"stage","required":false,"desc":"New stage (not covered on this page). Send this or sub_stage, not both.","kind":"string","value":""},{"path":"meta_data","required":false,"desc":"Required if the sub-stage requires fields: ob_manager, cs_manager, cs_id, platforms, churn_reason, reason, meeting fields.","kind":"json","value":"{\n \"ob_manager\": \"USER_ID\",\n \"meet_required\": false\n}"},{"path":"live_date","required":false,"desc":"YYYY-MM-DD, only with stage Live (not covered on this page).","kind":"string","value":""}]},"onb-contract-create-checklist":{"title":"Create the onboarding checklist","method":"POST","url":"https://api.spyne.ai/console/v1/onboarding/task/create-onboarding-task-v2","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","A per-product-line lock (15 s, up to 5 retries 300 ms apart) blocks concurrent calls for the same product line."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"product_line_id","required":true,"desc":"Product line ID.","kind":"string","value":"PRODUCT_LINE_ID"}]},"onb-contract-task-template":{"title":"Get the onboarding task template","method":"POST","url":"https://api.spyne.ai/credit/v2/product-line-registry/get-onboarding-task-config","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; one database read."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"product_line_registry_id","required":false,"desc":"Registry ID; leave empty to get all registries, newest first.","kind":"string","value":"PRODUCT_LINE_REGISTRY_ID"}]},"onb-checklist-contracting-data":{"title":"Get contracting data","method":"GET","url":"https://api.spyne.ai/credit/v6/get-team-contracting-data","params":[{"name":"enterpriseId","in":"query","required":true,"value":"","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-checklist-contract-product-lines":{"title":"Get contract product lines","method":"GET","url":"https://api.spyne.ai/user-management/v1/team-onboarding/get-contract-product-lines","params":[{"name":"enterpriseId","in":"query","required":true,"value":"","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; reads the dealer group, rooftops, product lines and product registry."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-checklist-active-products":{"title":"List active Vini products","method":"GET","url":"https://api.spyne.ai/user-management/v1/vini/active-products","params":[{"name":"teamId","in":"query","required":true,"value":"","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-checklist-get-checklist":{"title":"Get the onboarding checklist","method":"GET","url":"https://api.spyne.ai/console/v1/onboarding/task/get-onboarding-task-v2","params":[{"name":"teamId","in":"query","required":false,"value":"","desc":"Rooftop ID. Required unless productLineId is sent; used with productLineName."},{"name":"productLineName","in":"query","required":false,"value":"conversationalAi","desc":"studioAi or conversationalAi (Vini). Required unless productLineId is sent."},{"name":"productLineId","in":"query","required":false,"value":"","desc":"One ID or up to 20 comma-separated IDs; with several, omit teamId, productLineName and productGroup."},{"name":"productGroup","in":"query","required":false,"value":"","desc":"Accepted but not used to filter the result."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-checklist-agent-details":{"title":"Get contracted agent details","method":"GET","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agents/teams/{teamId}/enterpriseId/{enterpriseId}","params":[{"name":"teamId","in":"path","required":true,"value":"","desc":"Rooftop ID."},{"name":"enterpriseId","in":"path","required":true,"value":"","desc":"Dealer group ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the agent service (30-second timeout)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-checklist-mark-task-done":{"title":"Mark a task done","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/onboarding-tracker/bulk-complete-shared-task","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; task rows are updated before the response returns."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":""},{"path":"taskName","required":true,"desc":"Task name; matched exactly, ignoring case.","kind":"string","value":"CRM Integration"},{"path":"segmentName","required":false,"desc":"Required for Agent Setup and Go Live Readiness tasks, e.g. inboundSales; case-sensitive.","kind":"string","value":""},{"path":"isCompleted","required":false,"desc":"true marks matching tasks COMPLETED; false or omitted marks them INPROGRESS.","kind":"boolean","value":"true"}]},"onb-rooftop-get-details":{"title":"Get rooftop details","method":"GET","url":"https://api.spyne.ai/user-management/v1/team/get-team-details","params":[{"name":"team_id","in":"query","required":true,"value":"TEAM_ID","desc":"The rooftop ID (snake_case)."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Database reads only."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-rooftop-get-vehicle-types":{"title":"Get vehicle types and department addresses","method":"GET","url":"https://api.spyne.ai/central-config/v1/integration","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"domain","in":"query","required":true,"value":"rooftop","desc":"rooftop for this task."},{"name":"entity","in":"query","required":true,"value":"INFO","desc":"INFO for this task."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous. One database read."]],"authHint":"Optional: this route does not check a token. Used only for this request; not saved.","fields":[]},"onb-rooftop-save-details":{"title":"Save rooftop details","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/update-rooftop-data","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Waits for every write (30 s timeout each); writes are not rolled back."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":true,"desc":"Rooftop name to save.","kind":"string","value":"Example Motors"},{"path":"enterpriseName","required":false,"desc":"Dealer group name, stored on the configuration record.","kind":"string","value":"Example Motors Group"},{"path":"rooftopData","required":true,"desc":"Rooftop profile.","kind":"group"},{"path":"rooftopData.website","required":true,"desc":"Rooftop website.","kind":"string","value":"https://www.example.com"},{"path":"rooftopData.websiteListingUrl","required":false,"desc":"Inventory listing page URL.","kind":"string","value":"https://www.example.com/used-inventory"},{"path":"rooftopData.address","required":true,"desc":"addressLine1, addressLine2, city, state, district, country, zipcode.","kind":"json","value":"{\n \"addressLine1\": \"100 Example Ave\",\n \"addressLine2\": \"\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"district\": \"\",\n \"country\": \"United States\",\n \"zipcode\": \"78701\"\n}"},{"path":"rooftopData.geoCoordinates","required":true,"desc":"Rooftop coordinates.","kind":"group"},{"path":"rooftopData.geoCoordinates.lat","required":true,"desc":"Latitude.","kind":"number","value":"30.2672"},{"path":"rooftopData.geoCoordinates.lng","required":true,"desc":"Longitude.","kind":"number","value":"-97.7431"},{"path":"rooftopData.regionType","required":true,"desc":"Region code, e.g. AMER.","kind":"string","value":"AMER"},{"path":"rooftopData.timeZone","required":true,"desc":"IANA timezone, e.g. America/Chicago.","kind":"string","value":"America/Chicago"},{"path":"rooftopData.userData","required":false,"desc":"{userId, name, email, contactNo, isdCode}; only isdCode and contactNo are saved.","kind":"json","value":"{\n \"userId\": \"USER_ID\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"contactNo\": \"5550100000\",\n \"isdCode\": \"+1\"\n}"},{"path":"entityConfig","required":true,"desc":"Leaving it out returns 500.","kind":"group"},{"path":"entityConfig.vehicleType","required":false,"desc":"Vehicle types the rooftop sells.","kind":"group"},{"path":"entityConfig.vehicleType.new","required":false,"desc":"Sells new vehicles.","kind":"boolean","value":"true"},{"path":"entityConfig.vehicleType.preOwned","required":false,"desc":"Sells pre-owned vehicles.","kind":"boolean","value":"true"},{"path":"entityConfig.salesAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"entityConfig.serviceAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"entityConfig.partsAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"entityConfig.financeAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"domain","required":false,"desc":"Used only for the agent configuration write. The UI sends rooftop.","kind":"string","value":"rooftop"},{"path":"entity","required":false,"desc":"The UI sends INFO; sales/service inbound/outbound also write agent config.","kind":"string","value":"INFO"},{"path":"productLineId","required":false,"desc":"With taskName, updates that checklist task. The UI does not send it.","kind":"string","value":""},{"path":"taskName","required":false,"desc":"Checklist task to update.","kind":"string","value":""},{"path":"segmentName","required":false,"desc":"Agent segment of the task. Needed for Vini product lines.","kind":"string","value":""},{"path":"isCompleted","required":false,"desc":"true completes the task, otherwise starts it.","kind":"boolean","value":""}]},"onb-rooftop-get-departments":{"title":"Get departments, hours and holidays","method":"GET","url":"https://api.spyne.ai/central-config/v1/vini-config/departments","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous. A failed write-back is logged and does not fail the read."]],"authHint":"Optional: this route does not check a token. Used only for this request; not saved.","fields":[]},"onb-rooftop-save-departments":{"title":"Save departments, hours and holidays","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/departments","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Pushes run in sequence and are not rolled back."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored on the configuration record.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the configuration record.","kind":"string","value":""},{"path":"timezone","required":false,"desc":"IANA timezone used for the sales working-days sync.","kind":"string","value":"America/Chicago"},{"path":"departments","required":false,"desc":"Complete department list (name, contact, timings, address). Leave out to keep as is.","kind":"json","value":"[\n {\n \"name\": \"sales\",\n \"contact\": {\n \"name\": \"Sales\",\n \"phone\": \"+15550100000\",\n \"isIvr\": false\n },\n \"timings\": {\n \"monday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"tuesday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"wednesday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"thursday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"friday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"saturday\": {\n \"isAvailable\": true,\n \"startTime\": \"10:00\",\n \"endTime\": \"16:00\"\n },\n \"sunday\": {\n \"isAvailable\": false\n }\n }\n },\n {\n \"name\": \"service\",\n \"timings\": {\n \"isSameAsSales\": true\n }\n }\n]"},{"path":"holidays","required":false,"desc":"Complete holiday list (name, reason, date, recurrence, open, hours, departments). Leave out to keep as is.","kind":"json","value":"[\n {\n \"name\": \"Thanksgiving\",\n \"reason\": \"Public holiday\",\n \"date\": \"2026-11-26\",\n \"recurrence\": \"yearly\",\n \"open\": false,\n \"hours\": [],\n \"departments\": \"all\"\n }\n]"}]},"onb-rooftop-list-users":{"title":"List console users","method":"GET","url":"https://api.spyne.ai/user-management/v1/team/get-team-users-details","params":[{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"skipEnterpriseFallback","in":"query","required":false,"value":"","desc":"true skips the fallback to dealer group users. Default false."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Database reads only."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-rooftop-invite-users":{"title":"Invite console users","method":"POST","url":"https://api.spyne.ai/console/v1/user/send-invite-links","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user) with CREATE_USER_MULTIPLE permission"],["Rate limit","Not documented"],["Processing","Synchronous database writes; emails are sent later by a scheduled job."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":true,"desc":"Rooftop name, echoed back in the response.","kind":"string","value":"Example Motors"},{"path":"resellerId","required":false,"desc":"Reseller flow only.","kind":"string","value":""},{"path":"userList","required":true,"desc":"1 to 100 users; each needs email and roleName. Avoid apostrophes in names.","kind":"items","value":"","sub":[{"key":"email","kind":"string","enum":null,"desc":"Required. Trimmed and lower-cased."},{"key":"roleName","kind":"string","enum":null,"desc":"Required. Role for the invite, e.g. TEAM_STANDARD."},{"key":"teamRole","kind":"string","enum":null,"desc":"Rooftop role; the UI sends the same as roleName."},{"key":"userName","kind":"string","enum":null,"desc":"Display name."},{"key":"designation","kind":"string","enum":null,"desc":"Job title."},{"key":"isdCode","kind":"string","enum":null,"desc":"Country code, e.g. +1."},{"key":"contactNo","kind":"string","enum":null,"desc":"Phone number."},{"key":"department","kind":"string","enum":null,"desc":"Department. The UI sends an empty string."}],"rows":[{"email":"john.roe@example.com","roleName":"TEAM_STANDARD","teamRole":"TEAM_STANDARD","userName":"John Roe","designation":"BDC Manager","isdCode":"+1","contactNo":"5550100001","department":""}]}]},"onb-rooftop-list-directory":{"title":"List the employee directory","method":"GET","url":"https://api.spyne.ai/user-management/v1/directory/enterprise/{enterpriseId}/team/{teamId}/get-directory","params":[{"name":"enterpriseId","in":"path","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"path","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"keyword","in":"query","required":false,"value":"","desc":"Search on first name, last name or email."},{"name":"active","in":"query","required":false,"value":"","desc":"true or false."},{"name":"page","in":"query","required":false,"value":"1","desc":"Default 1. Sending page or limit turns on paging."},{"name":"limit","in":"query","required":false,"value":"10","desc":"1 to 100. Default 20 when paging."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Database reads only."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-rooftop-add-directory-contacts":{"title":"Add directory contacts","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/directory/manual","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Waits for the directory write (30 s timeout)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID. Without it the call returns 400.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID. Without it the call returns 400.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":false,"desc":"Sent by the UI. Not used.","kind":"string","value":"Example Motors"},{"path":"users","required":true,"desc":"Non-empty list of contacts.","kind":"items","value":"","sub":[{"key":"firstName","kind":"string","enum":null,"desc":"Required. First name."},{"key":"lastName","kind":"string","enum":null,"desc":"Last name."},{"key":"role","kind":"string","enum":null,"desc":"Required. Job title, stored as designation."},{"key":"departmentId","kind":"string","enum":null,"desc":"Required. Department ID, a positive integer."},{"key":"isdCode","kind":"string","enum":null,"desc":"Required. Country code with a leading +, e.g. +1."},{"key":"phoneNumber","kind":"string","enum":null,"desc":"Required. Number without country code."},{"key":"extension","kind":"string","enum":null,"desc":"Extension."},{"key":"email","kind":"string","enum":null,"desc":"Email."}],"rows":[{"firstName":"Jane","lastName":"Doe","role":"Service Advisor","departmentId":"DEPARTMENT_ID","isdCode":"+1","phoneNumber":"5550100000","extension":"204","email":"jane.doe@example.com"}]}]},"onb-rooftop-upload-directory":{"title":"Upload the employee directory","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/directory/file","params":[],"contentType":"multipart/form-data","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Parses the file, then waits for the directory write (30 s timeout)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":false,"desc":"Sent by the UI. Not used.","kind":"string","value":"Example Motors"},{"path":"file","required":true,"desc":"One .xlsx file, up to 20 MB, exactly one sheet.","kind":"file"}]},"onb-rooftop-get-cnam":{"title":"Get the brand registration","method":"GET","url":"https://api.spyne.ai/user-management/v1/twilio/customer-profiles","params":[{"name":"enterprise_id","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"team_id","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Waits for the registration lookup and the address read."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-rooftop-save-cnam":{"title":"Submit or save the brand registration","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/business-registration","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous (30 s timeout). Carrier review continues after the response."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"draft","required":false,"desc":"true saves a draft and skips validation; false or omitted submits.","kind":"boolean","value":"false"},{"path":"businessProfile","required":false,"desc":"Required when submitting (draft false). Business details.","kind":"group"},{"path":"businessProfile.legalBusinessName","required":true,"desc":"Legal business name.","kind":"string","value":"Example Motors LLC"},{"path":"businessProfile.displayName","required":true,"desc":"Caller ID display name.","kind":"string","value":"Example Motors"},{"path":"businessProfile.entityType","required":true,"desc":"Business entity type.","kind":"enum","value":"private_profit","enum":["private_profit","public_profit","non_profit","government","sole_proprietor"]},{"path":"businessProfile.registrationId","required":true,"desc":"EIN, format ##-#######.","kind":"string","value":"12-3456789"},{"path":"businessProfile.email","required":true,"desc":"Business email.","kind":"string","value":"info@example.com"},{"path":"businessProfile.isdCode","required":true,"desc":"Country code, e.g. +1.","kind":"string","value":"+1"},{"path":"businessProfile.phoneNumber","required":true,"desc":"National number, without the country code.","kind":"string","value":"5550100000"},{"path":"businessProfile.privacyPolicyUrl","required":true,"desc":"Privacy policy URL.","kind":"string","value":"https://www.example.com/privacy"},{"path":"businessProfile.termsAndConditionsUrl","required":true,"desc":"Terms URL.","kind":"string","value":"https://www.example.com/terms"},{"path":"businessProfile.authorizedRepresentative","required":true,"desc":"firstName, lastName, email, isdCode, phoneNumber, jobTitle, jobPositionCategory, optional employeeId.","kind":"json","value":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"isdCode\": \"+1\",\n \"phoneNumber\": \"5550100000\",\n \"jobTitle\": \"General Manager\",\n \"jobPositionCategory\": \"GM\",\n \"employeeId\": \"EMPLOYEE_ID\"\n}"},{"path":"businessProfile.address","required":false,"desc":"Ignored: replaced with the rooftop address on file.","kind":"json","value":""},{"path":"businessProfile.website","required":false,"desc":"Ignored: replaced with the rooftop website on file.","kind":"string","value":""},{"path":"businessProfile.industry","required":false,"desc":"Ignored: always replaced with AUTOMOTIVE.","kind":"string","value":""}]},"onb-int-list-crm-partners":{"title":"List CRM and scheduler partners","method":"GET","url":"https://api.spyne.ai/integrations/registry","params":[{"name":"providerType","in":"query","required":false,"value":"crm","desc":"Exact match, e.g. crm, service-scheduler, dms. Omit for all."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","One database read."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-int-list-feed-partners":{"title":"List inventory and history partners","method":"GET","url":"https://api.spyne.ai/partner/category","params":[{"name":"category","in":"query","required":false,"value":"CarHistory","desc":"e.g. IMS, PHOTO, CGI, CarHistory. Omit for all."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","One database read."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-int-read-integration":{"title":"Read a saved integration","method":"GET","url":"https://api.spyne.ai/central-config/v1/integration","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"domain","in":"query","required":true,"value":"integration","desc":"integration."},{"name":"entity","in":"query","required":true,"value":"CRM","desc":"CRM, CAR_HISTORY or SERVICE_SCHEDULER (exact casing)."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","One database read, plus outbound reads for CRM and scheduler fallbacks."]],"authHint":"Optional: this route does not check a token. Used only for this request; not saved.","fields":[]},"onb-int-save-integration":{"title":"Save the CRM integration","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/integration","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous (up to 30 s). Partner onboarding failures are ignored."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"domain","required":true,"desc":"Always integration.","kind":"string","value":"integration"},{"path":"entity","required":true,"desc":"Which integration to save.","kind":"enum","value":"CRM","enum":["CRM"]},{"path":"entityconfig","required":true,"desc":"Shape depends on entity (see the tables on this page); unknown keys are dropped.","kind":"json","value":"{\n \"api\": {\n \"partnerId\": \"PARTNER_ID\",\n \"partnerName\": \"examplecrm\",\n \"dealerId\": \"DEALER_ID\",\n \"logo\": \"https://example.com/logo.png\",\n \"approved\": false\n },\n \"partnerProviderTypes\": [\n \"CRM\"\n ]\n}"},{"path":"enterpriseName","required":false,"desc":"Dealer group name, stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Rooftop name, stored with the record.","kind":"string","value":"Example Motors"}]},"onb-int-crm-lead-sync":{"title":"Set CRM lead sync rules","method":"PUT","url":"https://api.spyne.ai/leads/dealer/v1/crm-config/leads-sync","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user) with MODIFY_CRM_CONFIG_ALL (EDIT) permission"],["Rate limit","Not documented"],["Processing","One database write; the updated settings are returned."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterprise_id","required":true,"desc":"Dealer group ID (snake case).","kind":"string","value":"ENTERPRISE_ID"},{"path":"team_id","required":true,"desc":"Rooftop ID (snake case).","kind":"string","value":"TEAM_ID"},{"path":"agent","required":false,"desc":"inbound or outbound. Leave out to apply to both.","kind":"string","value":"","hint":"inbound"},{"path":"enforced","required":false,"desc":"Whether the gate holds conversations. The UI always sends true.","kind":"boolean","value":"true"},{"path":"selectedCallTypes","required":false,"desc":"Call types that sync, e.g. sales_shopping, human_request. Not no_signal.","kind":"list","value":"sales_shopping\nhuman_request","itemType":"string"},{"path":"selectedOutcomes","required":false,"desc":"Appointment, Transfer, Callback, Query Resolved, Qualified Lead or None.","kind":"list","value":"Appointment\nCallback\nTransfer","itemType":"string"},{"path":"selectedInterests","required":false,"desc":"not_interested, soft_considering, interested, strong_buying or no_vehicle_discussed.","kind":"list","value":"interested\nstrong_buying","itemType":"string"}]},"onb-int-list-feed-workflows":{"title":"List inventory feed workflows","method":"GET","url":"https://api.spyne.ai/partner/input-workflow","params":[{"name":"enterpriseId","in":"query","required":false,"value":"ENTERPRISE_ID","desc":"Dealer group ID. Send it to scope the result."},{"name":"teamId","in":"query","required":false,"value":"TEAM_ID","desc":"Rooftop ID. Send it to scope the result."},{"name":"partnerId","in":"query","required":false,"value":"","desc":"Valid id of an existing partner."},{"name":"dealerId","in":"query","required":false,"value":"","desc":"The rooftop's id at the partner."},{"name":"isActive","in":"query","required":false,"value":"","desc":"true or false."},{"name":"startDate","in":"query","required":false,"value":"","desc":"Created-date range start. Send with endDate or neither."},{"name":"endDate","in":"query","required":false,"value":"","desc":"Created-date range end. Send with startDate or neither."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Database reads per workflow, plus link signing for the latest file."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-int-create-feed-workflow":{"title":"Create an inventory feed workflow","method":"POST","url":"https://api.spyne.ai/partner/input-workflow","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous save; partner onboarding and the inventory pull run in the background."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"name","required":true,"desc":"Workflow name. The UI sends ' - Inventory Provider'.","kind":"string","value":"Example Inventory Feed - Inventory Provider"},{"path":"partnerId","required":true,"desc":"Partner id from the partner list.","kind":"string","value":"PARTNER_ID"},{"path":"dealerId","required":true,"desc":"The rooftop's id at the partner.","kind":"string","value":"DEALER_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseId","required":false,"desc":"Dealer group ID. Optional in validation, but send it.","kind":"string","value":"ENTERPRISE_ID"},{"path":"partnerProviderTypes","required":false,"desc":"Any of IMS, PHOTO, CGI. Send IMS for the inventory feed.","kind":"list","value":"IMS","itemType":"string"},{"path":"isActive","required":false,"desc":"Default true.","kind":"boolean","value":"true"},{"path":"createDraft","required":false,"desc":"Default false. The UI sends true.","kind":"boolean","value":"true"},{"path":"thresholdCounts","required":false,"desc":"Vehicle count thresholds. 0 is rejected; use -1 to disable.","kind":"group"},{"path":"thresholdCounts.newCars","required":false,"desc":"-1 or a positive number.","kind":"integer","value":"-1"},{"path":"thresholdCounts.usedCars","required":false,"desc":"-1 or a positive number.","kind":"integer","value":"-1"},{"path":"preliminaryConfigs","required":false,"desc":"enabled (boolean) and thresholds {new, used} (numbers).","kind":"json","value":"{\n \"enabled\": false,\n \"thresholds\": {\n \"new\": -1,\n \"used\": -1\n }\n}"},{"path":"productOptions","required":false,"desc":"spin, catalog, featureVideo (booleans), mediaKit, conversationalAi.","kind":"json","value":""},{"path":"processingConfigs","required":false,"desc":"backgroundId, numberplateId, bannerId, videoId, voiceId, musicId, aiHotspot.","kind":"json","value":""},{"path":"rules","required":false,"desc":"Each rule needs processingConfigs; conditions use column_name, condition, value.","kind":"json","value":""},{"path":"customIntegration","required":false,"desc":"Partner add-on selector, e.g. {\"evox\": {\"condition\": \"new\"}}.","kind":"json","value":""},{"path":"poc_name","required":false,"desc":"Passed to partner onboarding. Not stored.","kind":"string","value":""},{"path":"poc_email","required":false,"desc":"Passed to partner onboarding. Not stored.","kind":"string","value":""},{"path":"poc_contact","required":false,"desc":"Passed to partner onboarding. Not stored.","kind":"string","value":""}]},"onb-int-update-feed-workflow":{"title":"Update an inventory feed workflow","method":"PUT","url":"https://api.spyne.ai/partner/input-workflow/{id}","params":[{"name":"id","in":"path","required":true,"value":"WORKFLOW_ID","desc":"The workflow _id."}],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Waits for the update, the rule rewrite and the change log."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"partnerId","required":false,"desc":"If sent, must be a valid id of an existing partner.","kind":"string","value":""},{"path":"dealerId","required":false,"desc":"Changed if different.","kind":"string","value":"DEALER_ID"},{"path":"name","required":false,"desc":"Changed if different.","kind":"string","value":""},{"path":"teamId","required":false,"desc":"Changed if different.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseId","required":false,"desc":"Changed if different.","kind":"string","value":"ENTERPRISE_ID"},{"path":"isActive","required":false,"desc":"false turns the feed off.","kind":"boolean","value":""},{"path":"partnerProviderTypes","required":false,"desc":"IMS, PHOTO, CGI.","kind":"list","value":"","itemType":"string"},{"path":"thresholdCounts","required":false,"desc":"newCars and usedCars. 0 is rejected.","kind":"group"},{"path":"thresholdCounts.newCars","required":false,"desc":"-1 or a positive number.","kind":"integer","value":""},{"path":"thresholdCounts.usedCars","required":false,"desc":"-1 or a positive number.","kind":"integer","value":""},{"path":"preliminaryConfigs","required":false,"desc":"As in create.","kind":"json","value":"{\n \"enabled\": true,\n \"thresholds\": {\n \"new\": 5,\n \"used\": 3\n }\n}"},{"path":"productOptions","required":false,"desc":"As in create.","kind":"json","value":""},{"path":"processingConfigs","required":false,"desc":"As in create.","kind":"json","value":""},{"path":"rules","required":false,"desc":"Replaces all rules when sent.","kind":"json","value":""},{"path":"customIntegration","required":false,"desc":"Partner add-on selector.","kind":"json","value":""}]},"onb-agent-voice-library":{"title":"Browse the voice library","method":"GET","url":"https://api.spyne.ai/conversation/tts/voices/library","params":[{"name":"provider","in":"query","required":false,"value":"","desc":"Voice catalog. Only 11labs. Default 11labs."},{"name":"search","in":"query","required":false,"value":"","desc":"Free-text search."},{"name":"language","in":"query","required":false,"value":"en","desc":"Comma-separated languageIds or ISO codes; all must match."},{"name":"gender","in":"query","required":false,"value":"female","desc":"male or female."},{"name":"age","in":"query","required":false,"value":"","desc":"young, middle_aged or old."},{"name":"accent","in":"query","required":false,"value":"","desc":"Accent label, for example american."},{"name":"sort","in":"query","required":false,"value":"","desc":"relevance, trending, newest or most_used (default)."},{"name":"page","in":"query","required":false,"value":"0","desc":"Zero-based page index. Default 0."},{"name":"pageSize","in":"query","required":false,"value":"30","desc":"1 to 100. Default 30."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; each filter-and-page combination is cached for 24 hours"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-agent-list-avatars":{"title":"List avatars","method":"GET","url":"https://api.spyne.ai/conversation/avatars","params":[{"name":"teamId","in":"query","required":false,"value":"TEAM_ID","desc":"Rooftop; adds its custom avatars to the generic ones."},{"name":"gender","in":"query","required":false,"value":"female","desc":"male or female."},{"name":"nationality","in":"query","required":false,"value":"","desc":"Exact nationality label, for example american."},{"name":"age","in":"query","required":false,"value":"","desc":"young, middle_aged or old."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, one database read"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-agent-voice-languages":{"title":"List voice languages","method":"GET","url":"https://api.spyne.ai/conversation/tts/languages","params":[],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, one database read"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-agent-get-config":{"title":"Get an agent","method":"GET","url":"https://api.spyne.ai/conversation/agents/team/{teamId}/enterprise/{enterpriseId}/agent-mapping/{teamAgentMappingId}","params":[{"name":"teamId","in":"path","required":true,"value":"TEAM_ID","desc":"Rooftop."},{"name":"enterpriseId","in":"path","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group."},{"name":"teamAgentMappingId","in":"path","required":true,"value":"TEAM_AGENT_MAPPING_ID","desc":"Agent id."},{"name":"isDemoAgent","in":"query","required":false,"value":"","desc":"Only the literal true reads a console demo agent."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; database reads plus a best-effort voice catalog lookup"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-agent-create":{"title":"Create an agent","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the agent backend and the database write"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors"},{"path":"entity","required":true,"desc":"Agent type key.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"entityConfig","required":true,"desc":"Holds the agent.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"The agent. Do not send agentId on create.","kind":"group"},{"path":"entityConfig.agent.agentTypeId","required":true,"desc":"Contracted agent type.","kind":"string","value":"AGENT_TYPE_ID"},{"path":"entityConfig.agent.agentName","required":true,"desc":"Name the agent introduces itself with.","kind":"string","value":"Ava"},{"path":"entityConfig.agent.avatarId","required":true,"desc":"Avatar.","kind":"string","value":"AVATAR_ID"},{"path":"entityConfig.agent.tts","required":true,"desc":"Voice.","kind":"group"},{"path":"entityConfig.agent.tts.provider","required":false,"desc":"Default elevenlabs.","kind":"string","value":"elevenlabs"},{"path":"entityConfig.agent.tts.model","required":false,"desc":"Voice model.","kind":"string","value":""},{"path":"entityConfig.agent.tts.voiceId","required":true,"desc":"Voice.","kind":"string","value":"VOICE_ID"},{"path":"entityConfig.agent.tts.voiceSettings","required":false,"desc":"stability, similarity_boost, speed (numbers).","kind":"json","value":"{\n \"speed\": 1\n}"},{"path":"entityConfig.agent.tts.supportedLanguages","required":true,"desc":"At least one language code, one per line.","kind":"list","itemType":"string","value":"en"},{"path":"entityConfig.agent.agentDescription","required":false,"desc":"Description.","kind":"string","value":""},{"path":"entityConfig.agent.firstMessage","required":false,"desc":"Greeting during working hours. Default comes from the agent type.","kind":"string","value":"Thanks for calling Example Motors, this is Ava. How can I help?"},{"path":"entityConfig.agent.afterHoursMessage","required":false,"desc":"Greeting after hours.","kind":"string","value":"We are closed right now, but I can still help."},{"path":"entityConfig.agent.voicemailMessage","required":false,"desc":"Voicemail message. Default comes from the agent type.","kind":"string","value":"Hi, this is Ava from Example Motors. Please call us back."},{"path":"entityConfig.agent.endCallMessage","required":false,"desc":"End-of-call message. Default comes from the agent type.","kind":"string","value":""},{"path":"entityConfig.agent.assertiveness","required":false,"desc":"Sales agents only.","kind":"enum","enum":["none","low","medium","high"],"value":"low"},{"path":"entityConfig.agent.ambientSound","required":false,"desc":"type (office or off) and optional volume.","kind":"json","value":"{\n \"type\": \"office\",\n \"volume\": 0.6\n}"},{"path":"entityConfig.agent.transferMode","required":false,"desc":"Default seamless.","kind":"enum","enum":["seamless","nudge"],"value":"seamless"},{"path":"entityConfig.agent.transferModeRule","required":false,"desc":"Rule used with nudge.","kind":"string","value":""},{"path":"entityConfig.agent.reputationConfig","required":false,"desc":"Required only for reputation_outbound; rejected for any other entity.","kind":"json","value":""},{"path":"entityConfig.agent.templateId","required":false,"desc":"Stored only.","kind":"string","value":""},{"path":"entityConfig.agent.areaCode","required":false,"desc":"Stored only. 3 characters or null.","kind":"string","value":""},{"path":"entityConfig.agent.isReadyToGoLive","required":false,"desc":"Stored only.","kind":"boolean","value":""},{"path":"entityConfig.agent.fileUrls","required":false,"desc":"Stored only. One URL per line.","kind":"list","itemType":"string","value":""}]},"onb-agent-update":{"title":"Update an agent","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the agent backend and the database write"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors"},{"path":"entity","required":true,"desc":"Agent type key used at create.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"entityConfig","required":true,"desc":"Holds the changes.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"Send only what changes; other fields follow Create an agent.","kind":"group"},{"path":"entityConfig.agent.agentId","required":true,"desc":"Agent id. teamAgentMappingId is accepted as an alias.","kind":"string","value":"AGENT_ID"},{"path":"entityConfig.agent.agentTypeId","required":false,"desc":"Contracted agent type.","kind":"string","value":""},{"path":"entityConfig.agent.agentName","required":false,"desc":"Name the agent introduces itself with.","kind":"string","value":"Ava"},{"path":"entityConfig.agent.avatarId","required":false,"desc":"Avatar.","kind":"string","value":""},{"path":"entityConfig.agent.firstMessage","required":false,"desc":"Greeting during working hours.","kind":"string","value":"Thanks for calling Example Motors, this is Ava. How can I help today?"},{"path":"entityConfig.agent.tts","required":false,"desc":"Replaced as a whole.","kind":"group"},{"path":"entityConfig.agent.tts.voiceId","required":false,"desc":"Required if you send tts.","kind":"string","value":""},{"path":"entityConfig.agent.tts.supportedLanguages","required":false,"desc":"Required if you send tts. At least one language code, one per line.","kind":"list","itemType":"string","value":""}]},"onb-agent-list":{"title":"List agents","method":"GET","url":"https://api.spyne.ai/conversation/agents/team/{teamId}/onboarded-agents","params":[{"name":"teamId","in":"path","required":true,"value":"TEAM_ID","desc":"Rooftop."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, database reads"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-agent-assign-number":{"title":"Assign a phone number","method":"POST","url":"https://api.spyne.ai/console/v1/telephony/phone-numbers","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","5 requests / hour per dealer group and 5 per user"],["Processing","Synchronous; waits for purchase, messaging attach, save and call routing"],["Warning","Every success buys a real US phone number from the carrier and bills for it. Do not send unless you mean to buy a number."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group. Must match the token's dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop. Must belong to the dealer group and be active.","kind":"string","value":"TEAM_ID"},{"path":"teamAgentMappingId","required":true,"desc":"Agent the number is for.","kind":"string","value":"TEAM_AGENT_MAPPING_ID"}]},"onb-agent-get-policies":{"title":"Get the agent config","method":"GET","url":"https://api.spyne.ai/central-config/v1/vini-config/agent-config","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous; one read, four live fetches and a possible write-back"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-agent-save-policies":{"title":"Save sales policies","method":"POST","url":"https://api.spyne.ai/central-config/v1/vini-config/agent-config","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the database write and each push"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors"},{"path":"entityConfig","required":true,"desc":"Send at least one of the sections below; send each card in full.","kind":"group"},{"path":"entityConfig.sales","required":false,"desc":"Sales sections.","kind":"group"},{"path":"entityConfig.sales.policies","required":false,"desc":"Sales policy cards, for example testDrive or tradeIn.","kind":"json","value":"{\n \"testDrive\": {\n \"minDriverAge\": 18,\n \"insuranceRequired\": true,\n \"standardDurationMinutes\": 30\n }\n}"},{"path":"entityConfig.sales.reachOutAndFollowups","required":false,"desc":"Speed-to-lead and follow-up cards.","kind":"json","value":""},{"path":"entityConfig.ignoreAniNumbers","required":false,"desc":"Caller numbers to ignore, one per line. Replaces the list.","kind":"list","itemType":"string","value":""},{"path":"entityConfig.transferConfig","required":false,"desc":"type, mode, holdMusicUrl, ringingTimeout, onFailure and more.","kind":"json","value":""},{"path":"entityConfig.silentHours","required":false,"desc":"monday to sunday, each { enabled, start_time, end_time }.","kind":"json","value":""}]},"onb-agent-upload-calls":{"title":"Upload call transcripts or recordings","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/call-transcripts-recordings/files","params":[],"contentType":"multipart/form-data","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits until every file is stored"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group. Cannot be blank.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop. Cannot be blank.","kind":"string","value":"TEAM_ID"},{"path":"product","required":true,"desc":"Folder name, for example sales.","kind":"string","value":"sales"},{"path":"segmentName","required":true,"desc":"Folder name, for example inbound.","kind":"string","value":"inbound"},{"path":"uploadType","required":true,"desc":"Send transcripts and recordings in separate requests.","kind":"enum","enum":["transcript","recording"],"value":"transcript"},{"path":"files","required":true,"desc":"File to upload under the field name files; repeat the field for more files.","kind":"file","multiple":true}]},"onb-agent-list-scripts":{"title":"List chatbot scripts","method":"GET","url":"https://api.spyne.ai/central-config/v1/smartview-scripts","params":[{"name":"pageNo","in":"query","required":false,"value":"1","desc":"Page number from 1. Default 1."},{"name":"batch","in":"query","required":false,"value":"100","desc":"Page size, 1 to 100. Default 10."},{"name":"enterpriseId","in":"query","required":false,"value":"ENTERPRISE_ID","desc":"Exact match."},{"name":"teamId","in":"query","required":false,"value":"TEAM_ID","desc":"Exact match."},{"name":"enterpriseName","in":"query","required":false,"value":"","desc":"Contains, not case-sensitive."},{"name":"teamName","in":"query","required":false,"value":"","desc":"Contains, not case-sensitive."},{"name":"websiteUrl","in":"query","required":false,"value":"","desc":"Contains; scheme and trailing slash ignored."},{"name":"scriptUrl","in":"query","required":false,"value":"","desc":"Exact match."},{"name":"scriptId","in":"query","required":false,"value":"","desc":"Exact match."},{"name":"createdBy","in":"query","required":false,"value":"","desc":"Exact match."},{"name":"websiteProvider","in":"query","required":false,"value":"","desc":"Contains, not case-sensitive."},{"name":"sortBy","in":"query","required":false,"value":"","desc":"createdAt (default) or updatedAt."},{"name":"order","in":"query","required":false,"value":"","desc":"asc or desc (default)."},{"name":"startDate","in":"query","required":false,"value":"","desc":"YYYY-MM-DD, created date (UTC, inclusive)."},{"name":"endDate","in":"query","required":false,"value":"","desc":"YYYY-MM-DD, created date (UTC, inclusive)."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, one database query and count"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-agent-save-script":{"title":"Save a chatbot script","method":"POST","url":"https://api.spyne.ai/central-config/v1/integration","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the script service and the database write"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored and sent to the script service.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored and sent to the script service.","kind":"string","value":"Example Motors"},{"path":"domain","required":true,"desc":"Always publish.","kind":"enum","enum":["publish"],"value":"publish"},{"path":"entity","required":true,"desc":"Always SMARTVIEW.","kind":"enum","enum":["SMARTVIEW"],"value":"SMARTVIEW"},{"path":"entityconfig","required":true,"desc":"Script settings.","kind":"group"},{"path":"entityconfig.websiteUrl","required":true,"desc":"Dealer website.","kind":"string","value":"https://www.examplemotors.example"},{"path":"entityconfig.websiteProvider","required":true,"desc":"Website platform, for example dealeron.","kind":"string","value":"dealeron"},{"path":"entityconfig.active","required":true,"desc":"1 or 0.","kind":"integer","value":"1"},{"path":"entityconfig.selectedTeamId","required":true,"desc":"At least one rooftop id, one per line.","kind":"list","itemType":"string","value":"TEAM_ID"},{"path":"entityconfig.scriptId","required":false,"desc":"Required to update an existing script.","kind":"string","value":""},{"path":"entityconfig.scriptUrl","required":false,"desc":"Existing script URL.","kind":"string","value":""},{"path":"entityconfig.vehicleIdentificationType","required":false,"desc":"Default VIN.","kind":"string","hint":"VIN","value":""},{"path":"entityconfig.version","required":false,"desc":"Default v2.","kind":"string","hint":"v2","value":""},{"path":"entityconfig.globalConfigs","required":false,"desc":"Global settings.","kind":"group"},{"path":"entityconfig.globalConfigs.chatbotConfigs","required":false,"desc":"Chatbot settings; enabled is required when sent. Do not also set vdpConfigs.ci_enabled true.","kind":"json","value":"{\n \"enabled\": true,\n \"defaultDesktopPresentation\": \"floating\",\n \"initialWidgetState\": \"fab\",\n \"salesPages\": {\n \"mode\": \"ALL_PAGES\",\n \"pages\": []\n },\n \"servicePages\": {\n \"mode\": \"SPECIFIC_PAGES\",\n \"pages\": []\n }\n}"},{"path":"entityconfig.vdpConfigs","required":false,"desc":"VDP widget; needs studio_enabled, ci_enabled, integration_type and version when sent.","kind":"json","value":""},{"path":"entityconfig.vlpConfigs","required":false,"desc":"Listing page settings; needs studio_enabled when sent.","kind":"json","value":""},{"path":"entityconfig.created_by","required":false,"desc":"Kept from an earlier save.","kind":"string","value":""},{"path":"entityconfig.updated_by","required":false,"desc":"Kept from an earlier save.","kind":"string","value":""}]},"onb-golive-get-readiness":{"title":"Get readiness answers","method":"GET","url":"https://api.spyne.ai/central-config/v1/vini-config/go-live-readiness","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID. Must not be empty."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID. Must not be empty."},{"name":"entity","in":"query","required":true,"value":"sales_inbound","desc":"Agent type, for example sales_inbound or receptionist."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous, one database read"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-golive-save-readiness":{"title":"Save sales readiness answers","method":"POST","url":"https://api.spyne.ai/central-config/v1/vini-config/go-live-readiness","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; one read and one write of the config, plus a change-log entry"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID. Must not be empty.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID. Must not be empty.","kind":"string","value":"TEAM_ID"},{"path":"entity","required":true,"desc":"Agent type.","kind":"enum","enum":["sales_inbound","sales_outbound"],"value":"sales_inbound"},{"path":"enterpriseName","required":false,"desc":"Stored on the config if sent.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the config if sent.","kind":"string","value":""},{"path":"onboardingGoLiveReadiness","required":true,"desc":"Step name to an array of {question, answer, comment}, or null to clear the step.","kind":"json","value":"{\n \"afterHours\": [\n {\n \"question\": \"Calls during after hours\",\n \"answer\": true,\n \"comment\": \"\"\n },\n {\n \"question\": \"Speed to Lead on after hour leads\",\n \"answer\": true,\n \"comment\": \"\"\n },\n {\n \"question\": \"Followup on after hour leads\",\n \"answer\": false,\n \"comment\": \"BDC covers this\"\n },\n {\n \"question\": \"Appointment Reminder\",\n \"answer\": true,\n \"comment\": \"\"\n }\n ]\n}"}]},"onb-golive-agent-live":{"title":"Put an agent live","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user), validated again by the central config service"],["Rate limit","Not documented"],["Processing","Synchronous, 30-second forward timeout"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"entity","required":true,"desc":"Agent type, for example sales_inbound.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"enterpriseName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"entityConfig","required":true,"desc":"Holds the agent fields.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"Send only the two fields below unless you mean to change others.","kind":"group"},{"path":"entityConfig.agent.agentId","required":true,"desc":"Team-agent mapping ID; teamAgentMappingId is accepted as another name.","kind":"string","value":"AGENT_ID"},{"path":"entityConfig.agent.isOnboarded","required":true,"desc":"true to go live.","kind":"boolean","value":"true"}]},"onb-golive-agent-offline":{"title":"Take an agent offline","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user), validated again by the central config service"],["Rate limit","Not documented"],["Processing","Synchronous, 30-second forward timeout"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"entity","required":true,"desc":"Agent type, for example sales_inbound.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"enterpriseName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"entityConfig","required":true,"desc":"Holds the agent fields.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"Send only the two fields below unless you mean to change others.","kind":"group"},{"path":"entityConfig.agent.agentId","required":true,"desc":"Team-agent mapping ID; teamAgentMappingId is accepted as another name.","kind":"string","value":"AGENT_ID"},{"path":"entityConfig.agent.isOnboarded","required":true,"desc":"false to take the agent offline.","kind":"boolean","value":"false"}]},"onb-golive-list-plans":{"title":"List Receptionist plans","method":"GET","url":"https://api.spyne.ai/agent-marketplace/billing/products/{productKey}/plans","params":[{"name":"productKey","in":"path","required":true,"value":"receptionist_agent","desc":"Billing product key. Receptionist: receptionist_agent."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, two database reads"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-golive-checkout":{"title":"Start a paid-plan checkout","method":"POST","url":"https://api.spyne.ai/agent-marketplace/billing/checkout","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user); the token must carry a dealer group and rooftop"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the billing service"],["Warning","Starts a real paid checkout for the rooftop in enterprise_id and team_id. Replace the placeholders only if you mean to bill that rooftop."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"agent_key","required":true,"desc":"Billing product key, receptionist_agent.","kind":"string","value":"receptionist_agent"},{"path":"plan_key","required":true,"desc":"Plan key from List Receptionist plans.","kind":"string","value":"PLAN_KEY"},{"path":"success_url","required":true,"desc":"URL to return to after payment.","kind":"string","value":"https://console.example.com/reception"},{"path":"cancel_url","required":true,"desc":"URL to return to if the dealer cancels.","kind":"string","value":"https://console.example.com/reception"},{"path":"enterprise_id","required":true,"desc":"Dealer group being billed.","kind":"string","value":"ENTERPRISE_ID"},{"path":"team_id","required":true,"desc":"Rooftop being billed.","kind":"string","value":"TEAM_ID"}]},"onb-golive-phone-number":{"title":"Buy a phone number","method":"POST","url":"https://api.spyne.ai/console/v1/telephony/phone-numbers","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","5 requests / hour per dealer group and 5 per user"],["Processing","Synchronous; waits for purchase, messaging attach, save and call routing"],["Warning","Every success buys a real US phone number from the carrier and bills for it. Do not send unless you mean to buy a number."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group. Must match the token's dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop. Must belong to the dealer group and be active.","kind":"string","value":"TEAM_ID"},{"path":"teamAgentMappingId","required":true,"desc":"The Receptionist's agent id.","kind":"string","value":"TEAM_AGENT_MAPPING_ID"}]},"onb-golive-activate-trial":{"title":"Start the trial clock","method":"POST","url":"https://api.spyne.ai/agent-marketplace/billing/products/{productKey}/subscription/activate","params":[{"name":"productKey","in":"path","required":true,"value":"PRODUCT_KEY","desc":"Billing product key. Receptionist: receptionist_agent."}],"contentType":"application/json","meta":[["Auth","Bearer token (console user); dealer group and rooftop are read from the token"],["Rate limit","Not documented"],["Processing","Synchronous"],["Warning","Activates the subscription and starts the trial clock for the token's rooftop. Send an empty body; only call after the phone number purchase succeeds."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"onb-golive-add-live-product":{"title":"Grant the live product","method":"POST","url":"https://api.spyne.ai/user-management/v1/team/add-live-products","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; writes, task creation and stage rollup finish before the response"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"products","required":true,"desc":"Product registry names, one per line. Receptionist: receptionWebChat.","kind":"list","itemType":"string","value":"receptionWebChat"},{"path":"enterpriseId","required":false,"desc":"Dealer group ID; must match the rooftop's dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"updatedBy","required":false,"desc":"Actor on the stage events. Defaults to the caller, then system.","kind":"string","value":""},{"path":"reason","required":false,"desc":"Reason on the stage events.","kind":"string","hint":"Enabled as Live via agent marketplace","value":""},{"path":"source","required":false,"desc":"Default api.","kind":"enum","enum":["manual","automatic","system","api","webhook"],"value":""}]},"onb-golive-assign-number-done":{"title":"Mark Assign Number done","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/onboarding-tracker/bulk-complete-shared-task","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; task rows are updated before the response"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"taskName","required":true,"desc":"Checklist task name.","kind":"string","value":"Assign Number"},{"path":"segmentName","required":false,"desc":"Agent-level tasks only. Receptionist: receptionWebChat.","kind":"string","value":"receptionWebChat"},{"path":"isCompleted","required":true,"desc":"true to complete the task.","kind":"boolean","value":"true"}]},"onb-int-save-vehicle-history":{"title":"Save the vehicle history integration","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/integration","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous (up to 30 s). Partner onboarding failures are ignored."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"domain","required":true,"desc":"Always integration.","kind":"string","value":"integration"},{"path":"entity","required":true,"desc":"Which integration to save.","kind":"enum","value":"CAR_HISTORY","enum":["CAR_HISTORY"]},{"path":"entityconfig","required":true,"desc":"Shape depends on entity (see the tables on this page); unknown keys are dropped.","kind":"json","value":"{\n}"},{"path":"enterpriseName","required":false,"desc":"Dealer group name, stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Rooftop name, stored with the record.","kind":"string","value":"Example Motors"}]},"onb-int-save-scheduler":{"title":"Save the service scheduler integration","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/integration","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous (up to 30 s). Partner onboarding failures are ignored."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"domain","required":true,"desc":"Always integration.","kind":"string","value":"integration"},{"path":"entity","required":true,"desc":"Which integration to save.","kind":"enum","value":"SERVICE_SCHEDULER","enum":["SERVICE_SCHEDULER"]},{"path":"entityconfig","required":true,"desc":"Shape depends on entity (see the tables on this page); unknown keys are dropped.","kind":"json","value":"{\n}"},{"path":"enterpriseName","required":false,"desc":"Dealer group name, stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Rooftop name, stored with the record.","kind":"string","value":"Example Motors"}]},"onb-agent-save-service-policies":{"title":"Save service policies","method":"POST","url":"https://api.spyne.ai/central-config/v1/vini-config/agent-config","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the database write and each push"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors"},{"path":"entityConfig","required":true,"desc":"Send at least one of the sections below; send each card in full.","kind":"group"},{"path":"entityConfig.service","required":false,"desc":"Service sections.","kind":"group"},{"path":"entityConfig.service.policies","required":false,"desc":"Service policy string lists. Unknown keys are dropped.","kind":"json","value":"{\n \"transportationOptions\": [\n \"shuttle\",\n \"loaner\"\n ]\n}"},{"path":"entityConfig.ignoreAniNumbers","required":false,"desc":"Caller numbers to ignore, one per line. Replaces the list.","kind":"list","itemType":"string","value":""},{"path":"entityConfig.transferConfig","required":false,"desc":"type, mode, holdMusicUrl, ringingTimeout, onFailure and more.","kind":"json","value":""},{"path":"entityConfig.silentHours","required":false,"desc":"monday to sunday, each { enabled, start_time, end_time }.","kind":"json","value":""}]},"onb-golive-save-service-readiness":{"title":"Save service readiness answers","method":"POST","url":"https://api.spyne.ai/central-config/v1/vini-config/go-live-readiness","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; one read and one write of the config, plus a change-log entry"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID. Must not be empty.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID. Must not be empty.","kind":"string","value":"TEAM_ID"},{"path":"entity","required":true,"desc":"Agent type.","kind":"enum","enum":["service_inbound","service_outbound"],"value":"service_inbound"},{"path":"enterpriseName","required":false,"desc":"Stored on the config if sent.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the config if sent.","kind":"string","value":""},{"path":"onboardingGoLiveReadiness","required":true,"desc":"Step name to an array of {question, answer, comment}, or null to clear the step.","kind":"json","value":"{\n \"afterHours\": [\n {\n \"question\": \"Calls during after hours\",\n \"answer\": true,\n \"comment\": \"\"\n },\n {\n \"question\": \"Speed to Lead on after hour leads\",\n \"answer\": true,\n \"comment\": \"\"\n },\n {\n \"question\": \"Followup on after hour leads\",\n \"answer\": false,\n \"comment\": \"BDC covers this\"\n },\n {\n \"question\": \"Appointment Reminder\",\n \"answer\": true,\n \"comment\": \"\"\n }\n ]\n}"}]},"svc-contract-get-config":{"title":"Get contract config","method":"GET","url":"https://api.spyne.ai/credit/v6/contracting/get-contract-config","params":[{"name":"currency","in":"query","required":false,"value":"USD","desc":"Currency code for price conversion, e.g. USD or INR. Default USD."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; built from database reads in the same request."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-contract-prefill":{"title":"Reload a saved contract","method":"GET","url":"https://api.spyne.ai/credit/v6/contracting/prefill-contract-data","params":[{"name":"contractId","in":"query","required":true,"value":"CONTRACT_ID","desc":"ID of the contract to load."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the contract read and the pricing and rooftop name refresh."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-contract-create":{"title":"Save or submit a contract","method":"POST","url":"https://api.spyne.ai/credit/v6/contracting/create-contract-v2","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for validation and the contract write."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"isDraft","required":true,"desc":"true saves a draft; false submits the contract.","kind":"boolean","value":"false"},{"path":"contractId","required":false,"desc":"ID of an existing Draft contract to update. Leave empty to create a new one.","kind":"string","value":"CONTRACT_ID"},{"path":"isAmendment","required":false,"desc":"true routes to the amendment flow (not covered on this page).","kind":"boolean","value":"false"},{"path":"contractDetails","required":true,"desc":"Deal-level details.","kind":"group"},{"path":"contractDetails.enterpriseId","required":true,"desc":"Dealer group ID. Required for drafts too.","kind":"string","value":"ENTERPRISE_ID"},{"path":"contractDetails.currency","required":true,"desc":"Currency code; must be INR when the customer country is India.","kind":"string","value":"USD"},{"path":"contractDetails.dealType","required":true,"desc":"One of data.basicDetails.dealTypes; currently only New Deal.","kind":"enum","enum":["New Deal"],"value":"New Deal"},{"path":"contractDetails.customerType","required":true,"desc":"Dealer type of the customer.","kind":"enum","enum":["Individual Dealer","Group Dealer","Reseller"],"value":"Individual Dealer"},{"path":"contractDetails.managerName","required":false,"desc":"Account manager; if set, one of data.basicDetails.managerNames.","kind":"string","value":""},{"path":"customerDetails","required":false,"desc":"Required when submitting. Legal entity and address of the dealer group.","kind":"group"},{"path":"customerDetails.legalName","required":true,"desc":"Legal name of the dealer group.","kind":"string","value":"Example Motors LLC"},{"path":"customerDetails.brandName","required":true,"desc":"Trading name.","kind":"string","value":"Example Motors"},{"path":"customerDetails.region","required":true,"desc":"Region of the dealer group.","kind":"enum","enum":["AMER","APAC","EMEA","OTHERS"],"value":"AMER"},{"path":"customerDetails.streetAddress","required":true,"desc":"Street address.","kind":"string","value":"100 Example Street"},{"path":"customerDetails.country","required":true,"desc":"Country.","kind":"string","value":"United States"},{"path":"customerDetails.pincode","required":true,"desc":"Postal (ZIP) code, sent as a string.","kind":"string","value":"00000"},{"path":"customerDetails.state","required":true,"desc":"State.","kind":"string","value":"Example State"},{"path":"customerDetails.city","required":true,"desc":"City.","kind":"string","value":"Example City"},{"path":"customerDetails.stateCode","required":false,"desc":"Sent only when the country is India.","kind":"string","value":""},{"path":"customerDetails.contractedRooftops","required":false,"desc":"Required for Group Dealer. Number of contracted rooftops, above 0.","kind":"integer","value":""},{"path":"customerDetails.billingTo","required":false,"desc":"Required for Group Dealer. Currently only Group Dealer (Combined).","kind":"string","value":""},{"path":"pricing","required":false,"desc":"Required when submitting. data.pricing from Get contract config, unchanged; needs an entry per product line used.","kind":"json","value":"{\n \"conversationalAi\": {\n \"type\": \"\",\n \"allowedProducts\": {},\n \"items\": {}\n }\n}"},{"path":"rooftops","required":false,"desc":"Required when submitting. At least one rooftop.","kind":"items","sub":[{"key":"rooftopName","kind":"string","enum":null,"desc":"Rooftop name, unique within the contract."},{"key":"subType","kind":"enum","enum":["Independent Dealer","Franchise Dealer","Mixed"],"desc":"Rooftop type."},{"key":"region","kind":"enum","enum":["AMER","APAC","EMEA","OTHERS"],"desc":"Copied from customerDetails by the console."},{"key":"streetAddress","kind":"string","enum":null,"desc":"Rooftop street address."},{"key":"country","kind":"string","enum":null,"desc":"Rooftop country."},{"key":"pincode","kind":"string","enum":null,"desc":"Rooftop postal (ZIP) code."},{"key":"state","kind":"string","enum":null,"desc":"Rooftop state."},{"key":"city","kind":"string","enum":null,"desc":"Rooftop city."},{"key":"bundle","kind":"string","enum":null,"desc":"Key of the bundle in line_items.value, e.g. bundle-1."},{"key":"teamId","kind":"string","enum":null,"desc":"Existing rooftop ID; sent only for amendments."},{"key":"existingInventory","kind":"number","enum":null,"desc":"Optional; must be a number when sent."},{"key":"productsLines","kind":"json","enum":null,"desc":"Array of product lines (productLineName, plan, products, oneTimePurchases, addOns)."}],"rows":[{"rooftopName":"Example Motors","subType":"Franchise Dealer","region":"AMER","streetAddress":"100 Example Street","country":"United States","pincode":"00000","city":"Example City","state":"Example State","bundle":"bundle-1","productsLines":"[\n {\n \"productLineName\": \"conversationalAi\",\n \"plan\": \"\",\n \"oneTimePurchases\": [],\n \"products\": [\n {\n \"product\": \"salesInbound\",\n \"units\": \"100\",\n \"unitType\": \"vinsPerMonth\",\n \"cost\": 0\n },\n {\n \"product\": \"serviceInbound\",\n \"units\": \"100\",\n \"unitType\": \"roPerMonth\",\n \"cost\": 0\n }\n ]\n }\n]"}]},{"path":"signatoryDetails","required":false,"desc":"Required when submitting. The dealer-side person who signs.","kind":"group"},{"path":"signatoryDetails.name","required":true,"desc":"Signer name.","kind":"string","value":"Jane Doe"},{"path":"signatoryDetails.email","required":true,"desc":"Signer email; DocuSign sends the envelope here.","kind":"string","value":"jane.doe@example.com"},{"path":"signatoryDetails.designation","required":true,"desc":"Signer job title.","kind":"string","value":"General Manager"},{"path":"signatoryDetails.contactNumber","required":true,"desc":"Object with isdCode and number, both strings.","kind":"json","value":"{\n \"isdCode\": \"+1\",\n \"number\": \"5550100000\"\n}"},{"path":"signatoryDetails.clientPOCs","required":false,"desc":"Extra dealer emails to copy on the envelope, one per line.","kind":"list","itemType":"string","value":""},{"path":"billingDetails","required":false,"desc":"Required when submitting. Billing frequency and finance contact.","kind":"group"},{"path":"billingDetails.billingFrequency","required":true,"desc":"Billing frequency in months: 1, 3, 6 or 12.","kind":"integer","value":"12"},{"path":"billingDetails.financePOCName","required":true,"desc":"Finance contact name.","kind":"string","value":"John Doe"},{"path":"billingDetails.financePOCEmail","required":true,"desc":"Finance contact email.","kind":"string","value":"john.doe@example.com"},{"path":"billingDetails.financePOCNumber","required":true,"desc":"Object with isdCode and number, both strings.","kind":"json","value":"{\n \"isdCode\": \"+1\",\n \"number\": \"5550100000\"\n}"},{"path":"billingDetails.billingTo","required":false,"desc":"Copied from customerDetails.billingTo when set.","kind":"string","value":""},{"path":"billingDetails.billingEntity","required":false,"desc":"Billing entity from data.billingEntities (key vs label not confirmed).","kind":"string","value":""},{"path":"billingDetails.taxId","required":false,"desc":"Tax ID; sent only when not empty.","kind":"string","value":""},{"path":"terms","required":false,"desc":"Required when submitting. Contract terms.","kind":"group"},{"path":"terms.t&cTemplatePath","required":true,"desc":"Terms template path, normally data.defaultTcTemplatePathPdf.","kind":"string","value":"contracts/default-terms-and-conditions-template.pdf"},{"path":"terms.editT&C","required":true,"desc":"true if custom terms were uploaded.","kind":"boolean","value":"false"},{"path":"terms.exception","required":true,"desc":"true if the deal is raised as an exception.","kind":"boolean","value":"false"},{"path":"terms.contractTerm","required":true,"desc":"Contract term; unit not documented.","kind":"integer","value":"12"},{"path":"terms.lockInPeriod","required":true,"desc":"Lock-in period; unit not documented.","kind":"integer","value":"12"},{"path":"terms.noticePeriodForAutoRenewal","required":true,"desc":"Notice period for auto renewal; unit not documented.","kind":"integer","value":"30"},{"path":"terms.terminationDays","required":false,"desc":"Value from data.terminationDays (30 or 60).","kind":"integer","value":"30"},{"path":"terms.freeDays","required":false,"desc":"Must be a number when sent.","kind":"integer","value":""},{"path":"line_items","required":false,"desc":"Required when submitting. Priced line items grouped by bundle.","kind":"group"},{"path":"line_items.type","required":true,"desc":"Must be bundle.","kind":"enum","enum":["bundle"],"value":"bundle"},{"path":"line_items.value","required":true,"desc":"One entry per bundle key (e.g. bundle-1) with studioAi / conversationalAi sections of line items.","kind":"json","value":"{\n \"bundle-1\": {\n \"existingInventoryPerRooftop\": 0,\n \"rooftopsCount\": 1,\n \"studioAi\": {\n \"studio\": [],\n \"addOns\": []\n },\n \"conversationalAi\": {\n \"salesAgent\": [\n {\n \"type\": \"Inbound\",\n \"frequency\": \"Monthly\",\n \"basePrice\": 0,\n \"discountAmount\": 0,\n \"discountPercent\": 0,\n \"finalPrice\": 0,\n \"units\": 100\n }\n ],\n \"serviceAgent\": [\n {\n \"type\": \"Inbound\",\n \"frequency\": \"Monthly\",\n \"basePrice\": 0,\n \"discountAmount\": 0,\n \"discountPercent\": 0,\n \"finalPrice\": 0,\n \"units\": 100\n }\n ],\n \"receptionAgent\": [],\n \"acquisitionAgent\": [],\n \"addOns\": []\n }\n }\n}"},{"path":"summary","required":false,"desc":"Required when submitting. Fee totals.","kind":"group"},{"path":"summary.totalOneTimeFee","required":true,"desc":"Total one-time fees, at most 2 decimals.","kind":"number","value":"0"},{"path":"summary.totalMonthlyRecurringFee","required":true,"desc":"Total monthly recurring fees, at most 2 decimals.","kind":"number","value":"0"},{"path":"summary.totalAnnuallyRecurringFee","required":true,"desc":"Total annual recurring fees, at most 2 decimals.","kind":"number","value":"0"}]},"svc-contract-send-for-signature":{"title":"Send for signature","method":"POST","url":"https://api.spyne.ai/credit/v6/contracting/send-for-signature","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for DocuSign to create the envelope and for the stage update."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID; must match the contract.","kind":"string","value":"ENTERPRISE_ID"},{"path":"contractId","required":true,"desc":"Contract ID from Save or submit a contract.","kind":"string","value":"CONTRACT_ID"}]},"svc-contract-docusign-webhook":{"title":"Receive DocuSign events","method":"POST","url":"https://api.spyne.ai/credit/v6/contracting/docusign-webhook","params":[],"contentType":"application/json","meta":[["Auth","No user token. Requires X-DocuSign-Signature-1 (or -2): HMAC-SHA256, base64, of the raw body"],["Caller","DocuSign Connect, not a console user"],["Rate limit","Not documented"],["Processing","Synchronous; on envelope-completed waits for the signed PDF copy, child records and stage update."]],"authHint":"No bearer token: DocuSign calls this endpoint. Without a valid X-DocuSign-Signature-1 HMAC header the request is rejected.","fields":[{"path":"event","required":true,"desc":"DocuSign event name; also read from data.event.","kind":"enum","enum":["envelope-sent","envelope-delivered","recipient-viewed","envelope-viewed","recipient-authentication-failed","envelope-voided","voided","declined","recipient-completed","envelope-completed"],"value":"envelope-completed"},{"path":"data","required":false,"desc":"DocuSign payload wrapper.","kind":"group"},{"path":"data.envelopeId","required":false,"desc":"Required if the event is processed. Envelope ID; also read from top-level envelopeId.","kind":"string","value":"ENVELOPE_ID"},{"path":"data.envelopeSummary.customFields.textCustomFields","required":false,"desc":"contractId and enterpriseId entries used to find the contract.","kind":"items","sub":[{"key":"name","kind":"string","enum":null,"desc":"contractId or enterpriseId."},{"key":"value","kind":"string","enum":null,"desc":"The matching ID."}],"rows":[{"name":"contractId","value":"CONTRACT_ID"},{"name":"enterpriseId","value":"ENTERPRISE_ID"}]},{"path":"data.signerEmail","required":false,"desc":"Dealer signer email for recipient-completed; falls back to the stored email.","kind":"string","value":""},{"path":"data.spyneSignerEmail","required":false,"desc":"Spyne signer email for envelope-completed.","kind":"string","value":""}]},"svc-contract-handover-details":{"title":"Save handover details","method":"POST","url":"https://api.spyne.ai/console/v1/contracting/onboarding/update-handover-details-v2","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; one read and one update of the product line record."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"product_line_details_id","required":true,"desc":"Product line ID.","kind":"string","value":"PRODUCT_LINE_ID"},{"path":"input_medium","required":false,"desc":"Systems the rooftop's data comes from; must contain ims_dms and website_provider.","kind":"json","value":"{\n \"ims_dms\": \"IMS_DMS\",\n \"website_provider\": \"WEBSITE_PROVIDER\"\n}"},{"path":"output_medium","required":false,"desc":"Systems the output goes to; must contain ims_dms and website_provider.","kind":"json","value":"{\n \"ims_dms\": \"IMS_DMS\",\n \"website_provider\": \"WEBSITE_PROVIDER\"\n}"},{"path":"platforms","required":false,"desc":"Platform list, one per line; allowed values not documented.","kind":"list","itemType":"string","value":"PLATFORM"},{"path":"website_url","required":false,"desc":"Dealer website URL.","kind":"string","value":"https://www.example.com"},{"path":"spyne_rooftops","required":false,"desc":"Number of rooftops on Spyne.","kind":"number","value":"1"},{"path":"potential_rooftops","required":false,"desc":"Number of potential rooftops.","kind":"number","value":"1"},{"path":"markets_serving","required":false,"desc":"Markets the dealer serves.","kind":"string","value":"Example City"},{"path":"languages_spoken","required":false,"desc":"Languages spoken, one per line.","kind":"list","itemType":"string","value":"English"},{"path":"notes","required":false,"desc":"Handover notes.","kind":"string","value":"Example handover notes"}]},"svc-contract-schedule-meeting":{"title":"Schedule an onboarding meeting","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/schedule-onboarding-meeting","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for Google Calendar to create the event."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"startTime","required":true,"desc":"Start time, ISO 8601.","kind":"string","value":"2026-01-01T15:00:00.000Z"},{"path":"endTime","required":true,"desc":"End time, ISO 8601; must be after startTime.","kind":"string","value":"2026-01-01T15:15:00.000Z"},{"path":"timeZone","required":true,"desc":"IANA time zone, e.g. America/New_York.","kind":"string","value":"America/New_York"},{"path":"attendees","required":true,"desc":"Attendee emails, one per line; must not be empty.","kind":"list","itemType":"string","value":"jane.doe@example.com"},{"path":"summary","required":true,"desc":"Event title.","kind":"string","value":"Example Motors onboarding"}]},"svc-contract-update-sub-stage":{"title":"Update handover sub-stage","method":"POST","url":"https://api.spyne.ai/user-management/v1/product-line/update-stage","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; on Meet Done also calls the checklist creation (its failure does not fail the request)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"entityType","required":true,"desc":"product_line for this use; product, team and addon are not covered here.","kind":"enum","enum":["product_line","product","team","addon"],"value":"product_line"},{"path":"entityId","required":true,"desc":"Product line ID when entityType is product_line.","kind":"string","value":"PRODUCT_LINE_ID"},{"path":"sub_stage","required":false,"desc":"New sub-stage, e.g. Meet Scheduled or Meet Done. Send this or stage, not both.","kind":"string","value":"Meet Done"},{"path":"stage","required":false,"desc":"New stage (not covered on this page). Send this or sub_stage, not both.","kind":"string","value":""},{"path":"meta_data","required":false,"desc":"Required if the sub-stage requires fields: ob_manager, cs_manager, cs_id, platforms, churn_reason, reason, meeting fields.","kind":"json","value":"{\n \"ob_manager\": \"USER_ID\",\n \"meet_required\": false\n}"},{"path":"live_date","required":false,"desc":"YYYY-MM-DD, only with stage Live (not covered on this page).","kind":"string","value":""}]},"svc-contract-create-checklist":{"title":"Create the onboarding checklist","method":"POST","url":"https://api.spyne.ai/console/v1/onboarding/task/create-onboarding-task-v2","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","A per-product-line lock (15 s, up to 5 retries 300 ms apart) blocks concurrent calls for the same product line."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"product_line_id","required":true,"desc":"Product line ID.","kind":"string","value":"PRODUCT_LINE_ID"}]},"svc-contract-task-template":{"title":"Get the onboarding task template","method":"POST","url":"https://api.spyne.ai/credit/v2/product-line-registry/get-onboarding-task-config","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; one database read."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"product_line_registry_id","required":false,"desc":"Registry ID; leave empty to get all registries, newest first.","kind":"string","value":"PRODUCT_LINE_REGISTRY_ID"}]},"svc-checklist-contracting-data":{"title":"Get contracting data","method":"GET","url":"https://api.spyne.ai/credit/v6/get-team-contracting-data","params":[{"name":"enterpriseId","in":"query","required":true,"value":"","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-checklist-contract-product-lines":{"title":"Get contract product lines","method":"GET","url":"https://api.spyne.ai/user-management/v1/team-onboarding/get-contract-product-lines","params":[{"name":"enterpriseId","in":"query","required":true,"value":"","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; reads the dealer group, rooftops, product lines and product registry."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-checklist-active-products":{"title":"List active Vini products","method":"GET","url":"https://api.spyne.ai/user-management/v1/vini/active-products","params":[{"name":"teamId","in":"query","required":true,"value":"","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-checklist-get-checklist":{"title":"Get the onboarding checklist","method":"GET","url":"https://api.spyne.ai/console/v1/onboarding/task/get-onboarding-task-v2","params":[{"name":"teamId","in":"query","required":false,"value":"","desc":"Rooftop ID. Required unless productLineId is sent; used with productLineName."},{"name":"productLineName","in":"query","required":false,"value":"conversationalAi","desc":"studioAi or conversationalAi (Vini). Required unless productLineId is sent."},{"name":"productLineId","in":"query","required":false,"value":"","desc":"One ID or up to 20 comma-separated IDs; with several, omit teamId, productLineName and productGroup."},{"name":"productGroup","in":"query","required":false,"value":"","desc":"Accepted but not used to filter the result."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-checklist-agent-details":{"title":"Get contracted agent details","method":"GET","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agents/teams/{teamId}/enterpriseId/{enterpriseId}","params":[{"name":"teamId","in":"path","required":true,"value":"","desc":"Rooftop ID."},{"name":"enterpriseId","in":"path","required":true,"value":"","desc":"Dealer group ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the agent service (30-second timeout)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-checklist-mark-task-done":{"title":"Mark a task done","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/onboarding-tracker/bulk-complete-shared-task","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; task rows are updated before the response returns."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":""},{"path":"taskName","required":true,"desc":"Task name; matched exactly, ignoring case.","kind":"string","value":"CRM Integration"},{"path":"segmentName","required":false,"desc":"Required for Agent Setup and Go Live Readiness tasks, e.g. inboundSales; case-sensitive.","kind":"string","value":""},{"path":"isCompleted","required":false,"desc":"true marks matching tasks COMPLETED; false or omitted marks them INPROGRESS.","kind":"boolean","value":"true"}]},"svc-rooftop-get-details":{"title":"Get rooftop details","method":"GET","url":"https://api.spyne.ai/user-management/v1/team/get-team-details","params":[{"name":"team_id","in":"query","required":true,"value":"TEAM_ID","desc":"The rooftop ID (snake_case)."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Database reads only."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-rooftop-get-vehicle-types":{"title":"Get vehicle types and department addresses","method":"GET","url":"https://api.spyne.ai/central-config/v1/integration","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"domain","in":"query","required":true,"value":"rooftop","desc":"rooftop for this task."},{"name":"entity","in":"query","required":true,"value":"INFO","desc":"INFO for this task."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous. One database read."]],"authHint":"Optional: this route does not check a token. Used only for this request; not saved.","fields":[]},"svc-rooftop-save-details":{"title":"Save rooftop details","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/update-rooftop-data","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Waits for every write (30 s timeout each); writes are not rolled back."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":true,"desc":"Rooftop name to save.","kind":"string","value":"Example Motors"},{"path":"enterpriseName","required":false,"desc":"Dealer group name, stored on the configuration record.","kind":"string","value":"Example Motors Group"},{"path":"rooftopData","required":true,"desc":"Rooftop profile.","kind":"group"},{"path":"rooftopData.website","required":true,"desc":"Rooftop website.","kind":"string","value":"https://www.example.com"},{"path":"rooftopData.websiteListingUrl","required":false,"desc":"Inventory listing page URL.","kind":"string","value":"https://www.example.com/used-inventory"},{"path":"rooftopData.address","required":true,"desc":"addressLine1, addressLine2, city, state, district, country, zipcode.","kind":"json","value":"{\n \"addressLine1\": \"100 Example Ave\",\n \"addressLine2\": \"\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"district\": \"\",\n \"country\": \"United States\",\n \"zipcode\": \"78701\"\n}"},{"path":"rooftopData.geoCoordinates","required":true,"desc":"Rooftop coordinates.","kind":"group"},{"path":"rooftopData.geoCoordinates.lat","required":true,"desc":"Latitude.","kind":"number","value":"30.2672"},{"path":"rooftopData.geoCoordinates.lng","required":true,"desc":"Longitude.","kind":"number","value":"-97.7431"},{"path":"rooftopData.regionType","required":true,"desc":"Region code, e.g. AMER.","kind":"string","value":"AMER"},{"path":"rooftopData.timeZone","required":true,"desc":"IANA timezone, e.g. America/Chicago.","kind":"string","value":"America/Chicago"},{"path":"rooftopData.userData","required":false,"desc":"{userId, name, email, contactNo, isdCode}; only isdCode and contactNo are saved.","kind":"json","value":"{\n \"userId\": \"USER_ID\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane.doe@example.com\",\n \"contactNo\": \"5550100000\",\n \"isdCode\": \"+1\"\n}"},{"path":"entityConfig","required":true,"desc":"Leaving it out returns 500.","kind":"group"},{"path":"entityConfig.vehicleType","required":false,"desc":"Vehicle types the rooftop sells.","kind":"group"},{"path":"entityConfig.vehicleType.new","required":false,"desc":"Sells new vehicles.","kind":"boolean","value":"true"},{"path":"entityConfig.vehicleType.preOwned","required":false,"desc":"Sells pre-owned vehicles.","kind":"boolean","value":"true"},{"path":"entityConfig.salesAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"entityConfig.serviceAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"entityConfig.partsAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"entityConfig.financeAddress","required":false,"desc":"{address, geoCoordinates{lat, lng}}. The UI does not send it.","kind":"json","value":""},{"path":"domain","required":false,"desc":"Used only for the agent configuration write. The UI sends rooftop.","kind":"string","value":"rooftop"},{"path":"entity","required":false,"desc":"The UI sends INFO; sales/service inbound/outbound also write agent config.","kind":"string","value":"INFO"},{"path":"productLineId","required":false,"desc":"With taskName, updates that checklist task. The UI does not send it.","kind":"string","value":""},{"path":"taskName","required":false,"desc":"Checklist task to update.","kind":"string","value":""},{"path":"segmentName","required":false,"desc":"Agent segment of the task. Needed for Vini product lines.","kind":"string","value":""},{"path":"isCompleted","required":false,"desc":"true completes the task, otherwise starts it.","kind":"boolean","value":""}]},"svc-rooftop-get-departments":{"title":"Get departments, hours and holidays","method":"GET","url":"https://api.spyne.ai/central-config/v1/vini-config/departments","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous. A failed write-back is logged and does not fail the read."]],"authHint":"Optional: this route does not check a token. Used only for this request; not saved.","fields":[]},"svc-rooftop-save-departments":{"title":"Save departments, hours and holidays","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/departments","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Pushes run in sequence and are not rolled back."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored on the configuration record.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the configuration record.","kind":"string","value":""},{"path":"timezone","required":false,"desc":"IANA timezone used for the sales working-days sync.","kind":"string","value":"America/Chicago"},{"path":"departments","required":false,"desc":"Complete department list (name, contact, timings, address). Leave out to keep as is.","kind":"json","value":"[\n {\n \"name\": \"sales\",\n \"contact\": {\n \"name\": \"Sales\",\n \"phone\": \"+15550100000\",\n \"isIvr\": false\n },\n \"timings\": {\n \"monday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"tuesday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"wednesday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"thursday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"friday\": {\n \"isAvailable\": true,\n \"startTime\": \"09:00\",\n \"endTime\": \"18:00\"\n },\n \"saturday\": {\n \"isAvailable\": true,\n \"startTime\": \"10:00\",\n \"endTime\": \"16:00\"\n },\n \"sunday\": {\n \"isAvailable\": false\n }\n }\n },\n {\n \"name\": \"service\",\n \"timings\": {\n \"isSameAsSales\": true\n }\n }\n]"},{"path":"holidays","required":false,"desc":"Complete holiday list (name, reason, date, recurrence, open, hours, departments). Leave out to keep as is.","kind":"json","value":"[\n {\n \"name\": \"Thanksgiving\",\n \"reason\": \"Public holiday\",\n \"date\": \"2026-11-26\",\n \"recurrence\": \"yearly\",\n \"open\": false,\n \"hours\": [],\n \"departments\": \"all\"\n }\n]"}]},"svc-rooftop-list-users":{"title":"List console users","method":"GET","url":"https://api.spyne.ai/user-management/v1/team/get-team-users-details","params":[{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"skipEnterpriseFallback","in":"query","required":false,"value":"","desc":"true skips the fallback to dealer group users. Default false."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Database reads only."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-rooftop-invite-users":{"title":"Invite console users","method":"POST","url":"https://api.spyne.ai/console/v1/user/send-invite-links","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user) with CREATE_USER_MULTIPLE permission"],["Rate limit","Not documented"],["Processing","Synchronous database writes; emails are sent later by a scheduled job."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":true,"desc":"Rooftop name, echoed back in the response.","kind":"string","value":"Example Motors"},{"path":"resellerId","required":false,"desc":"Reseller flow only.","kind":"string","value":""},{"path":"userList","required":true,"desc":"1 to 100 users; each needs email and roleName. Avoid apostrophes in names.","kind":"items","value":"","sub":[{"key":"email","kind":"string","enum":null,"desc":"Required. Trimmed and lower-cased."},{"key":"roleName","kind":"string","enum":null,"desc":"Required. Role for the invite, e.g. TEAM_STANDARD."},{"key":"teamRole","kind":"string","enum":null,"desc":"Rooftop role; the UI sends the same as roleName."},{"key":"userName","kind":"string","enum":null,"desc":"Display name."},{"key":"designation","kind":"string","enum":null,"desc":"Job title."},{"key":"isdCode","kind":"string","enum":null,"desc":"Country code, e.g. +1."},{"key":"contactNo","kind":"string","enum":null,"desc":"Phone number."},{"key":"department","kind":"string","enum":null,"desc":"Department. The UI sends an empty string."}],"rows":[{"email":"john.roe@example.com","roleName":"TEAM_STANDARD","teamRole":"TEAM_STANDARD","userName":"John Roe","designation":"BDC Manager","isdCode":"+1","contactNo":"5550100001","department":""}]}]},"svc-rooftop-list-directory":{"title":"List the employee directory","method":"GET","url":"https://api.spyne.ai/user-management/v1/directory/enterprise/{enterpriseId}/team/{teamId}/get-directory","params":[{"name":"enterpriseId","in":"path","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"path","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"keyword","in":"query","required":false,"value":"","desc":"Search on first name, last name or email."},{"name":"active","in":"query","required":false,"value":"","desc":"true or false."},{"name":"page","in":"query","required":false,"value":"1","desc":"Default 1. Sending page or limit turns on paging."},{"name":"limit","in":"query","required":false,"value":"10","desc":"1 to 100. Default 20 when paging."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Database reads only."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-rooftop-add-directory-contacts":{"title":"Add directory contacts","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/directory/manual","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Waits for the directory write (30 s timeout)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID. Without it the call returns 400.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID. Without it the call returns 400.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":false,"desc":"Sent by the UI. Not used.","kind":"string","value":"Example Motors"},{"path":"users","required":true,"desc":"Non-empty list of contacts.","kind":"items","value":"","sub":[{"key":"firstName","kind":"string","enum":null,"desc":"Required. First name."},{"key":"lastName","kind":"string","enum":null,"desc":"Last name."},{"key":"role","kind":"string","enum":null,"desc":"Required. Job title, stored as designation."},{"key":"departmentId","kind":"string","enum":null,"desc":"Required. Department ID, a positive integer."},{"key":"isdCode","kind":"string","enum":null,"desc":"Required. Country code with a leading +, e.g. +1."},{"key":"phoneNumber","kind":"string","enum":null,"desc":"Required. Number without country code."},{"key":"extension","kind":"string","enum":null,"desc":"Extension."},{"key":"email","kind":"string","enum":null,"desc":"Email."}],"rows":[{"firstName":"Jane","lastName":"Doe","role":"Service Advisor","departmentId":"DEPARTMENT_ID","isdCode":"+1","phoneNumber":"5550100000","extension":"204","email":"jane.doe@example.com"}]}]},"svc-rooftop-upload-directory":{"title":"Upload the employee directory","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/directory/file","params":[],"contentType":"multipart/form-data","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Parses the file, then waits for the directory write (30 s timeout)."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"teamName","required":false,"desc":"Sent by the UI. Not used.","kind":"string","value":"Example Motors"},{"path":"file","required":true,"desc":"One .xlsx file, up to 20 MB, exactly one sheet.","kind":"file"}]},"svc-rooftop-get-cnam":{"title":"Get the brand registration","method":"GET","url":"https://api.spyne.ai/user-management/v1/twilio/customer-profiles","params":[{"name":"enterprise_id","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"team_id","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous. Waits for the registration lookup and the address read."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-rooftop-save-cnam":{"title":"Submit or save the brand registration","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/business-registration","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous (30 s timeout). Carrier review continues after the response."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"draft","required":false,"desc":"true saves a draft and skips validation; false or omitted submits.","kind":"boolean","value":"false"},{"path":"businessProfile","required":false,"desc":"Required when submitting (draft false). Business details.","kind":"group"},{"path":"businessProfile.legalBusinessName","required":true,"desc":"Legal business name.","kind":"string","value":"Example Motors LLC"},{"path":"businessProfile.displayName","required":true,"desc":"Caller ID display name.","kind":"string","value":"Example Motors"},{"path":"businessProfile.entityType","required":true,"desc":"Business entity type.","kind":"enum","value":"private_profit","enum":["private_profit","public_profit","non_profit","government","sole_proprietor"]},{"path":"businessProfile.registrationId","required":true,"desc":"EIN, format ##-#######.","kind":"string","value":"12-3456789"},{"path":"businessProfile.email","required":true,"desc":"Business email.","kind":"string","value":"info@example.com"},{"path":"businessProfile.isdCode","required":true,"desc":"Country code, e.g. +1.","kind":"string","value":"+1"},{"path":"businessProfile.phoneNumber","required":true,"desc":"National number, without the country code.","kind":"string","value":"5550100000"},{"path":"businessProfile.privacyPolicyUrl","required":true,"desc":"Privacy policy URL.","kind":"string","value":"https://www.example.com/privacy"},{"path":"businessProfile.termsAndConditionsUrl","required":true,"desc":"Terms URL.","kind":"string","value":"https://www.example.com/terms"},{"path":"businessProfile.authorizedRepresentative","required":true,"desc":"firstName, lastName, email, isdCode, phoneNumber, jobTitle, jobPositionCategory, optional employeeId.","kind":"json","value":"{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"isdCode\": \"+1\",\n \"phoneNumber\": \"5550100000\",\n \"jobTitle\": \"General Manager\",\n \"jobPositionCategory\": \"GM\",\n \"employeeId\": \"EMPLOYEE_ID\"\n}"},{"path":"businessProfile.address","required":false,"desc":"Ignored: replaced with the rooftop address on file.","kind":"json","value":""},{"path":"businessProfile.website","required":false,"desc":"Ignored: replaced with the rooftop website on file.","kind":"string","value":""},{"path":"businessProfile.industry","required":false,"desc":"Ignored: always replaced with AUTOMOTIVE.","kind":"string","value":""}]},"svc-int-list-crm-partners":{"title":"List CRM and scheduler partners","method":"GET","url":"https://api.spyne.ai/integrations/registry","params":[{"name":"providerType","in":"query","required":false,"value":"crm","desc":"Exact match, e.g. crm, service-scheduler, dms. Omit for all."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","One database read."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-int-read-integration":{"title":"Read a saved integration","method":"GET","url":"https://api.spyne.ai/central-config/v1/integration","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID."},{"name":"domain","in":"query","required":true,"value":"integration","desc":"integration."},{"name":"entity","in":"query","required":true,"value":"CRM","desc":"CRM, CAR_HISTORY or SERVICE_SCHEDULER (exact casing)."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","One database read, plus outbound reads for CRM and scheduler fallbacks."]],"authHint":"Optional: this route does not check a token. Used only for this request; not saved.","fields":[]},"svc-agent-voice-library":{"title":"Browse the voice library","method":"GET","url":"https://api.spyne.ai/conversation/tts/voices/library","params":[{"name":"provider","in":"query","required":false,"value":"","desc":"Voice catalog. Only 11labs. Default 11labs."},{"name":"search","in":"query","required":false,"value":"","desc":"Free-text search."},{"name":"language","in":"query","required":false,"value":"en","desc":"Comma-separated languageIds or ISO codes; all must match."},{"name":"gender","in":"query","required":false,"value":"female","desc":"male or female."},{"name":"age","in":"query","required":false,"value":"","desc":"young, middle_aged or old."},{"name":"accent","in":"query","required":false,"value":"","desc":"Accent label, for example american."},{"name":"sort","in":"query","required":false,"value":"","desc":"relevance, trending, newest or most_used (default)."},{"name":"page","in":"query","required":false,"value":"0","desc":"Zero-based page index. Default 0."},{"name":"pageSize","in":"query","required":false,"value":"30","desc":"1 to 100. Default 30."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; each filter-and-page combination is cached for 24 hours"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-agent-list-avatars":{"title":"List avatars","method":"GET","url":"https://api.spyne.ai/conversation/avatars","params":[{"name":"teamId","in":"query","required":false,"value":"TEAM_ID","desc":"Rooftop; adds its custom avatars to the generic ones."},{"name":"gender","in":"query","required":false,"value":"female","desc":"male or female."},{"name":"nationality","in":"query","required":false,"value":"","desc":"Exact nationality label, for example american."},{"name":"age","in":"query","required":false,"value":"","desc":"young, middle_aged or old."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, one database read"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-agent-voice-languages":{"title":"List voice languages","method":"GET","url":"https://api.spyne.ai/conversation/tts/languages","params":[],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, one database read"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-agent-get-config":{"title":"Get an agent","method":"GET","url":"https://api.spyne.ai/conversation/agents/team/{teamId}/enterprise/{enterpriseId}/agent-mapping/{teamAgentMappingId}","params":[{"name":"teamId","in":"path","required":true,"value":"TEAM_ID","desc":"Rooftop."},{"name":"enterpriseId","in":"path","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group."},{"name":"teamAgentMappingId","in":"path","required":true,"value":"TEAM_AGENT_MAPPING_ID","desc":"Agent id."},{"name":"isDemoAgent","in":"query","required":false,"value":"","desc":"Only the literal true reads a console demo agent."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; database reads plus a best-effort voice catalog lookup"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-agent-create":{"title":"Create an agent","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the agent backend and the database write"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors"},{"path":"entity","required":true,"desc":"Agent type key.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"entityConfig","required":true,"desc":"Holds the agent.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"The agent. Do not send agentId on create.","kind":"group"},{"path":"entityConfig.agent.agentTypeId","required":true,"desc":"Contracted agent type.","kind":"string","value":"AGENT_TYPE_ID"},{"path":"entityConfig.agent.agentName","required":true,"desc":"Name the agent introduces itself with.","kind":"string","value":"Ava"},{"path":"entityConfig.agent.avatarId","required":true,"desc":"Avatar.","kind":"string","value":"AVATAR_ID"},{"path":"entityConfig.agent.tts","required":true,"desc":"Voice.","kind":"group"},{"path":"entityConfig.agent.tts.provider","required":false,"desc":"Default elevenlabs.","kind":"string","value":"elevenlabs"},{"path":"entityConfig.agent.tts.model","required":false,"desc":"Voice model.","kind":"string","value":""},{"path":"entityConfig.agent.tts.voiceId","required":true,"desc":"Voice.","kind":"string","value":"VOICE_ID"},{"path":"entityConfig.agent.tts.voiceSettings","required":false,"desc":"stability, similarity_boost, speed (numbers).","kind":"json","value":"{\n \"speed\": 1\n}"},{"path":"entityConfig.agent.tts.supportedLanguages","required":true,"desc":"At least one language code, one per line.","kind":"list","itemType":"string","value":"en"},{"path":"entityConfig.agent.agentDescription","required":false,"desc":"Description.","kind":"string","value":""},{"path":"entityConfig.agent.firstMessage","required":false,"desc":"Greeting during working hours. Default comes from the agent type.","kind":"string","value":"Thanks for calling Example Motors, this is Ava. How can I help?"},{"path":"entityConfig.agent.afterHoursMessage","required":false,"desc":"Greeting after hours.","kind":"string","value":"We are closed right now, but I can still help."},{"path":"entityConfig.agent.voicemailMessage","required":false,"desc":"Voicemail message. Default comes from the agent type.","kind":"string","value":"Hi, this is Ava from Example Motors. Please call us back."},{"path":"entityConfig.agent.endCallMessage","required":false,"desc":"End-of-call message. Default comes from the agent type.","kind":"string","value":""},{"path":"entityConfig.agent.assertiveness","required":false,"desc":"Sales agents only.","kind":"enum","enum":["none","low","medium","high"],"value":"low"},{"path":"entityConfig.agent.ambientSound","required":false,"desc":"type (office or off) and optional volume.","kind":"json","value":"{\n \"type\": \"office\",\n \"volume\": 0.6\n}"},{"path":"entityConfig.agent.transferMode","required":false,"desc":"Default seamless.","kind":"enum","enum":["seamless","nudge"],"value":"seamless"},{"path":"entityConfig.agent.transferModeRule","required":false,"desc":"Rule used with nudge.","kind":"string","value":""},{"path":"entityConfig.agent.reputationConfig","required":false,"desc":"Required only for reputation_outbound; rejected for any other entity.","kind":"json","value":""},{"path":"entityConfig.agent.templateId","required":false,"desc":"Stored only.","kind":"string","value":""},{"path":"entityConfig.agent.areaCode","required":false,"desc":"Stored only. 3 characters or null.","kind":"string","value":""},{"path":"entityConfig.agent.isReadyToGoLive","required":false,"desc":"Stored only.","kind":"boolean","value":""},{"path":"entityConfig.agent.fileUrls","required":false,"desc":"Stored only. One URL per line.","kind":"list","itemType":"string","value":""}]},"svc-agent-update":{"title":"Update an agent","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the agent backend and the database write"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored with the record.","kind":"string","value":"Example Motors"},{"path":"entity","required":true,"desc":"Agent type key used at create.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"entityConfig","required":true,"desc":"Holds the changes.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"Send only what changes; other fields follow Create an agent.","kind":"group"},{"path":"entityConfig.agent.agentId","required":true,"desc":"Agent id. teamAgentMappingId is accepted as an alias.","kind":"string","value":"AGENT_ID"},{"path":"entityConfig.agent.agentTypeId","required":false,"desc":"Contracted agent type.","kind":"string","value":""},{"path":"entityConfig.agent.agentName","required":false,"desc":"Name the agent introduces itself with.","kind":"string","value":"Ava"},{"path":"entityConfig.agent.avatarId","required":false,"desc":"Avatar.","kind":"string","value":""},{"path":"entityConfig.agent.firstMessage","required":false,"desc":"Greeting during working hours.","kind":"string","value":"Thanks for calling Example Motors, this is Ava. How can I help today?"},{"path":"entityConfig.agent.tts","required":false,"desc":"Replaced as a whole.","kind":"group"},{"path":"entityConfig.agent.tts.voiceId","required":false,"desc":"Required if you send tts.","kind":"string","value":""},{"path":"entityConfig.agent.tts.supportedLanguages","required":false,"desc":"Required if you send tts. At least one language code, one per line.","kind":"list","itemType":"string","value":""}]},"svc-agent-list":{"title":"List agents","method":"GET","url":"https://api.spyne.ai/conversation/agents/team/{teamId}/onboarded-agents","params":[{"name":"teamId","in":"path","required":true,"value":"TEAM_ID","desc":"Rooftop."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, database reads"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-agent-assign-number":{"title":"Assign a phone number","method":"POST","url":"https://api.spyne.ai/console/v1/telephony/phone-numbers","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","5 requests / hour per dealer group and 5 per user"],["Processing","Synchronous; waits for purchase, messaging attach, save and call routing"],["Warning","Every success buys a real US phone number from the carrier and bills for it. Do not send unless you mean to buy a number."]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group. Must match the token's dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop. Must belong to the dealer group and be active.","kind":"string","value":"TEAM_ID"},{"path":"teamAgentMappingId","required":true,"desc":"Agent the number is for.","kind":"string","value":"TEAM_AGENT_MAPPING_ID"}]},"svc-agent-get-policies":{"title":"Get the agent config","method":"GET","url":"https://api.spyne.ai/central-config/v1/vini-config/agent-config","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous; one read, four live fetches and a possible write-back"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-agent-upload-calls":{"title":"Upload call transcripts or recordings","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/call-transcripts-recordings/files","params":[],"contentType":"multipart/form-data","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits until every file is stored"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group. Cannot be blank.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop. Cannot be blank.","kind":"string","value":"TEAM_ID"},{"path":"product","required":true,"desc":"Folder name, for example sales.","kind":"string","value":"sales"},{"path":"segmentName","required":true,"desc":"Folder name, for example inbound.","kind":"string","value":"inbound"},{"path":"uploadType","required":true,"desc":"Send transcripts and recordings in separate requests.","kind":"enum","enum":["transcript","recording"],"value":"transcript"},{"path":"files","required":true,"desc":"File to upload under the field name files; repeat the field for more files.","kind":"file","multiple":true}]},"svc-agent-list-scripts":{"title":"List chatbot scripts","method":"GET","url":"https://api.spyne.ai/central-config/v1/smartview-scripts","params":[{"name":"pageNo","in":"query","required":false,"value":"1","desc":"Page number from 1. Default 1."},{"name":"batch","in":"query","required":false,"value":"100","desc":"Page size, 1 to 100. Default 10."},{"name":"enterpriseId","in":"query","required":false,"value":"ENTERPRISE_ID","desc":"Exact match."},{"name":"teamId","in":"query","required":false,"value":"TEAM_ID","desc":"Exact match."},{"name":"enterpriseName","in":"query","required":false,"value":"","desc":"Contains, not case-sensitive."},{"name":"teamName","in":"query","required":false,"value":"","desc":"Contains, not case-sensitive."},{"name":"websiteUrl","in":"query","required":false,"value":"","desc":"Contains; scheme and trailing slash ignored."},{"name":"scriptUrl","in":"query","required":false,"value":"","desc":"Exact match."},{"name":"scriptId","in":"query","required":false,"value":"","desc":"Exact match."},{"name":"createdBy","in":"query","required":false,"value":"","desc":"Exact match."},{"name":"websiteProvider","in":"query","required":false,"value":"","desc":"Contains, not case-sensitive."},{"name":"sortBy","in":"query","required":false,"value":"","desc":"createdAt (default) or updatedAt."},{"name":"order","in":"query","required":false,"value":"","desc":"asc or desc (default)."},{"name":"startDate","in":"query","required":false,"value":"","desc":"YYYY-MM-DD, created date (UTC, inclusive)."},{"name":"endDate","in":"query","required":false,"value":"","desc":"YYYY-MM-DD, created date (UTC, inclusive)."}],"contentType":null,"meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous, one database query and count"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-agent-save-script":{"title":"Save a chatbot script","method":"POST","url":"https://api.spyne.ai/central-config/v1/integration","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user)"],["Rate limit","Not documented"],["Processing","Synchronous; waits for the script service and the database write"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop.","kind":"string","value":"TEAM_ID"},{"path":"enterpriseName","required":false,"desc":"Stored and sent to the script service.","kind":"string","value":"Example Motors Group"},{"path":"teamName","required":false,"desc":"Stored and sent to the script service.","kind":"string","value":"Example Motors"},{"path":"domain","required":true,"desc":"Always publish.","kind":"enum","enum":["publish"],"value":"publish"},{"path":"entity","required":true,"desc":"Always SMARTVIEW.","kind":"enum","enum":["SMARTVIEW"],"value":"SMARTVIEW"},{"path":"entityconfig","required":true,"desc":"Script settings.","kind":"group"},{"path":"entityconfig.websiteUrl","required":true,"desc":"Dealer website.","kind":"string","value":"https://www.examplemotors.example"},{"path":"entityconfig.websiteProvider","required":true,"desc":"Website platform, for example dealeron.","kind":"string","value":"dealeron"},{"path":"entityconfig.active","required":true,"desc":"1 or 0.","kind":"integer","value":"1"},{"path":"entityconfig.selectedTeamId","required":true,"desc":"At least one rooftop id, one per line.","kind":"list","itemType":"string","value":"TEAM_ID"},{"path":"entityconfig.scriptId","required":false,"desc":"Required to update an existing script.","kind":"string","value":""},{"path":"entityconfig.scriptUrl","required":false,"desc":"Existing script URL.","kind":"string","value":""},{"path":"entityconfig.vehicleIdentificationType","required":false,"desc":"Default VIN.","kind":"string","hint":"VIN","value":""},{"path":"entityconfig.version","required":false,"desc":"Default v2.","kind":"string","hint":"v2","value":""},{"path":"entityconfig.globalConfigs","required":false,"desc":"Global settings.","kind":"group"},{"path":"entityconfig.globalConfigs.chatbotConfigs","required":false,"desc":"Chatbot settings; enabled is required when sent. Do not also set vdpConfigs.ci_enabled true.","kind":"json","value":"{\n \"enabled\": true,\n \"defaultDesktopPresentation\": \"floating\",\n \"initialWidgetState\": \"fab\",\n \"salesPages\": {\n \"mode\": \"ALL_PAGES\",\n \"pages\": []\n },\n \"servicePages\": {\n \"mode\": \"SPECIFIC_PAGES\",\n \"pages\": []\n }\n}"},{"path":"entityconfig.vdpConfigs","required":false,"desc":"VDP widget; needs studio_enabled, ci_enabled, integration_type and version when sent.","kind":"json","value":""},{"path":"entityconfig.vlpConfigs","required":false,"desc":"Listing page settings; needs studio_enabled when sent.","kind":"json","value":""},{"path":"entityconfig.created_by","required":false,"desc":"Kept from an earlier save.","kind":"string","value":""},{"path":"entityconfig.updated_by","required":false,"desc":"Kept from an earlier save.","kind":"string","value":""}]},"svc-golive-get-readiness":{"title":"Get readiness answers","method":"GET","url":"https://api.spyne.ai/central-config/v1/vini-config/go-live-readiness","params":[{"name":"enterpriseId","in":"query","required":true,"value":"ENTERPRISE_ID","desc":"Dealer group ID. Must not be empty."},{"name":"teamId","in":"query","required":true,"value":"TEAM_ID","desc":"Rooftop ID. Must not be empty."},{"name":"entity","in":"query","required":true,"value":"sales_inbound","desc":"Agent type, for example sales_inbound or receptionist."}],"contentType":null,"meta":[["Auth","None (route has no auth check)"],["Rate limit","Not documented"],["Processing","Synchronous, one database read"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[]},"svc-golive-agent-live":{"title":"Put an agent live","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user), validated again by the central config service"],["Rate limit","Not documented"],["Processing","Synchronous, 30-second forward timeout"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"entity","required":true,"desc":"Agent type, for example sales_inbound.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"enterpriseName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"entityConfig","required":true,"desc":"Holds the agent fields.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"Send only the two fields below unless you mean to change others.","kind":"group"},{"path":"entityConfig.agent.agentId","required":true,"desc":"Team-agent mapping ID; teamAgentMappingId is accepted as another name.","kind":"string","value":"AGENT_ID"},{"path":"entityConfig.agent.isOnboarded","required":true,"desc":"true to go live.","kind":"boolean","value":"true"}]},"svc-golive-agent-offline":{"title":"Take an agent offline","method":"POST","url":"https://api.spyne.ai/console/v1/product-onboarding/vini/agent","params":[],"contentType":"application/json","meta":[["Auth","Bearer token (console user), validated again by the central config service"],["Rate limit","Not documented"],["Processing","Synchronous, 30-second forward timeout"]],"authHint":"Paste the bearer token of a signed-in console user. Used only for this request; not saved.","fields":[{"path":"enterpriseId","required":true,"desc":"Dealer group ID.","kind":"string","value":"ENTERPRISE_ID"},{"path":"teamId","required":true,"desc":"Rooftop ID.","kind":"string","value":"TEAM_ID"},{"path":"entity","required":true,"desc":"Agent type, for example sales_inbound.","kind":"enum","enum":["sales_inbound","sales_outbound","service_inbound","service_outbound","receptionist","acquisition_outbound","reputation_outbound"],"value":"sales_inbound"},{"path":"enterpriseName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"teamName","required":false,"desc":"Stored on the config if sent. The console sends it.","kind":"string","value":""},{"path":"entityConfig","required":true,"desc":"Holds the agent fields.","kind":"group"},{"path":"entityConfig.agent","required":true,"desc":"Send only the two fields below unless you mean to change others.","kind":"group"},{"path":"entityConfig.agent.agentId","required":true,"desc":"Team-agent mapping ID; teamAgentMappingId is accepted as another name.","kind":"string","value":"AGENT_ID"},{"path":"entityConfig.agent.isOnboarded","required":true,"desc":"false to take the agent offline.","kind":"boolean","value":"false"}]},"instant-check":{"title":"Check for a match","method":"POST","url":"https://api.spyne.ai/api/pv1/instant","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"],["Rate limit","120 requests / min per rooftop key"],["Credits","None"]],"fields":[{"path":"vin","required":true,"desc":"17-character VIN.","kind":"string","value":"4T1BZ1HK5KU012345"},{"path":"checkOnly","required":true,"desc":"Send true: only check for a match.","kind":"boolean","value":"true"},{"path":"year","required":false,"desc":"Required if Spyne doesn't know the vehicle. 1981 to two years ahead.","kind":"integer","value":"2024"},{"path":"make","required":false,"desc":"Required if Spyne doesn't know the vehicle.","kind":"string","value":"Toyota"},{"path":"model","required":false,"desc":"Required if Spyne doesn't know the vehicle.","kind":"string","value":"Camry"},{"path":"trim","required":false,"desc":"Required if Spyne doesn't know the vehicle.","kind":"string","value":"XLE"},{"path":"exteriorColor","required":false,"desc":"Required if not in inventory. As the dealer names it.","kind":"string","value":"Midnight Black Metallic"},{"path":"interiorColor","required":false,"desc":"Required if not in inventory.","kind":"string","value":"Black"},{"path":"condition","required":false,"desc":"Required if not in inventory. used covers CPO, demo and rental.","kind":"enum","value":"used","enum":["new","used"]},{"path":"stockNumber","required":false,"desc":"Dealer stock number. Saved on a generate.","kind":"string","value":""},{"path":"rooftopId","required":false,"desc":"Group-level keys only. Leave out with a rooftop key.","kind":"string","value":""}]},"instant-generate":{"title":"Generate the Instant set","method":"POST","url":"https://api.spyne.ai/api/pv1/instant","params":[],"contentType":"application/json","meta":[["Auth","Bearer token"],["Rate limit","120 requests / min per rooftop key"],["Processing","Asynchronous"]],"fields":[{"path":"vin","required":true,"desc":"17-character VIN.","kind":"string","value":"4T1BZ1HK5KU012345"},{"path":"checkOnly","required":false,"desc":"true: only check. Leave out to generate.","kind":"boolean","value":""},{"path":"year","required":false,"desc":"Required if Spyne doesn't know the vehicle. 1981 to two years ahead.","kind":"integer","value":"2024"},{"path":"make","required":false,"desc":"Required if Spyne doesn't know the vehicle.","kind":"string","value":"Toyota"},{"path":"model","required":false,"desc":"Required if Spyne doesn't know the vehicle.","kind":"string","value":"Camry"},{"path":"trim","required":false,"desc":"Required if Spyne doesn't know the vehicle.","kind":"string","value":"XLE"},{"path":"exteriorColor","required":false,"desc":"Required if not in inventory. As the dealer names it.","kind":"string","value":"Midnight Black Metallic"},{"path":"interiorColor","required":false,"desc":"Required if not in inventory.","kind":"string","value":"Black"},{"path":"condition","required":false,"desc":"Required if not in inventory. used covers CPO, demo and rental.","kind":"enum","value":"used","enum":["new","used"]},{"path":"stockNumber","required":false,"desc":"Dealer stock number. Saved on a generate.","kind":"string","value":"A12345"},{"path":"rooftopId","required":false,"desc":"Group-level keys only. Leave out with a rooftop key.","kind":"string","value":""}]},"instant-retrieve":{"title":"Read status and images","method":"GET","url":"https://api.spyne.ai/api/pv1/merchandise","params":[{"name":"vin","in":"query","required":false,"value":"4T1BZ1HK5KU012345","desc":"The vehicle's VIN (recommended). Send one of vin, stockNumber or registrationNumber."},{"name":"stockNumber","in":"query","required":false,"value":"","desc":"Look it up by stock number instead."},{"name":"registrationNumber","in":"query","required":false,"value":"","desc":"Look it up by registration (plate) number instead."}],"contentType":null,"meta":[["Auth","Bearer token"]],"fields":[]}}; export const TryIt = (props) => { const { config } = props || {}; const endpoint = (props && (props.endpoint || props.endPoint)) || ''; const cfg = (config && typeof config === 'object' ? config : null) || TRYIT_CONFIGS[endpoint] || {}; const fields = cfg.fields || []; const leafFields = fields.filter((f) => f.kind !== 'group'); const [open, setOpen] = useState(false); const [apiKey, setApiKey] = useState(''); const [params, setParams] = useState(() => Object.fromEntries((cfg.params || []).map((p) => [p.name, p.value || '']))); const [vals, setVals] = useState(() => Object.fromEntries(leafFields.filter((f) => f.kind !== 'items').map((f) => [f.path, f.value || '']))); const [items, setItems] = useState(() => Object.fromEntries(leafFields.filter((f) => f.kind === 'items').map((f) => [f.path, (f.rows || [{}]).map((r) => Object.assign({}, r))]))); const [collapsed, setCollapsed] = useState({}); const [sending, setSending] = useState(false); const [result, setResult] = useState(null); const [copied, setCopied] = useState(false); const [urlCopied, setUrlCopied] = useState(false); const [dark, setDark] = useState(false); const [theme, setTheme] = useState({ bg: '#ffffff', fg: '#111111' }); useEffect(() => { const read = () => { const b = getComputedStyle(document.body); const m = (b.backgroundColor || '').match(/\d+/g); if (m) setDark((0.299 * m[0] + 0.587 * m[1] + 0.114 * m[2]) < 128); setTheme({ bg: b.backgroundColor || '#ffffff', fg: b.color || '#111111' }); }; read(); const obs = new MutationObserver(read); obs.observe(document.documentElement, { attributes: true, attributeFilter: ['class', 'data-theme', 'data-color-mode', 'style'] }); return () => obs.disconnect(); }, []); useEffect(() => { if (!open) return undefined; const onKey = (e) => { if (e.key === 'Escape') setOpen(false); }; window.addEventListener('keydown', onKey); return () => window.removeEventListener('keydown', onKey); }, [open]); const P = dark ? { muted: '#26252F', border: '#343241', text: '#F1F1F5', text3: '#AAA8BD', post: ['rgba(132,96,217,.35)', '#C9B9F0'], get: ['rgba(0,162,81,.18)', '#91E3BA'], delete: ['rgba(240,68,56,.18)', '#FDA29B'], evt: ['rgba(249,115,22,.14)', '#FDBA74'], req: ['rgba(220,38,38,.18)', '#FCA5A5'] } : { muted: '#F1F1F5', border: '#E1E3E9', text: '#262C42', text3: '#68657A', post: ['#E4DCF8', '#44259E'], get: ['#DAF5E8', '#006C36'], delete: ['#FDE2E1', '#B42318'], evt: ['#FFF7ED', '#9A3412'], req: ['#FEE2E2', '#B91C1C'] }; const mono = 'ui-monospace, SFMono-Regular, Menlo, Consolas, monospace'; const pill = (m) => { const c = P[(m || '').toLowerCase()] || P.post; return { fontFamily: 'Inter, system-ui, sans-serif', fontSize: 12, fontWeight: 600, letterSpacing: '.2px', padding: '3px 8px', borderRadius: 4, background: c[0], color: c[1], flex: '0 0 auto' }; }; const tag = (bg, fg) => ({ fontSize: 10, fontWeight: 600, padding: '1px 6px', borderRadius: 4, background: bg, color: fg, fontFamily: 'Inter, system-ui, sans-serif' }); const ct = cfg.contentType || 'application/json'; const hasBody = leafFields.length > 0; const coerce = (kind, raw, errs, path) => { const v = typeof raw === 'string' ? raw.trim() : raw; if (v === '' || v === undefined || v === null) return undefined; if (kind === 'boolean') return v === 'true'; if (kind === 'integer' || kind === 'number') { const n = Number(v); if (Number.isNaN(n)) { errs.push(path + ' must be a number'); return undefined; } return n; } if (kind === 'json') { try { return JSON.parse(v); } catch (e) { errs.push(path + ' is not valid JSON'); return undefined; } } return v; }; const setPath = (obj, path, value) => { const keys = path.split('.'); let cur = obj; keys.slice(0, -1).forEach((k) => { if (!cur[k] || typeof cur[k] !== 'object') cur[k] = {}; cur = cur[k]; }); cur[keys[keys.length - 1]] = value; }; const buildBody = () => { const errs = []; const body = {}; leafFields.forEach((f) => { if (f.kind === 'items') { const rows = (items[f.path] || []).map((row) => { const o = {}; (f.sub || []).forEach((s) => { const val = coerce(s.kind === 'enum' ? 'string' : s.kind, row[s.key], errs, f.path + '[].' + s.key); if (val !== undefined) o[s.key] = val; }); return o; }).filter((o) => Object.keys(o).length); if (rows.length) setPath(body, f.path, rows); } else if (f.kind === 'list') { const arr = (vals[f.path] || '').split('\n').map((x) => x.trim()).filter(Boolean).map((x) => coerce(f.itemType, x, errs, f.path)); if (arr.length) setPath(body, f.path, arr); } else if (f.kind === 'file') { const fl = vals[f.path]; if (Array.isArray(fl) && fl.length) setPath(body, f.path, fl); } else { const val = coerce(f.kind === 'enum' ? 'string' : f.kind, vals[f.path], errs, f.path); if (val !== undefined) setPath(body, f.path, val); } }); return { body, errs }; }; const buildUrl = () => { let url = cfg.url || ''; const q = new URLSearchParams(); (cfg.params || []).forEach((p) => { const v = (params[p.name] || '').trim(); if (!v) return; if (p.in === 'path') url = url.replace('{' + p.name + '}', encodeURIComponent(v)); else q.set(p.name, v); }); const qs = q.toString(); return qs ? url + (url.includes('?') ? '&' : '?') + qs : url; }; const sq = (s) => String(s).replace(/'/g, "'\\''"); const curl = () => { const parts = ['curl --request ' + cfg.method + ' \\', " --url '" + buildUrl() + "' \\", " --header 'Authorization: Bearer " + (apiKey || 'YOUR_API_KEY') + "'"]; if (hasBody) { const { body } = buildBody(); const keys = Object.keys(body); if (keys.length) { parts[parts.length - 1] += ' \\'; if (ct === 'application/json') { parts.push(" --header 'Content-Type: application/json' \\"); parts.push(" --data '" + sq(JSON.stringify(body, null, 2)) + "'"); } else { keys.forEach((k, i) => { const v = body[k]; const val = typeof v === 'string' ? v : JSON.stringify(v); parts.push(' ' + (ct === 'multipart/form-data' ? '--form' : '--data-urlencode') + " '" + k + '=' + sq(val) + "'" + (i < keys.length - 1 ? ' \\' : '')); }); } } } return parts.join('\n'); }; const copyText = async (text, done) => { try { await navigator.clipboard.writeText(text); done(true); setTimeout(() => done(false), 1500); } catch (e) { done(false); } }; const send = async () => { if (!apiKey.trim()) { setResult({ error: 'Paste your API key first.' }); return; } const missing = (cfg.params || []).filter((p) => p.required && !(params[p.name] || '').trim()).map((p) => p.name); if (missing.length) { setResult({ error: 'Required: ' + missing.join(', ') }); return; } const { body, errs } = buildBody(); if (errs.length) { setResult({ error: errs.join(' · ') }); return; } setSending(true); setResult(null); const started = Date.now(); try { const headers = { Authorization: 'Bearer ' + apiKey.trim() }; let payload; if (hasBody && Object.keys(body).length) { if (ct === 'application/json') { headers['Content-Type'] = 'application/json'; payload = JSON.stringify(body); } else if (ct === 'multipart/form-data') { payload = new FormData(); Object.entries(body).forEach(([k, v]) => { if (Array.isArray(v) && v.length && v[0] instanceof File) v.forEach((file) => payload.append(k, file)); else payload.append(k, typeof v === 'string' ? v : JSON.stringify(v)); }); } else { payload = new URLSearchParams(); Object.entries(body).forEach(([k, v]) => payload.append(k, typeof v === 'string' ? v : JSON.stringify(v))); } } const res = await fetch(buildUrl(), { method: cfg.method, headers, body: payload }); const text = await res.text(); let pretty = text; try { pretty = JSON.stringify(JSON.parse(text), null, 2); } catch (e) { pretty = text; } setResult({ status: res.status, statusText: res.statusText, ms: Date.now() - started, body: pretty }); } catch (e) { setResult({ error: 'Request failed: ' + e.message }); } finally { setSending(false); } }; const line = P.border; const input = { width: '100%', boxSizing: 'border-box', padding: '7px 9px', borderRadius: 6, border: '1px solid ' + line, background: 'transparent', color: 'inherit', fontFamily: mono, fontSize: 12.5 }; const btn = { display: 'inline-flex', alignItems: 'center', justifyContent: 'center', gap: 6, padding: '8px 12px', borderRadius: 8, border: '1px solid ' + line, background: 'transparent', color: 'inherit', fontWeight: 600, fontSize: 13, cursor: 'pointer' }; const primary = Object.assign({}, btn, { background: '#522EBF', borderColor: '#522EBF', color: '#fff' }); const okStatus = result && result.status >= 200 && result.status < 300; const depthOf = (path) => path.split('.').length - 1; const hiddenBy = (path) => Object.keys(collapsed).some((g) => collapsed[g] && path.startsWith(g + '.')); const typeLabel = (f) => (f.kind === 'items' ? 'object[]' : f.kind === 'list' ? (f.itemType || 'string') + '[]' : f.kind === 'json' ? 'object' : f.kind === 'enum' ? 'string' : f.kind); const Head = ({ name, type, required, desc, full }) => (

{name} {type && {type}} {required && required}

{desc &&

{desc}

}

); const renderInput = (f, value, onChange, placeholder) => { if (f.kind === 'file') { return onChange(e.target.files && e.target.files.length ? Array.from(e.target.files) : '')} style={input} />; } if (f.kind === 'boolean') { return ( ); } if (f.kind === 'enum') { return ( ); } if (f.kind === 'json' || f.kind === 'list') { return

onChange(e.target.value)} rows={f.kind === 'json' ? 3 : 2} spellCheck={false} placeholder={f.kind === 'list' ? 'One value per line' : '{ }'} style={Object.assign({}, input, { resize: 'vertical' })} />;
    }
    return <input type={f.kind === 'integer' || f.kind === 'number' ? 'number' : 'text'} value={value || ''} onChange={(e) => onChange(e.target.value)} placeholder={placeholder || ''} style={input} />;
  };

const urlBar = (
    <div style={{ display: 'flex', alignItems: 'center', gap: 6, padding: 4, border: '1px solid ' + P.border, borderRadius: 8, boxShadow: '0 1px 2px rgba(20,19,26,.05)', marginBottom: 10 }}>
      <div style={{ flex: 1, minWidth: 0, height: 36, display: 'flex', alignItems: 'center', gap: 10, padding: '0 6px 0 8px', borderRadius: 6, background: P.muted }}>
        <span style={pill(cfg.method)}>{cfg.method}</span>
        <code style={{ flex: 1, minWidth: 0, fontSize: 13, whiteSpace: 'nowrap', overflow: 'hidden', textOverflow: 'ellipsis', color: P.text, background: 'transparent', border: 0, padding: 0, fontFamily: mono }}>{cfg.url}</code>
        <button type="button" onClick={() => copyText(cfg.url || '', setUrlCopied)} aria-label="Copy URL" title="Copy URL" style={{ height: 28, display: 'inline-flex', alignItems: 'center', padding: '0 8px', border: 0, borderRadius: 6, background: 'transparent', color: P.text3, fontSize: 12, cursor: 'pointer' }}>{urlCopied ? 'Copied' : '⧉ Copy'}</button>
      </div>
      <button type="button" onClick={() => setOpen(true)} style={Object.assign({}, primary, { height: 36, padding: '0 14px', flex: '0 0 auto' })}>Try it ▶</button>
    </div>
  );

return (
    <div style={{ margin: '4px 0 18px' }}>
      {urlBar}
      {(cfg.meta || []).length > 0 && (
        <div style={{ display: 'flex', flexWrap: 'wrap', gap: 6 }}>
          {(cfg.meta || []).map(([k, v]) => (
            <span key={k} style={{ height: 24, display: 'inline-flex', alignItems: 'center', padding: '0 8px', borderRadius: 6, background: P.muted, fontSize: 12, color: P.text3 }}>
              <b style={{ color: P.text, fontWeight: 500, marginRight: 6 }}>{k}</b>{v}
            </span>
          ))}
        </div>
      )}
      {open && (
        <div role="presentation" onClick={() => setOpen(false)} style={{ position: 'fixed', inset: 0, background: 'rgba(0,0,0,0.45)', zIndex: 2147483000 }}>
          <aside role="dialog" aria-modal="true" aria-label={'Try it · ' + (cfg.title || '')} onClick={(e) => e.stopPropagation()}
            style={{ position: 'absolute', top: 0, right: 0, height: '100%', width: 'min(560px, 100%)', background: theme.bg, color: theme.fg, borderLeft: '1px solid ' + line, boxShadow: '-12px 0 40px rgba(0,0,0,0.35)', display: 'flex', flexDirection: 'column' }}>
            <div style={{ display: 'flex', alignItems: 'center', gap: 10, padding: '14px 18px', borderBottom: '1px solid ' + line }}>
              <span style={pill(cfg.method)}>{cfg.method}</span>
              <strong style={{ flex: 1, fontSize: 15 }}>{'Try it · ' + (cfg.title || '')}</strong>
              <button type="button" aria-label="Close" onClick={() => setOpen(false)} style={Object.assign({}, btn, { padding: '4px 10px' })}>✕</button>
            </div>
            <div style={{ flex: 1, overflowY: 'auto', padding: '14px 18px', display: 'flex', flexDirection: 'column', gap: 14 }}>
              <section>
                <div style={{ fontSize: 11, fontWeight: 700, letterSpacing: '.06em', textTransform: 'uppercase', opacity: 0.7, marginBottom: 8 }}>Authentication</div>
                <Head name="Authorization" type="Bearer" required desc={cfg.authHint || "Paste a key from Developer Hub › API Keys. Used only for this request; not saved."} />
                <input type="password" autoComplete="off" value={apiKey} onChange={(e) => setApiKey(e.target.value)} placeholder="YOUR_API_KEY" style={input} />
              </section>
              {(cfg.params || []).length > 0 && (
                <section>
                  <div style={{ fontSize: 11, fontWeight: 700, letterSpacing: '.06em', textTransform: 'uppercase', opacity: 0.7, marginBottom: 8 }}>{(cfg.params || []).some((p) => p.in === 'path') ? 'Parameters' : 'Query parameters'}</div>
                  <div style={{ display: 'flex', flexDirection: 'column', gap: 12 }}>
                    {(cfg.params || []).map((p) => (
                      <div key={p.name}>
                        <Head name={p.name} type={p.in} required={p.required} desc={p.desc} full={p.name} />
                        <input value={params[p.name] || ''} onChange={(e) => setParams(Object.assign({}, params, { [p.name]: e.target.value }))} style={input} />
                      </div>
                    ))}
                  </div>
                </section>
              )}
              {hasBody && (
                <section>
                  <div style={{ fontSize: 11, fontWeight: 700, letterSpacing: '.06em', textTransform: 'uppercase', opacity: 0.7, marginBottom: 8 }}>Body {ct !== 'application/json' ? '(' + ct + ')' : ''}</div>
                  <div style={{ display: 'flex', flexDirection: 'column', gap: 12 }}>
                    {fields.map((f) => {
                      if (hiddenBy(f.path)) return null;
                      const d = depthOf(f.path);
                      const name = f.path.split('.').pop();
                      const wrap = { marginLeft: d * 12, paddingLeft: d ? 10 : 0, borderLeft: d ? '2px solid ' + line : 'none' };
                      if (f.kind === 'group') {
                        const isC = !!collapsed[f.path];
                        const kids = fields.filter((x) => x.path.startsWith(f.path + '.')).length;
                        return (
                          <div key={f.path} style={wrap}>
                            <button type="button" onClick={() => setCollapsed(Object.assign({}, collapsed, { [f.path]: !isC }))} style={{ display: 'flex', alignItems: 'center', gap: 6, width: '100%', padding: 0, border: 0, background: 'transparent', color: 'inherit', cursor: 'pointer', textAlign: 'left' }}>
                              <span style={{ fontSize: 10, opacity: 0.7 }}>{isC ? '▶' : '▼'}</span>
                              <code style={{ fontFamily: mono, fontSize: 12.5, fontWeight: 700, background: 'transparent', border: 0, padding: 0, color: 'inherit' }}>{name}</code>
                              <span style={tag(P.muted, P.text3)}>object</span>
                              {f.required && <span style={tag(P.req[0], P.req[1])}>required</span>}
                              <span style={{ fontSize: 11, opacity: 0.6 }}>{kids} field{kids === 1 ? '' : 's'}</span>
                            </button>
                            {f.desc && !isC && <div style={{ fontSize: 11.5, opacity: 0.72, marginTop: 3, lineHeight: 1.4 }}>{f.desc}</div>}
                          </div>
                        );
                      }
                      if (f.kind === 'items') {
                        const rows = items[f.path] || [];
                        const setRow = (i, key, v) => setItems(Object.assign({}, items, { [f.path]: rows.map((r, j) => (j === i ? Object.assign({}, r, { [key]: v }) : r)) }));
                        return (
                          <div key={f.path} style={wrap}>
                            <Head name={name} type="object[]" required={f.required} desc={f.desc} full={f.path} />
                            <div style={{ display: 'flex', flexDirection: 'column', gap: 8 }}>
                              {rows.map((row, i) => (
                                <div key={i} style={{ border: '1px solid ' + line, borderRadius: 8, padding: 10, display: 'flex', flexDirection: 'column', gap: 8 }}>
                                  <div style={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between' }}>
                                    <span style={{ fontSize: 11, fontWeight: 700, opacity: 0.7 }}>{name}[{i}]</span>
                                    <button type="button" onClick={() => setItems(Object.assign({}, items, { [f.path]: rows.filter((_, j) => j !== i) }))} style={Object.assign({}, btn, { padding: '2px 8px', fontSize: 11 })}>Remove</button>
                                  </div>
                                  {(f.sub || []).map((s) => (
                                    <div key={s.key}>
                                      <Head name={s.key} type={s.kind === 'json' ? 'object' : s.kind === 'enum' ? 'string' : s.kind} desc={s.desc} full={f.path + '[].' + s.key} />
                                      {renderInput(s, row[s.key], (v) => setRow(i, s.key, v))}
                                    </div>
                                  ))}
                                </div>
                              ))}
                              <button type="button" onClick={() => setItems(Object.assign({}, items, { [f.path]: rows.concat([{}]) }))} style={Object.assign({}, btn, { alignSelf: 'flex-start', padding: '4px 10px', fontSize: 12 })}>+ Add {name} item</button>
                            </div>
                          </div>
                        );
                      }
                      return (
                        <div key={f.path} style={wrap}>
                          <Head name={name} type={typeLabel(f)} required={f.required} desc={f.desc} full={f.path} />
                          {renderInput(f, vals[f.path], (v) => setVals(Object.assign({}, vals, { [f.path]: v })), f.hint)}
                        </div>
                      );
                    })}
                  </div>
                </section>
              )}
              <section>
                <div style={{ display: 'flex', alignItems: 'center', justifyContent: 'space-between', marginBottom: 6 }}>
                  <span style={{ fontSize: 11, fontWeight: 700, letterSpacing: '.06em', textTransform: 'uppercase', opacity: 0.7 }}>cURL · updates as you type</span>
                  <button type="button" onClick={() => copyText(curl(), setCopied)} style={Object.assign({}, btn, { padding: '2px 8px', fontSize: 11 })}>{copied ? 'Copied' : 'Copy'}</button>
                </div>
                <pre style={{ margin: 0, padding: 12, borderRadius: 8, border: '1px solid ' + line, background: P.muted, color: P.text, fontFamily: mono, fontSize: 12, whiteSpace: 'pre-wrap', wordBreak: 'break-all', maxHeight: 260, overflow: 'auto' }}>{curl()}</pre>
              </section>
              {result && (
                <section>
                  <div style={{ fontSize: 11, fontWeight: 700, letterSpacing: '.06em', textTransform: 'uppercase', opacity: 0.7, marginBottom: 6 }}>Response</div>
                  {result.error ? (
                    <div style={{ padding: 10, borderRadius: 8, border: '1px solid #dc2626', color: '#dc2626', fontSize: 13 }}>{result.error}</div>
                  ) : (
                    <div>
                      <div style={{ fontFamily: mono, fontSize: 12, marginBottom: 6 }}>
                        <span style={{ fontWeight: 700, color: okStatus ? '#16a34a' : '#dc2626' }}>{result.status} {result.statusText}</span>
                        <span style={{ opacity: 0.7 }}> · {result.ms} ms</span>
                      </div>
                      <pre style={{ margin: 0, padding: 12, borderRadius: 8, border: '1px solid ' + line, background: P.muted, color: P.text, fontFamily: mono, fontSize: 12, whiteSpace: 'pre-wrap', wordBreak: 'break-all', maxHeight: 320, overflow: 'auto' }}>{result.body || '(empty body)'}</pre>
                    </div>
                  )}
                </section>
              )}
            </div>
            <div style={{ padding: '12px 18px', borderTop: '1px solid ' + line, display: 'flex', flexDirection: 'column', gap: 8 }}>
              <div style={{ display: 'flex', gap: 8 }}>
                <button type="button" onClick={() => copyText(curl(), setCopied)} style={Object.assign({}, btn, { flex: 1 })}>{copied ? 'Copied' : 'Copy cURL'}</button>
                <button type="button" onClick={send} disabled={sending} style={Object.assign({}, primary, { flex: 1, opacity: sending ? 0.7 : 1 })}>{sending ? 'Sending…' : 'Send request'}</button>
              </div>
              <small style={{ fontSize: 11, opacity: 0.7 }}>Sends a real request to api.spyne.ai from your browser with your key. Only filled-in fields are sent.</small>
            </div>
          </aside>
        </div>
      )}
    </div>
  );
};</article></body></html>