Quickstart

This quickstart takes you from organization setup to a working API request through the public Gateway API.

1. Prepare Company Setup

Start in Company Setup.

1. In Models, add at least one provider key and enable the models your organization allows applications to use.
2. In Governance, set data residency and training restrictions if your organization needs them.
3. In Data Integrations, enable vector search and create data sources if your applications need document retrieval.
4. In Tools, enable web search if your applications need current web context.

Provider keys are used only by Optiak to call upstream model providers. They are different from application API keys.

2. Create an Application

Go to Applications -> New Application.

Provide a name and optional description. During creation you can also configure the application's modules:

• Guardrails - Detect prompt injection attempts and personal or sensitive information.
• Data Integrations - Allow vector search over selected organization data sources.
• Tools - Allow web search.
• Models - Choose which organization-enabled models this application can use.
• Smart Router - Let Optiak choose among eligible models when the request uses smart.
• Inference - Set the application system prompt, choose how it combines with request-level instructions, and configure max completion tokens.
• Cost - Set a monthly cost budget for application visibility.

You can change these settings later from the application's Modules tab.

3. Select Application Models

Open your application and go to Modules -> Models.

Enable the models this application may use. The application cannot use models that are not enabled at the organization level.

4. Create an Application API Key

Open your application and go to Credentials -> New Key.

Copy the generated value immediately. It is shown once. This is the key your service uses in the Authorization header when calling the public Gateway API.

5. Validate Available Models

Use the public API base URL and the application API key:

export OPTIAK_BASE_URL="https://api.optiak.dev/v1"
export OPTIAK_API_KEY="your_application_api_key"

curl "$OPTIAK_BASE_URL/models" \
  -H "Authorization: Bearer $OPTIAK_API_KEY"

The response contains the models this application key can use:

{
  "data": [
    {
      "id": "openai/gpt-5-nano",
      "model_name": "gpt-5-nano",
      "model_type": "inference",
      "context_window": 128000,
      "smart_routing": true
    }
  ]
}

6. Send a Request

Use smart when Smart Router is enabled for the application. To call a specific model directly, use a public model ID returned by /models, such as openai/gpt-5-nano.

export OPTIAK_BASE_URL="https://api.optiak.dev/v1"
export OPTIAK_API_KEY="your_application_api_key"

curl "$OPTIAK_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $OPTIAK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "smart",
    "messages": [
      { "role": "user", "content": "Write a short product FAQ." }
    ]
  }'

For Python, JavaScript, SDK, cURL, and streaming examples, see Using the API.

7. Monitor the Request

Open the application's Requests tab to inspect the request and its platform timeline.

Use the Dashboard for organization-wide observability across traffic, health, cost behavior, and module usage.