Quick Start

1. Create an API key

Sign in to the AsterFlow console and create an API key. Store it only in a trusted server-side environment. Never commit it to a public repository or expose it in browser code.

2. Set the API base URL

AsterFlow provides an OpenAI-compatible endpoint:

https://asterflow.ai/v1

You can use it with most SDKs and applications that support a custom OpenAI base URL.

3. List available models

curl https://asterflow.ai/v1/models \
  -H "Authorization: Bearer $ASTERFLOW_API_KEY"

Choose a model ID from the response and send a chat request:

curl https://asterflow.ai/v1/chat/completions \
  -H "Authorization: Bearer $ASTERFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<MODEL_ID>",
    "messages": [
      {"role": "user", "content": "Hello! Introduce yourself."}
    ]
  }'

Tip

When using the OpenAI SDK, set base_url to https://asterflow.ai/v1 and use your AsterFlow API key.

Next steps

Manage API keys

Create, restrict, and manage your API keys.

API reference

Explore endpoints, parameters, responses, and examples.

App integrations

Connect AsterFlow to popular AI applications and developer tools.