API Documentation
Programmatic access to the AI Office — deploy agents, manage agentic rooms, and retrieve conversational intelligence outputs via the Qik Office REST API
Secure Authentication
OAuth 2.0 and API key authentication with rate limiting and SSL encryption for secure AI Office access
Fast & Reliable
99.9% uptime SLA with global CDN and sub-100ms response times
Developer Friendly
SDKs for JavaScript, Python, Ruby, PHP, Java, and Go — with examples for deploying agents, managing rooms, and retrieving conversational intelligence outputs
API Rate Limits
Standard plans: 1,000 requests/hour | Enterprise plans: 10,000 requests/hour
Contact our sales team for custom rate limits.
Authentication
All API requests require authentication using API keys
Authorization: Bearer YOUR_API_KEYHow to Get Your API Key
- 1Log in to your Qik Office account
- 2Navigate to Settings → API Keys
- 3Click "Generate New API Key"
- 4Copy and securely store your API key
Quick Start Examples
Get started deploying agentic rooms and retrieving structured outputs with these examples
// Initialize the Qik Office API client
import { QikOfficeClient } from '@qikoffice/sdk'; const client = new QikOfficeClient({ apiKey: 'your-api-key', apiSecret: 'your-api-secret'
}); // Create a new agentic room
const room = await client.rooms.create({ title: 'Product Planning Room', startTime: '2024-01-15T10:00:00Z', duration: 30, attendees: ['user1@example.com', 'user2@example.com']
}); console.log('Agentic room created:', room.id);# Initialize the Qik Office API client
from qikoffice import QikOfficeClient client = QikOfficeClient( api_key='your-api-key', api_secret='your-api-secret'
) # Create a new agentic room
room = client.rooms.create( title='Product Planning Room', start_time='2024-01-15T10:00:00Z', duration=30, attendees=['user1@example.com', 'user2@example.com']
) print(f'Agentic room created: {room.id}')# Create a new agentic room using cURL
curl -X POST https://api.qikoffice.com/v1/rooms \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Product Planning Room", "startTime": "2024-01-15T10:00:00Z", "duration": 30, "attendees": ["user1@example.com", "user2@example.com"] }'API Endpoints
RESTful API endpoints for agentic rooms, tasks, and workspace management — including structured artifact retrieval
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/rooms | List all agentic rooms |
| POST | /api/v1/rooms | Create a new agentic room |
| GET | /api/v1/rooms/{id} | Get agentic room details and structured artifacts |
| GET | /api/v1/tasks | List all tasks |
| POST | /api/v1/tasks | Create a new task |
| PUT | /api/v1/tasks/{id} | Update a task |
| GET | /api/v1/users | List workspace users |
| POST | /api/v1/users | Invite a new user |
View complete endpoint documentation with request/response schemas
Request Full API ReferenceAvailable SDKs
Official libraries for popular programming languages
JavaScript/Node.js
v2.1.0@qikoffice/sdkPython
v1.5.2qikoffice-sdkRuby
v1.3.1qikoffice-rubyPHP
v1.4.0qikoffice/sdkJava
v1.2.5com.qikoffice.sdkGo
v0.9.3github.com/qikoffice/go-sdkNeed Help with API Integration?
Our developer support team is here to help you build integrations that deploy agents, manage agentic rooms, and surface conversational intelligence outputs