Welcome to the Neurall API, your gateway to powerful AI-driven media generation, editing, and processing. Whether you're creating stunning visuals, enhancing media, or automating workflows, our API provides the tools you need to bring your ideas to life.
The Neurall API is designed for seamless integration and high performance. To begin, make sure to follow these key requirements:
Base URL: All API requests should be directed to: https://api.neurall.io
Secure Communication: All requests must be made over HTTPS. Any attempt to use plain HTTP will result in failure.
Authentication: Every request requires an API Key for authorization. You can manage API Keys in the Neurall app by navigating to Projects → API Keys.
By default, each organization is limited to 100 concurrent API requests. This ensures optimal performance and reliability for all users. If your use case requires a higher concurrency limit, please contact our support team at support@neurall.io to request an increase.
All additional requests beyond this limit will return a 429 Too Many Requests error.
The AI Cloning section provides endpoints for training and managing AI-generated clones of subjects. Using a set of images, you can train an AI Cloning model to replicate a subject's appearance.
Once the training is complete, generate new images by calling /v1/images/pegasus-generation and passing the identity_id parameter in the request.
A set of images in JPEG, PNG, or WebP format, each up to 5MB. A minimum of 5 and a maximum of 15 images are required to train the AI Cloning model.
An optional URL to receive a POST request once training is complete. The request will have an application/json content type and include any data specified in the callback_params object.
https://api.neurall.io/v1/images/pegasus-training
const axios = require('axios');
const fs = require('fs');
const FormData = require('form-data');
// Create form data
const form = new FormData();
const imagePaths = [
'path/to/image1.png',
'path/to/image2.png',
'path/to/image3.png',
'path/to/image4.png',
'path/to/image5.png',
'path/to/image6.png',
'path/to/image7.png',
'path/to/image8.png',
'path/to/image9.png',
'path/to/image10.png'
]
// Append images to form data
for (let item of imagePaths) {
form.append('images', fs.createReadStream(item));
}
// Make request
axios.post('https://api.neurall.io/v1/images/pegasus-training', form, {
headers: {
...form.getHeaders(),
authorization: '{{YOUR_API_KEY_HERE}}'
}
}).then((response) => {
console.log('Training started - IdentityId: ', response.data.identityId);
}).catch((err) => {
console.error('Error in request: ', err);
}){ "identityId": "a281923dhasdf72136" }
https://api.neurall.io/v1/images/pegasus-status-training
import FormData from 'form-data';
import fetch from 'node-fetch';
async function run() {
const form = new FormData();
form.append('identity_ids','aajsu227sla,oquycbzwi2');
const resp = await fetch(
`https://api.neurall.io/v1/images/pegasus-status-training`,
{
method: 'POST',
headers: {
Authorization: 'YOUR_API_KEY_HERE'
},
body: form
}
);
const data = await resp.text();
console.log(data);
}
run();{ "trainingStatus": [ { … }, { … } ] }
https://api.neurall.io/v1/images/pegasus-delete-training
import FormData from 'form-data';
import fetch from 'node-fetch';
async function run() {
const form = new FormData();
form.append('identity_id','string');
const resp = await fetch(
`https://api.neurall.io/v1/images/pegasus-delete-training`,
{
method: 'POST',
headers: {
Authorization: 'YOUR_API_KEY_HERE'
},
body: form
}
);
const data = await resp.text();
console.log(data);
}
run();