Get Started

Welcome to the Carrier Network AI Public API.

Follow the steps below to create your account, obtain your API credentials, generate an access token, and start using the Carrier Network AI APIs.

1. Create a Carrier Network Account

If you do not already have a Carrier Network account, create one before using the API.

Click here to create your Carrier Network account

During registration, provide the required account and company information and complete the email verification process.

2. Complete Your Subscription

After creating your account, complete the required subscription to access the Carrier Network AI Public API.

Important: An active subscription is required to access the Carrier Network AI Public API.

3. Generate Your API Credentials

After completing your registration and subscription:

1. Log in to your Carrier Network account.
2. Go to Settings.
3. Generate your API Key and Secret Key.
4. Store your API credentials securely.

Your API Key and Secret Key are required to generate an access token for the Carrier Network AI Public API.

4. Generate an Access Token

Use your API Key and Secret Key to generate an access token.

Endpoint:

POST /public-api/v1/auth/token

Request

Send your API Key and Secret Key in the request body.

{
  "apiKey": "YOUR_API_KEY",
  "secretKey": "YOUR_SECRET_KEY"
}

Successful Response

If your credentials are valid, the API returns an access token.

{
  "success": true,
  "message": "Access token generated successfully.",
  "data": {
    "accessToken": "YOUR_ACCESS_TOKEN"
  }
}

5. Use the Access Token

Use the generated access token when calling protected Carrier Network AI API endpoints.

Include the access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Example

curl --request GET \
  --url https://api.carriernetwork.ai/public-api/v1/... \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"

Replace /public-api/v1/... with the endpoint you want to call.

6. Start Using the API

You can now call the available Carrier Network AI APIs using your access token.

See the API Reference for available endpoints, request parameters, response formats, examples, and the Try It feature.

Authentication Flow

The complete authentication flow is:

Create Account → Complete Subscription → Generate API Key & Secret Key → Generate Access Token → Call API

Security

Keep your API Key, Secret Key, and Access Token secure.

• Never share your API credentials publicly.
• Do not commit your credentials to public repositories.
• Do not expose your credentials in client-side applications.
• Do not include real credentials in documentation examples.
• Use environment variables or a secure secrets manager to store your credentials.