Getting started

The SeekrFlow API provides programmatic access to train, validate, deploy, and manage AI models. You can use the API to build applications across financial services, customer support, risk management, and compliance workflows.

This guide shows you how to authenticate and make your first API request. To use the Python SDK instead, see the Developer Guide.

Prerequisites

Before you begin, you need a SeekrFlow account. If you don't have one, sign up for SeekrFlow.

Get your API key

1. Sign in to the SeekrFlow dashboard.
2. From the user menu, go to My Account.
3. From the My Account page, go to API Key.
4. Generate and copy a new key.

⚠️

Important

Keep your API key secure. Don't share it in publicly accessible areas such as GitHub, client-side code, or support channels.

Base URL

All API requests use this base URL:

https://flow.seekr.com/v1

Authentication

All API requests require authentication. Include your API key in the Authorization header:

Authorization: YOUR_API_KEY

Request and response format

For POST and PUT requests, send data as JSON and include the Content-Type header:

curl --location 'https://flow.seekr.com/v1/flow/agents/create' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: YOUR_API_KEY' \
--data '{
  "name": "EXAMPLE",
  "instructions": "EXAMPLE",
  "tools": [
    {
      "name": "web_search",
      "tool_env": {
        "WEB_SEARCH_TOOL_DESCRIPTION": "TESTING"
      }
    }
  ],
  "model_id": "43"
}'

All responses use JSON format. Each endpoint's response schema is documented in the SeekrFlow API.

Versioning

The API version is included in the URL path (v1). When breaking changes are introduced:

1. A new API version is released.
2. The current version continues to function.
3. You receive notification with migration timelines before deprecation.

This approach ensures your application continues to work while you migrate to a new version.