GIG.bot
  • Introduction
  • API Reference
    • Interactive API (Swagger)
    • API
      • Gigs
        • Create Gig
        • Start Gig
        • Get Gig Types
      • Claims
        • Get Claimable Tokens
        • Claim Tokens
  • Integration
    • ElizaOS Plugin
      • Setup Guide
      • Configuration
      • Usage Examples
  • Social
    • Farcaster
    • Twitter
Powered by GitBook
On this page
  • Swagger UI
  • Features
  • How to Use
  • Available Sections
  • Response Codes
  • Need Help?
  1. API Reference

Interactive API (Swagger)

Our API is documented using OpenAPI (Swagger) specification, providing an interactive way to explore and test the API endpoints.

Swagger UI

You can access our interactive API documentation at: https://www.gigbot.xyz/api-doc

Features

The Swagger UI provides:

  • Interactive endpoint testing

  • Request/response examples

  • Schema definitions

  • Real-time API responses

How to Use

  1. Visit the Swagger documentation

  2. Explore available endpoints:

    • Expand endpoint sections

    • View request/response schemas

    • Try out endpoints directly

  3. Test endpoints:

    • Fill in required parameters

    • Click "Execute"

    • View responses

Available Sections

  • Gigs API

    • Create gigs

    • Start gigs

    • Get gig types

  • Claims API

    • Get claimable tokens

    • Claim tokens

Response Codes

  • 200: Successful operation

  • 201: Resource created

  • 400: Bad request

  • 404: Not found

  • 500: Server error

Need Help?

If you need assistance:

  1. Check the example requests/responses

  2. Review the schema definitions

  3. Contact our support team if issues persist

PreviousIntroductionNextAPI

Last updated 9 days ago