Gateways

Create a new gateway

Creates a new gateway with a unique topic and URL.

post/gateway

Request

Base URL
https://api.quiva.ai
Auth
- HTTP bearer
- or API key in header x-api-key
TypeScript
https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-4/docs/gateway/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Name of the gateway

descriptionstring

Description of the gateway

activeboolean required

Whether the gateway is active

timeoutinteger

Timeout in milliseconds for gateway requests

Example request

{
  "name": "My API Gateway",
  "description": "Gateway for my service APIs",
  "active": true,
  "middleware": [
    {
      "order": 1,
      "resource": "auth-middleware",
      "resource_type": "function",
      "resource_version": "latest",
      "type": "pre-request"
    }
  ],
  "limit": {
    "request": 5000,
    "time": 1000
  },
  "timeout": 30000
}

Response

Gateway created successfully

Example response

{
  "body": {
    "name": "My API Gateway",
    "description": "Gateway for my service APIs",
    "url": "https://abc123.quiva.ai",
    "subject": "ms.gateway.abcdef123456.gateway",
    "active": true,
    "timeout": 30000,
    "limit": {
      "request": 5000,
      "time": 1000
    },
    "middleware": [
      {
        "order": 1,
        "resource": "auth-middleware",
        "resource_type": "function",
        "resource_version": "latest",
        "type": "pre-request"
      }
    ],
    "modified": 1713531894,
    "type": "created"
  },
  "metadata": {
    "subject": "ms.gateway.abcdef123456.gateway"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.