Skip to content

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.

Getting Started with Multi-Tenancy

  1. Create a Tenant: Use the tenant creation endpoint to get your credentials
  2. Test the Platform: Use our standard onboarding to familiarize yourself with Genway's features
  3. Review API Documentation: Identify the endpoints needed for your integration

For enterprise and partnership setup and support, contact us at support@genway.ai.

API Key Types

Genway uses API keys with different scopes for different purposes:

  1. Partnership API Keys

    • Used exclusively for creating new tenants via the tenant creation endpoint
    • Provided manually by the Genway team for partners and enterprises

  2. Standard Tenant API Keys

    • Used for all regular API operations (projects, interviews, webhooks, etc.)
    • Generated automatically when a tenant is created
    • Each tenant receives their own unique API key for data isolation

Tenant Creation

Partnership Key Requirement

  • Tenant creation requires a special Partnership Key provided by the Genway team
  • Contact support@genway.ai to obtain your partnership key
  • This key is generated manually and is required for the tenant creation endpoint

Automated Tenant Creation

  • Use the tenant creation endpoint to programmatically create new tenants
  • Include the partnership API key in the X-Api-Key header
  • Each tenant receives a unique TENANT_ID and corresponding TENANT_API_KEY
  • Keys do not expire and are unique per tenant

Security & Data Isolation

  • 1:1 Mapping: Each TENANT_API_KEY is strictly matched to its corresponding TENANT_ID
  • Dual Header Verification: Both headers act as security layers for all operations
  • Tenant Isolation: Prevents data leakage and misuse between different tenants
  • Validation: Mismatched keys and tenant IDs will result in authentication failure

Tenants

Manage tenant creation and multi-tenancy setup.

Operations

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.