API reference overview

For integration engineers wiring combo agent into existing systems—start here.

Sections

Base URLs & auth

Base URL

• SaaS: https://api.your-combo-saas.com/v1
• On-premises: http://<your-host>:9380/v1

Authentication

Create API keys under Personal settings → API keys; webhook secrets under Integrations → Webhooks.

Versioning

• Stable surface: /v1/*, backward compatible
• Deprecation: ≥6 months notice via release notes before removal after another 6 months
• Responses may include X-Deprecated: true plus X-Deprecated-Sunset: <date>

Response envelopes

Default JSON

{
  "code": 0,
  "data": { "...": "..." },
  "message": "ok"
}

Streaming (SSE)

Used for completions (text/event-stream):

event: message
data: {"answer": "...", "reference": [...]}

event: done
data: {"session_id": "..."}

Rate limits

Default per API key:

HTTP 429 Too Many Requests includes Retry-After.

SDKs & codegen

Community SDKs may be generated from the published OpenAPI document:

GET /v1/openapi.json

Quick samples

Python

from combo_sdk import ComboAgent
 
client = ComboAgent(api_key="ragflow-...", base_url="https://...")
 
session = client.sessions.create(agent_id="...")
response = client.completions.create(
    session_id=session.id,
    question="Review this PR for me",
    stream=False,
)
print(response.answer)

curl

curl -H "Authorization: Bearer ragflow-..." \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{"question":"hello","session_id":"...","stream":false}' \
     https://api.your-combo-saas.com/v1/combo/agents/{agent_id}/completions

Tooling

• Postman collection — download from the admin console API page
• Swagger UI — /v1/docs

Related docs

• Session model
• Integrations hub
• Security overview