Skip to content
Tenants/
Create a new tenant

Genway Public API (1.0.0)

Genway's API enables you to programmatically manage various aspects of your projects, prototypes, and interviews using our AI interviewer.

  • Projects - Create and manage Contextual Interviews or Prototype Testing projects.
  • Interviews - Manage and export interview data, including transcripts, summaries, audio, and video.

Genway API overview

Authentication

Genway API uses dual-header authentication for all requests to ensure secure access and proper tenant isolation.

Required Headers:

X-Api-Key: YOUR_API_KEY
X-Tenant-Id: YOUR_TENANT_UUID

Both headers are mandatory for every API call. Missing either header will result in authentication failure.

Versioning and stability

We strongly aim for backward compatibility for the documented endpoints. If backwards-incompatible changes are made, we will aim to release a new version.

  • URLs’ entry point is https://api.genway.ai/.
  • URLs are versioned https://api.genway.ai/v1/{endpoint}, e.g. https://api.genway.ai/v1/projects.

Rate limits and API status

The Genway API enforces per-IP rate limits to keep the platform responsive:

ScopeLimitEndpoints / Examples
Global throughputUp to 50 requests per minute per IPApplies to every endpoint, including Export interview video and Activate project.
Project creation10 requests per minute per IPCreate a new project (POST /projects).

When a limit is exceeded the API responds with 429 Too Many Requests, includes a Retry-After header indicating when you can resume sending requests, and returns the rate-limit payload documented in the 429 response example for endpoints such as Create a new project.

You can subscribe to our status page.

API support

If you require help you can contact our support team at support@genway.ai.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Production environment

https://api.genway.ai/v1/

Multi-Tenancy

Genway provides a secure tenant-based authentication system that ensures strong data isolation between customers.

Tenants

Manage tenant creation and multi-tenancy setup.

Operations

Create a new tenant

Request

Create a new tenant with automatic API key provisioning. This endpoint creates a unique tenant with its own isolated data space and dedicated API credentials.

Authentication: This endpoint requires a special Partnership API Key (starts with sk-partner-) with the tenants:create scope. The partnership key is passed via the standard x-api-key header along with the tenant ID that owns the partnership key.

Required Headers:

  • X-Api-Key: sk-partner-... (Partnership key provided by Genway team)
  • X-Tenant-Id: YOUR_TENANT_UUID (Tenant UUID that owns the partnership key)

Contact support@genway.ai to obtain your partnership key.

Security
api_key and tenant_id
Bodyapplication/jsonrequired
organization_namestringrequired

Name of the organization/customer

Example: "Acme Corporation"
contact_emailstring(email)required

Primary contact email for this tenant

Example: "admin@acme.com"
descriptionstring

Optional description of the tenant/organization

Example: "Enterprise customer for user research platform"
curl -i -X POST \
  https://api.genway.ai/v1/tenants \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY_HERE' \
  -H 'X-Tenant-Id: YOUR_API_KEY_HERE' \
  -d '{
    "organization_name": "Acme Corporation",
    "contact_email": "admin@acme.com",
    "description": "Enterprise customer for user research platform"
  }'

Responses

Tenant created successfully

Bodyapplication/json
tenant_idstring(uuid)required

Unique identifier for the tenant

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

Unique API key for this tenant (store securely)

Example: "gw_live_123abc456def789ghi012jkl345mno678pqr"
organization_namestringrequired
Example: "Acme Corporation"
contact_emailstring(email)required
Example: "admin@acme.com"
descriptionstring or null
Example: "Enterprise customer for user research platform"
created_atstring(date-time)required
Example: "2025-06-29T10:30:00Z"
Response
application/json
{
  "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
  "api_key": "gw_live_123abc456def789ghi012jkl345mno678pqr",
  "organization_name": "Acme Corporation",
  "contact_email": "admin@acme.com",
  "description": "Enterprise customer for user research platform",
  "created_at": "2025-06-29T10:30:00Z"
}

Projects

Manage your projects programmatically.

Operations

Interviews

Manage and export interview data.

Operations

Webhooks

Webhooks deliver event data to your applications as it happens, offering an alternative to frequent data polling.

  • The secret created via the /webhooks/secrets endpoint is permanent and should be stored securely in your system. This secret will serve for the verifying section.
  • The x-hook-secret is temporary and should be used only once during the confirmation process.
  • Until the webhook is confirmed, no events will be sent to the subscriber's endpoint.
Operations

Errors

The Genway API uses standard HTTP response codes to indicate the success or failure of the request. Codes follow this pattern:

  • 2xx codes indicate success.
  • 4xx codes indicate a request that failed given the information provided (e.g., a required parameter was omitted).
  • 5xx codes indicate an error with Genway's platform.