Dataset Overview & Information
-
Records
-
Columns
-
Size
JSON
Format
Metadata
Created:
-
Updated:
-
License:
Open Source
Tags:
-
Quality Metrics
Completeness:
-
Accuracy:
-
Consistency:
-
Freshness:
-
Data Schema
Loading schema information...
Data Preview
Loading data preview...
API Endpoints
Loading endpoints...
Code Examples
cURL
curl "https://api.example.com/data"
Python
import requests
response = requests.get(
'https://api.example.com/data'
)
data = response.json()
Advanced Examples
curl "https://api.example.com/data?sort_by=name&sort_order=desc&limit=50"
curl "https://api.example.com/data?skip=100&limit=50"
Interactive API Testing
Select Endpoint
Request Builder
Request Body (JSON)
Response
Response
Status: -
Time: -
Size: -
Click "Send Request" to test the API
Socket.io Real-time API
Connect to your APIs using Socket.io for real-time, chat-based interactions. Ask natural language questions about your data and receive instant responses.
1. Initialize Socket Connection
POST /v1/apis/{api_id}/socket/init
Content-Type: application/json
Response:
{
"status": "success",
"message": "Socket namespace initialized for API abc123",
"socket_url": "/api/abc123",
"events": {
"chat_message": "Send chat messages for natural language queries",
"query_data": "Send structured data queries",
"stream_data": "Request data streaming",
"ping": "Keep connection alive"
}
}
2. Socket Events
Chat Messages (Natural Language)
// Send chat message
socket.emit('chat_message', {
message: "How many records are there?",
user_id: "user123",
timestamp: "2024-01-01T12:00:00Z"
});
// Receive response
socket.on('chat_response', (data) => {
if (data.type === 'success') {
console.log('Response:', data.message);
}
});
Structured Data Queries
// Send structured query
socket.emit('query_data', {
query: {
filters: { status: "active" },
sort_by: "created_at",
sort_order: "desc",
limit: 10,
offset: 0
},
user_id: "user123"
});
// Receive results
socket.on('query_result', (data) => {
if (data.type === 'success') {
console.log('Data:', data.data);
console.log('Total count:', data.total_count);
}
});
Data Streaming
// Request data streaming
socket.emit('stream_data', {
params: {
chunk_size: 100,
delay: 0.5 // seconds between chunks
},
user_id: "user123"
});
// Receive streaming chunks
socket.on('stream_chunk', (chunk) => {
console.log('Chunk:', chunk.chunk_number);
console.log('Data:', chunk.data);
console.log('Progress:', chunk.progress + '%');
});
// Streaming complete
socket.on('stream_complete', (data) => {
console.log('Streaming finished:', data.total_rows, 'records');
});
3. JavaScript Client Example
// Initialize socket connection
const apiId = 'your-api-id';
const socket = io(`${window.APIUI_AUTH_BASE_URL}/api/${apiId}`);
// Connection events
socket.on('connect', () => {
console.log('Connected to API socket');
});
socket.on('disconnect', () => {
console.log('Disconnected from API socket');
});
// Chat with your data
function askQuestion(question) {
socket.emit('chat_message', {
message: question,
user_id: 'web-user',
timestamp: new Date().toISOString()
});
}
// Listen for responses
socket.on('chat_response', (data) => {
if (data.type === 'success') {
displayMessage(data.message);
} else {
displayError(data.message);
}
});
// Query data
function queryData(filters) {
socket.emit('query_data', {
query: {
filters: filters,
limit: 10
},
user_id: 'web-user'
});
}
socket.on('query_result', (data) => {
if (data.type === 'success') {
displayData(data.data, data.total_count);
}
});
4. Python Client Example
import socketio
import json
# Create socket client
sio = socketio.Client()
@sio.event
def connect():
print('Connected to API socket')
@sio.event
def disconnect():
print('Disconnected from API socket')
@sio.on('chat_response')
def on_chat_response(data):
if data['type'] == 'success':
print('API Response:', data['message'])
else:
print('Error:', data['message'])
@sio.on('query_result')
def on_query_result(data):
if data['type'] == 'success':
print(f"Received {len(data['data'])} records")
print(json.dumps(data['data'][:3], indent=2)) # First 3 records
# Connect to your API
api_id = 'your-api-id'
backend_url = 'https://apiui-backend-44565368406.us-central1.run.app'
# First initialize the socket endpoint
import requests
init_response = requests.post(f'{backend_url}/v1/apis/{api_id}/socket/init')
print('Socket initialized:', init_response.json())
# Connect to socket
sio.connect(f'{backend_url}/api/{api_id}')
# Ask questions
sio.emit('chat_message', {
'message': 'Show me a sample of the data',
'user_id': 'python-client'
})
# Query with filters
sio.emit('query_data', {
'query': {'limit': 5},
'user_id': 'python-client'
})
# Keep connection alive
sio.wait()
Try the Interactive Chat
Experience real-time chat with your APIs using our web interface.
API Performance Metrics
99.9%
Uptime (30 days)
127ms
Avg Response Time
2.4K
Total Requests
0.1%
Error Rate
API Availability
99.9% uptime
Response Time Trends
Last 24 hours