Developer Login

Nyata AI Developer Portal

Build innovative applications with our AI characters featuring authentic Bristol accents and local knowledge

API Documentation Create Developer Account

Getting Started

Learn how to integrate Nyata AI's characters into your applications in minutes

Create an Account

Sign up for a free developer account to get your API key and start exploring our platform. No credit card required.

Create Account

Get Your API Key

Generate your API key from your developer dashboard. You'll need this to authenticate all your API requests.

Generate API Key

Make Your First API Call

Start with a simple API call to get a list of our available AI characters.

curl -X GET "https://api.nyata.ai/v1/characters" \ -H "Authorization: Bearer YOUR_API_KEY"
View Endpoint Documentation

Key Features

Explore the unique capabilities of our AI characters API

  • Authentic Bristol Characters Access AI characters with genuine Bristol accents, local dialect, and knowledge about specific neighborhoods and resources.
  • Natural Conversations Engage users with conversational AI that understands context, remembers previous interactions, and responds in a natural, friendly manner.
  • Extensive Local Knowledge Access accurate information about Bristol's neighborhoods, venues, services, events, and more through our specialized local knowledge endpoints.
  • Character Personalization Adjust character responses to match user preferences or adapt to specific contexts, creating more personalized interactions.
  • Fast Response Times Our API is designed for speed with response times typically under 300ms, ensuring smooth, real-time conversations.
  • Secure & Compliant Built with security in mind, featuring encryption, access controls, and compliance with data protection regulations.
  • Analytics & Insights Track user interactions, analyze conversation patterns, and gain insights to improve engagement.
  • Easy Integration Comprehensive documentation, SDKs for popular languages, and webhook support make integration straightforward.

Code Examples

Get started quickly with example code in multiple programming languages

JavaScript
Python
PHP
Ruby
cURL
// Install the package: npm install nyata-ai const NyataAI = require('nyata-ai'); const client = new NyataAI('YOUR_API_KEY'); // Start a conversation with Brenda async function startConversation() { try { // Initialize a conversation const conversation = await client.conversations.create({ character_id: 'brenda', user_id: 'user_123', initial_context: { location: 'Stokes Croft, Bristol', preferences: ['affordable', 'vegetarian'], query_type: 'food_recommendation' } }); console.log('Conversation started:', conversation.id); console.log('Initial greeting:', conversation.initial_message.content); // Send a message const message = await client.conversations.sendMessage( conversation.id, { content: "I'm looking for affordable food options near Stokes Croft." } ); // Get the AI reply const reply = await client.conversations.getReply(conversation.id); console.log('Brenda says:', reply.content); // Access the entities extracted from the response if (reply.entities && reply.entities.locations) { console.log('Suggested locations:', reply.entities.locations); } } catch (error) { console.error('Error:', error); } }
# Install the package: pip install nyata-ai from nyata_ai import NyataAI client = NyataAI("YOUR_API_KEY") # Start a conversation with Brenda def start_conversation(): try: # Initialize a conversation conversation = client.conversations.create( character_id="brenda", user_id="user_123", initial_context={ "location": "Stokes Croft, Bristol", "preferences": ["affordable", "vegetarian"], "query_type": "food_recommendation" } ) print(f"Conversation started: {conversation.id}") print(f"Initial greeting: {conversation.initial_message.content}") # Send a message message = client.conversations.send_message( conversation.id, content="I'm looking for affordable food options near Stokes Croft." ) # Get the AI reply reply = client.conversations.get_reply(conversation.id) print(f"Brenda says: {reply.content}") # Access the entities extracted from the response if hasattr(reply, 'entities') and hasattr(reply.entities, 'locations'): print(f"Suggested locations: {reply.entities.locations}") except Exception as e: print(f"Error: {e}") if __name__ == "__main__": start_conversation()
// Install the package: composer require nyata/nyata-ai conversations->create([ 'character_id' => 'brenda', 'user_id' => 'user_123', 'initial_context' => [ 'location' => 'Stokes Croft, Bristol', 'preferences' => ['affordable', 'vegetarian'], 'query_type' => 'food_recommendation' ] ]); echo "Conversation started: " . $conversation->id . PHP_EOL; echo "Initial greeting: " . $conversation->initial_message->content . PHP_EOL; // Send a message $message = $client->conversations->sendMessage( $conversation->id, ['content' => "I'm looking for affordable food options near Stokes Croft."] ); // Get the AI reply $reply = $client->conversations->getReply($conversation->id); echo "Brenda says: " . $reply->content . PHP_EOL; // Access the entities extracted from the response if (isset($reply->entities) && isset($reply->entities->locations)) { echo "Suggested locations: " . json_encode($reply->entities->locations) . PHP_EOL; } } catch (Exception $e) { echo "Error: " . $e->getMessage() . PHP_EOL; }
# Install the gem: gem install nyata-ai require 'nyata_ai' client = NyataAI::Client.new('YOUR_API_KEY') # Start a conversation with Brenda begin # Initialize a conversation conversation = client.conversations.create( character_id: 'brenda', user_id: 'user_123', initial_context: { location: 'Stokes Croft, Bristol', preferences: ['affordable', 'vegetarian'], query_type: 'food_recommendation' } ) puts "Conversation started: #{conversation.id}" puts "Initial greeting: #{conversation.initial_message.content}" # Send a message message = client.conversations.send_message( conversation.id, content: "I'm looking for affordable food options near Stokes Croft." ) # Get the AI reply reply = client.conversations.get_reply(conversation.id) puts "Brenda says: #{reply.content}" # Access the entities extracted from the response if reply.respond_to?(:entities) && reply.entities.respond_to?(:locations) puts "Suggested locations: #{reply.entities.locations}" end rescue => e puts "Error: #{e.message}" end
# Start a conversation curl -X POST "https://api.nyata.ai/v1/conversations" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "character_id": "brenda", "user_id": "user_123", "initial_context": { "location": "Stokes Croft, Bristol", "preferences": ["affordable", "vegetarian"], "query_type": "food_recommendation" } }' # Send a message (replace CONVERSATION_ID with the ID returned from the previous call) curl -X POST "https://api.nyata.ai/v1/conversations/CONVERSATION_ID/messages" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "content": "I'\''m looking for affordable food options near Stokes Croft." }' # Get the AI reply curl -X GET "https://api.nyata.ai/v1/conversations/CONVERSATION_ID/messages/reply" \ -H "Authorization: Bearer YOUR_API_KEY"

View Full API Documentation

Client Libraries & SDKs

Official client libraries to help you integrate with our API quickly and easily

JavaScript

Use our JavaScript SDK to integrate Nyata AI into your web applications or Node.js backends.

npm install nyata-ai
View on GitHub

Python

Integrate Nyata AI into your Python applications with our official Python library.

pip install nyata-ai
View on GitHub

PHP

Add Nyata AI capabilities to your PHP websites and applications.

composer require nyata/nyata-ai
View on GitHub

Ruby

Integrate Nyata AI into your Ruby applications and Rails projects.

gem install nyata-ai
View on GitHub

Missing a language? Let us know what you'd like to see next.

View All Libraries on GitHub

API Status

Check the current status of our API services

API Platform Status

Operational

Conversation Service

Operational

Knowledge Database

Operational

Authentication Service

Operational
Average Response Time
275 ms
Uptime (Last 30 days)
99.98%

View Detailed Status Page

API Pricing

Flexible pricing options to suit your needs, from hobbyists to enterprises

Free

For developers just getting started

£0

per month

  • 1,000 API calls per month
  • Access to all AI characters
  • Basic conversation functionality
  • Community support
  • Rate limit: 60 requests/minute
Sign Up Free

Standard

For startups and growing apps

£49

per month

  • 25,000 API calls per month
  • Access to all AI characters
  • Advanced conversation features
  • Email support
  • Rate limit: 300 requests/minute
  • Webhook integrations
Start Free Trial

Premium

For businesses with serious needs

£199

per month

  • 100,000 API calls per month
  • Access to all AI characters
  • Full feature set & priority access
  • Dedicated support & SLA
  • Rate limit: 600 requests/minute
  • Custom character development
Contact Sales

Need a custom plan or have specific requirements?

Enterprise Solutions

Frequently Asked Questions

Find answers to common questions about our developer platform

What can I build with the Nyata AI API?

The Nyata AI API enables you to build a wide range of applications that can benefit from AI characters with Bristol accents and local knowledge. Some examples include:

  • Chatbots for websites and customer service
  • Virtual guides for Bristol-based tourism apps
  • Personalized local recommendation systems
  • Interactive storytelling experiences
  • Educational tools about Bristol culture and history
  • Community resource finders for social services

How do I get started with the API?

Getting started is simple:

  1. Sign up for a free developer account
  2. Generate your API key from your dashboard
  3. Install one of our client libraries for your preferred programming language
  4. Make your first API call following our quickstart guide

Our documentation includes step-by-step tutorials and code examples to help you implement specific features quickly.

What is the difference between characters?

Each character has a unique personality, area of expertise, and knowledge base:

  • Brenda: A community guide with knowledge of local resources, support services, and neighborhoods
  • Jack: Specializes in student life, including university information, student discounts, and campus resources
  • Margaret: Focuses on Bristol's history, landmarks, and cultural heritage
  • Sam: A wellness-focused character who can discuss mental health resources and wellbeing
  • Dave: An expert on Bristol's food and drink scene

You can view the complete list of characters and their capabilities through the GET /characters endpoint.

What happens when I exceed my API quota?

When you reach your monthly API call limit, requests will return a 429 Too Many Requests response with information about your quota usage. You have several options:

  • Upgrade to a higher tier plan to increase your quota
  • Purchase additional API calls as a one-time add-on
  • Wait until your quota resets at the beginning of your next billing cycle

You can monitor your current usage and remaining quota in your developer dashboard.

Is there a way to test the API before committing?

Yes, we offer multiple ways to test the API:

  • Our free tier includes 1,000 API calls per month with no credit card required
  • Standard and Premium plans include a 14-day free trial
  • Our interactive API documentation includes a playground where you can test endpoints directly
  • Code examples in our documentation can be run in your development environment

These options allow you to thoroughly test the API capabilities before committing to a paid plan.

View All FAQs

Developer Resources

Tools and resources to help you succeed with the Nyata AI API

Documentation

Comprehensive guides, API reference, and tutorials to help you implement our API effectively.

Read Documentation

Sample Projects

Explore example applications and projects that demonstrate real-world implementations of our API.

View Sample Projects

Community Forum

Connect with other developers, share ideas, ask questions, and get help from our community.

Join the Community
Explore All Resources

Ready to Start Building?

Create your developer account today and start integrating Nyata AI's unique Bristol characters into your applications.

Create Free Account View Documentation