API Reference

Welcome to the Segmind API Docs! This guide will help you get started with using our REST APIs.

Authentication

Create an API key

The Segmind Serverless API uses API keys for authentication. To create one, login to your account and head to the API Keys page on the dashboard.

Use the API

You can authenticate by including your Segmind API key in the Request Header and pass it as x-api-key section of the request.

Example cURL request:

curl --location 'https://api.segmind.com/v1/instantid' \
--header 'x-api-key: YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    }'

Example Python request:

import requests

api_key = "YOUR-API-KEY"
url = "https://api.segmind.com/v1/face-to-sticker"

# Request payload
data = {
}

response = requests.post(url, json=data, headers={'x-api-key': api_key})
print(response)

APIs

To integrate an API, visit the model's page and click on the "API" tab. You can see the list of parameters and example code to get started with the API.

Endpoints

Base URL

POST https://api.segmind.com/...

Version 1 (v1)

Some endpoints that typically complete their requests within 60 seconds are on version 1. For example: https://api.segmind.com/v1/sdxl1.0-newreality-lightning

Version 2 (v2)

We created v2 to serve APIs that typically take longer than 60 seconds to process.

API error codes

Below are a list of error codes to help you

200 - Output Generated
401 - UnauthorizedUser authentication failed
404 - Not FoundThe requested URL does not exist
405 - Method Not AllowedThe requested HTTP method is not allowed
406 - Not AcceptableNot enough credits
500 - Server ErrorServer had some issue with processing

Postman Collection

Use this Postman collection to get started faster.