Quickstart Guide

Get up and running with Co-one in minutes. This guide will walk you through setting up your account, obtaining an API key, and making your first request.

1. Sign Up & Get API Key

First, create an account on the Co-one dashboard. Once logged in, navigate to the Settings page and generate a new API key.

WARNING: Keep your API key secret. Do not commit it to version control.

2. Make Your First Request

Use `curl` or your favorite HTTP client to send a request to the Co-one API. Here's an example of how to evaluate a simple text response.

// Evaluate a response
curl -X POST https://api.co-one.co/v1/evaluate/grounding \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "What is the capital of France?",
    "response": "Paris is the capital of France.",
    "context": ["Paris is the capital and most populous city of France."]
  }'

3. Analyze the Response

The API will return a JSON object containing the evaluation results, including the grounding score and any detected issues.

{
  "id": "eval_123456789",
  "score": 1.0,
  "reliability": 0.99,
  "safe": true,
  "violations": []
}

Choose whether to allow optional analytics and marketing tags.