Welcome to the API Quickstart Guide! This guide will help you get started with using the API endpoints efficiently.

​
Prerequisites

Before you begin, ensure that you have:
  1. A valid API key. You can obtain this by signing up on our service.
  2. A tool for testing API requests, such as Postman or curl.

​
Base URL

All API requests should be made to the following base URL: 
https://api-builder-dev.ai.ftech.ai/

​
Authentication

The API uses Bearer Token authentication. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY

​
Example Endpoints

​
1. List all api docs

Request Example: 
curl -X 'GET' \
  'https://api-builder-dev.ai.ftech.ai/api/api-doc/' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Response Example: 
{
  "status": "success",
  "data": [
    {
      "id": "675f9e0e999bf840f651726a",
      "created_at": "2024-12-16T10:27:10.138000",
      "modified_at": "2024-12-16T10:27:10.138000",
      "is_disabled": false,
      "project_name": "va-tools",
      "swagger_url": "https://va-tools.dev.ftech.ai/openapi.json",
      "version": "dev"
    }
  ]
}

​
2. Create/Update an api doc

Request Example: 
curl -X 'POST' \
  'https://api-builder-dev.ai.ftech.ai/api/api-doc/' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "swagger_url": "https://va-tools.dev.ftech.ai/openapi.json",
  "project_name": "va-tools",
  "version": "dev"
}'
Response Example: 
{
  "status": "success"
}

​
3. Delete an api doc

Request Example: 
curl -X 'DELETE' \
  'https://api-builder-dev.ai.ftech.ai/api/api-doc/' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "project_name": "va-tools",
  "version": "dev"
}'
Response Example: 
{
  "status": "success"
}

​
Playground

For experimenting with these endpoints, visit our API Playground.