Skip to main content

​
Getting Started with Weir AI API v1.0.1

Welcome to Weir AI API v1.0.1! This section will guide you through everything you need to know to start building with our powerful platform.

Quick Start Guide

Get up and running with Weir AI API in minutes. Complete setup guide for developers.

Authentication Setup

Learn how to authenticate with different API categories and manage tokens securely.

First API Call

Make your first successful API call and understand the response format.

API Categories

Understand the different API categories and when to use each one.

​
What You’ll Learn

Choose Your API Category

Learn about External, Console, and Admin APIs and choose the right one for your use case.

Set Up Authentication

Configure authentication for your chosen API category and understand token management.

Make Your First Call

Make your first API request and understand the response format.

Explore Advanced Features

Learn about team management, platform administration, and other advanced features.

​
Prerequisites

Before you begin, ensure you have:

API Credentials

Access to Weir AI API credentials (client ID, secret key, or user account)

Development Environment

A development environment with your preferred programming language

HTTP Client

A tool to make HTTP requests (curl, Postman, or your preferred client)

Basic API Knowledge

Familiarity with REST APIs and JSON (we’ll guide you through everything)

​
Choose Your Path

I'm building a third-party integration

Start with: External APIs Quick StartExternal APIs are perfect for:
  • Third-party application integrations
  • Public API access for external developers
  • Simple integrations with basic authentication
  • Limited scope for security
Start with: Console APIs Quick StartConsole APIs are perfect for:
  • Internal management tools
  • Organization administration
  • Team collaboration platforms
  • Platform management interfaces
Start with: Admin APIs DocumentationAdmin APIs are perfect for:
  • System administration dashboards
  • Platform monitoring and management
  • User administration tools
  • System maintenance and operations

​
Next Steps

Once you’ve completed the getting started guide, explore these resources:

API Reference

Complete reference documentation for all endpoints

Integration Guides

Detailed guides for building specific types of integrations

Code Examples

Ready-to-use code examples in multiple programming languages

Best Practices

Proven patterns and recommendations for building robust integrations
Pro Tip: Start with the Quick Start Guide to get familiar with the API, then dive into the specific guides for your use case. The API Reference provides complete details for every endpoint.