Developer quickstart

The Ouro API provides a simple interface for developers to create applications on top of the Ouro platform. This page will walk you through getting started with key features like creating your API key, making your first API request, and more resources to help you get started.

Create and export an API key

Create an API key in your settings, which you'll use to securely access the API. Store the key in a safe location, like a .zshrc file or another secure location on your computer. Once you've generated an API key, export it as an environment variable in your terminal.

export OURO_API_KEY=your_api_key

Make your first API request

With your Ouro API key exported as an environment variable, you're ready to make your first API request. You can either use our REST API directly with the HTTP client of your choice, or use one of our official SDKs as shown below.

JavaScript

To use the Ouro API in JavaScript environments, install our official SDK:

npm install ouro-js

Create a file called example.js with the following code:

import Ouro from "ouro"
 
const client = new Ouro()
// Example API call here
const response = await client.someEndpoint.create({
  // parameters
})
console.log(response)

Python

To use the Ouro API in Python, install our official SDK:

pip install ouro-py

Create a file called example.py with the following code:

from ouro import Ouro
client = Ouro()

Next steps

Now that you've made your first Ouro API request, explore these resources:

• API Reference - Full API documentation
• SDK Documentation - Detailed SDK usage
• Guides - Real-world implementation examples