Getting Started

Getting Started

View as Markdown

Use Apologist AI Agent API when you want Agent capabilities embedded directly in your own application.

Integration Checklist

1

Choose an Agent

Select the Agent your application should call. The Agent’s Console configuration controls behavior, knowledge, branding defaults, and available capabilities.

2

Configure Authentication

Create or obtain the API credentials required by the Agent API reference.

3

Pick Response Behavior

Decide whether your application needs streaming responses, non-streaming responses, and which output format it should request.

4

Pass Optional Context Identifiers

If useful, send user, session, or conversation identifiers so your application can preserve continuity across conversations.

5

Forward Trace Context

If your application already uses OpenTelemetry, send traceparent on Agent API calls and read traceresponse plus notification trace ids. See Tracing.

6

Render Citations

Plan your UI so cited sources returned with responses are visible and useful to readers.

Compatibility

The Agent API uses familiar chat completion patterns, so existing OpenAI-compatible client code may be a useful starting point. Confirm each request field against the generated API reference before relying on it in production.

Next Step

Review the Agent API reference in this section.