Developer Portal

Everything you need to integrate Optiq Code into your tools, agents, and workflows.

Get Started

Get API Keys

Generate API keys from your dashboard. Free tier available, no credit card required.

Quickstart Guide

Index your first repo and run a search query in under 2 minutes.

Install the CLI

bash

npm install -g @optiqcode/cli
optiq login
optiq index .
optiq search "your query"

API Overview

Base URL: https://api.optiqcode.com

Method	Endpoint	Description
POST	/api/v1/search	Search indexed code with natural language
POST	/api/v1/repos	Index a repository
GET	/api/v1/repos	List indexed repositories
GET	/api/v1/jobs/{job_id}	Check indexing job status
GET	/api/v1/health	Health check (no auth)

Full specification: openapi.json

Authentication

All API requests require a Bearer token. Get your API key from the dashboard.

bash

curl -X POST https://api.optiqcode.com/api/v1/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "authentication middleware", "repo_id": "my-project"}'

Scoped permissions

search:read

Search indexed code

repos:read

List repositories

repos:write

Index new repositories

repos:delete

Delete repositories

jobs:read

Check job status

Agent Integration

Optiq exposes an MCP server so AI agents can call search and indexing tools natively.

json

// Add to your MCP client config
{
  "mcpServers": {
    "optiq": {
      "command": "optiq",
      "args": ["mcp"]
    }
  }
}

Remote MCP: https://api.optiqcode.com/mcp (Streamable HTTP)

Sandbox Environment

The Free tier works as a sandbox — no credit card required, no approval process. Sign up, get an API key, and start making requests immediately.

Free tier sandbox limits

3 repositories, 50k lines indexed, 100 queries/day
Full API access including search, indexing, and MCP
Self-serve API key generation at /dashboard/api-keys
No rate limit on the health endpoint for integration testing

Machine-Readable Resources

Documentation

Quickstart, API reference, CLI commands, and integration guides.

/docs

OpenAPI Spec

Machine-readable API specification (OpenAPI 3.1) for auto-generating clients.

/openapi.json

MCP Server

Model Context Protocol server discovery for AI agent integration.

/.well-known/mcp

Agent Card

Structured agent discovery card with capabilities and authentication info.

/.well-known/agent-card.json

llms.txt

Machine-readable product overview optimized for LLM consumption.

/llms.txt

Pricing

Machine-readable pricing tiers, features, and limits in markdown.

/pricing.md

Rate Limits

Rate limit headers are included in every API response:

Header	Description
X-RateLimit-Limit	Requests allowed per window
X-RateLimit-Remaining	Requests remaining in current window
Retry-After	Seconds until rate limit resets (on 429)

SDK

Node.js / TypeScript

npm install -g @optiqcode/cli