Getting Started

Getting Started#

The Gydr Integration API is a RESTful JSON API that lets you manage knowledge base resources and AI conversations programmatically. Use it to automate syncs from your e-commerce platform, run bulk imports via CI/CD pipelines, integrate AI chat into custom channels, or build custom integrations.

Base URL#

All API endpoints are served from a single base URL:

Prerequisites#

• A Gydr account on the Growth plan or above
• At least one knowledge base created in the Console
• An API key created in Console → Settings → Developer

Your First Request#

List all products in a knowledge base. Replace {kbId} with your knowledge base ID and use your API key in the X-API-Key header.

curl https://api.gydr.ai/knowledge-bases/{kbId}/products \
  -H "X-API-Key: api_your_api_key"

A successful response looks like this:

{
  "data": [
    { "id": "abc123", "name": "Premium Wireless Headphones", ... }
  ],
  "pagination": { "cursor": "abc123", "hasMore": true, "total": 42 },
  "meta": { "creditsConsumed": 1 }
}