Crocodile

This section covers the OpenGiant REST API, offering the same powerful features as our TypeScript SDK. Use it to refine AI responses and manage personas directly from your backend.

​
Welcome to the OpenGiant API

The OpenGiant REST API gives you fine-grained control over the tone, style, and personality of your AI-powered applications. Whether you’re integrating with OpenAI, Anthropic, Cohere, or a custom LLM, our API helps ensure your AI sounds intentional, on-brand, and human.

If you’re looking for SDK-based integration, head over to our Quickstart Guide for TypeScript.

​
What You Can Do with the API

  • Refine AI Responses: Pass raw LLM outputs through OpenGiant to shape responses that resonate.
  • Manage AI Personas: Connect your applications to personas crafted in OpenGiant Studio.
  • Ensure Brand Consistency: Maintain a consistent tone and style across all user interactions.

​
Authentication

All API requests require authentication using a Bearer token.

You’ll need two keys to get started:

  • OG Key: Your personal API key from OpenGiant.
  • Provider API Key: The API key from your chosen AI provider (e.g., OpenAI, Anthropic).

Include your OG Key in the Authorization header for all requests:

Authorization: Bearer YOUR_OG_KEY

​
Base URL

All API requests are made to the following base URL:

https://api.opengiant.com/v1

​
Example Request

Here’s how you can refine an AI response using the API:

curl -X POST https://api.opengiant.com/v1/refine \
  -H "Authorization: Bearer YOUR_OG_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "openai",
    "providerApiKey": "YOUR_PROVIDER_API_KEY",
    "personaId": "YOUR_PERSONA_ID",
    "content": "I can help with that. Please specify the issue you are facing."
  }'

Expected response:

{
  "response": "I’d be happy to help with your account statement! Could you tell a little more about the issue you’re facing?"
}