Skip to main content

Authentication

All requests made to the Cogfy API must be authenticated. This is done by providing an API key in the headers of each request:

Api-Key: <COGFY_API_KEY>
danger

Make sure to keep your API key secure. Do not expose the API key in public repositories or client-side code.

Managing API Keys​

API Keys can be managed in the Cogfy app at https://app.cogfy.com/<YOUR_WORKSPACE>/api-keys.

info

Each API key is associated with a single workspace.

Examples​

Cogfy npm package​

An example of making a call to the Cogfy API using the cogfy package. Using the package is the recommended way to interact with the Cogfy API.

import { Cogfy } from 'cogfy'

const cogfy = new Cogfy({ apiKey: process.env.COGFY_API_KEY })

const collections = await cogfy.collections.list()

Node.js​

An example of making a call to the Cogfy API using the fetch function:

const response = await fetch(
  'https://api.cogfy.com/collections',
  {
    headers: {
      'Api-Key': process.env.COGFY_API_KEY
    }
  }
)
const collections = await response.json()