API Integration

Vertical AI - Marketplace: Technical Onboarding Guide

V01 Last updated: January 20, 2025

Welcome to the Vertical Studio AI - Marketplace

We’re thrilled to have you join our platform for sharing and monetizing your API models. This guide is designed to ensure a smooth onboarding experience, covering everything from account setup to deploying your API model live on our marketplace.

Follow the below steps in order to list your models on our Marketplace 🤘

1

👷🏼 Create and set-up your account

Sign up at app.verticalstudio.ai and complete your profile with the following information:

• Banner image

• Avatar image

• Name

• Description

• Website URL

• Social links: Twitter, Telegram, Discord, GitHub

2

🆙 Wait for account upgrade:

Once your profile is complete, our team will review and upgrade your account to a Creator Account.

3

📥 Submit model details and parameters on this link

After the initial account setup, we will request your model & API information through a form.

• API endpoint URL The base URL for your API

• Authentication Token: A secure token for authentication

• Input Parameters: Specify required fields and data formats (e.g., image_url, threshold).

• Output Specifications: Define the expected response structure (e.g., object_detected, confidence).

Our team will validate the API to ensure it meets marketplace standards.

4

🎁 Proxy API wrapping

After we have validated the API, we will create a wrapper for your API and return the new endpoint & tokens.

Why Wrap Your API?

• Protects your API from unauthorized access.

• Enables transparent usage tracking for future payouts (coming soon).

• Facilitates seamless integration with our credit-based payment system.

What Happens Next?

• We create a proxy API as an intermediary layer.

• Upon completion, we’ll share the final proxy API details with you, including the endpoint and authentication token.

5

📤 Wait until we upload your model

We'll upload your model to our platform, your account will be assigned as the owner ("Creator") of this model.

6

📝 Add model details

After we assign the draft model to your account, you can find it under the Your Models section in the sidebar. We will pre-fill your information, however check if the following information is filled in correctly.

• Name: Provide a clear and concise name (e.g., “PDF Text Extractor Pro”).

• Description: Briefly describe the core functionality (Max. 200 characters).

• Supported Input Types: Select supported formats (e.g., txt, pdf, png, jpeg).

• Supported Output Types: Define response formats (e.g., txt, pdf, png, jpeg).

• Categories: Choose the category that best fits your model.

• Tags: Add up to three relevant tags.

Add additional model information

• Intro Text: Opening sequence of the chat of your model (e.g. "This is a image-to-text model send a JPG to start this conversation."; max. 300 char.)

• Intro Model Text: Write your model’s introduction text (e.g. "Hi! My name is Alice what can I do for you today."; max 300 char.)

• Link to Documentation and Tutorials: Optional but recommended for better user understanding.

• Terms of Service: Define usage policies for your API. If none are provided, our standard Terms of Service will apply (maximum 1000 characters).

7

🧪 Test your model

Test your draft model in the "My Model" section

Note: As a draft, the model will only be accessible and testable by you.

8

✅ Request approval

After successful testing, submit your model for approval. Our team will conduct the following checks:

1. Functional Testing: Verify the model’s input and output behavior.

2. Security Testing: Ensure robust security protocols are in place.

3. Check response times and reliability: Upon successful validation, your model will be approved for launch.

9

🚀 Your model is live

Your model will be published on our marketplace and available for our users. You can monitor activity, track usage, and view customer interactions via the Creator Dashboard (future feature).

10

🎗️ Post launch support

Our team supports you every step of the way:

• Marketing Assistance: Together, let’s promote your model to attract users.

• Performance Monitoring: Use analytics to refine your offerings.

• Support Team: Our team will support you every step of the way.

We're excited to have you on board

For support message [email protected]

Sign-up form:

https://n2v3dj59n7d.typeform.com/to/PaIdA7Emn2v3dj59n7d.typeform.com

Vertical AI - Marketplace sign-up form

Let’s build the future of AI together!