Skip to main content

Bid API Endpoints

Introduction​

The Affinity AI Bid API provides a set of RESTful endpoints for real-time bidding. All endpoints follow industry standards and best practices for performance, security, and reliability.

Core Enhancement: Affinity AI extends the standard OpenRTB 2.6 protocol with powerful Affinity AI Extensions designed for modern advertising contexts, particularly AI-powered platforms and conversational interfaces. These extensions enable:

  • Context Enhancement: Rich contextual signals for better targeting without PII
  • AdCP (Ad Context Protocol): Dynamic creative assembly and advanced ad formats
  • AI-Native Advertising: Purpose-built for LLM and conversational platforms

See the Affinity AI Extensions Overview to understand how these extensions transform standard OpenRTB into a powerful platform for modern advertising.

Available Endpoints​

OpenRTB 2.6 Endpoint​

Primary bidding endpoint implementing the OpenRTB 2.6 standard

  • Path: /openrtb2
  • Method: POST
  • Protocol: OpenRTB 2.6 with Affinity AI extensions
  • Purpose: Real-time bid requests and responses
  • Latency: < 100ms typical response time

Key Features:

Documentation:

Endpoint Architecture​

Common Characteristics​

Rate Limiting​

Rate limits apply to all endpoints:

  • Standard: 1,000 requests/second per API key
  • Premium: 10,000 requests/second per API key
  • Enterprise: Custom limits

See: Rate Limiting

Response Format​

All endpoints return JSON responses with consistent structure:

{
  "status": "success|error",
  "data": {...},
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message"
  }
}

Error Handling​

Standard HTTP status codes:

  • 200 OK: Successful request
  • 204 No Content: Successful but no bid
  • 400 Bad Request: Invalid request format
  • 401 Unauthorized: Authentication failed
  • 429 Too Many Requests: Rate limit exceeded
  • 500 Internal Server Error: Server error

See: Error Codes Reference

Performance Characteristics​

Latency Targets​

EndpointP50P95P99
OpenRTB50ms80ms100ms

Throughput​

  • OpenRTB: 100,000+ requests/second (per region)

Availability​

  • SLA: 99.9% uptime
  • Multi-region: Active-active deployment
  • Failover: Automatic with less than 1s recovery

See: Performance Guide

Regional Endpoints​

Affinity AI Bid API is deployed in multiple regions for low latency:

Production Endpoints​

RegionEndpointLocation
US Easthttps://us-east.bid.aura.comVirginia
US Westhttps://us-west.bid.aura.comCalifornia
EUhttps://eu.bid.aura.comFrankfurt
APAChttps://apac.bid.aura.comSingapore

Staging Endpoints​

RegionEndpointLocation
Globalhttps://staging.bid.aura.comUS East

Integration Patterns​

Synchronous Bidding​

Standard real-time bidding flow:

Security​

Transport Security​

  • TLS 1.3: All endpoints require HTTPS
  • Certificate Pinning: Available for mobile apps
  • HSTS: Strict transport security enabled

Request Validation​

  • Schema Validation: All requests validated against OpenRTB schema
  • Size Limits: Maximum 1MB request size
  • Timeout: 5-second request timeout

Privacy & Compliance​

  • No PII Storage: User data not persisted
  • GDPR Compliant: Privacy string support
  • CCPA Compliant: Opt-out mechanisms
  • Audit Logging: All requests logged (without PII)

See: Privacy & Compliance

Best Practices​

Connection Management​

  • Keep-Alive: Use persistent connections
  • Connection Pooling: Reuse connections
  • Timeout Settings: Set appropriate timeouts

Request Optimization​

  • Compression: Use gzip compression
  • Minimal Payloads: Include only required fields
  • Batch Requests: Not supported (use parallel requests)

Error Handling​

  • Retry Logic: Implement exponential backoff
  • Circuit Breaker: Fail fast on repeated errors
  • Fallback: Have backup endpoints ready

See: Best Practices Guide

Monitoring & Observability​

Metrics​

Key metrics to monitor:

  • Request rate (requests/second)
  • Response time (latency percentiles)
  • Error rate (errors/total requests)
  • Bid rate (bids/requests)

Logging​

Structured logging available:

  • Request/response logs
  • Error logs
  • Performance logs
  • Audit logs

Tracing​

Distributed tracing support:

  • OpenTelemetry compatible
  • Trace ID in response headers
  • End-to-end request tracking

Getting Started​

Quick Start​

1. Get API Credentials: Contact sales for API key 2. Review Documentation: Read OpenRTB Overview 3. Test Integration: Use staging endpoint 4. Go Live: Switch to production endpoint

Use Cases​

Support​

Documentation​

Help & Support​

  • Email: support@aura.com
  • Slack: Join our community
  • Status Page: status.aura.com

Next Steps​

1. Understand Core Enhancements: Review Affinity AI Extensions Overview ⭐ 2. Understand OpenRTB Foundation: Review OpenRTB Overview 3. Explore Extension Capabilities: