Skip to content
Apical Apical
Docs

Resource Creators

Guide for New Resource Creators on Apical

Welcome to Apical! We’re excited that you’re interested in adding your AI API to our marketplace. This guide will walk you through the process of creating and managing your resource on Apical.

Getting Started

  1. Create an Account: If you haven’t already, sign up for an Apical account and ensure you have API provider privileges.

  2. Prepare Your API: Make sure your API is well-documented and follows best practices for RESTful APIs.

Creating a New Resource

To add your API to Apical, you’ll use our resource creation interface. Here’s how to get started:

  1. Navigate to the “New Resource” page in your Apical dashboard.

  2. Fill out the basic information:

    • Name
    • Description
    • Version
    • Base URL
    • Status (e.g., “active”)
    • Visibility (e.g., “public” or “private”)

  3. Add additional details (optional but recommended):

    • Terms of Service URL
    • Contact Email
    • License Information
    • External Documentation URL
    • Logo URL

Adding Endpoints

For each endpoint in your API:

  1. Click “Add Endpoint”
  2. Provide the following information:
    • Path
    • HTTP Method (GET, POST, etc.)
    • Summary
    • Description
    • Operation ID (optional)
    • Deprecated status

Defining Parameters

For each parameter in your endpoint:

  1. Click “Add Parameter”
  2. Fill in:
    • Name
    • Location (query, header, path, body)
    • Description
    • Required status
    • Type
    • Default value (if any)

Adding Tags

Tags help categorize your API:

  1. Click “Add Tag”
  2. Enter a tag name

Best Practices for Resource Creation

  1. Clear Descriptions: Provide clear, concise descriptions for your API and each endpoint.
  2. Comprehensive Documentation: The more detailed your documentation, the easier it will be for developers to use your API.
  3. Examples: Include example requests and responses for each endpoint.
  4. Keep It Updated: Regularly update your API information, especially when you make changes to your endpoints.

Managing Your Resource

After creating your resource, you can:

  • Edit details
  • Add or remove endpoints
  • Update parameters
  • Monitor usage statistics

Access these features from your resource dashboard.

OpenAPI Specification

Apical supports importing OpenAPI (formerly Swagger) specifications. If you have an OpenAPI spec for your API:

  1. Go to the “Auto Create” page
  2. Upload your OpenAPI specification file (JSON or YAML)
  3. Review the imported information
  4. Make any necessary adjustments
  5. Click “Create Resource”

Pricing and Monetization

If you plan to charge for your API:

  1. Set up your pricing model in your account settings
  2. Choose between subscription-based or pay-per-call models
  3. Define your pricing tiers

Apical will handle the billing and provide you with payment reports.

Support and Community

  • Join the Apical community forums to connect with other API providers and developers
  • Offer support to users of your API through our integrated support system
  • Stay updated on Apical features and best practices through our newsletter

Next Steps

  1. Start creating your resource using the steps above
  2. Test your API thoroughly within the Apical ecosystem
  3. Promote your API to potential users

Remember, a well-documented and reliable API will attract more users and lead to greater success on the Apical platform.

We’re here to help you succeed! If you have any questions or need assistance, please don’t hesitate to contact our provider support team.

Welcome to the Apical community, and happy API publishing!