API Integration
Vertical AI - Marketplace: Technical Onboarding Guide
Last updated
Vertical AI - Marketplace: Technical Onboarding Guide
Last updated
V01 Last updated: January 20, 2025
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 🤘
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.
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.
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).
After successful testing, submit your model for approval. Our team will conduct the following checks:
Functional Testing: Verify the model’s input and output behavior.
Security Testing: Ensure robust security protocols are in place.
Check response times and reliability: Upon successful validation, your model will be approved for launch.
For support message
Let’s build the future of AI together!