Get Started

This page should help you get started on grabbing your API Keys from the dashboard and making your first request to Autogon.

Our Structure

Our API is based on both a single and multi-endpoint architecture. Specific operations are determined by requests sent to the respective endpoints.

Some requests made to Autogon will require an API key. Please refer to the sections below on API key creation.

While most requests require authentication using API keys; any of such requests that doesn't include an API key will return an error. You can generate an API key from your portal at any time.

Getting your API Keys

Before you begin integration with the Autogon API,

1. Create an Autogon account and complete necessary verification

2. Fetch your integration credentials from the Integrations tab in Settings.

3. Proceed to set up your integration.

Refer to the article/video embedded below for a complete guide on how to get API keys and integrate with the Autogon API.

Install the library

The best way to interact with our API is to use any of our supported integration libraries:

Node

# Install via NPM
npm install -g autogonai-node

Python

# Install via pip
pip3 install autogonai-python

Learn More: Find out more about our supported libraries here.

Make your first request

To make your first request, send an authenticated request to the project endpoint. This will create a project. A project is the baseline for using our powerful tools.

Create project.

POST https://autogon.ai/api/v1/project

Creates a new project.

Request Body

Name	Type	Description
project_name*	String	name of project
project_description	String	short description for project.

200 Project created successfully

{
    "id": 1,
    "app_id": "a295d247-05c9-424d-aa8c-5a8990ef5f6a",
    "project_name": "My First Project",
    "project_description": "This is a great project. I hope to achieve more with Autogon",
    "project_compiled_models": null,
    "created_at": "2023-01-22T01:47:43.158604Z"
}

403: Forbidden Project already exists

{
    "status": "false",
    "message": "This project name already exists"
}

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl -L -X POST "https://autogon.ai/api/v1/api/v1/engine/project" -H "X-AUG-KEY: <API-KEY>" -H "Content-Type: application/json" --data-raw "{
    \"project_name\": \"My First Project\",
    \"project_description\": \"This is a great project. I hope to achieve more with Autogon\"
}"

Node

// require the autogonai module and set it up with your API key
const autogonai = require('autogonai');

// load environment variables
require("dotenv").config();

// initilalize client
const client = new Client(process.env.AUTOGON_API_KEY);

// create project
const newProject = await client.Project.create({
    project_name: 'My First Project',
    project_description: 'This is a great project. I hope to achieve more with Autogon',
})

Python

import os
from dotenv import load_dotenv
from autogonai.core import Client

# Set your API key before making the request
client = Client(api_key=API_KEY)

client.Project.create(
    project_name="My First Project",
    project_description="This is a great project. I hope to achieve" \
    " more with Autogon",
)