Skip to main content

​
Quickstart

Follow these step-by-step instructions to start using the Agnes AI API quickly and efficiently.

​
Prerequisites

Before making any API requests, make sure you have the following:
  • An active Agnes AI Platform account
  • A valid API key (generated in the Agnes AI developer dashboard)
  • Sufficient account balance (required for paid API usage; free tiers may provide limited access)

​
Step 1: Create an Account

Sign up for a new account, or log in to your existing Agnes AI Platform account. From the developer dashboard, you can manage API keys, billing, and more.

​
Step 2: Generate an API Key

To authenticate your API requests, generate a secret API key in the Agnes AI Platform: Navigate to: Settings → API Keys → Create new secret key Save this key securely. You will use it to authenticate all API requests (as described in the Authentication section): 
Authorization: Bearer YOUR_API_KEY

​
Step 3: Add Billing Balance

To access the full set of API features, ensure your account has enough billing balance: Navigate to: Billing → Balance Follow the on-screen instructions to add funds to your account. Note: Some free usage tiers may be available for testing.

​
Step 4: Make Your First Request

Below is a sample request to create a chat completion using curl (you can also use tools like Postman, Python requests, or other HTTP clients): 
curl https://apihub.agnes-ai.com/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "agnes-2.0-flash",
    "messages": [
      {
        "role": "user",
        "content": "Hello!"
      }
    ]
  }'
💡Replace YOUR_API_KEY with your actual API key before running the request. A successful response will return a chat completion that matches your input.

​
Step 5: Next Steps

After your first request, explore these next steps to get more out of the Agnes AI API:
  • Review the available models in the Models section of the developer dashboard to find the best fit for your use case.
  • Read the documentation for request parameters, response formats, and error handling for each API endpoint.
  • Integrate advanced features like streaming responses or tool calling to enhance your application’s functionality.