Skip to main content

SaaS Quickstart

This guide walks you through obtaining a token using Client Credentials authentication and conversing with an agent via SSE.

Introduction

Here are the quickest steps to use the SaaS API. You can start conversing with an agent in just three steps.

Prerequisites
  • API option subscription is activated
  • Admin manager can log in to Console
  • A Client Credentials type client (application) has been created in Console (Console Setup Guide)
  • You have obtained the following information:
    • Client ID - The ID of the created client
    • Client Secret - The client secret (confidential)

Step 1: Verify Authentication Information

Before using the API, confirm you have the following information. These can be verified in the admin console.

Preparation Checklist

  • API option subscription is activated
  • Admin manager can log in to Console
  • A Client Credentials type client (application) has been created in Console
  • You have obtained the following information:
    • Client ID - The ID of the created client
    • Client Secret - The client secret (confidential)

Example

Client ID: saas-app-001
Client Secret: (hidden)

Step 2: Obtain Token

Use the Client Credentials flow to obtain an access token. Execute the following request from your server.

Request Example

curl
curl -X POST https://auth.agenticstar.jp/federation/auth/v1/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=<your-client-id>" \
-d "client_secret=<your-client-secret>"

Parameters

  • <your-client-id>: Client ID verified in Step 1
  • <your-client-secret>: Secret verified in Step 1

Response Example

JSON
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600
}
Token Expiration

The token is valid for the number of seconds specified in expires_in. Obtain a new token before expiration. The Client Credentials flow does not issue refresh tokens, so after expiration, execute the same request again. If you want to use Authorization Code flow, see the Authentication Guide.

Step 3: Call Chat API

Use the obtained access token to call the Chat API via SSE (Server-Sent Events). You will receive real-time responses from the agent in stream format.

Request Example

curl
curl -X POST https://api.agenticstar.jp/v1/chat/completions \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"model": "AGENTIC STAR",
"stream": true,
"messages": [
{
"role": "user",
"content": "こんにちは"
}
]
}'

Parameters

  • <access_token>: Access token obtained in Step 2
  • stream: true: Enable SSE streaming
  • messages: Message from user. Multiple messages can be sent in array format

Response Example (SSE Stream)

data: {"choices":[{"delta":{"content":"Hello"}}]}

data: {"choices":[{"delta":{"content":", how can I"}}]}

data: {"choices":[{"delta":{"content":"help you?"}}]}

data: [DONE]
About SSE Streaming

The response is in Server-Sent Events (SSE) format, sent in real-time in chunks. Each chunk is in the format data: JSON. The conversation completes with data: [DONE]. See Streaming Guide for details.

Next Steps

For more detailed information and implementation patterns, see the following documentation.