Skip to main content
API Integration lets your Ourguide agent call your backend to perform actions like checking order status, canceling subscriptions, or updating user profiles.

​
How It Works

  1. You provide an OpenAPI spec describing your API endpoints
  2. Ourguide maps those endpoints to agent capabilities
  3. When a user asks the agent to do something, it calls the appropriate endpoint

​
Adding Your OpenAPI Spec

  1. Go to API Integration in your dashboard
  2. Upload your OpenAPI/Swagger spec (JSON or YAML)
  3. Ourguide will parse the spec and show available endpoints
  4. Select which endpoints the agent can access
Example OpenAPI Spec
openapi: "3.0.0"
info:
  title: "My API"
  version: "1.0.0"
paths:
  /orders/{id}:
    get:
      summary: "Get order status"
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: "Order details"

​
Authentication

Your API likely requires authentication. See OpenAPI Auth for supported auth methods.