Get tenant details

GET

/v1/tenant

const url = 'https://api.neuramancer.dev/v1/tenant';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.neuramancer.dev/v1/tenant \
  --header 'Authorization: <Authorization>'

Returns tenant information including analytics and masked API keys. Requires authentication with settings scope for users, or API key belonging to the tenant.

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Query Parameters

string

Tenant ID (ObjectId string). Either id or tenantName is required.

tenantName

string

Tenant name. Either id or tenantName is required.

Responses

200

Tenant details retrieved successfully

application/json

object

required

Tenant ID (ObjectId string)

string

name

required

Tenant name

string

createdDate

required

Tenant creation timestamp

string format: date-time

apiKeys

List of API keys for this tenant (secrets are masked after first read)

Array<object>

object

name

required

Human-readable name for the API key

string

uuid

required

Unique identifier for the API key

string

createdDate

required

Creation timestamp

string format: date-time

expiryDate

required

Expiration timestamp

string format: date-time

secret

required

API key secret (masked, not the actual secret after first read)

string

storageType

Storage backend type

string

Allowed values: azure s3

storageConfig

Storage configuration (optional, defaults to Neuramancer storage if not set)

object

endpoint

required

string

port

required

integer

useSSL

required

boolean

bucketName

required

string

region

required

string

accessKeyId

required

string

secretAccessKey

required

string

presignedUrlExpirySeconds

Presign URL expiry time in seconds, default: 7 days

integer

>= 600

corsAllowedOrigins

List of allowed CORS origins for browser-based uploads to S3 presigned URLs (e.g. [“https://app.example.com”, “http://localhost:4321”]). Applied to the bucket on tenant update and on first presigned URL creation. Defaults to [“https://app.neuramancer.dev”, “https://app.neuramancer.de”, “http://app.neuramancer.localhost”, “https://app.neuramancer.localhost”] when not set.

Array<string>

azure

object

containerName

required

string

connectionString

required

string

webhookUrl

Optional webhook URL to call for analysis status updates

string

isTrial

System-managed trial flag. When true, only approved trial images (real.jpg, fake.jpg) can be analyzed. Cannot be changed via API.

boolean

Example

{
  "storageType": "azure"
}

400

Missing required parameter: id or tenantName is mandatory

application/json

Standardized error response following the APIResponse schema.

object

success

required

boolean

message

required

string

Example

{
  "success": false,
  "message": "Bad request"
}

403

Unauthorized - user lacks settings scope or API key does not belong to tenant

application/json

Standardized error response following the APIResponse schema.

object

success

required

boolean

message

required

string

Example

{
  "success": false,
  "message": "Bad request"
}

404

Tenant not found

application/json

Standardized error response following the APIResponse schema.

object

success

required

boolean

message

required

string

Example

{
  "success": false,
  "message": "Bad request"
}

500

Server error

application/json

Standardized error response following the APIResponse schema.

object

success

required

boolean

message

required

string

Example

{
  "success": false,
  "message": "Bad request"
}