Admin API key

Create organization via admin API key

post

Creates an organization by admin API key. The response includes organization details.

Authorizations

Super-Admin-Secret-Key

Super-Admin-Secret-KeystringRequired

Custom authentication header

Body

application/json

namestring · max: 255Required

Organization name.

Example: New Organization

subscriptionIdstring · uuidOptional

Subscription ID. Subscribes to trial subscription if undefined.

Example: 123e4567-e89b-12d3-a456-426614174000

endedAtstring · date-timeOptional

Subscription end date. Applies if "subscriptionId" is specified and this subscription is not a trial.

Example: 2024-03-20T12:00:00Z

Responses

201

Successfully created the organization.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

404

Subscription not found.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

post

/external/organizations

HTTPcURLJavaScriptPython

POST /external/organizations HTTP/1.1
Host: api.raia2.com
Super-Admin-Secret-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "name": "New Organization",
  "users": [
    {
      "email": "[email protected]",
      "role": "user"
    }
  ],
  "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
  "endedAt": "2024-03-20T12:00:00Z"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "New Organization",
  "status": "active",
  "createdAt": "2024-03-20T12:00:00Z",
  "updatedAt": "2024-03-20T12:00:00Z",
  "createdBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "firstName": "UserFN",
    "lastName": "UserLN"
  },
  "subscription": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Subscription title",
    "description": "Subscription description",
    "agentsAmount": 10,
    "tokensAmountPerMonth": 1000000,
    "secondsAmountPerMonth": 1000000,
    "smsAmountPerMonth": 1000,
    "emailsAmountPerMonth": 1000,
    "usersWithAccessAmount": 100,
    "status": "active",
    "visibility": "public",
    "isTrial": false,
    "createdBy": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[email protected]",
      "firstName": "UserFN",
      "lastName": "UserLN"
    },
    "createdAt": "2024-03-20T12:00:00Z",
    "updatedAt": "2024-03-20T12:00:00Z",
    "organizationsCount": 100,
    "price": 49900
  }
}

Get subscriptions by admin API key

get

Fetches subscriptions by admin API key. The response includes the subscriptions details.

Authorizations

Super-Admin-Secret-Key

Super-Admin-Secret-KeystringRequired

Custom authentication header

Query parameters

visibilitystring · enumOptional

Subscription visibility.

Example: publicPossible values:

statusstring · enumOptional

Subscription status.

Example: activePossible values:

Responses

200

Successfully retrieved subscriptions.

application/json

403

Invalid API key or secret key. Ensure that you are using a valid authentication key.

application/json

500

Unexpected error occurred while processing the request. Please try again later.

application/json

get

/external/subscriptions

HTTPcURLJavaScriptPython

GET /external/subscriptions HTTP/1.1
Host: api.raia2.com
Super-Admin-Secret-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Subscription title",
  "description": "Subscription description",
  "agentsAmount": 10,
  "tokensAmountPerMonth": 1000000,
  "secondsAmountPerMonth": 1000000,
  "smsAmountPerMonth": 1000,
  "emailsAmountPerMonth": 1000,
  "usersWithAccessAmount": 100,
  "status": "active",
  "visibility": "public",
  "isTrial": false,
  "createdBy": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[email protected]",
    "firstName": "UserFN",
    "lastName": "UserLN"
  },
  "createdAt": "2024-03-20T12:00:00Z",
  "updatedAt": "2024-03-20T12:00:00Z",
  "organizationsCount": 100,
  "price": 49900
}